joomla/Component-Builder
joomla
/
Component-Builder
38
20
Fork 11
Code Issues 54 Pull Requests Projects 3 Releases Wiki Activity

Updated 040 Adding Helper Structures to any JCB component (markdown)

Amigo 2019-08-03 11:06:03 +02:00
parent 8d763f2573
commit 4ab284c421
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
040-Adding-Helper-Structures-to-any-JCB-component.md

@ -62,10 +62,10 @@ What has happened in the code? If the 'com_demo_v2_0_0_J3.zip' package of a comp
To illustrate what happens if the component is no longer installed, and a attempt is made to compile it: First thing is to uninstall the Demo Component. Then go to the compiler and try and compile Demo Component. It will indicate 'An error has occurred' and that it could not find "Table 'demo.#_demo_help_document'doesn't exist". [00:14:24](https://www.youtube.com/watch?v=nw9YPu9emws&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h14m24s) It could not find that table because it has been uninstalled. The only way to compile this component would be to go back to the Admin View, and 'delink' the component from the table. Remember to compile the component before you uninstall the component which you are linking to. We are linked to the installed components table. [00:14:55](https://www.youtube.com/watch?v=nw9YPu9emws&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h14m55s) Use a Dump file to avoid this , instead of linking to the table. Select 'Dump' and open the 'sql' file that it created, and copy the values from that file. Paste those values in here MySQL. [00:15:28](https://www.youtube.com/watch?v=nw9YPu9emws&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h15m28s) You could leave a comment or even leave a comment out. Save and close. Even if the component is uninstalled it will still be possible to compile and still have this Demo or Shipping values of the component in place. Let's compile it again. This time it compiled without any errors. [00:16:04](https://www.youtube.com/watch?v=nw9YPu9emws&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h16m04s) If the 'com_demo_v2_0_0_J3.zip' package is opened, and then open 'install.mysql.utf8.sql' file. It may be seen that it added that Dump Values right back into the file, and that is exactly what it should do. This was just to demonstrate how to add a Help Menu Structure to any JCB Component. [00:16:45](https://www.youtube.com/watch?v=nw9YPu9emws&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h16m45s)
You could do that without purchasing the Sermon Distributor Component. The only part that really is necessary, is to create a Helper Document, and of course this Helper Document that is used from the Sermon Distributor Package has custom scripting in it. It is this custom scripting that makes it adaptable to any other Component.<<<<<
I can quickly show you which areas this custom scripting must go, [00:17:18](https://www.youtube.com/watch?v=nw9YPu9emws&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h17m18s) but I would rather want you to buy the Components Package. It's in a relation to the Articles, and to the Site Views, and the Admin View, that we have Custom Fields that are a little tricky, as well as the user group. You need to [00:17:42](https://www.youtube.com/watch?v=nw9YPu9emws&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h17m42s) have a little perspective on how to setup user groups.
You could do that without purchasing the Sermon Distributor Component. The only part that really is necessary, is to create a Helper Document, and of course this Helper Document that is used from the Sermon Distributor Package has custom scripting in it. It is this custom scripting that makes it adaptable to any other Component.
### JCB Detects If It Is A Help Document
Admin View and Site View are the two areas that are difficult as well as the Articles. When JCB detects that this is a Help Document, and it detects those specific field values that are set up correctly, then it automatically build some of the front-end necessary concepts as well as adding this dynamic behavior in the back end. I hope this helps to at least show you that it is very doable, the adding in help [00:18:25](https://www.youtube.com/watch?v=nw9YPu9emws&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h18m25s) structure to a component. What I think makes this quite unique is that the component then ships with this pre-built in Help Structure, but the user that uses your component, he might want to give extra help or little different kind of help to the front end users of his Website, and he will be having access to this Help Area and editing it and changing it to the correct wording and expectations that he might have. [00:18:59](https://www.youtube.com/watch?v=nw9YPu9emws&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h18m59s) That is the way that you could add Helper structures to your JCB components.
[00:17:51](https://www.youtube.com/watch?v=nw9YPu9emws&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h17m51s)
When JCB detects that this is a Help Document, and it detects those specific field values that are set up correctly, then it automatically build some of the necessary front-end concepts as well as adding this dynamic behavior in the back end. What makes this unique is that the component is shipped with this pre-built in Help Structure, but the user that uses your component, might want to give extra help or a little different kind of help to the front end users of his Website, and he will have access to this Help Area and editing it and changing it to the correct wording and expectations that he might have. [00:18:59](https://www.youtube.com/watch?v=nw9YPu9emws&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h18m59s) That is the way that you could add Helper structures to your JCB components.