Developing a Model-View-Controller (MVC) Component for Joomla!1.6 - Part 10/ja
出典: Joomla! ドキュメンテーション
| This
{{#namespace:developing a model-view-controller (mvc) component for joomla!1.6 - part 10/ja}} page or section is in the middle of an expansion or major revamping.
However, you are welcome to assist in its construction by editing it as well. Please view the edit history should you wish to contact the person who placed this template. If the
{{#namespace:developing a model-view-controller (mvc) component for joomla!1.6 - part 10/ja}} page has not been edited in several days please remove this template. |
Articles actively undergoing construction]]
This
{{#namespace:developing a model-view-controller (mvc) component for joomla!1.6 - part 10/ja}} page contains preliminary information which is subject to change.目次 |
Articles in this series
- 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
Introduction
This tutorial is part of the Developing a Model-View-Controller (MVC) Component for Joomla!1.6 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/helloworldlist/view.html.php file put these lines:
admin/views/helloworldlist/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'); /** * HelloWorldList View */ class HelloWorldViewHelloWorldList extends JView { /** * items to be displayed */ protected $items; /** * pagination for the items */ protected $pagination; /** * HelloWorldList view display method * @return void */ function display($tpl = null) { // Get data from the model $items = $this->get('Items'); $pagination = $this->get('Pagination'); // Assign data to the view $this->items = $items; $this->pagination = $pagination; // Set the toolbar $this->_setToolBar(); // Display the template parent::display($tpl); // Set the document $this->_setDocument(); } /** * Setting the toolbar */ protected function _setToolBar() { JToolBarHelper::title(JText::_('com_helloworld_Manager'), 'helloworld'); JToolBarHelper::deleteListX('com_helloworld_HelloWorldList_Are_you_sure_you_want_to_delete_these_greetings', 'helloworldlist.remove'); 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 set 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 Form $form = & $this->get('Form'); // get the Data $data = & $this->get('Data'); // Bind the Data $form->bind($data); // Assign the form $this->form = $form; // Set the toolbar $this->_setToolBar(); // Display the template parent::display($tpl); // Set the document $this->_setDocument(); } /** * Setting the toolbar */ protected function _setToolBar() { JRequest::setVar('hidemainmenu', 1); $isNew = ($this->form->getValue('id') < 1); JToolBarHelper::title(JText::_('com_helloworld_Manager') . ': <small><small>[ ' . ($isNew ? JText::_('JToolBar_New') : JText::_('JToolBar_Edit')) . ' ]</small></small>', '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->form->getValue('id') < 1); $document = &JFactory::getDocument(); $document->setTitle(JText::_('com_helloworld_Administration') . ' - ' . ($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 $controller->execute(JRequest::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
# Joomla16.Tutorials # Copyright (C) 2005 - 2009 Open Source Matters. All rights reserved. # License GNU General Public License version 2 or later; see LICENSE.txt, see LICENSE.php # Note : All ini files need to be saved as UTF-8 - No BOM COM_HELLOWORLD_ADMINISTRATION=HelloWorld administration COM_HELLOWORLD_HELLOWORLD_CREATING=Creating COM_HELLOWORLD_HELLOWORLD_DETAILS=Details COM_HELLOWORLD_HELLOWORLD_EDIT_CANCELLED=Edit Cancelled COM_HELLOWORLD_HELLOWORLD_EDITING=Editing COM_HELLOWORLD_HELLOWORLD_ERROR_SAVING_GREETING=Error saving greeting: %s COM_HELLOWORLD_HELLOWORLD_GREETING_DESC=Message to be displayed COM_HELLOWORLD_HELLOWORLD_GREETING=Greeting COM_HELLOWORLD_HELLOWORLD_GREETING_SAVED=Greeting saved COM_HELLOWORLD_HELLOWORLDLIST_ARE_YOU_SURE_YOU_WANT_TO_DELETE_THESE_GREETINGS=Are you sure you want to delete these greetings? COM_HELLOWORLD_HELLOWORLDLIST_GREETING=Greeting COM_HELLOWORLD_HELLOWORLDLIST_GREETINGS_REMOVED=Greetings removed COM_HELLOWORLD_HELLOWORLDLIST_ID=Id COM_HELLOWORLD_HELLOWORLDLIST_ONE_OR_MORE_GREETINGS_COULD_NOT_BE_DELETED=One or more greetings could not be deleted: %s COM_HELLOWORLD_HELLOWORLD_VIEW_DEFAULT_MSG_DESC=This message will be displayed COM_HELLOWORLD_HELLOWORLD_VIEW_DEFAULT_MSG_LABEL=Message COM_HELLOWORLD_MANAGER=HelloWorld manager
Packaging the component
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/sql/index.html
- admin/sql/install.mysql.utf8.sql
- admin/sql/uninstall.mysql.utf8.sql
- admin/sql/update.mysql.utf8.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/helloworld.php
- admin/models/helloworldlist.php
- admin/views/index.html
- admin/views/helloworldlist/index.html
- admin/views/helloworldlist/view.html.php
- admin/views/helloworldlist/tmpl/index.html
- admin/views/helloworldlist/tmpl/default.php
- admin/views/helloworldlist/tmpl/default_head.php
- admin/views/helloworldlist/tmpl/default_body.php
- admin/views/helloworldlist/tmpl/default_foot.php
- admin/views/helloworldlist/index.html
- admin/views/helloworld/view.html.php
- admin/views/helloworld/tmpl/index.html
- admin/views/helloworld/tmpl/default.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!1.6. 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="1.6.0" method="upgrade"> <name>Hello World!</name> <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> <version>0.0.10</version> <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 --> <sql> <file driver="mysql" charset="utf8">sql/update.mysql.utf8.sql</file> </sql> </update> <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> <menu img="../media/com_helloworld/images/tux-16x16.png">Hello World!</menu> <files folder="admin"> <filename>index.html</filename> <filename>helloworld.php</filename> <filename>controller.php</filename> <folder>sql</folder> <folder>tables</folder> <folder>models</folder> <folder>views</folder> <folder>controllers</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.menu.ini</language> </languages> </administration> </extension>
