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

Updated 010 Component Settings (markdown)

Amigo 2019-06-07 08:30:00 +02:00
parent 5055764467
commit d9831ed600
1 changed files with 16 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
010-Component-Settings.md

@ -1,33 +1,32 @@
# COMPONENT SETTINGS
Now that we've added the admin views to the component, let's look at some of the features still available inside components. Adding your custom admin views is done there and the site views is done here. (See video.) There is a custom admin menus. Controlling the menu structures for these and custom admin views in the site views are done inside these. This is if you are adding custom back end views that haven't been developed inside of component builder. [00:00:40](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h00m40s)
Now that we've added the admin views to the component, let's look at some of the features still available inside components. Adding your custom admin views is done there and the site views is done here. (See video.) There is a 'custom admin menus'. Controlling the menu structures for these and custom admin views in the site views are done inside these. This is if you are adding custom back end views that haven't been developed inside of component builder. [00:00:40](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h00m40s)
**Compiler Info**
Component builder its self has a compiler view. It's this view here. This entire view is done outside component builder. [00:01:04](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h01m04s) It needs a model, a controller, a view, and everything in regards to it if you look at my infrastructure of component builder. [00:01:32](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h01m32s) You would see that I have a place called custom. Inside custom everything that you want to include inside of your component is added into the custom folder. Anything that you want to integrate is in here. [00:02:02](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h02m02s) You might find a bunch of things already there. I would encourage you not to remove them because depending on what you do in component builder it will automatically include these. (See video.) [00:02:32](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h02m32s) All of these are in the custom tab. There are files as well. The component builder itself has its compiler view here. It is just empty folders. The actual files and the default compiler file is here; if I open it the script shows a dropdown of items. [00:02:59](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h02m59s) I also have the controller, the model, the compiler, and the helper file. I am including it into my component.[00:03:48](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h03m48s)
>>>>>>>>>>>>>>>>>>>>>>> Edited.
Component builder its self has a compiler view. It's this view here. This entire view is done outside component builder. [00:01:04](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h01m04s) It needs a model, a controller, a view, and everything in regards to it if you look at the infrastructure of component builder. [00:01:32](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h01m32s) You would see there is place called custom. Inside custom everything that you want to include inside of your component is added into the custom folder. Anything that you want to integrate is in here. [00:02:02](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h02m02s) You might find a bunch of things already there. I would encourage you not to remove them because depending on what you do in component builder it will automatically include these. (See video.) [00:02:32](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h02m32s) All of these are in the custom tab. There are files as well. The component builder itself has its compiler view here. It is just empty folders. The actual files and the default compiler file is here; if I open it the script shows a dropdown of items. [00:02:59](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h02m59s) I also have the controller, the model, the compiler, and the helper file. I am including it into my component.[00:03:48](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h03m48s)
**Adding Custom Files - Folders**
In files I'm including a bunch of things and that also means I'm including that. Here it is the compiler. And I'm saying take this file and put it in admin views compiler and rename it. See it's got the wrong name here. If you add the right name at the end of the string and click yes, it will rename that file to this, that is adding custom [00:04:16](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h04m16s) files as well as custom folders. I'm grabbing the compiler views and dumping it into views, and rename it to compiler, compiler views becomes compiler inside of the views folder. The system will first build the folders and then move your data your files to those folders. You will put the files here(see video). [00:04:44](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h04m44s) And then have the system do the folders and then it will move the files. That's adding custom files to any component.
In files I'm including a bunch of things and that also means I'm including the 'Compiler' and then I take this file and put it in 'admin views compiler' and rename it. In this instance it got the wrong name. If you add the right name at the end of the string and click 'yes', it will rename that file to this(See video), that is adding custom [00:04:16](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h04m16s) files as well as custom folders. I'm grabbing the compiler views and dumping it into views, and rename it to compiler, compiler views becomes compiler inside of the views folder. The system will first build the folders and then move your data your files to those folders. You will put the files here(see video). [00:04:44](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h04m44s) And then have the system do the folders and then it will move the files. That's adding custom files to any component.
**Adding Custom Admin Views**
This custom admin menu is basically what I use to the map the compiler menu. I want to call it compiler, the code is compiler. I'm not using a link, because it's not another extension or another website or something like that which you can also do. Then I would select an icon. Here is the information. It's the same kind of switches [00:05:17](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h05m17s) As with adding a back end admin view. You can tweak whether it should be an admin menu or be a dashboard and be a submenu. So you can tweak that. Then also in which order behind it says 'select before what admin view this one should be placed'. We are placing it before component. That means it can [00:05:49](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h05m49s) go at the very top. That is adding a custom admin menu. Because of custom files and folders that you have created by hand and are importing into your component when you compile it. The same is done with the compiler of component builder. I'm actually including it as files. [00:06:16](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h06m16s) There is the compiler. I took all the compiler files and I put it in the folder called compiler. There it is and it's a folder which moves all the files at once. That can also be done, like for example, as you see here PHPExcel which is a folder has a lot of content in it if we were to open it. [00:06:48](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h06m48s) You'd see all these files and folders and things. I put everything I wanted to move inside of this folder and then in my component I simply target that folder and it pulls it in full. That's simply showing you how I have added a whole lot of folders to component builder. When I need a back end admin view custom [00:07:18](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h07m18s) added, this feature here(Custom Admin Views - add) does that for me.
This custom admin menu is basically what I use to the map the compiler menu. I want to call it compiler, the code is compiler. I'm not using a link, because it's not another extension or another website or something like that which you can also do. Then I would select an icon. Here is the information. It's the same kind of switches [00:05:17](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h05m17s) as with adding a back end admin view. You can tweak whether it should be an admin menu or be a dashboard or be a submenu. Then also in which order behind it says 'select before what admin view this one should be placed'. We are placing it before component.
That means it can [00:05:49](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h05m49s) go at the very top. That is adding a custom admin menu. Because of custom files and folders that you have created by hand and are importing into your component when you compile it. The same is done with the compiler of component builder. I'm actually including it as files. [00:06:16](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h06m16s) There is the compiler(See video). I took all the compiler files and I put it into the folder called compiler. There it is and it's a folder which moves all the files at once. That can also be done, like for example, as you see here 'PHPExcel' which is a folder with a lot of content in it. [00:06:48](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h06m48s) I put everything I wanted to move inside of this folder and then in my component I simply target that folder and it pulls it in .That's simply shows how a whole lot of folders are added to component builder. When I need a back end admin view custom [00:07:18](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h07m18s) added, this feature here(Custom Admin Views - add) does that.
**Adding Custom Config Fields**
I also want to quickly cover the area called config. This area deals with something that is actually quite useful. That is to set up your back end global fields. [00:07:42](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h07m42s) Let me go to sermon distributor. There we've done some really amazing things. sermon distributor, settings and then config. As you can see it is a very long list of things. If we go to the actual component, let me open it and then I'll click on options. [00:08:25](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h08m25s) You will see that it has many tabs.
A quick overview of the area called config. This area deals with something that is actually quite useful. That is to set up your back end global fields. [00:07:42](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h07m42s) Let me go to sermon distributor. There we've done some really amazing things.Go to 'Sermon distributor', 'settings' and then 'config'. As you can see it is a very long list of things. If we go to the actual component, let me open it and then I'll click on options. [00:08:25](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h08m25s) You will see that it has many tabs. <<<<<<
>>>>>>>>>>>>>>>>>
**Custom Switches Using Sermon Component**
All of these switches are done in the config area. All of them except some of these default switch. Is added by to the simple switches. For example the global timer, remember we spoke about the check-in. Here you can set it all whether it should be every 5 hours, 12 hours, once a day, every second day, once a week or never. Checking in your items automatically. The version control buttons are added automatically as well. Which means the person can set the version control on or off. [00:09:07](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h09m07s) And also set, how many records should be set. If zero then all versions will be saved. This is the version control.
All of these switches are done in the config area. All of them except some of these default which is added by to the simple switches. For example the global timer, remember we spoke about the check-in. Here you can set it all whether it should be every 5 hours, 12 hours, once a day, every second day, once a week or never. Checking in your items automatically. The version control buttons are added automatically as well. Which means the person can set the version control on or off. [00:09:07](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h09m07s) And also set, how many records should be set. If zero then all versions will be saved. This is the version control.
**Adding Contributors**
@ -39,7 +38,10 @@ And if you have in the component you can actually set that it includes UIKit, yo
**Adding Fields To Custom Config Fields**
To add fields to the config area, you first need to add that field to fields. [00:11:07](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h11m07s) You would go to fields and whatever field you want to use there, you need to create here(Fields). So you first create the fields. Then you need to remember the system name that you're using. Because then when you open up this(add) you would be able to type in the name and it will be selected. And then by convention that tab name as long as you use the same tab name it will be bundled in the order of which you set it here. [00:11:40](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h11m40s) This is where the Dropbox area all there fields are being set. The reason why we include this demo component into the application with the tutorial, is that you can go and look and see he's using [00:12:00](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h12m00s) Dropbox update method here. Then you can go look at this file. The Dropbox update method, the files, and the text, and even some of this(Update listing Now!) I mean here is a button. If I click it [00:12:23](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h12m23s) it starts an update. It even shows it here. How to do this is very tricky. It's not that simple to do that because we are not inside of our component, as you can see, were actually in the config component in the global if you have global settings. This whole feature that is build into sermon distributor is so smart I would tell you For you to be able to do that is just stunning. [00:12:56](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h12m56s) You can look at how I've done that by simply going to these fields and you would find the answer to how did he do that. And you can look at these things in this list view. All the Dropbox information is there. And then there is some global like, local folder, download link.
To add fields to the config area, you first need to add that field to fields. [00:11:07](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h11m07s) You would go to fields and whatever field you want to use there, you need to create here(Fields). So you first create the fields. Then you need to remember the system name that you're using. Because then when you open up this(add) you would be able to type in the name and it will be selected. And then by convention that tab name as long as you use the same tab name it will be bundled in the order of which you set it here. [00:11:40](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h11m40s) This is where the Dropbox area all there fields are being set. The reason why we include this demo component into the application with the tutorial, is that you can go and look and see he's using [00:12:00](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h12m00s) Dropbox update method here. Then you can go look at this file. The Dropbox update method, the files, and the text, and even some of this(Update listing Now!) I mean here is a button. If I click it [00:12:23](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h12m23s) it starts an update. It even shows it here. How to do this is very tricky. It's not that simple to do that because we are not inside of our component, as you can see, were actually in the config component in the global if you have global settings. This whole feature that is build into sermon distributor is so smart I would tell you For you to be able to do that is just stunning. [00:12:56](https://www.youtube.com/watch?v=V2WkTjNFjvo&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h12m56s) You can look at how I've done that by simply going to these fields and you would find the answer to how did he do that. And you can look at these things in this list view. All the Dropbox information is there. And then there is some global like, local folder, download link. @@
**Spacer HR Field In Component Fields**