Actions

J3.x

Difference between revisions of "Developing a MVC Component/Adding decorations to the backend"

From Joomla! Documentation

< J3.x:Developing a MVC Component
(Created page with "{{:J3.1:Developing a MVC Component}} {{review}} This is a multiple-article series of tutorials on how to develop a Model-View-Contoller Component for Joomla! Version {{J...")
 
Line 1: Line 1:
{{:J3.1:Developing a MVC Component}}
+
{{:J3.2:Developing a MVC Component}}
  
 
{{review}}
 
{{review}}
  
 
This is a multiple-article series of tutorials on how to develop a Model-View-Contoller [[Component]] for Joomla! Version {{JVer|{{CurrentSTSVer|minor}}}}.
 
This is a multiple-article series of tutorials on how to develop a Model-View-Contoller [[Component]] for Joomla! Version {{JVer|{{CurrentSTSVer|minor}}}}.
 +
 +
== Introduction ==
 +
This tutorial is part of the [[J3.2:Developing a MVC Component | Developing a MVC Component for Joomla! 3.2]] tutorial. You are encouraged to read the previous parts of the tutorial before reading this.
 +
 +
== Adding some icons ==
 +
With your favorite file manager put a 16x16 image and a 48x48 image (I choose ''tux'') in a ''media/images/'' folder and add a ''media'' tag in your [[#helloworld.xml|install file]]. Modify the ''menu'' tag in order to use the new icon.
 +
 +
== Modifying the views ==
 +
In the ''admin/views/helloworlds/view.html.php'' file put these lines:
 +
 +
<span id="admin/views/helloworlds/view.html.php">
 +
''admin/views/helloworlds/view.html.php''
 +
<source lang="php">
 +
<?php
 +
// No direct access to this file
 +
defined('_JEXEC') or die('Restricted access');
 +
 +
// import Joomla view library
 +
jimport('joomla.application.component.view');
 +
 +
/**
 +
* HelloWorlds View
 +
*/
 +
class HelloWorldViewHelloWorlds extends JView
 +
{
 +
/**
 +
* HelloWorlds view display method
 +
* @return void
 +
*/
 +
function display($tpl = null)
 +
{
 +
// Get data from the model
 +
$items = $this->get('Items');
 +
$pagination = $this->get('Pagination');
 +
 +
// Check for errors.
 +
if (count($errors = $this->get('Errors')))
 +
{
 +
JError::raiseError(500, implode('<br />', $errors));
 +
return false;
 +
}
 +
// Assign data to the view
 +
$this->items = $items;
 +
$this->pagination = $pagination;
 +
 +
// Set the toolbar and number of found items
 +
$this->addToolBar($this->pagination->total);
 +
 +
// Display the template
 +
parent::display($tpl);
 +
 +
// Set the document
 +
$this->setDocument();
 +
}
 +
 +
/**
 +
* Setting the toolbar
 +
*/
 +
protected function addToolBar($total=null)
 +
{
 +
JToolBarHelper::title(JText::_('COM_HELLOWORLD_MANAGER_HELLOWORLDS').
 +
//Reflect number of items in title!
 +
($total?' <span style="font-size: 0.5em; vertical-align: middle;">('.$total.')</span>':'')
 +
, 'helloworld');
 +
JToolBarHelper::deleteListX('', 'helloworlds.delete');
 +
JToolBarHelper::editListX('helloworld.edit');
 +
JToolBarHelper::addNewX('helloworld.add');
 +
}
 +
/**
 +
* Method to set up the document properties
 +
*
 +
* @return void
 +
*/
 +
protected function setDocument()
 +
{
 +
$document = JFactory::getDocument();
 +
$document->setTitle(JText::_('COM_HELLOWORLD_ADMINISTRATION'));
 +
}
 +
}
 +
</source>
 +
</span>
 +
 +
This view uses a second parameter for the ''JToolBarHelper::title'' function. It will be used to construct the css class for the title. The ''_setDocument'' method sets the browser title.
 +
 +
In ''admin/views/helloworld/view.html.php'', put these lines:
 +
 +
<span id="admin/views/helloworld/view.html.php">
 +
''admin/views/helloworld/view.html.php''
 +
<source lang="php">
 +
<?php
 +
// No direct access to this file
 +
defined('_JEXEC') or die('Restricted access');
 +
 +
// import Joomla view library
 +
jimport('joomla.application.component.view');
 +
 +
/**
 +
* HelloWorld View
 +
*/
 +
class HelloWorldViewHelloWorld extends JView
 +
{
 +
/**
 +
* View form
 +
*
 +
* @var form
 +
*/
 +
protected $form = null;
 +
 +
/**
 +
* display method of Hello view
 +
* @return void
 +
*/
 +
public function display($tpl = null)
 +
{
 +
// get the Data
 +
$form = $this->get('Form');
 +
$item = $this->get('Item');
 +
 +
// Check for errors.
 +
if (count($errors = $this->get('Errors')))
 +
{
 +
JError::raiseError(500, implode('<br />', $errors));
 +
return false;
 +
}
 +
// Assign the Data
 +
$this->form = $form;
 +
$this->item = $item;
 +
 +
// Set the toolbar
 +
$this->addToolBar();
 +
 +
// Display the template
 +
parent::display($tpl);
 +
 +
// Set the document
 +
$this->setDocument();
 +
}
 +
 +
/**
 +
* Setting the toolbar
 +
*/
 +
protected function addToolBar()
 +
{
 +
$input = JFactory::getApplication()->input;
 +
$input->set('hidemainmenu', true);
 +
$isNew = ($this->item->id == 0);
 +
JToolBarHelper::title($isNew ? JText::_('COM_HELLOWORLD_MANAGER_HELLOWORLD_NEW')
 +
                            : JText::_('COM_HELLOWORLD_MANAGER_HELLOWORLD_EDIT'), 'helloworld');
 +
JToolBarHelper::save('helloworld.save');
 +
JToolBarHelper::cancel('helloworld.cancel', $isNew ? 'JTOOLBAR_CANCEL' : 'JTOOLBAR_CLOSE');
 +
}
 +
/**
 +
* Method to set up the document properties
 +
*
 +
* @return void
 +
*/
 +
protected function setDocument()
 +
{
 +
$isNew = ($this->item->id < 1);
 +
$document = JFactory::getDocument();
 +
$document->setTitle($isNew ? JText::_('COM_HELLOWORLD_HELLOWORLD_CREATING')
 +
                          : JText::_('COM_HELLOWORLD_HELLOWORLD_EDITING'));
 +
}
 +
}
 +
</source>
 +
</span>
 +
 +
This view also uses the second parameter of the JToolBarHelper::title function and set the browser title
 +
 +
== Modifying the main entry file ==
 +
In the ''admin/helloworld.php'' file, put these lines in order to use the 48x48 icon:
 +
 +
<span id="admin/helloworld.php">
 +
<source lang="php">
 +
<?php
 +
// No direct access to this file
 +
defined('_JEXEC') or die('Restricted access');
 +
 +
// Set some global property
 +
$document = JFactory::getDocument();
 +
$document->addStyleDeclaration('.icon-48-helloworld {background-image: url(../media/com_helloworld/images/tux-48x48.png);}');
 +
 +
// 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 strings in the language file==
 +
Modify the ''admin/language/en-GB/en-GB.com_helloworld.ini'' and 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_ADMINISTRATION="HelloWorld - Administration"
 +
COM_HELLOWORLD_HELLOWORLD_CREATING="HelloWorld - Creating"
 +
COM_HELLOWORLD_HELLOWORLD_DETAILS="Details"
 +
COM_HELLOWORLD_HELLOWORLD_EDITING="HelloWorld - Editing"
 +
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"
 +
</source>
 +
</span>
 +
 +
== Packaging the component ==
 +
 +
Content of your code directory
 +
* ''[[#helloworld.xml|helloworld.xml]]''
 +
* ''[[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!2.5_-_Part_02#site/helloworld.php|site/helloworld.php]]''
 +
* ''[[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!2.5_-_Part_01#index.html|site/views/index.html]]''
 +
* ''[[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!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!2.5_-_Part_01#index.html|site/views/helloworld/tmpl/index.html]]''
 +
* ''[[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!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!2.5_-_Part_01#index.html|site/models/index.html]]''
 +
* ''[[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!2.5_-_Part_01#index.html|site/language/index.html]]''
 +
* ''[[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!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!2.5_-_Part_07#admin/controller.php|admin/controller.php]]''
 +
* ''[[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!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!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!2.5_-_Part_01#index.html|admin/sql/updates/index.html]]''
 +
* ''[[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!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!2.5_-_Part_01#index.html|admin/models/index.html]]''
 +
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_01#index.html|admin/models/fields/index.html]]''
 +
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_06#admin/models/fields/helloworld.php|admin/models/fields/helloworld.php]]''
 +
* ''[[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!2.5_-_Part_09#admin/models/forms/helloworld.xml|admin/models/forms/helloworld.xml]]''
 +
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_09#admin/models/helloworld.php|admin/models/helloworld.php]]''
 +
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_07#admin/models/helloworlds.php|admin/models/helloworlds.php]]''
 +
* ''[[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!2.5_-_Part_01#index.html|admin/views/helloworlds/index.html]]''
 +
* ''[[#admin/views/helloworlds/view.html.php|admin/views/helloworlds/view.html.php]]''
 +
* ''[[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_(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!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!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/helloworld/index.html]]''
 +
* ''[[#admin/views/helloworld/view.html.php|admin/views/helloworld/view.html.php]]''
 +
* ''[[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!2.5_-_Part_09#admin/views/helloworld/tmpl/edit.php|admin/views/helloworld/tmpl/edit.php]]''
 +
* ''[[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!2.5_-_Part_06#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_09#admin/controllers/helloworld.php|admin/controllers/helloworld.php]]''
 +
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_09#admin/controllers/helloworlds.php|admin/controllers/helloworlds.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-48x48.png''
 +
 +
Create a compressed file of this directory or directly download the [http://joomlacode.org/gf/download/frsrelease/11394/58408/com_helloworld-1.6-part10.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">
 +
''helloworld.xml''
 +
<source lang="xml">
 +
<?xml version="1.0" encoding="utf-8"?>
 +
<extension type="component" version="2.5.0" method="upgrade">
 +
 +
<name>Hello World!</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.10</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>
 +
<!-- SQL files section -->
 +
<folder>sql</folder>
 +
<!-- tables files section -->
 +
<folder>tables</folder>
 +
<!-- models files section -->
 +
<folder>models</folder>
 +
<!-- views files section -->
 +
<folder>views</folder>
 +
                        <!-- admin languages files section -->
 +
                        <folder>language</folder>
 +
<!-- controllers files section -->
 +
<folder>controllers</folder>
 +
</files>
 +
</administration>
 +
</extension>
 +
</source>
 +
</span>
 +
 +
{{:J3.2:Developing a MVC Component/Navigate
 +
|prev=Adding backend actions <!-- previous article subpage name -->
 +
 +
|next=Adding verifications <!-- next article subpage name -->}}
 +
 +
== Contributors ==
 +
*[[User:cdemko|Christophe Demko]]
 +
*[[User:oaksu|Ozgur Aksu]]
 +
*[[User:Onliner|Campergue Patrick]]
  
 
[[Category:Joomla! 3.0]]
 
[[Category:Joomla! 3.0]]

Revision as of 18:34, 21 January 2014


This is a multiple-article series of tutorials on how to develop a Model-View-Controller Component for Joomla! Version Joomla 3.x.

Begin with the Introduction, and navigate the articles in this series by using the navigation box to the right (the Articles in this series).

Copyedit.png
This Page Needs Your Help

This page is tagged because it NEEDS REVIEW. You can help the Joomla! Documentation Wiki by contributing to it.
More pages that need help similar to this one are here. NOTE-If you feel the need is satistified, please remove this notice.


This is a multiple-article series of tutorials on how to develop a Model-View-Contoller Component for Joomla! Version Joomla 3.3.

Introduction

This tutorial is part of the Developing a MVC Component for Joomla! 3.2 tutorial. You are encouraged to read the previous parts of the tutorial before reading this.

Adding some icons

With your favorite file manager put a 16x16 image and a 48x48 image (I choose tux) in a media/images/ folder and add a media tag in your install file. Modify the menu tag in order to use the new icon.

Modifying the views

In the admin/views/helloworlds/view.html.php file put these lines:

admin/views/helloworlds/view.html.php

<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');
 
// import Joomla view library
jimport('joomla.application.component.view');
 
/**
 * HelloWorlds View
 */
class HelloWorldViewHelloWorlds extends JView
{
        /**
         * HelloWorlds view display method
         * @return void
         */
        function display($tpl = null) 
        {
                // Get data from the model
                $items = $this->get('Items');
                $pagination = $this->get('Pagination');
 
                // Check for errors.
                if (count($errors = $this->get('Errors'))) 
                {
                        JError::raiseError(500, implode('<br />', $errors));
                        return false;
                }
                // Assign data to the view
                $this->items = $items;
                $this->pagination = $pagination;
 
                // Set the toolbar and number of found items
                $this->addToolBar($this->pagination->total);
 
                // Display the template
                parent::display($tpl);
 
                // Set the document
                $this->setDocument();
        }
 
        /**
         * Setting the toolbar
         */
        protected function addToolBar($total=null) 
        {
                JToolBarHelper::title(JText::_('COM_HELLOWORLD_MANAGER_HELLOWORLDS').
                        //Reflect number of items in title!
                        ($total?' <span style="font-size: 0.5em; vertical-align: middle;">('.$total.')</span>':'')
                        , 'helloworld');
                JToolBarHelper::deleteListX('', 'helloworlds.delete');
                JToolBarHelper::editListX('helloworld.edit');
                JToolBarHelper::addNewX('helloworld.add');
        }
        /**
         * Method to set up the document properties
         *
         * @return void
         */
        protected function setDocument() 
        {
                $document = JFactory::getDocument();
                $document->setTitle(JText::_('COM_HELLOWORLD_ADMINISTRATION'));
        }
}

This view uses a second parameter for the JToolBarHelper::title function. It will be used to construct the css class for the title. The _setDocument method sets the browser title.

In admin/views/helloworld/view.html.php, put these lines:

admin/views/helloworld/view.html.php

<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');
 
// import Joomla view library
jimport('joomla.application.component.view');
 
/**
 * HelloWorld View
 */
class HelloWorldViewHelloWorld extends JView
{
        /**
         * View form
         *
         * @var         form
         */
        protected $form = null;
 
        /**
         * display method of Hello view
         * @return void
         */
        public function display($tpl = null) 
        {
                // get the Data
                $form = $this->get('Form');
                $item = $this->get('Item');
 
                // Check for errors.
                if (count($errors = $this->get('Errors'))) 
                {
                        JError::raiseError(500, implode('<br />', $errors));
                        return false;
                }
                // Assign the Data
                $this->form = $form;
                $this->item = $item;
 
                // Set the toolbar
                $this->addToolBar();
 
                // Display the template
                parent::display($tpl);
 
                // Set the document
                $this->setDocument();
        }
 
        /**
         * Setting the toolbar
         */
        protected function addToolBar() 
        {               
                $input = JFactory::getApplication()->input;
                $input->set('hidemainmenu', true);
                $isNew = ($this->item->id == 0);
                JToolBarHelper::title($isNew ? JText::_('COM_HELLOWORLD_MANAGER_HELLOWORLD_NEW')
                                             : JText::_('COM_HELLOWORLD_MANAGER_HELLOWORLD_EDIT'), 'helloworld');
                JToolBarHelper::save('helloworld.save');
                JToolBarHelper::cancel('helloworld.cancel', $isNew ? 'JTOOLBAR_CANCEL' : 'JTOOLBAR_CLOSE');
        }
        /**
         * Method to set up the document properties
         *
         * @return void
         */
        protected function setDocument() 
        {
                $isNew = ($this->item->id < 1);
                $document = JFactory::getDocument();
                $document->setTitle($isNew ? JText::_('COM_HELLOWORLD_HELLOWORLD_CREATING')
                                           : JText::_('COM_HELLOWORLD_HELLOWORLD_EDITING'));
        }
}

This view also uses the second parameter of the JToolBarHelper::title function and set the browser title

Modifying the main entry file

In the admin/helloworld.php file, put these lines in order to use the 48x48 icon:

<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');
 
// Set some global property
$document = JFactory::getDocument();
$document->addStyleDeclaration('.icon-48-helloworld {background-image: url(../media/com_helloworld/images/tux-48x48.png);}');
 
// 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 strings in the language file

Modify the admin/language/en-GB/en-GB.com_helloworld.ini and put these lines

admin/language/en-GB/en-GB.com_helloworld.ini

COM_HELLOWORLD_ADMINISTRATION="HelloWorld - Administration"
COM_HELLOWORLD_HELLOWORLD_CREATING="HelloWorld - Creating"
COM_HELLOWORLD_HELLOWORLD_DETAILS="Details"
COM_HELLOWORLD_HELLOWORLD_EDITING="HelloWorld - Editing"
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"

Packaging the component

Content of your code directory

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>Hello World!</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.10</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>
                        <!-- SQL files section -->
                        <folder>sql</folder>
                        <!-- tables files section -->
                        <folder>tables</folder>
                        <!-- models files section -->
                        <folder>models</folder>
                        <!-- views files section -->
                        <folder>views</folder>
                        <!-- admin languages files section -->
                        <folder>language</folder>
                        <!-- controllers files section -->
                        <folder>controllers</folder>
                </files>
        </administration>
</extension>


Tutorial Navigation


Contributors