Difference between revisions of "Developing a MVC Component/Adding categories"
From Joomla! Documentation
< Archived:Developing a MVC Component
(72 intermediate revisions by 20 users not shown) | |||
Line 1: | Line 1: | ||
− | {{ | + | {{version/tutor|2.5}} |
− | {{ | + | {{Chunk:Developing a Model-View-Controller (MVC) Component for Joomla!2.5 - Contents}} |
− | == | + | == Introduction == |
− | + | This tutorial is part of the [[Developing a Model-View-Controller (MVC) Component for Joomla!2.5]] tutorial. You are encouraged to read the previous parts of the tutorial before reading this. | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | The Joomla framework has implemented the use of categories for all components. Adding categorized ability to a component is fairly simple. | |
− | |||
− | |||
− | The Joomla | ||
== Modifying the SQL == | == Modifying the SQL == | ||
Line 48: | Line 30: | ||
</span> | </span> | ||
− | <span id="admin/sql/ | + | <span id="admin/sql/updates/mysql/0.0.12.sql"> |
− | ''admin/sql/ | + | ''admin/sql/updates/mysql/0.0.12.sql'' |
<source lang="sql"> | <source lang="sql"> | ||
ALTER TABLE `#__helloworld` ADD `catid` int(11) NOT NULL default '0' | ALTER TABLE `#__helloworld` ADD `catid` int(11) NOT NULL default '0' | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
</source> | </source> | ||
</span> | </span> | ||
== Modifying the form == | == Modifying the form == | ||
− | A HelloWorld message can now belong to a category. We have to modify the editing form. In the ''admin/models/ | + | A HelloWorld message can now belong to a category. We have to modify the editing form. In the ''admin/models/forms/helloworld.xml'' file, put these lines: |
− | <span id="admin/models/ | + | <span id="admin/models/forms/helloworld.xml"> |
− | ''admin/models/ | + | ''admin/models/forms/helloworld.xml'' |
<source lang="xml"> | <source lang="xml"> | ||
<?xml version="1.0" encoding="utf-8"?> | <?xml version="1.0" encoding="utf-8"?> | ||
− | <form> | + | <form |
− | < | + | addrulepath="/administrator/components/com_helloworld/models/rules" |
+ | > | ||
+ | <fieldset> | ||
<field | <field | ||
− | |||
name="id" | name="id" | ||
type="hidden" | type="hidden" | ||
/> | /> | ||
<field | <field | ||
− | |||
name="greeting" | name="greeting" | ||
type="text" | type="text" | ||
+ | label="COM_HELLOWORLD_HELLOWORLD_FIELD_GREETING_LABEL" | ||
+ | description="COM_HELLOWORLD_HELLOWORLD_FIELD_GREETING_DESC" | ||
size="40" | size="40" | ||
class="inputbox validate-greeting" | class="inputbox validate-greeting" | ||
Line 122: | Line 62: | ||
required="true" | required="true" | ||
default="" | default="" | ||
− | |||
− | |||
/> | /> | ||
<field | <field | ||
− | |||
name="catid" | name="catid" | ||
− | type=" | + | type="category" |
extension="com_helloworld" | extension="com_helloworld" | ||
− | |||
class="inputbox" | class="inputbox" | ||
default="" | default="" | ||
− | label=" | + | label="COM_HELLOWORLD_HELLOWORLD_FIELD_CATID_LABEL" |
− | description=" | + | description="COM_HELLOWORLD_HELLOWORLD_FIELD_CATID_DESC" |
required="true" | required="true" | ||
> | > | ||
− | <option value="0"> | + | <option value="0">JOPTION_SELECT_CATEGORY</option> |
</field> | </field> | ||
− | </ | + | </fieldset> |
− | </form></source> | + | </form> |
+ | </source> | ||
</span> | </span> | ||
Line 146: | Line 83: | ||
== Modifying the menu type == | == Modifying the menu type == | ||
+ | The HelloWorld menu type displays a drop down list of all messages. If the message is categorized, we have to add the category in this display. | ||
+ | In the ''admin/models/fields/helloworld.php'' file, put these lines: | ||
+ | |||
+ | <span id="admin/models/fields/helloworld.php"> | ||
+ | ''admin/models/fields/helloworld.php'' | ||
+ | <source lang="php"> | ||
+ | <?php | ||
+ | // No direct access to this file | ||
+ | defined('_JEXEC') or die; | ||
+ | |||
+ | // import the list field type | ||
+ | jimport('joomla.form.helper'); | ||
+ | JFormHelper::loadFieldClass('list'); | ||
+ | |||
+ | /** | ||
+ | * HelloWorld Form Field class for the HelloWorld component | ||
+ | */ | ||
+ | class JFormFieldHelloWorld extends JFormFieldList | ||
+ | { | ||
+ | /** | ||
+ | * The field type. | ||
+ | * | ||
+ | * @var string | ||
+ | */ | ||
+ | protected $type = 'HelloWorld'; | ||
+ | |||
+ | /** | ||
+ | * Method to get a list of options for a list input. | ||
+ | * | ||
+ | * @return array An array of JHtml options. | ||
+ | */ | ||
+ | protected function getOptions() | ||
+ | { | ||
+ | $db = JFactory::getDBO(); | ||
+ | |||
+ | /// $query = new JDatabaseQuery; WARNING - There's an error in this line, JDatabaseQuery is an abstract class | ||
+ | $query = $db->getQuery(true); // THIS IS THE FIX, WARNING IT MUST BE FIXED IN THE ZIP FILES | ||
+ | |||
+ | $query->select('#__helloworld.id as id,greeting,#__categories.title as category,catid'); | ||
+ | $query->from('#__helloworld'); | ||
+ | $query->leftJoin('#__categories on catid=#__categories.id'); | ||
+ | $db->setQuery((string)$query); | ||
+ | $messages = $db->loadObjectList(); | ||
+ | $options = array(); | ||
+ | if ($messages) | ||
+ | { | ||
+ | foreach($messages as $message) | ||
+ | { | ||
+ | $options[] = JHtml::_('select.option', $message->id, $message->greeting . | ||
+ | ($message->catid ? ' (' . $message->category . ')' : '')); | ||
+ | } | ||
+ | } | ||
+ | $options = array_merge(parent::getOptions(), $options); | ||
+ | return $options; | ||
+ | } | ||
+ | } | ||
+ | </source> | ||
+ | </span> | ||
+ | |||
+ | It will now display the category between parenthesis. | ||
+ | |||
+ | == Managing the submenu == | ||
+ | The ''com_categories'' component allows to set the submenu using a helper file. With your favorite file manager and editor, put a ''admin/helpers/helloworld.php'' file containing these lines: | ||
+ | |||
+ | <span id="admin/helpers/helloworld.php"> | ||
+ | ''admin/helpers/helloworld.php'' | ||
+ | <source lang="php"> | ||
+ | <?php | ||
+ | // No direct access to this file | ||
+ | defined('_JEXEC') or die; | ||
+ | |||
+ | /** | ||
+ | * HelloWorld component helper. | ||
+ | */ | ||
+ | abstract class HelloWorldHelper | ||
+ | { | ||
+ | /** | ||
+ | * Configure the Linkbar. | ||
+ | */ | ||
+ | public static function addSubmenu($submenu) | ||
+ | { | ||
+ | JSubMenuHelper::addEntry(JText::_('COM_HELLOWORLD_SUBMENU_MESSAGES'), | ||
+ | 'index.php?option=com_helloworld', $submenu == 'messages'); | ||
+ | JSubMenuHelper::addEntry(JText::_('COM_HELLOWORLD_SUBMENU_CATEGORIES'), | ||
+ | 'index.php?option=com_categories&view=categories&extension=com_helloworld', | ||
+ | $submenu == 'categories'); | ||
+ | // set some global property | ||
+ | $document = JFactory::getDocument(); | ||
+ | $document->addStyleDeclaration('.icon-48-helloworld ' . | ||
+ | '{background-image: url(../media/com_helloworld/images/tux-48x48.png);}'); | ||
+ | if ($submenu == 'categories') | ||
+ | { | ||
+ | $document->setTitle(JText::_('COM_HELLOWORLD_ADMINISTRATION_CATEGORIES')); | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | </source> | ||
+ | </span> | ||
+ | '''NOTE:''' You MUST use your component name (without com_) for the helper file name, or else your submenus won't show in category view. | ||
+ | |||
+ | This function will be automatically called by the ''com_categories'' component. Note that it will | ||
+ | * change the submenu | ||
+ | * change some css properties (for displaying icons) | ||
+ | * change the browser title if the submenu is ''categories'' | ||
+ | * change the title and add a ''preferences'' button | ||
+ | |||
+ | We have to change the general controller to call this function and modify the component entry point (the ''.icon-48-helloworld'' css class is now set in the ''addSubmenu'' function) | ||
+ | |||
+ | <span id="admin/controller.php"> | ||
+ | ''admin/controller.php'' | ||
+ | <source lang="php"> | ||
+ | <?php | ||
+ | // No direct access to this file | ||
+ | defined('_JEXEC') or die('Restricted access'); | ||
+ | |||
+ | // import Joomla controller library | ||
+ | jimport('joomla.application.component.controller'); | ||
+ | |||
+ | /** | ||
+ | * General Controller of HelloWorld component | ||
+ | */ | ||
+ | class HelloWorldController extends JController | ||
+ | { | ||
+ | /** | ||
+ | * display task | ||
+ | * | ||
+ | * @return void | ||
+ | */ | ||
+ | public function display($cachable = false, $urlparams = false) | ||
+ | { | ||
+ | // set default view if not set | ||
+ | $input = JFactory::getApplication()->input; | ||
+ | $input->set('view', $input->getCmd('view', 'HelloWorlds')); | ||
+ | |||
+ | // call parent behavior | ||
+ | parent::display($cachable, $urlparams); | ||
+ | |||
+ | // Set the submenu | ||
+ | HelloWorldHelper::addSubmenu('messages'); | ||
+ | } | ||
+ | } | ||
+ | </source> | ||
+ | </span> | ||
+ | == Adding some ACL == | ||
+ | <span id="admin/access.xml"> | ||
+ | ''admin/access.xml'' | ||
+ | <source lang="xml"> | ||
+ | <?xml version="1.0" encoding="utf-8" ?> | ||
+ | <access component="com_helloworld"> | ||
+ | <section name="component"> | ||
+ | <action name="core.admin" title="JACTION_ADMIN" description="JACTION_ADMIN_COMPONENT_DESC" /> | ||
+ | <action name="core.manage" title="JACTION_MANAGE" description="JACTION_MANAGE_COMPONENT_DESC" /> | ||
+ | <action name="core.create" title="JACTION_CREATE" description="JACTION_CREATE_COMPONENT_DESC" /> | ||
+ | <action name="core.delete" title="JACTION_DELETE" description="JACTION_DELETE_COMPONENT_DESC" /> | ||
+ | <action name="core.edit" title="JACTION_EDIT" description="JACTION_EDIT_COMPONENT_DESC" /> | ||
+ | </section> | ||
+ | <section name="message"> | ||
+ | <action name="core.delete" title="JACTION_DELETE" description="COM_HELLOWORD_ACCESS_DELETE_DESC" /> | ||
+ | <action name="core.edit" title="JACTION_EDIT" description="COM_OLA_HELLOWORD_EDIT_DESC" /> | ||
+ | </section> | ||
+ | </access> | ||
+ | |||
+ | </source> | ||
+ | </span> | ||
+ | |||
+ | '''NOTE:''' If you don't add this file, buttons "New" "Edit" and ... don't show in category view . for more information read section Adding ACL on top of the page. | ||
+ | |||
+ | <span id="admin/helloworld.php"> | ||
+ | ''admin/helloworld.php'' | ||
+ | <source lang="php"> | ||
+ | <?php | ||
+ | // No direct access to this file | ||
+ | defined('_JEXEC') or die('Restricted access'); | ||
+ | |||
+ | // require helper file | ||
+ | JLoader::register('HelloWorldHelper', dirname(__FILE__) . DS . 'helpers' . DS . 'helloworld.php'); | ||
+ | |||
+ | // import joomla controller library | ||
+ | jimport('joomla.application.component.controller'); | ||
+ | |||
+ | // Get an instance of the controller prefixed by HelloWorld | ||
+ | $controller = JController::getInstance('HelloWorld'); | ||
+ | |||
+ | // Perform the Request task | ||
+ | $input = JFactory::getApplication()->input; | ||
+ | $controller->execute($input->getCmd('task')); | ||
+ | |||
+ | // Redirect if set by the controller | ||
+ | $controller->redirect(); | ||
+ | </source> | ||
+ | </span> | ||
+ | |||
+ | == Adding some translation strings == | ||
+ | Some strings have to be translated. In the ''admin/language/en-GB/en-GB.com_helloworld.ini'' file, put these lines: | ||
+ | |||
+ | <span id="admin/language/en-GB/en-GB.com_helloworld.ini"> | ||
+ | ''admin/language/en-GB/en-GB.com_helloworld.ini'' | ||
+ | <source lang="ini"> | ||
+ | COM_HELLOWORLD="Hello World!" | ||
+ | COM_HELLOWORLD_ADMINISTRATION="HelloWorld - Administration" | ||
+ | COM_HELLOWORLD_ADMINISTRATION_CATEGORIES="HelloWorld - Categories" | ||
+ | COM_HELLOWORLD_HELLOWORLD_CREATING="HelloWorld - Creating" | ||
+ | COM_HELLOWORLD_HELLOWORLD_DETAILS="Details" | ||
+ | COM_HELLOWORLD_HELLOWORLD_EDITING="HelloWorld - Editing" | ||
+ | COM_HELLOWORLD_HELLOWORLD_ERROR_UNACCEPTABLE="Some values are unacceptable" | ||
+ | COM_HELLOWORLD_HELLOWORLD_FIELD_CATID_DESC="The category the messages belongs to" | ||
+ | COM_HELLOWORLD_HELLOWORLD_FIELD_CATID_LABEL="Category" | ||
+ | COM_HELLOWORLD_HELLOWORLD_FIELD_GREETING_DESC="This message will be displayed" | ||
+ | COM_HELLOWORLD_HELLOWORLD_FIELD_GREETING_LABEL="Message" | ||
+ | COM_HELLOWORLD_HELLOWORLD_HEADING_GREETING="Greeting" | ||
+ | COM_HELLOWORLD_HELLOWORLD_HEADING_ID="Id" | ||
+ | COM_HELLOWORLD_MANAGER_HELLOWORLD_EDIT="HelloWorld manager: Edit Message" | ||
+ | COM_HELLOWORLD_MANAGER_HELLOWORLD_NEW="HelloWorld manager: New Message" | ||
+ | COM_HELLOWORLD_MANAGER_HELLOWORLDS="HelloWorld manager" | ||
+ | COM_HELLOWORLD_N_ITEMS_DELETED_1="One message deleted" | ||
+ | COM_HELLOWORLD_N_ITEMS_DELETED_MORE="%d messages deleted" | ||
+ | COM_HELLOWORLD_SUBMENU_MESSAGES="Messages" | ||
+ | COM_HELLOWORLD_SUBMENU_CATEGORIES="Categories" | ||
+ | </source> | ||
+ | </span> | ||
== Packaging the component == | == Packaging the component == | ||
Line 152: | Line 309: | ||
Content of your code directory | Content of your code directory | ||
* ''[[#helloworld.xml|helloworld.xml]]'' | * ''[[#helloworld.xml|helloworld.xml]]'' | ||
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_01#index.html|site/index.html]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_02#site/helloworld.php|site/helloworld.php]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_02#site/controller.php|site/controller.php]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_01#index.html|site/views/index.html]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_01#index.html|site/views/helloworld/index.html]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_04#site/views/helloworld/view.html.php|site/views/helloworld/view.html.php]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_01#index.html|site/views/helloworld/tmpl/index.html]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_06#site/views/helloworld/tmpl/default.xml|site/views/helloworld/tmpl/default.xml]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_02#site/views/helloworld/tmpl/default.php|site/views/helloworld/tmpl/default.php]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_01#index.html|site/models/index.html]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_06#site/models/helloworld.php|site/models/helloworld.php]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_01#index.html|site/language/index.html]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_01#index.html|site/language/en-GB/index.html]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_08#site/language/en-GB/en-GB.com_helloworld.ini|site/language/en-GB/en-GB.com_helloworld.ini]]'' |
− | * ''[[ | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_01#index.html|admin/index.html]]'' |
− | * ''[[ | + | * ''[[#admin/helloworld.php|admin/helloworld.php]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[#admin/controller.php|admin/controller.php]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_12#Adding%20some%20ACL|admin/access.xml]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_01#index.html|admin/sql/index.html]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_06#admin/sql/install.mysql.utf8.sql|admin/sql/install.mysql.utf8.sql]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_06#admin/sql/uninstall.mysql.utf8.sql|admin/sql/uninstall.mysql.utf8.sql]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_01#index.html|admin/sql/updates/index.html]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_01#index.html|admin/sql/updates/mysql/index.html]]'' |
− | * ''[[ | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_01#admin/sql/updates/mysql/0.0.1.sql|admin/sql/updates/mysql/0.0.1.sql]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_06#admin/sql/install.mysql.utf8.sql|admin/sql/updates/mysql/0.0.6.sql]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[#admin/sql/updates/mysql/0.0.12.sql|admin/sql/updates/mysql/0.0.12.sql]]'' |
− | * ''[[ | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_01#index.html|admin/models/index.html]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_01#index.html|admin/models/fields/index.html]]'' |
− | * ''[[ | + | * ''[[#admin/models/fields/helloworld.php|admin/models/fields/helloworld.php]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_01#index.html|admin/models/forms/index.html]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[#admin/models/forms/helloworld.xml|admin/models/forms/helloworld.xml]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_11#admin/models/forms/helloworld.js|admin/models/forms/helloworld.js]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_01#index.html|admin/models/rules/index.html]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_11#admin/models/rules/greeting.php|admin/models/rules/greeting.php]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_11#admin/models/helloworld.php|admin/models/helloworld.php]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_09#admin/models/helloworlds.php|admin/models/helloworlds.php]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_01#index.html|admin/views/index.html]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_01#index.html|admin/views/helloworlds/index.html]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_10#admin/views/helloworlds/view.html.php|admin/views/helloworlds/view.html.php]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_01#index.html|admin/views/helloworlds/tmpl/index.html]]'' |
− | * ''[[Developing_a_Model-View-Controller_ | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_09#admin/views/helloworlds/tmpl/default.php|admin/views/helloworlds/tmpl/default.php]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_07#admin/views/helloworlds/tmpl/default_head.php|admin/views/helloworlds/tmpl/default_head.php]]'' |
− | * ''[[ | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_07#admin/views/helloworlds/tmpl/default_body.php|admin/views/helloworlds/tmpl/default_body.php]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_07#admin/views/helloworlds/tmpl/default_foot.php|admin/views/helloworlds/tmpl/default_foot.php]]'' |
− | * ''[[ | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_01#index.html|admin/views/helloworlds/index.html]]'' |
− | * ''[[ | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_11#admin/views/helloworld/view.html.php|admin/views/helloworld/view.html.php]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_11#admin/views/helloworld/submitbutton.js|admin/views/helloworld/submitbutton.js]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_01#index.html|admin/views/helloworld/tmpl/index.html]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_11#admin/views/helloworld/tmpl/edit.php|admin/views/helloworld/tmpl/edit.php]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_01#index.html|admin/helpers/index.html]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[#admin/helpers/helloworld.php|admin/helpers/helloworld.php]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_01#index.html|admin/tables/index.html]]'' |
− | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla! | + | * ''[[#admin/tables/helloworld.php|admin/tables/helloworld.php]]'' |
+ | * ''[[#admin/language/en-GB/en-GB.com_helloworld.ini|admin/language/en-GB/en-GB.com_helloworld.ini]]'' | ||
+ | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_08#admin/language/en-GB/en-GB.com_helloworld.menu.ini|admin/language/en-GB/en-GB.com_helloworld.menu.ini]]'' | ||
+ | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_01#index.html|admin/controllers/index.html]]'' | ||
+ | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_11#admin/controllers/helloworld.php|admin/controllers/helloworld.php]]'' | ||
+ | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_11#admin/controllers/helloworlds.php|admin/controllers/helloworldlist.php]]'' | ||
+ | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_08#language/en-GB/en-GB.ini|language/en-GB/en-GB.ini]]'' | ||
+ | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_01#index.html|media/index.html]]'' | ||
+ | * ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_01#index.html|media/images/index.html]]'' | ||
* ''media/images/tux-16x16.png'' | * ''media/images/tux-16x16.png'' | ||
* ''media/images/tux-48x48.png'' | * ''media/images/tux-48x48.png'' | ||
− | Create a compressed file of this directory or directly download the [http://joomlacode.org/gf/download/frsrelease/11394/ | + | Create a compressed file of this directory or directly download the [http://joomlacode.org/gf/download/frsrelease/11394/58410/com_helloworld-1.6-part12.zip archive] and install it using the extension manager of Joomla. You can add a menu item of this component using the menu manager in the backend. |
<span id="helloworld.xml"> | <span id="helloworld.xml"> | ||
Line 214: | Line 379: | ||
<source lang="xml"> | <source lang="xml"> | ||
<?xml version="1.0" encoding="utf-8"?> | <?xml version="1.0" encoding="utf-8"?> | ||
− | <extension type="component" version=" | + | <extension type="component" version="2.5.0" method="upgrade"> |
− | <name> | + | |
+ | <name>COM_HELLOWORLD</name> | ||
+ | <!-- The following elements are optional and free of formatting constraints --> | ||
<creationDate>November 2009</creationDate> | <creationDate>November 2009</creationDate> | ||
<author>John Doe</author> | <author>John Doe</author> | ||
Line 222: | Line 389: | ||
<copyright>Copyright Info</copyright> | <copyright>Copyright Info</copyright> | ||
<license>License Info</license> | <license>License Info</license> | ||
+ | <!-- The version string is recorded in the components table --> | ||
<version>0.0.12</version> | <version>0.0.12</version> | ||
− | <description> | + | <!-- The description is optional and defaults to the name --> |
+ | <description>COM_HELLOWORLD_DESCRIPTION</description> | ||
<install> <!-- Runs on install --> | <install> <!-- Runs on install --> | ||
Line 235: | Line 404: | ||
</sql> | </sql> | ||
</uninstall> | </uninstall> | ||
− | <update> <!-- Runs on update --> | + | <update> <!-- Runs on update; New in 2.5 --> |
− | < | + | <schemas> |
− | < | + | <schemapath type="mysql">sql/updates/mysql</schemapath> |
− | </ | + | </schemas> |
</update> | </update> | ||
+ | <!-- Site Main File Copy Section --> | ||
+ | <!-- Note the folder attribute: This attribute describes the folder | ||
+ | to copy FROM in the package to install therefore files copied | ||
+ | in this section are copied from /site/ in the package --> | ||
<files folder="site"> | <files folder="site"> | ||
<filename>index.html</filename> | <filename>index.html</filename> | ||
Line 254: | Line 427: | ||
<folder>images</folder> | <folder>images</folder> | ||
</media> | </media> | ||
− | + | ||
<administration> | <administration> | ||
− | <menu img="../media/com_helloworld/images/tux-16x16.png"> | + | <!-- Administration Menu Section --> |
+ | <menu img="../media/com_helloworld/images/tux-16x16.png">COM_HELLOWORLD_MENU</menu> | ||
+ | <!-- Administration Main File Copy Section --> | ||
+ | <!-- Note the folder attribute: This attribute describes the folder | ||
+ | to copy FROM in the package to install therefore files copied | ||
+ | in this section are copied from /admin/ in the package --> | ||
<files folder="admin"> | <files folder="admin"> | ||
+ | <!-- Admin Main File Copy Section --> | ||
<filename>index.html</filename> | <filename>index.html</filename> | ||
<filename>helloworld.php</filename> | <filename>helloworld.php</filename> | ||
<filename>controller.php</filename> | <filename>controller.php</filename> | ||
+ | <!-- WARNING <filename>access.php</filename> has an incorrect file extension, should be corrected in the ZIP-file --> | ||
+ | <filename>access.xml</filename> | ||
+ | <!-- SQL files section --> | ||
<folder>sql</folder> | <folder>sql</folder> | ||
+ | <!-- tables files section --> | ||
<folder>tables</folder> | <folder>tables</folder> | ||
+ | <!-- models files section --> | ||
<folder>models</folder> | <folder>models</folder> | ||
+ | <!-- views files section --> | ||
<folder>views</folder> | <folder>views</folder> | ||
+ | <!-- controllers files section --> | ||
<folder>controllers</folder> | <folder>controllers</folder> | ||
− | </files> | + | <!-- helpers files section --> |
+ | <folder>helpers</folder> | ||
+ | </files> | ||
+ | |||
<languages folder="admin"> | <languages folder="admin"> | ||
<language tag="en-GB">language/en-GB/en-GB.com_helloworld.ini</language> | <language tag="en-GB">language/en-GB/en-GB.com_helloworld.ini</language> | ||
− | <language tag="en-GB">language/en-GB/en-GB.com_helloworld. | + | <language tag="en-GB">language/en-GB/en-GB.com_helloworld.sys.ini</language> |
</languages> | </languages> | ||
</administration> | </administration> | ||
+ | |||
</extension> | </extension> | ||
</source> | </source> | ||
</span> | </span> | ||
+ | |||
+ | == Zips == | ||
+ | Download the zip file for this Part: | ||
+ | [https://github.com/downloads/rvsjoen/joomla-tutorials/com_helloworld-part12.zip] | ||
+ | |||
+ | == Navigate == | ||
+ | [[Developing a Model-View-Controller (MVC) Component for Joomla!2.5 - Part 11|Prev: Adding verifications]] | ||
+ | [[Developing a Model-View-Controller (MVC) Component for Joomla!2.5 - Part 13|Next: Adding configuration]] | ||
== Contributors == | == Contributors == | ||
*[[User:cdemko|Christophe Demko]] | *[[User:cdemko|Christophe Demko]] | ||
+ | *[[User:oaksu|Ozgur Aksu]] | ||
+ | *[[User:Anibal.sanchez|Anibal Sanchez]] // Just a fix | ||
+ | *[[User:Postema|Hans Postema]] // Just another fix | ||
[[Category:Development]] | [[Category:Development]] | ||
− | [[ | + | [[Category:Joomla! 1.6]] |
− | [[ | + | [[Category:Joomla! 1.7]] |
+ | [[Category:Joomla! 2.5]] |
Revision as of 10:59, 1 December 2013
This page has been archived. This page contains information for an unsupported Joomla! version or is no longer relevant. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.
Articles in this Series
- Introduction
- Developing a Basic Component
- Adding a view to the site part
- Adding a menu type to the site part
- Adding a model to the site part
- Adding a variable request in the menu type
- Using the database
- Basic backend
- Adding language management
- Adding backend actions
- Adding decorations to the backend
- Adding verifications
- Adding categories
- Adding configuration
- Adding ACL
- Adding an install/uninstall/update script file
- Using the language filter facility
- Adding an update server
- Example of a Frontend Update Function
- Example of Menu Parameters & Stylesheets
Introduction[edit]
This tutorial is part of the Developing a Model-View-Controller (MVC) Component for Joomla!2.5 tutorial. You are encouraged to read the previous parts of the tutorial before reading this.
The Joomla framework has implemented the use of categories for all components. Adding categorized ability to a component is fairly simple.
Modifying the SQL[edit]
In order to manage categories, we have to change the SQL tables.
With your favorite editor, modify admin/sql/install.mysql.utf8.sql and put these lines:
admin/sql/install.mysql.utf8.sql
DROP TABLE IF EXISTS `#__helloworld`;
CREATE TABLE `#__helloworld` (
`id` int(11) NOT NULL auto_increment,
`greeting` varchar(25) NOT NULL,
`catid` int(11) NOT NULL default '0',
PRIMARY KEY (`id`)
) ENGINE=MyISAM AUTO_INCREMENT=0 DEFAULT CHARSET=utf8;
INSERT INTO `#__helloworld` (`greeting`) VALUES
('Hello World!'),
('Good bye World!');
admin/sql/updates/mysql/0.0.12.sql
ALTER TABLE `#__helloworld` ADD `catid` int(11) NOT NULL default '0'
Modifying the form[edit]
A HelloWorld message can now belong to a category. We have to modify the editing form. In the admin/models/forms/helloworld.xml file, put these lines:
admin/models/forms/helloworld.xml
<?xml version="1.0" encoding="utf-8"?>
<form
addrulepath="/administrator/components/com_helloworld/models/rules"
>
<fieldset>
<field
name="id"
type="hidden"
/>
<field
name="greeting"
type="text"
label="COM_HELLOWORLD_HELLOWORLD_FIELD_GREETING_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_FIELD_GREETING_DESC"
size="40"
class="inputbox validate-greeting"
validate="greeting"
required="true"
default=""
/>
<field
name="catid"
type="category"
extension="com_helloworld"
class="inputbox"
default=""
label="COM_HELLOWORLD_HELLOWORLD_FIELD_CATID_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_FIELD_CATID_DESC"
required="true"
>
<option value="0">JOPTION_SELECT_CATEGORY</option>
</field>
</fieldset>
</form>
Note that the category can be 0 (representing no category).
[edit]
The HelloWorld menu type displays a drop down list of all messages. If the message is categorized, we have to add the category in this display.
In the admin/models/fields/helloworld.php file, put these lines:
admin/models/fields/helloworld.php
<?php
// No direct access to this file
defined('_JEXEC') or die;
// import the list field type
jimport('joomla.form.helper');
JFormHelper::loadFieldClass('list');
/**
* HelloWorld Form Field class for the HelloWorld component
*/
class JFormFieldHelloWorld extends JFormFieldList
{
/**
* The field type.
*
* @var string
*/
protected $type = 'HelloWorld';
/**
* Method to get a list of options for a list input.
*
* @return array An array of JHtml options.
*/
protected function getOptions()
{
$db = JFactory::getDBO();
/// $query = new JDatabaseQuery; WARNING - There's an error in this line, JDatabaseQuery is an abstract class
$query = $db->getQuery(true); // THIS IS THE FIX, WARNING IT MUST BE FIXED IN THE ZIP FILES
$query->select('#__helloworld.id as id,greeting,#__categories.title as category,catid');
$query->from('#__helloworld');
$query->leftJoin('#__categories on catid=#__categories.id');
$db->setQuery((string)$query);
$messages = $db->loadObjectList();
$options = array();
if ($messages)
{
foreach($messages as $message)
{
$options[] = JHtml::_('select.option', $message->id, $message->greeting .
($message->catid ? ' (' . $message->category . ')' : ''));
}
}
$options = array_merge(parent::getOptions(), $options);
return $options;
}
}
It will now display the category between parenthesis.
[edit]
The com_categories component allows to set the submenu using a helper file. With your favorite file manager and editor, put a admin/helpers/helloworld.php file containing these lines:
admin/helpers/helloworld.php
<?php
// No direct access to this file
defined('_JEXEC') or die;
/**
* HelloWorld component helper.
*/
abstract class HelloWorldHelper
{
/**
* Configure the Linkbar.
*/
public static function addSubmenu($submenu)
{
JSubMenuHelper::addEntry(JText::_('COM_HELLOWORLD_SUBMENU_MESSAGES'),
'index.php?option=com_helloworld', $submenu == 'messages');
JSubMenuHelper::addEntry(JText::_('COM_HELLOWORLD_SUBMENU_CATEGORIES'),
'index.php?option=com_categories&view=categories&extension=com_helloworld',
$submenu == 'categories');
// set some global property
$document = JFactory::getDocument();
$document->addStyleDeclaration('.icon-48-helloworld ' .
'{background-image: url(../media/com_helloworld/images/tux-48x48.png);}');
if ($submenu == 'categories')
{
$document->setTitle(JText::_('COM_HELLOWORLD_ADMINISTRATION_CATEGORIES'));
}
}
}
NOTE: You MUST use your component name (without com_) for the helper file name, or else your submenus won't show in category view.
This function will be automatically called by the com_categories component. Note that it will
- change the submenu
- change some css properties (for displaying icons)
- change the browser title if the submenu is categories
- change the title and add a preferences button
We have to change the general controller to call this function and modify the component entry point (the .icon-48-helloworld css class is now set in the addSubmenu function)
admin/controller.php
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');
// import Joomla controller library
jimport('joomla.application.component.controller');
/**
* General Controller of HelloWorld component
*/
class HelloWorldController extends JController
{
/**
* display task
*
* @return void
*/
public function display($cachable = false, $urlparams = false)
{
// set default view if not set
$input = JFactory::getApplication()->input;
$input->set('view', $input->getCmd('view', 'HelloWorlds'));
// call parent behavior
parent::display($cachable, $urlparams);
// Set the submenu
HelloWorldHelper::addSubmenu('messages');
}
}
Adding some ACL[edit]
admin/access.xml
<?xml version="1.0" encoding="utf-8" ?>
<access component="com_helloworld">
<section name="component">
<action name="core.admin" title="JACTION_ADMIN" description="JACTION_ADMIN_COMPONENT_DESC" />
<action name="core.manage" title="JACTION_MANAGE" description="JACTION_MANAGE_COMPONENT_DESC" />
<action name="core.create" title="JACTION_CREATE" description="JACTION_CREATE_COMPONENT_DESC" />
<action name="core.delete" title="JACTION_DELETE" description="JACTION_DELETE_COMPONENT_DESC" />
<action name="core.edit" title="JACTION_EDIT" description="JACTION_EDIT_COMPONENT_DESC" />
</section>
<section name="message">
<action name="core.delete" title="JACTION_DELETE" description="COM_HELLOWORD_ACCESS_DELETE_DESC" />
<action name="core.edit" title="JACTION_EDIT" description="COM_OLA_HELLOWORD_EDIT_DESC" />
</section>
</access>
NOTE: If you don't add this file, buttons "New" "Edit" and ... don't show in category view . for more information read section Adding ACL on top of the page.
admin/helloworld.php
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');
// require helper file
JLoader::register('HelloWorldHelper', dirname(__FILE__) . DS . 'helpers' . DS . 'helloworld.php');
// import joomla controller library
jimport('joomla.application.component.controller');
// Get an instance of the controller prefixed by HelloWorld
$controller = JController::getInstance('HelloWorld');
// Perform the Request task
$input = JFactory::getApplication()->input;
$controller->execute($input->getCmd('task'));
// Redirect if set by the controller
$controller->redirect();
Adding some translation strings[edit]
Some strings have to be translated. In the admin/language/en-GB/en-GB.com_helloworld.ini file, put these lines:
admin/language/en-GB/en-GB.com_helloworld.ini
COM_HELLOWORLD="Hello World!"
COM_HELLOWORLD_ADMINISTRATION="HelloWorld - Administration"
COM_HELLOWORLD_ADMINISTRATION_CATEGORIES="HelloWorld - Categories"
COM_HELLOWORLD_HELLOWORLD_CREATING="HelloWorld - Creating"
COM_HELLOWORLD_HELLOWORLD_DETAILS="Details"
COM_HELLOWORLD_HELLOWORLD_EDITING="HelloWorld - Editing"
COM_HELLOWORLD_HELLOWORLD_ERROR_UNACCEPTABLE="Some values are unacceptable"
COM_HELLOWORLD_HELLOWORLD_FIELD_CATID_DESC="The category the messages belongs to"
COM_HELLOWORLD_HELLOWORLD_FIELD_CATID_LABEL="Category"
COM_HELLOWORLD_HELLOWORLD_FIELD_GREETING_DESC="This message will be displayed"
COM_HELLOWORLD_HELLOWORLD_FIELD_GREETING_LABEL="Message"
COM_HELLOWORLD_HELLOWORLD_HEADING_GREETING="Greeting"
COM_HELLOWORLD_HELLOWORLD_HEADING_ID="Id"
COM_HELLOWORLD_MANAGER_HELLOWORLD_EDIT="HelloWorld manager: Edit Message"
COM_HELLOWORLD_MANAGER_HELLOWORLD_NEW="HelloWorld manager: New Message"
COM_HELLOWORLD_MANAGER_HELLOWORLDS="HelloWorld manager"
COM_HELLOWORLD_N_ITEMS_DELETED_1="One message deleted"
COM_HELLOWORLD_N_ITEMS_DELETED_MORE="%d messages deleted"
COM_HELLOWORLD_SUBMENU_MESSAGES="Messages"
COM_HELLOWORLD_SUBMENU_CATEGORIES="Categories"
Packaging the component[edit]
Content of your code directory
- helloworld.xml
- site/index.html
- site/helloworld.php
- site/controller.php
- site/views/index.html
- site/views/helloworld/index.html
- site/views/helloworld/view.html.php
- site/views/helloworld/tmpl/index.html
- site/views/helloworld/tmpl/default.xml
- site/views/helloworld/tmpl/default.php
- site/models/index.html
- site/models/helloworld.php
- site/language/index.html
- site/language/en-GB/index.html
- site/language/en-GB/en-GB.com_helloworld.ini
- admin/index.html
- admin/helloworld.php
- admin/controller.php
- admin/access.xml
- admin/sql/index.html
- admin/sql/install.mysql.utf8.sql
- admin/sql/uninstall.mysql.utf8.sql
- admin/sql/updates/index.html
- admin/sql/updates/mysql/index.html
- admin/sql/updates/mysql/0.0.1.sql
- admin/sql/updates/mysql/0.0.6.sql
- admin/sql/updates/mysql/0.0.12.sql
- admin/models/index.html
- admin/models/fields/index.html
- admin/models/fields/helloworld.php
- admin/models/forms/index.html
- admin/models/forms/helloworld.xml
- admin/models/forms/helloworld.js
- admin/models/rules/index.html
- admin/models/rules/greeting.php
- admin/models/helloworld.php
- admin/models/helloworlds.php
- admin/views/index.html
- admin/views/helloworlds/index.html
- admin/views/helloworlds/view.html.php
- admin/views/helloworlds/tmpl/index.html
- admin/views/helloworlds/tmpl/default.php
- admin/views/helloworlds/tmpl/default_head.php
- admin/views/helloworlds/tmpl/default_body.php
- admin/views/helloworlds/tmpl/default_foot.php
- admin/views/helloworlds/index.html
- admin/views/helloworld/view.html.php
- admin/views/helloworld/submitbutton.js
- admin/views/helloworld/tmpl/index.html
- admin/views/helloworld/tmpl/edit.php
- admin/helpers/index.html
- admin/helpers/helloworld.php
- admin/tables/index.html
- admin/tables/helloworld.php
- admin/language/en-GB/en-GB.com_helloworld.ini
- admin/language/en-GB/en-GB.com_helloworld.menu.ini
- admin/controllers/index.html
- admin/controllers/helloworld.php
- admin/controllers/helloworldlist.php
- language/en-GB/en-GB.ini
- media/index.html
- media/images/index.html
- media/images/tux-16x16.png
- media/images/tux-48x48.png
Create a compressed file of this directory or directly download the archive and install it using the extension manager of Joomla. You can add a menu item of this component using the menu manager in the backend.
helloworld.xml
<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="2.5.0" method="upgrade">
<name>COM_HELLOWORLD</name>
<!-- The following elements are optional and free of formatting constraints -->
<creationDate>November 2009</creationDate>
<author>John Doe</author>
<authorEmail>john.doe@example.org</authorEmail>
<authorUrl>http://www.example.org</authorUrl>
<copyright>Copyright Info</copyright>
<license>License Info</license>
<!-- The version string is recorded in the components table -->
<version>0.0.12</version>
<!-- The description is optional and defaults to the name -->
<description>COM_HELLOWORLD_DESCRIPTION</description>
<install> <!-- Runs on install -->
<sql>
<file driver="mysql" charset="utf8">sql/install.mysql.utf8.sql</file>
</sql>
</install>
<uninstall> <!-- Runs on uninstall -->
<sql>
<file driver="mysql" charset="utf8">sql/uninstall.mysql.utf8.sql</file>
</sql>
</uninstall>
<update> <!-- Runs on update; New in 2.5 -->
<schemas>
<schemapath type="mysql">sql/updates/mysql</schemapath>
</schemas>
</update>
<!-- Site Main File Copy Section -->
<!-- Note the folder attribute: This attribute describes the folder
to copy FROM in the package to install therefore files copied
in this section are copied from /site/ in the package -->
<files folder="site">
<filename>index.html</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>
<folder>views</folder>
<folder>models</folder>
<folder>language</folder>
</files>
<media destination="com_helloworld" folder="media">
<filename>index.html</filename>
<folder>images</folder>
</media>
<administration>
<!-- Administration Menu Section -->
<menu img="../media/com_helloworld/images/tux-16x16.png">COM_HELLOWORLD_MENU</menu>
<!-- Administration Main File Copy Section -->
<!-- Note the folder attribute: This attribute describes the folder
to copy FROM in the package to install therefore files copied
in this section are copied from /admin/ in the package -->
<files folder="admin">
<!-- Admin Main File Copy Section -->
<filename>index.html</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>
<!-- WARNING <filename>access.php</filename> has an incorrect file extension, should be corrected in the ZIP-file -->
<filename>access.xml</filename>
<!-- SQL files section -->
<folder>sql</folder>
<!-- tables files section -->
<folder>tables</folder>
<!-- models files section -->
<folder>models</folder>
<!-- views files section -->
<folder>views</folder>
<!-- controllers files section -->
<folder>controllers</folder>
<!-- helpers files section -->
<folder>helpers</folder>
</files>
<languages folder="admin">
<language tag="en-GB">language/en-GB/en-GB.com_helloworld.ini</language>
<language tag="en-GB">language/en-GB/en-GB.com_helloworld.sys.ini</language>
</languages>
</administration>
</extension>
Zips[edit]
Download the zip file for this Part: [1]
[edit]
Prev: Adding verifications Next: Adding configuration
Contributors[edit]
- Christophe Demko
- Ozgur Aksu
- Anibal Sanchez // Just a fix
- Hans Postema // Just another fix