J2.5:Developing a MVC Component/Adding a model to the site part

From Joomla! Documentation
< J2.5:Developing a MVC Component(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
−
This tutorial is for {{JVer|1.7}}
+
This tutorial is for {{JVer|1.6}} {{JVer|1.7}} {{JVer|2.5}}
  
 
== Articles in this series ==
 
== Articles in this series ==
−
{{Chunk:Developing a Model-View-Controller (MVC) Component for Joomla!1.7 - Contents}}
+
{{Chunk:Developing a Model-View-Controller (MVC) Component for Joomla!2.5 - Contents}}
  
 
== Introduction ==
 
== Introduction ==
−
This tutorial is part of the [[Developing a Model-View-Controller (MVC) Component for Joomla!1.7]] tutorial. You are encouraged to read the previous parts of the tutorial before reading this.
+
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.
  
 
== Adding a model ==
 
== Adding a model ==
−
In the Joomla!1.7 framework, models are responsible for managing the data. The first function that has to be written for a model is a ''get'' function. It returns data to the caller. In our case, the caller will be the ''HelloWorldViewHelloWorld'' view. By default, the model named ''HelloWorldModelHelloWorld'' is the main model associated to this view. with your favorite file manager and editor put a ''site/models/helloworld.php'' file containing:
+
In the Joomla framework, models are responsible for managing the data. The first function that has to be written for a model is a ''get'' function. It returns data to the caller. In our case, the caller will be the ''HelloWorldViewHelloWorld'' view. By default, the model named ''HelloWorldModelHelloWorld'' is the main model associated to this view. with your favorite file manager and editor put a ''site/models/helloworld.php'' file containing:
  
 
<span id="site/models/helloworld.php">
 
<span id="site/models/helloworld.php">
Line 88: Line 88:
 
<source lang="xml">
 
<source lang="xml">
 
<?xml version="1.0" encoding="utf-8"?>
 
<?xml version="1.0" encoding="utf-8"?>
−
<extension type="component" version="1.7.0" method="upgrade">
+
<extension type="component" version="2.5.0" method="upgrade">
  
 
<name>Hello World!</name>
 
<name>Hello World!</name>
Line 103: Line 103:
 
<description>Description of the Hello World component ...</description>
 
<description>Description of the Hello World component ...</description>
  
−
<update> <!-- Runs on update; New in 1.7 -->
+
<update> <!-- Runs on update; New in 2.5 -->
 
<schemas>
 
<schemas>
 
<schemapath type="mysql">sql/updates/mysql</schemapath>
 
<schemapath type="mysql">sql/updates/mysql</schemapath>
Line 145: Line 145:
 
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!1.7_-_Part_01#index.html|site/index.html]]''
+
* ''[[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!1.7_-_Part_02#site/helloworld.php|site/helloworld.php]]''
+
* ''[[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!1.7_-_Part_02#site/controller.php|site/controller.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!1.7_-_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/index.html]]''
−
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|site/views/helloworld/index.html]]''
+
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_01#index.html|site/views/helloworld/index.html]]''
 
* ''[[#site/views/helloworld/view.html.php|site/views/helloworld/view.html.php]]''
 
* ''[[#site/views/helloworld/view.html.php|site/views/helloworld/view.html.php]]''
−
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|site/views/helloworld/tmpl/index.html]]''
+
* ''[[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!1.7_-_Part_03#site/views/helloworld/tmpl/default.xml|site/views/helloworld/tmpl/default.xml]]''
+
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_03#site/views/helloworld/tmpl/default.xml|site/views/helloworld/tmpl/default.xml]]''
−
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_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_02#site/views/helloworld/tmpl/default.php|site/views/helloworld/tmpl/default.php]]''
−
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|site/models/index.html]]''
+
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_01#index.html|site/models/index.html]]''
 
* ''[[#site/models/helloworld.php|site/models/helloworld.php]]''
 
* ''[[#site/models/helloworld.php|site/models/helloworld.php]]''
−
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|admin/index.html]]''
+
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_01#index.html|admin/index.html]]''
−
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#admin/helloworld.php|admin/helloworld.php]]''
+
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!2.5_-_Part_01#admin/helloworld.php|admin/helloworld.php]]''
−
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|admin/sql/index.html]]''
+
* ''[[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!1.7_-_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/index.html]]''
−
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|admin/sql/updates/mysql/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!1.7_-_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_01#admin/sql/updates/mysql/0.0.1.sql|admin/sql/updates/mysql/0.0.1.sql]]''
  
−
Create a compressed file of this directory or directly download the [http://joomlacode.org/gf/download/frsrelease/11394/58228/com_helloworld-1.6-part04.zip archive] and install it using the extension manager of Joomla!1.7. You can add a menu item of this component using the menu manager in the backend.
+
Create a compressed file of this directory or directly download the [http://joomlacode.org/gf/download/frsrelease/11394/58228/com_helloworld-1.6-part04.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.
  
 
== Zips ==
 
== Zips ==
Line 171: Line 171:
 
== Navigate ==
 
== Navigate ==
  
−
[[Developing a Model-View-Controller (MVC) Component for Joomla!1.7 - Part 03|Prev: Adding a menu type to the site part]]
+
[[Developing a Model-View-Controller (MVC) Component for Joomla!2.5 - Part 03|Prev: Adding a menu type to the site part]]
−
[[Developing a Model-View-Controller (MVC) Component for Joomla!1.7 - Part 05|Next: Adding a variable request in the menu type]]
+
[[Developing a Model-View-Controller (MVC) Component for Joomla!2.5 - Part 05|Next: Adding a variable request in the menu type]]
  
 
== Contributors ==
 
== Contributors ==
Line 181: Line 181:
 
[[category:Joomla! 1.6]]
 
[[category:Joomla! 1.6]]
 
[[category:Joomla! 1.7]]
 
[[category:Joomla! 1.7]]
 +
[[category:Joomla! 2.5]]
 
[[category:Manual]]
 
[[category:Manual]]
 
'''Bold text'''
 
'''Bold text'''

Revision as of 10:12, 13 February 2012

Only this version

This tutorial is for Joomla 1.6 Joomla 1.7 Joomla 2.5

Articles in this series

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.

Adding a model

In the Joomla framework, models are responsible for managing the data. The first function that has to be written for a model is a get function. It returns data to the caller. In our case, the caller will be the HelloWorldViewHelloWorld view. By default, the model named HelloWorldModelHelloWorld is the main model associated to this view. with your favorite file manager and editor put a site/models/helloworld.php file containing:

site/models/helloworld.php 

<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');
 
// import Joomla modelitem library
jimport('joomla.application.component.modelitem');
 
/**
 * HelloWorld Model
 */
class HelloWorldModelHelloWorld extends JModelItem
{
        /**
         * @var string msg
         */
        protected $msg;
 
        /**
         * Get the message
         * @return string The message to be displayed to the user
         */
        public function getMsg() 
        {
                if (!isset($this->msg)) 
                {
                        $this->msg = 'Hello World!';
                }
                return $this->msg;
        }
}

The HelloWorldViewHelloWorld class asks the model for data using the get method of the JView class:

site/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');
 
/**
 * HTML View class for the HelloWorld Component
 */
class HelloWorldViewHelloWorld extends JView
{
        // Overwriting JView display method
        function display($tpl = null) 
        {
                // Assign data to the view
                $this->msg = $this->get('Msg');
 
                // Check for errors.
                if (count($errors = $this->get('Errors'))) 
                {
                        JError::raiseError(500, implode('<br />', $errors));
                        return false;
                }
                // Display the view
                parent::display($tpl);
        }
}

Also modify your helloworld.xml file to indicate use of models and the new version:

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.4</version>
        <!-- The description is optional and defaults to the name -->
        <description>Description of the Hello World component ...</description>
 
        <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>
        </files>
 
        <administration>
                <!-- Administration Menu Section -->
                <menu>Hello World!</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>
                        <!-- SQL files section -->
                        <folder>sql</folder>
                </files>
        </administration>
 
</extension>

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.

Zips

Download the zip file for this Part: [1]

Navigate

Prev: Adding a menu type to the site part Next: Adding a variable request in the menu type

Contributors

Bold text

Retrieved from "http://docs.joomla.org/index.php?title=J2.5:Developing_a_MVC_Component/Adding_a_model_to_the_site_part&oldid=64904"
Personal tools
Namespaces

Variants
Actions
Navigation
Joomla! Sites
Toolbox