joomla/Component-Builder
40
26
Fork 12
Code Issues 82 Pull Requests 2 Projects 4 Wiki Activity

Updated 4a. JCB Demo Component Directory, Folders and Files (markdown)

Joseph Geller
2018-09-19 11:43:29 -05:00
parent 69d7972000
commit f26ba360fc
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
4a.-JCB-Demo-Component-Directory,-Folders-and-Files.md

@@ -1,4 +1,4 @@
The directories, folders and files of the JCB Demo component, found in the JCB Demo installation package named com_demo_v2_0_0__J3.zip are presented here for your convenience. For simplicity, it is recommended you install only Joomla! and the JCB component without installing the JCB Demo component using the Joomla! installer. This allows you to focus on the following:
The directories, folders and files of the JCB Demo component, found in the JCB Demo installation package named com_demo_v2_0_0__J3.zip are presented here for your convenience. Other topics are presented that will facilitate the process. For simplicity, it is recommended you install only Joomla! and the JCB component without installing the JCB Demo component using the Joomla! installer. This allows you to focus on the following:
* JCB
* JCB Demo package import
@@ -39,7 +39,7 @@ Debugging tools are an essential part of any developer's IDE. Spending hours try
There are [many other features]([XDEBUG debugging](https://netbeans.org/kb/docs/php/debugging.html)) and functionalities not mentioned here. Effective debugging is indispensable during the development cycle of a component. It enhances the JCB build process and allows you to quickly identify and resolve issues in the component after JCB has compiled it successfully, but the component has run-time errors. Also, make use of Joomla's! built in debugging enabled in its configuration settings. The stack trace it displays, including links if using XDEBUG, are also indispensable. Plus, it integrates with an IDE like NetBeans using the [Chrome NetBeans extension]([Interaction with Chrome](https://chrome.google.com/webstore/detail/netbeans-connector/hafdlehgocfcodbgjnpecfajgkeejnaa?hl=en)).
It should be mentioned for those wishing to take the quick path you can browse com_demo_v2_0_0__J3.zip directly using Windows File Explorer as one example and skim through the tree and files without extracting it. However, this is a Joomla! component install package so it will not have the exact same directory structure. Doing this does have benefit as adn this explains hiw the package wroksFor some, this is all they require, especially if they are very experienced PHP developers, have used the Joomla! API extensively and found JCB was not very difficult to learn by just reading its code. However, if you are not at this point yet, creating the text file and performing the same analysis done here for your own component or ones freely supplied by JCB, as some are complex, is an excellent exercise. Make notes in your text file as you browse through the directories and files on your development site for later review or revisiting concepts that perhaps were not very clear at the time. Follow along as you go through the directory tree on your system. Locate and open the files in each one shown below and view its contents. Good study habits will enable you to progress quickly to become an advanced developer of components built using the MVC paradignm, JCB and the Joomla! API. Microsoft Notepad is not recommended by the way to accomplish this, despite your level of expertise. It, along with the other tools mentioned here, allows you to save a lot of time, develop more components and most importantly, adhere to the MVC paradigm which is a time-saver in itself.
It should be mentioned for those wishing to take the quick path you can browse com_demo_v2_0_0__J3.zip directly using Windows File Explorer as one example and skim through the tree and files without extracting it. However, this is a Joomla! component install package so it will not match the directory structure. Doing this does have benefit as adn this explains hiw the package wroksFor some, this is all they require, especially if they are very experienced PHP developers, have used the Joomla! API extensively and found JCB was not very difficult to learn by just reading its code. However, if you are not at this point yet, creating the text file and performing the same analysis done here for your own component or ones freely supplied by JCB, as some are complex, is an excellent exercise. Make notes in your text file as you browse through the directories and files on your development site for later review or revisiting concepts that perhaps were not very clear at the time. Follow along as you go through the directory tree on your system. Locate and open the files in each one shown below and view its contents. Good study habits will enable you to progress quickly to become an advanced developer of components built using the MVC paradignm, JCB and the Joomla! API. Microsoft Notepad is not recommended by the way to accomplish this, despite your level of expertise. It, along with the other tools mentioned here, allows you to save a lot of time, develop more components and most importantly, adhere to the MVC paradigm which is a time-saver in itself.
Beneath the directory structure and files presented next you will find a short explanation of their relation to the component, the areas of the JCB component that builds each and JCB's interaction with the Joomla! API. You'll see how JCB reuses and extends Joomla!'s abstract base classes, including their methods and properties to implement the many features and functions built into JCB which are utilized by you while building a component. As you peruse the directory structure and files, links are available allowing you to quickly go to the explanatory text below the directory structure for that file, including a reference to where in JCB it originated from and any interaction between JCB and the Joomla! API.
***