Actions

J2.5

Difference between revisions of "Developing a MVC Component/Adding a variable request in the menu type"

From Joomla! Documentation

< J2.5:Developing a MVC Component
m
m (Removed JFactory::getApplication from model code example and replaced it with JRequest. JFactory line was invalid and inconsistent with the archive code.)
(10 intermediate revisions by 8 users not shown)
Line 1: Line 1:
This tutorial is for {{JVer|1.6}} {{JVer|1.7}} {{JVer|2.5}}
+
{{version/tutor|2.5}}
 
+
== Articles in this series ==
+
 
{{Chunk:Developing a Model-View-Controller (MVC) Component for Joomla!2.5 - Contents}}
 
{{Chunk:Developing a Model-View-Controller (MVC) Component for Joomla!2.5 - Contents}}
  
Line 38: Line 36:
 
Two important things to note:
 
Two important things to note:
 
* the ''request'' group of fields indicates mandatory fields
 
* the ''request'' group of fields indicates mandatory fields
* <span style="text-decoration:line-through;">the ''array'' parameter that indicates that these parameters will be added in the request URL</span> [??]<!-- What??? Where? -->
+
* the name attribute can be passed to the component in the URL. In this case ''?option=com_helloworld&id=1'' would indicate that you had chosen option 1.
  
 
The model has to be modified in order to switch between the two different messages (which is chosen by the user with the field defined above):
 
The model has to be modified in order to switch between the two different messages (which is chosen by the user with the field defined above):
Line 61: Line 59:
 
*/
 
*/
 
protected $msg;
 
protected $msg;
 
+
 
/**
 
/**
 
* Get the message
 
* Get the message
Line 73: Line 71:
 
switch ($id)  
 
switch ($id)  
 
{
 
{
case 2:
+
case 2:
$this->msg = 'Good bye World!';
+
$this->msg = 'Good bye World!';
break;
+
break;
default:
+
default:
case 1:
+
case 1:
$this->msg = 'Hello World!';
+
$this->msg = 'Hello World!';
break;
+
break;
 
}
 
}
 
}
 
}
Line 147: Line 145:
 
</span>
 
</span>
  
<span style="text-decoration:line-through;">You can test this variable request by putting ''index.php?option=com_helloworld&id=1'' or ''index.php?option=com_helloworld&id=2'' in your browser address.</span> [??] <!-- This line does nothing yet as I follow the tutorial -->
+
You can test this variable request by putting ''index.php?option=com_helloworld&id=1'' or ''index.php?option=com_helloworld&id=2'' in your browser address.
  
 
== Packaging the component ==
 
== Packaging the component ==
Line 173: Line 171:
 
Create a compressed file of this directory or directly download the [http://joomlacode.org/gf/download/frsrelease/11394/58229/com_helloworld-1.6-part05.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.
 
Create a compressed file of this directory or directly download the [http://joomlacode.org/gf/download/frsrelease/11394/58229/com_helloworld-1.6-part05.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 ==
 
Download the zip file for this Part:
 
[http://www.leyar.com/joomlaorg/part05.zip]
 
  
 
== Navigate ==
 
== Navigate ==
Line 187: Line 182:
  
 
[[Category:Development]]
 
[[Category:Development]]
[[category:Joomla! 1.6]]
+
[[Category:Joomla! 1.6]]
[[category:Joomla! 1.7]]
+
[[Category:Joomla! 1.7]]
[[category:Joomla! 2.5]]
+
[[Category:Joomla! 2.5]]
[[category:Manual]]
+

Revision as of 23:54, 3 October 2012


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 variable request in the menu type

For the moment, the displayed message is always Hello World!. Joomla!2.5 gives the possibility to add parameters to menu types. In our case, this is done in the site/views/helloworld/tmpl/default.xml file:

site/views/helloworld/tmpl/default.xml

<?xml version="1.0" encoding="utf-8"?>
<metadata>
        <layout title="COM_HELLOWORLD_HELLOWORLD_VIEW_DEFAULT_TITLE">
                <message>COM_HELLOWORLD_HELLOWORLD_VIEW_DEFAULT_DESC</message>
        </layout>
        <fields name="request">
                <fieldset name="request">
                        <field
                                name="id"
                                type="list"
                                label="COM_HELLOWORLD_HELLOWORLD_FIELD_GREETING_LABEL"
                                description="COM_HELLOWORLD_HELLOWORLD_FIELD_GREETING_DESC"
                                default="1"
                        >
                                <option value="1">Hello World!</option>
                                <option value="2">Good bye World!</option>
                        </field>
                </fieldset>
        </fields>
</metadata>

Two important things to note:

  • the request group of fields indicates mandatory fields
  • the name attribute can be passed to the component in the URL. In this case ?option=com_helloworld&id=1 would indicate that you had chosen option 1.

The model has to be modified in order to switch between the two different messages (which is chosen by the user with the field defined above):

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)) 
                {
                        $id = JRequest::getInt('id');
                        switch ($id) 
                        {
                        case 2:
                                $this->msg = 'Good bye World!';
                        break;
                        default:
                        case 1:
                                $this->msg = 'Hello World!';
                        break;
                        }
                }
                return $this->msg;
        }
}

Also modify your helloworld.xml file to indicate 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.5</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>

You can test this variable request by putting index.php?option=com_helloworld&id=1 or index.php?option=com_helloworld&id=2 in your browser address.

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.


Navigate

Prev: Adding a model to the site part Next: Using the database

Contributors