Joomla! Documentation - User contributions [en]

Archived:Developing a MVC Component/Developing a Basic Component

2014-01-03T12:50:53Z

Jossnaz:

{{version/tutor|2.5}}
{{Chunk:Developing a Model-View-Controller (MVC) Component for Joomla!2.5 - Contents}}

This tutorial is part of the [[Developing a Model-View-Controller (MVC) Component for Joomla!2.5]] tutorial.
== Before heading out and starting ==
It is recommended watching these 2 basics videos. They last for about 2 hours total, and cover some things with more patience and obviously visual support. So first get to know things with these videos, then go ahead and play around yourself with the help of this tutorial:

http://www.youtube.com/watch?v=kUTH2DKmjhI

http://www.youtube.com/watch?v=5Q_a5g3gEMM

== The first basic component ==
Let's create a ''Hello World!'' component.
=== Public display ===
With your favorite file manager and editor, create a file ''yoursite/components/com_helloworld/helloworld.php'' containing
<source lang="php">
Hello world
</source>

You can test this basic component by putting ''index.php?option=com_helloworld'' in your browser address (don't forget to prefix this address with your Joomla!2.5 installation path) after installing this component.

=== Administrator management ===
With your favorite file manager and editor, create a file ''yoursite/administrator/components/com_helloworld/helloworld.php'' containing
<source lang="php">
Hello world administration
</source>

You can test this basic component by putting ''administrator/index.php?option=com_helloworld'' in your browser address after installing the component.

=== Packaging an installation zip file ===
If you have used Joomla before reading this tutorial, you have noticed that extensions are installed using a compressed file containing all the things which are needed for installing and uninstalling them.

With your favorite file manager, create a directory (outside your Joomla installation directory) containing
* ''[[#helloworld.xml|helloworld.xml]]''
* ''[[#site/helloworld.php|site/helloworld.php]]''
* ''[[#index.html|site/index.html]]''
* ''[[#index.html|admin/index.html]]''
* ''[[#admin/helloworld.php|admin/helloworld.php]]''
* ''[[#index.html|admin/sql/index.html]]''
* ''[[#index.html|admin/sql/updates/index.html]]''
* ''[[#index.html|admin/sql/updates/mysql/index.html]]''
* ''[[#admin/sql/updates/mysql/0.0.1.sql|admin/sql/updates/mysql/0.0.1.sql]]''

''admin/sql/updates/mysql/0.0.1.sql'' is an empty file allowing to initialise schema version of the com_helloworld component.


''admin/sql/updates/mysql/0.0.1.sql''
<source lang="sql">
</source>


Create a compressed file of this directory or directly download the [http://joomlacode.org/gf/download/frsrelease/11394/58225/com_helloworld-1.6-part01.zip archive] and install it using the extension manager of Joomla. You can test this basic component by putting ''index.php?option=com_helloworld'' or ''administrator/index.php?option=com_helloworld'' in your browser address. You can also notice that the ''Hello World!'' component is visible in the administrator site of your Joomla installation under the ''Components'' menu.

Note: '''<name>Hello World!</name>''' is tricking you into thinking that this is actually only a name, and you could call it 'fluffy' or 'bippo', but this is not true. As far as I understand the name in between the tags is getting automagically lowercased, white spaces and special characters are removed (the ! for example) and joomla starts to look for files/folders responding to this name. So the name you are giving there is actually very crucial for your component to work. In other words, if you would change "Hello World!" to "helloworld" everyhting would still work. If you would change it to "helloworld2" the component would be looking for different folders and file names.


''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>

<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.1</version>

<description>Description of the Hello World component ...</description>

<update> 
<schemas>
<schemapath type="mysql">sql/updates/mysql</schemapath>
</schemas>
</update>



<files folder="site">
<filename>index.html</filename>
<filename>helloworld.php</filename>
</files>

<administration>

<menu>Hello World!</menu>


<files folder="admin">

<filename>index.html</filename>
<filename>helloworld.php</filename>

<folder>sql</folder>
</files>
</administration>

</extension>
</source>



''site/helloworld.php''
<source lang="php">
Hello World
</source>



''admin/helloworld.php''
<source lang="php">
Hello World administration
</source>



''index.html'' common to all folders
<source lang="html4strict">
<html><body bgcolor="#FFFFFF"></body></html>
</source>


== Navigate ==

[[J2.5:Developing_a_MVC_Component/Adding_a_view_to_the_site_part|Next: Adding a view to the site part]]

== Contributors ==
*[[User:cdemko|Christophe Demko]]
*[[User:oaksu|Ozgur Aksu]]

[[Category:Component Development]]
[[Category:Joomla! 1.6]]
[[Category:Joomla! 1.7]]
[[Category:Joomla! 2.5]]

Archived:Developing a MVC Component/Developing a Basic Component

2014-01-03T12:50:04Z

Jossnaz:

{{version/tutor|2.5}}
{{Chunk:Developing a Model-View-Controller (MVC) Component for Joomla!2.5 - Contents}}

This tutorial is part of the [[Developing a Model-View-Controller (MVC) Component for Joomla!2.5]] tutorial.
== Before heading out and start ==
It is recommended watching these 2 basics videos. They last for about 2 hours total, and cover some things with more patience and obviously visual support. So first get to know things with these videos, then go ahead and play around yourself with the help of this tutorial:

http://www.youtube.com/watch?v=kUTH2DKmjhI

http://www.youtube.com/watch?v=5Q_a5g3gEMM

== The first basic component ==
Let's create a ''Hello World!'' component.
=== Public display ===
With your favorite file manager and editor, create a file ''yoursite/components/com_helloworld/helloworld.php'' containing
<source lang="php">
Hello world
</source>

You can test this basic component by putting ''index.php?option=com_helloworld'' in your browser address (don't forget to prefix this address with your Joomla!2.5 installation path) after installing this component.

=== Administrator management ===
With your favorite file manager and editor, create a file ''yoursite/administrator/components/com_helloworld/helloworld.php'' containing
<source lang="php">
Hello world administration
</source>

You can test this basic component by putting ''administrator/index.php?option=com_helloworld'' in your browser address after installing the component.

=== Packaging an installation zip file ===
If you have used Joomla before reading this tutorial, you have noticed that extensions are installed using a compressed file containing all the things which are needed for installing and uninstalling them.

With your favorite file manager, create a directory (outside your Joomla installation directory) containing
* ''[[#helloworld.xml|helloworld.xml]]''
* ''[[#site/helloworld.php|site/helloworld.php]]''
* ''[[#index.html|site/index.html]]''
* ''[[#index.html|admin/index.html]]''
* ''[[#admin/helloworld.php|admin/helloworld.php]]''
* ''[[#index.html|admin/sql/index.html]]''
* ''[[#index.html|admin/sql/updates/index.html]]''
* ''[[#index.html|admin/sql/updates/mysql/index.html]]''
* ''[[#admin/sql/updates/mysql/0.0.1.sql|admin/sql/updates/mysql/0.0.1.sql]]''

''admin/sql/updates/mysql/0.0.1.sql'' is an empty file allowing to initialise schema version of the com_helloworld component.


''admin/sql/updates/mysql/0.0.1.sql''
<source lang="sql">
</source>


Create a compressed file of this directory or directly download the [http://joomlacode.org/gf/download/frsrelease/11394/58225/com_helloworld-1.6-part01.zip archive] and install it using the extension manager of Joomla. You can test this basic component by putting ''index.php?option=com_helloworld'' or ''administrator/index.php?option=com_helloworld'' in your browser address. You can also notice that the ''Hello World!'' component is visible in the administrator site of your Joomla installation under the ''Components'' menu.

Note: '''<name>Hello World!</name>''' is tricking you into thinking that this is actually only a name, and you could call it 'fluffy' or 'bippo', but this is not true. As far as I understand the name in between the tags is getting automagically lowercased, white spaces and special characters are removed (the ! for example) and joomla starts to look for files/folders responding to this name. So the name you are giving there is actually very crucial for your component to work. In other words, if you would change "Hello World!" to "helloworld" everyhting would still work. If you would change it to "helloworld2" the component would be looking for different folders and file names.


''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>

<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.1</version>

<description>Description of the Hello World component ...</description>

<update> 
<schemas>
<schemapath type="mysql">sql/updates/mysql</schemapath>
</schemas>
</update>



<files folder="site">
<filename>index.html</filename>
<filename>helloworld.php</filename>
</files>

<administration>

<menu>Hello World!</menu>


<files folder="admin">

<filename>index.html</filename>
<filename>helloworld.php</filename>

<folder>sql</folder>
</files>
</administration>

</extension>
</source>



''site/helloworld.php''
<source lang="php">
Hello World
</source>



''admin/helloworld.php''
<source lang="php">
Hello World administration
</source>



''index.html'' common to all folders
<source lang="html4strict">
<html><body bgcolor="#FFFFFF"></body></html>
</source>


== Navigate ==

[[J2.5:Developing_a_MVC_Component/Adding_a_view_to_the_site_part|Next: Adding a view to the site part]]

== Contributors ==
*[[User:cdemko|Christophe Demko]]
*[[User:oaksu|Ozgur Aksu]]

[[Category:Component Development]]
[[Category:Joomla! 1.6]]
[[Category:Joomla! 1.7]]
[[Category:Joomla! 2.5]]

Archived:Developing a MVC Component/Adding a model to the site part

2013-12-31T23:13:38Z

Jossnaz: /* Contributors */

{{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.

== 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'' residing in ''site/models/helloworld.php'' is the main model associated to this view.

So let's have a quick look at the naming conventions with an example, since the naming convention are the actual magic, that make everything work:

The class ''HelloWorldView'''HelloWorld''''' resides in ''site/views/'''helloworld'''/view.html.php'' and will make use of the class ''HelloWorldModel'''HelloWorld''''' in the file ''site/models/'''helloworld'''.php''

So let's just assume we want to use an imaginary view ''fluffy'', you would have to have:

The class ''HelloWorldView'''Fluffy''''' which resides in ''site/views/'''fluffy'''/view.html.php''. The view will make use of ''HelloWorldModel'''Fluffy''''' in the file ''site/models/'''fluffy'''.php''. Note: the actual screen of the view: ''site/views/'''fluffy'''/tmpl/default.php'' is required as well to make this example work.

Breaking any of these bold conventions will lead to errors or a blank page.

So back to the actual implementation of the single classes:

With your favorite file manager and editor put a ''site/models/helloworld.php'' file containing:


''site/models/helloworld.php''
<source lang="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;
}
}
</source>


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


''site/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');

/**
* 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')))
{
JLog::add(implode(' ', $errors), JLog::WARNING, 'jerror');
return false;
}
// Display the view
parent::display($tpl);
}
}
</source>


Note: $this->get() is a member of JView::get which is a proxy to get* methods of the default model where * is populated with the value of the first parameter passed to get()

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


''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>

<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.4</version>

<description>Description of the Hello World component ...</description>

<update> 
<schemas>
<schemapath type="mysql">sql/updates/mysql</schemapath>
</schemas>
</update>



<files folder="site">
<filename>index.html</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>
<folder>views</folder>
<folder>models</folder>
</files>

<administration>

<menu>Hello World!</menu>


<files folder="admin">

<filename>index.html</filename>
<filename>helloworld.php</filename>

<folder>sql</folder>
</files>
</administration>

</extension>
</source>


== 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]]''
* ''[[#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_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_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]]''
* ''[[#site/models/helloworld.php|site/models/helloworld.php]]''
* ''[[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!2.5_-_Part_01#admin/helloworld.php|admin/helloworld.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_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]]''

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.

== Navigate ==

[[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!2.5 - Part 05|Next: Adding a variable request in the menu type]]

== Contributors ==
*[[User:cdemko|Christophe Demko]]
*[[User:oaksu|Ozgur Aksu]]
*[[User:Jossnaz|Lukas Meier]]

[[Category:Development]]
[[Category:Joomla! 1.6]]
[[Category:Joomla! 1.7]]
[[Category:Joomla! 2.5]]

Archived:Developing a MVC Component/Adding a model to the site part

2013-12-31T23:12:55Z

Jossnaz: /* Adding a model */

{{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.

== 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'' residing in ''site/models/helloworld.php'' is the main model associated to this view.

So let's have a quick look at the naming conventions with an example, since the naming convention are the actual magic, that make everything work:

The class ''HelloWorldView'''HelloWorld''''' resides in ''site/views/'''helloworld'''/view.html.php'' and will make use of the class ''HelloWorldModel'''HelloWorld''''' in the file ''site/models/'''helloworld'''.php''

So let's just assume we want to use an imaginary view ''fluffy'', you would have to have:

The class ''HelloWorldView'''Fluffy''''' which resides in ''site/views/'''fluffy'''/view.html.php''. The view will make use of ''HelloWorldModel'''Fluffy''''' in the file ''site/models/'''fluffy'''.php''. Note: the actual screen of the view: ''site/views/'''fluffy'''/tmpl/default.php'' is required as well to make this example work.

Breaking any of these bold conventions will lead to errors or a blank page.

So back to the actual implementation of the single classes:

With your favorite file manager and editor put a ''site/models/helloworld.php'' file containing:


''site/models/helloworld.php''
<source lang="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;
}
}
</source>


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


''site/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');

/**
* 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')))
{
JLog::add(implode(' ', $errors), JLog::WARNING, 'jerror');
return false;
}
// Display the view
parent::display($tpl);
}
}
</source>


Note: $this->get() is a member of JView::get which is a proxy to get* methods of the default model where * is populated with the value of the first parameter passed to get()

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


''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>

<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.4</version>

<description>Description of the Hello World component ...</description>

<update> 
<schemas>
<schemapath type="mysql">sql/updates/mysql</schemapath>
</schemas>
</update>



<files folder="site">
<filename>index.html</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>
<folder>views</folder>
<folder>models</folder>
</files>

<administration>

<menu>Hello World!</menu>


<files folder="admin">

<filename>index.html</filename>
<filename>helloworld.php</filename>

<folder>sql</folder>
</files>
</administration>

</extension>
</source>


== 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]]''
* ''[[#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_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_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]]''
* ''[[#site/models/helloworld.php|site/models/helloworld.php]]''
* ''[[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!2.5_-_Part_01#admin/helloworld.php|admin/helloworld.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_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]]''

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.

== Navigate ==

[[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!2.5 - Part 05|Next: Adding a variable request in the menu type]]

== Contributors ==
*[[User:cdemko|Christophe Demko]]
*[[User:oaksu|Ozgur Aksu]]

[[Category:Development]]
[[Category:Joomla! 1.6]]
[[Category:Joomla! 1.7]]
[[Category:Joomla! 2.5]]

Archived:Developing a MVC Component/Adding a menu type to the site part

2013-12-31T22:34:38Z

Jossnaz:

Archived:Developing a MVC Component/Adding a view to the site part

2013-12-31T21:36:00Z

Jossnaz: /* Contributors */

{{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.

In the Joomla!2.5 framework, third party component authors divide their code into three main parts:
* ''models'' They manage the data
* ''controllers'' They perform tasks, set and get the states of the models and ask the views to display
* ''views'' They display the content according to the type (''error'', ''feed'', ''html'', ''json'', ''raw'', ''xml'') and the layout chosen by the controllers

== Setting the controller ==
In the core code of Joomla, there is a class able to manage controllers: ''[http://api.joomla.org/Joomla-Platform/Application/JController.html JController]''. This class has to be extended to be used in our component. In the file ''site/helloworld.php'' (entry point of our ''Hello World'' component), put these lines


''site/helloworld.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');

// 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>

The ''[http://api.joomla.org/Joomla-Platform/Application/JController.html#getInstance getInstance]'' static method of the ''JController'' class will create a controller. In the code above, it will instantiate a controller object of a class named ''HelloWorldController''. Joomla will look for the declaration of that class in an aptly named file called ''controller.php'' (it's a default behavior).

Now, ''controller.php'' needs to be created and ''HelloWorldController'' needs to be declared and defined. So with your favorite file manager and editor, create a ''site/controller.php'' file containing


''site/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');

/**
* Hello World Component Controller
*/
class HelloWorldController extends JController
{
}
</source>


When no task is given in the request variables, the default task will be executed. It's the ''display'' task by default. The ''JController'' class has such a task. In our example, it will display a view named ''HelloWorld''.

So with ''task'' simply a public function display() of ''JController'' is refered to.

{{tip|Just a side note for completion, you could call another function aside from ''display()'' by using an URL like this one:

<pre>http://localhost/index.php?option=com_helloworld&task=insert</pre>

This would try to call a function ''insert()'' of our controller (which we would actually have to implement in ''HelloWorldController'' ).}}

== Setting the view ==

When JController wants to display a view, it will look for certain files in the ''component/com_[component_name]/views/[name of view]/'' folder.

The name of the folder of the default view is the name of the component itself. In our case the path is ''component/com_helloworld/views/helloworld/''.

The file that will contain the code of the view is called ''view.[view_mode].php''. The default view mode, and probably the only view a component might need is the ''html'' mode. So this give us our file name which is ''view.html.php''.

With your favorite file manager and editor, create a file ''site/views/helloworld/view.html.php'' able to display the default view and containing


''site/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');

/**
* 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 = 'Hello World';

// Display the view
parent::display($tpl);
}
}
</source>


The ''display'' method of the ''[http://api.joomla.org/Joomla-Platform/Application/JView.html JView]'' class is called with the ''display'' task of the JController class. In our case, this method will display data using the ''tmpl/default.php'' file. With your favorite file manager and editor, create a file ''site/views/helloworld/tmpl/default.php'' able to display the default view and containing


''site/views/helloworld/tmpl/default.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');
?>
<h1><?php echo $this->msg; ?></h1>
</source>

This template file will be included by the JView class. Therefore, here, $this refers to the HelloWorldViewHelloWorld class.

So to give an example, one could call the view inside the ''component/com_[component_name]/views/[name of view]/'' folder by calling:

http://localhost/joomla/index.php?option=com_helloworld

(this would default to the ''component/com_helloworld/views/helloworld/'' folder)
or we could explicitly call the folder by calling

http://localhost/joomla/index.php?option=com_helloworld&view=helloworld

if we change ''&view=helloworld'' to something else, e.g. ''&view=fluffy'' we would have to create a folder:

''component/com_helloworld/views/fluffy/''

Copy the contents of ''views/helloworld'' to ''views/fluffy''

The classname of the file ''view.html.php'' of the fluffy folder would be ''HelloWorldViewFluffy''. Afterwards you can customize the contents of ''default.php'' of the ''fluffy'' subfolder for custom output and see the output by calling:

''http://localhost/joomla/index.php?option=com_helloworld&view=fluffy''

== 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]]''
* ''[[#site/helloworld.php|site/helloworld.php]]''
* ''[[#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]]''
* ''[[#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]]''
* ''[[#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|admin/index.html]]''
* ''[[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!2.5_-_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/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]]''

Create a compressed file of this directory or directly download the [http://joomlacode.org/gf/download/frsrelease/11394/58226/com_helloworld-1.6-part02.zip archive] and install it using the extension manager of Joomla. You can test this basic component by putting ''index.php?option=com_helloworld'' in your browser address.


''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>

<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.2</version>

<description>Description of the Hello World component ...</description>

<update> 
<schemas>
<schemapath type="mysql">sql/updates/mysql</schemapath>
</schemas>
</update>



<files folder="site">
<filename>index.html</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>
<folder>views</folder>
</files>

<administration>

<menu>Hello World!</menu>


<files folder="admin">

<filename>index.html</filename>
<filename>helloworld.php</filename>

<folder>sql</folder>
</files>
</administration>

</extension>
</source>


'''Result:'''
You will see by default the message contained in the variable ''$this->msg'' in the ''view.html.php'' file.

== Navigate ==

[[Developing a Model-View-Controller (MVC) Component for Joomla!2.5 - Part 01|Prev: Developing a Basic Component]] [[Developing a Model-View-Controller (MVC) Component for Joomla!2.5 - Part 03|Next: Adding a menu type to the site part]]

== Contributors ==
*[[User:cdemko|Christophe Demko]]
*[[User:oaksu|Ozgur Aksu]]
*[[User:Jossnaz|Lukas Meier]]

[[Category:Development]]
[[Category:Joomla! 1.6]]
[[Category:Joomla! 1.7]]
[[Category:Joomla! 2.5]]

User:Jossnaz

2013-12-31T21:34:56Z

Jossnaz: Created page with "I am Lukas Meier and I am here to make it easier for people to connect the dots of tutorials by giving examples which should lead to a better and deeper understanding. I stud..."

I am Lukas Meier and I am here to make it easier for people to connect the dots of tutorials by giving examples which should lead to a better and deeper understanding.

I studied computer science and worked for 4 years as software developer.

Archived:Developing a MVC Component/Adding a view to the site part

2013-12-31T21:28:24Z

Jossnaz: /* Setting the view */

{{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.

In the Joomla!2.5 framework, third party component authors divide their code into three main parts:
* ''models'' They manage the data
* ''controllers'' They perform tasks, set and get the states of the models and ask the views to display
* ''views'' They display the content according to the type (''error'', ''feed'', ''html'', ''json'', ''raw'', ''xml'') and the layout chosen by the controllers

== Setting the controller ==
In the core code of Joomla, there is a class able to manage controllers: ''[http://api.joomla.org/Joomla-Platform/Application/JController.html JController]''. This class has to be extended to be used in our component. In the file ''site/helloworld.php'' (entry point of our ''Hello World'' component), put these lines


''site/helloworld.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');

// 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>

The ''[http://api.joomla.org/Joomla-Platform/Application/JController.html#getInstance getInstance]'' static method of the ''JController'' class will create a controller. In the code above, it will instantiate a controller object of a class named ''HelloWorldController''. Joomla will look for the declaration of that class in an aptly named file called ''controller.php'' (it's a default behavior).

Now, ''controller.php'' needs to be created and ''HelloWorldController'' needs to be declared and defined. So with your favorite file manager and editor, create a ''site/controller.php'' file containing


''site/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');

/**
* Hello World Component Controller
*/
class HelloWorldController extends JController
{
}
</source>


When no task is given in the request variables, the default task will be executed. It's the ''display'' task by default. The ''JController'' class has such a task. In our example, it will display a view named ''HelloWorld''.

So with ''task'' simply a public function display() of ''JController'' is refered to.

{{tip|Just a side note for completion, you could call another function aside from ''display()'' by using an URL like this one:

<pre>http://localhost/index.php?option=com_helloworld&task=insert</pre>

This would try to call a function ''insert()'' of our controller (which we would actually have to implement in ''HelloWorldController'' ).}}

== Setting the view ==

When JController wants to display a view, it will look for certain files in the ''component/com_[component_name]/views/[name of view]/'' folder.

The name of the folder of the default view is the name of the component itself. In our case the path is ''component/com_helloworld/views/helloworld/''.

The file that will contain the code of the view is called ''view.[view_mode].php''. The default view mode, and probably the only view a component might need is the ''html'' mode. So this give us our file name which is ''view.html.php''.

With your favorite file manager and editor, create a file ''site/views/helloworld/view.html.php'' able to display the default view and containing


''site/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');

/**
* 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 = 'Hello World';

// Display the view
parent::display($tpl);
}
}
</source>


The ''display'' method of the ''[http://api.joomla.org/Joomla-Platform/Application/JView.html JView]'' class is called with the ''display'' task of the JController class. In our case, this method will display data using the ''tmpl/default.php'' file. With your favorite file manager and editor, create a file ''site/views/helloworld/tmpl/default.php'' able to display the default view and containing


''site/views/helloworld/tmpl/default.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');
?>
<h1><?php echo $this->msg; ?></h1>
</source>

This template file will be included by the JView class. Therefore, here, $this refers to the HelloWorldViewHelloWorld class.

So to give an example, one could call the view inside the ''component/com_[component_name]/views/[name of view]/'' folder by calling:

http://localhost/joomla/index.php?option=com_helloworld

(this would default to the ''component/com_helloworld/views/helloworld/'' folder)
or we could explicitly call the folder by calling

http://localhost/joomla/index.php?option=com_helloworld&view=helloworld

if we change ''&view=helloworld'' to something else, e.g. ''&view=fluffy'' we would have to create a folder:

''component/com_helloworld/views/fluffy/''

Copy the contents of ''views/helloworld'' to ''views/fluffy''

The classname of the file ''view.html.php'' of the fluffy folder would be ''HelloWorldViewFluffy''. Afterwards you can customize the contents of ''default.php'' of the ''fluffy'' subfolder for custom output and see the output by calling:

''http://localhost/joomla/index.php?option=com_helloworld&view=fluffy''

== 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]]''
* ''[[#site/helloworld.php|site/helloworld.php]]''
* ''[[#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]]''
* ''[[#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]]''
* ''[[#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|admin/index.html]]''
* ''[[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!2.5_-_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/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]]''

Create a compressed file of this directory or directly download the [http://joomlacode.org/gf/download/frsrelease/11394/58226/com_helloworld-1.6-part02.zip archive] and install it using the extension manager of Joomla. You can test this basic component by putting ''index.php?option=com_helloworld'' in your browser address.


''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>

<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.2</version>

<description>Description of the Hello World component ...</description>

<update> 
<schemas>
<schemapath type="mysql">sql/updates/mysql</schemapath>
</schemas>
</update>



<files folder="site">
<filename>index.html</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>
<folder>views</folder>
</files>

<administration>

<menu>Hello World!</menu>


<files folder="admin">

<filename>index.html</filename>
<filename>helloworld.php</filename>

<folder>sql</folder>
</files>
</administration>

</extension>
</source>


'''Result:'''
You will see by default the message contained in the variable ''$this->msg'' in the ''view.html.php'' file.

== Navigate ==

[[Developing a Model-View-Controller (MVC) Component for Joomla!2.5 - Part 01|Prev: Developing a Basic Component]] [[Developing a Model-View-Controller (MVC) Component for Joomla!2.5 - Part 03|Next: Adding a menu type to the site part]]

== Contributors ==
*[[User:cdemko|Christophe Demko]]
*[[User:oaksu|Ozgur Aksu]]

[[Category:Development]]
[[Category:Joomla! 1.6]]
[[Category:Joomla! 1.7]]
[[Category:Joomla! 2.5]]

Archived:Developing a MVC Component/Adding a view to the site part

2013-12-31T21:27:18Z

Jossnaz: /* Setting the view */

{{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.

In the Joomla!2.5 framework, third party component authors divide their code into three main parts:
* ''models'' They manage the data
* ''controllers'' They perform tasks, set and get the states of the models and ask the views to display
* ''views'' They display the content according to the type (''error'', ''feed'', ''html'', ''json'', ''raw'', ''xml'') and the layout chosen by the controllers

== Setting the controller ==
In the core code of Joomla, there is a class able to manage controllers: ''[http://api.joomla.org/Joomla-Platform/Application/JController.html JController]''. This class has to be extended to be used in our component. In the file ''site/helloworld.php'' (entry point of our ''Hello World'' component), put these lines


''site/helloworld.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');

// 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>

The ''[http://api.joomla.org/Joomla-Platform/Application/JController.html#getInstance getInstance]'' static method of the ''JController'' class will create a controller. In the code above, it will instantiate a controller object of a class named ''HelloWorldController''. Joomla will look for the declaration of that class in an aptly named file called ''controller.php'' (it's a default behavior).

Now, ''controller.php'' needs to be created and ''HelloWorldController'' needs to be declared and defined. So with your favorite file manager and editor, create a ''site/controller.php'' file containing


''site/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');

/**
* Hello World Component Controller
*/
class HelloWorldController extends JController
{
}
</source>


When no task is given in the request variables, the default task will be executed. It's the ''display'' task by default. The ''JController'' class has such a task. In our example, it will display a view named ''HelloWorld''.

So with ''task'' simply a public function display() of ''JController'' is refered to.

{{tip|Just a side note for completion, you could call another function aside from ''display()'' by using an URL like this one:

<pre>http://localhost/index.php?option=com_helloworld&task=insert</pre>

This would try to call a function ''insert()'' of our controller (which we would actually have to implement in ''HelloWorldController'' ).}}

== Setting the view ==

When JController wants to display a view, it will look for certain files in the ''component/com_[component_name]/views/[name of view]/'' folder.

The name of the folder of the default view is the name of the component itself. In our case the path is ''component/com_helloworld/views/helloworld/''.

The file that will contain the code of the view is called ''view.[view_mode].php''. The default view mode, and probably the only view a component might need is the ''html'' mode. So this give us our file name which is ''view.html.php''.

With your favorite file manager and editor, create a file ''site/views/helloworld/view.html.php'' able to display the default view and containing


''site/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');

/**
* 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 = 'Hello World';

// Display the view
parent::display($tpl);
}
}
</source>


The ''display'' method of the ''[http://api.joomla.org/Joomla-Platform/Application/JView.html JView]'' class is called with the ''display'' task of the JController class. In our case, this method will display data using the ''tmpl/default.php'' file. With your favorite file manager and editor, create a file ''site/views/helloworld/tmpl/default.php'' able to display the default view and containing


''site/views/helloworld/tmpl/default.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');
?>
<h1><?php echo $this->msg; ?></h1>
</source>

This template file will be included by the JView class. Therefore, here, $this refers to the HelloWorldViewHelloWorld class.

So to give an example, one could call the view inside the ''component/com_[component_name]/views/[name of view]/'' folder by calling:

http://localhost/joomla/index.php?option=com_helloworld

(this would default to the ''component/com_helloworld/views/helloworld/'' folder)
or we could explicitly call the folder by calling

http://localhost/joomla/index.php?option=com_helloworld&view=helloworld

if we change ''&view=helloworld'' to e.g. ''&view=fluffy'' we would have to create a folder:

''component/com_helloworld/views/fluffy/''

Copy the contents of ''views/helloworld'' to ''views/fluffy''

The classname of the file ''view.html.php'' of the fluffy folder would be ''HelloWorldViewFluffy''. Afterwards you can customize the contents of ''default.php'' of the ''fluffy'' subfolder for custom output and see the output by calling:

''http://localhost/joomla/index.php?option=com_helloworld&view=fluffy''

== 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]]''
* ''[[#site/helloworld.php|site/helloworld.php]]''
* ''[[#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]]''
* ''[[#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]]''
* ''[[#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|admin/index.html]]''
* ''[[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!2.5_-_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/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]]''

Create a compressed file of this directory or directly download the [http://joomlacode.org/gf/download/frsrelease/11394/58226/com_helloworld-1.6-part02.zip archive] and install it using the extension manager of Joomla. You can test this basic component by putting ''index.php?option=com_helloworld'' in your browser address.


''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>

<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.2</version>

<description>Description of the Hello World component ...</description>

<update> 
<schemas>
<schemapath type="mysql">sql/updates/mysql</schemapath>
</schemas>
</update>



<files folder="site">
<filename>index.html</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>
<folder>views</folder>
</files>

<administration>

<menu>Hello World!</menu>


<files folder="admin">

<filename>index.html</filename>
<filename>helloworld.php</filename>

<folder>sql</folder>
</files>
</administration>

</extension>
</source>


'''Result:'''
You will see by default the message contained in the variable ''$this->msg'' in the ''view.html.php'' file.

== Navigate ==

[[Developing a Model-View-Controller (MVC) Component for Joomla!2.5 - Part 01|Prev: Developing a Basic Component]] [[Developing a Model-View-Controller (MVC) Component for Joomla!2.5 - Part 03|Next: Adding a menu type to the site part]]

== Contributors ==
*[[User:cdemko|Christophe Demko]]
*[[User:oaksu|Ozgur Aksu]]

[[Category:Development]]
[[Category:Joomla! 1.6]]
[[Category:Joomla! 1.7]]
[[Category:Joomla! 2.5]]

Archived:Developing a MVC Component/Adding a view to the site part

2013-12-31T06:01:45Z

Jossnaz: /* Setting the view */

{{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.

In the Joomla!2.5 framework, third party component authors divide their code into three main parts:
* ''models'' They manage the data
* ''controllers'' They perform tasks, set and get the states of the models and ask the views to display
* ''views'' They display the content according to the type (''error'', ''feed'', ''html'', ''json'', ''raw'', ''xml'') and the layout chosen by the controllers

== Setting the controller ==
In the core code of Joomla, there is a class able to manage controllers: ''[http://api.joomla.org/Joomla-Platform/Application/JController.html JController]''. This class has to be extended to be used in our component. In the file ''site/helloworld.php'' (entry point of our ''Hello World'' component), put these lines


''site/helloworld.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');

// 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>

The ''[http://api.joomla.org/Joomla-Platform/Application/JController.html#getInstance getInstance]'' static method of the ''JController'' class will create a controller. In the code above, it will instantiate a controller object of a class named ''HelloWorldController''. Joomla will look for the declaration of that class in an aptly named file called ''controller.php'' (it's a default behavior).

Now, ''controller.php'' needs to be created and ''HelloWorldController'' needs to be declared and defined. So with your favorite file manager and editor, create a ''site/controller.php'' file containing


''site/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');

/**
* Hello World Component Controller
*/
class HelloWorldController extends JController
{
}
</source>


When no task is given in the request variables, the default task will be executed. It's the ''display'' task by default. The ''JController'' class has such a task. In our example, it will display a view named ''HelloWorld''.

So with ''task'' simply a public function display() of ''JController'' is refered to.

{{tip|Just a side note for completion, you could call another function aside from ''display()'' by using an URL like this one:

<pre>http://localhost/index.php?option=com_helloworld&task=insert</pre>

This would try to call a function ''insert()'' of our controller (which we would actually have to implement in ''HelloWorldController'' ).}}

== Setting the view ==

When JController wants to display a view, it will look for certain files in the ''component/com_[component_name]/views/[name of view]/'' folder.

The name of the folder of the default view is the name of the component itself. In our case the path is ''component/com_helloworld/views/helloworld/''.

The file that will contain the code of the view is called ''view.[view_mode].php''. The default view mode, and probably the only view a component might need is the ''html'' mode. So this give us our file name which is ''view.html.php''.

With your favorite file manager and editor, create a file ''site/views/helloworld/view.html.php'' able to display the default view and containing


''site/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');

/**
* 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 = 'Hello World';

// Display the view
parent::display($tpl);
}
}
</source>


The ''display'' method of the ''[http://api.joomla.org/Joomla-Platform/Application/JView.html JView]'' class is called with the ''display'' task of the JController class. In our case, this method will display data using the ''tmpl/default.php'' file. With your favorite file manager and editor, create a file ''site/views/helloworld/tmpl/default.php'' able to display the default view and containing


''site/views/helloworld/tmpl/default.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');
?>
<h1><?php echo $this->msg; ?></h1>
</source>

This template file will be included by the JView class. Therefore, here, $this refers to the HelloWorldViewHelloWorld class.

So to give an example, one could call the view inside the ''component/com_[component_name]/views/[name of view]/'' folder by calling:

http://localhost/joomla/index.php?option=com_helloworld

(this would default to the ''component/com_helloworld/views/helloworld/'' folder)
or we could explicitly call the folder by calling

http://localhost/joomla/index.php?option=com_helloworld&view=helloworld

if we change ''&view=helloworld'' to e.g. ''&view=fluffy'' we would have to create a folder:

''component/com_helloworld/views/fluffy/''

The classname of the file ''view.html.php'' of this new folder would be ''HelloWorldViewFluffy''.

== 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]]''
* ''[[#site/helloworld.php|site/helloworld.php]]''
* ''[[#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]]''
* ''[[#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]]''
* ''[[#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|admin/index.html]]''
* ''[[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!2.5_-_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/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]]''

Create a compressed file of this directory or directly download the [http://joomlacode.org/gf/download/frsrelease/11394/58226/com_helloworld-1.6-part02.zip archive] and install it using the extension manager of Joomla. You can test this basic component by putting ''index.php?option=com_helloworld'' in your browser address.


''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>

<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.2</version>

<description>Description of the Hello World component ...</description>

<update> 
<schemas>
<schemapath type="mysql">sql/updates/mysql</schemapath>
</schemas>
</update>



<files folder="site">
<filename>index.html</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>
<folder>views</folder>
</files>

<administration>

<menu>Hello World!</menu>


<files folder="admin">

<filename>index.html</filename>
<filename>helloworld.php</filename>

<folder>sql</folder>
</files>
</administration>

</extension>
</source>


'''Result:'''
You will see by default the message contained in the variable ''$this->msg'' in the ''view.html.php'' file.

== Navigate ==

[[Developing a Model-View-Controller (MVC) Component for Joomla!2.5 - Part 01|Prev: Developing a Basic Component]] [[Developing a Model-View-Controller (MVC) Component for Joomla!2.5 - Part 03|Next: Adding a menu type to the site part]]

== Contributors ==
*[[User:cdemko|Christophe Demko]]
*[[User:oaksu|Ozgur Aksu]]

[[Category:Development]]
[[Category:Joomla! 1.6]]
[[Category:Joomla! 1.7]]
[[Category:Joomla! 2.5]]

Archived:Developing a MVC Component/Adding a view to the site part

2013-12-31T06:00:54Z

Jossnaz: /* Setting the view */

{{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.

In the Joomla!2.5 framework, third party component authors divide their code into three main parts:
* ''models'' They manage the data
* ''controllers'' They perform tasks, set and get the states of the models and ask the views to display
* ''views'' They display the content according to the type (''error'', ''feed'', ''html'', ''json'', ''raw'', ''xml'') and the layout chosen by the controllers

== Setting the controller ==
In the core code of Joomla, there is a class able to manage controllers: ''[http://api.joomla.org/Joomla-Platform/Application/JController.html JController]''. This class has to be extended to be used in our component. In the file ''site/helloworld.php'' (entry point of our ''Hello World'' component), put these lines


''site/helloworld.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');

// 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>

The ''[http://api.joomla.org/Joomla-Platform/Application/JController.html#getInstance getInstance]'' static method of the ''JController'' class will create a controller. In the code above, it will instantiate a controller object of a class named ''HelloWorldController''. Joomla will look for the declaration of that class in an aptly named file called ''controller.php'' (it's a default behavior).

Now, ''controller.php'' needs to be created and ''HelloWorldController'' needs to be declared and defined. So with your favorite file manager and editor, create a ''site/controller.php'' file containing


''site/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');

/**
* Hello World Component Controller
*/
class HelloWorldController extends JController
{
}
</source>


When no task is given in the request variables, the default task will be executed. It's the ''display'' task by default. The ''JController'' class has such a task. In our example, it will display a view named ''HelloWorld''.

So with ''task'' simply a public function display() of ''JController'' is refered to.

{{tip|Just a side note for completion, you could call another function aside from ''display()'' by using an URL like this one:

<pre>http://localhost/index.php?option=com_helloworld&task=insert</pre>

This would try to call a function ''insert()'' of our controller (which we would actually have to implement in ''HelloWorldController'' ).}}

== Setting the view ==

When JController wants to display a view, it will look for certain files in the ''component/com_[component_name]/views/[name of view]/'' folder.

The name of the folder of the default view is the name of the component itself. In our case the path is ''component/com_helloworld/views/helloworld/''.

The file that will contain the code of the view is called ''view.[view_mode].php''. The default view mode, and probably the only view a component might need is the ''html'' mode. So this give us our file name which is ''view.html.php''.

With your favorite file manager and editor, create a file ''site/views/helloworld/view.html.php'' able to display the default view and containing


''site/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');

/**
* 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 = 'Hello World';

// Display the view
parent::display($tpl);
}
}
</source>


The ''display'' method of the ''[http://api.joomla.org/Joomla-Platform/Application/JView.html JView]'' class is called with the ''display'' task of the JController class. In our case, this method will display data using the ''tmpl/default.php'' file. With your favorite file manager and editor, create a file ''site/views/helloworld/tmpl/default.php'' able to display the default view and containing


''site/views/helloworld/tmpl/default.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');
?>
<h1><?php echo $this->msg; ?></h1>
</source>

This template file will be included by the JView class. Therefore, here, $this refers to the HelloWorldViewHelloWorld class.

So to give an example, one could call the view inside the ''component/com_[component_name]/views/[name of view]/'' folder by calling:

http://localhost/joomla/index.php?option=com_helloworld

(this would default to the ''helloworld'' folder)
or we could explicitly call the folder by calling

http://localhost/joomla/index.php?option=com_helloworld&view=helloworld

if we change ''&view=helloworld'' to e.g. ''&view=fluffy'' we would have to create a folder:

''component/com_helloworld/views/fluffy/''

The classname of the file ''view.html.php'' of this new folder would be ''HelloWorldViewFluffy''.

== 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]]''
* ''[[#site/helloworld.php|site/helloworld.php]]''
* ''[[#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]]''
* ''[[#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]]''
* ''[[#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|admin/index.html]]''
* ''[[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!2.5_-_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/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]]''

Create a compressed file of this directory or directly download the [http://joomlacode.org/gf/download/frsrelease/11394/58226/com_helloworld-1.6-part02.zip archive] and install it using the extension manager of Joomla. You can test this basic component by putting ''index.php?option=com_helloworld'' in your browser address.


''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>

<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.2</version>

<description>Description of the Hello World component ...</description>

<update> 
<schemas>
<schemapath type="mysql">sql/updates/mysql</schemapath>
</schemas>
</update>



<files folder="site">
<filename>index.html</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>
<folder>views</folder>
</files>

<administration>

<menu>Hello World!</menu>


<files folder="admin">

<filename>index.html</filename>
<filename>helloworld.php</filename>

<folder>sql</folder>
</files>
</administration>

</extension>
</source>


'''Result:'''
You will see by default the message contained in the variable ''$this->msg'' in the ''view.html.php'' file.

== Navigate ==

[[Developing a Model-View-Controller (MVC) Component for Joomla!2.5 - Part 01|Prev: Developing a Basic Component]] [[Developing a Model-View-Controller (MVC) Component for Joomla!2.5 - Part 03|Next: Adding a menu type to the site part]]

== Contributors ==
*[[User:cdemko|Christophe Demko]]
*[[User:oaksu|Ozgur Aksu]]

[[Category:Development]]
[[Category:Joomla! 1.6]]
[[Category:Joomla! 1.7]]
[[Category:Joomla! 2.5]]

Archived:Developing a MVC Component/Adding a view to the site part

2013-12-31T05:47:45Z

Jossnaz: /* Setting the view */

{{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.

In the Joomla!2.5 framework, third party component authors divide their code into three main parts:
* ''models'' They manage the data
* ''controllers'' They perform tasks, set and get the states of the models and ask the views to display
* ''views'' They display the content according to the type (''error'', ''feed'', ''html'', ''json'', ''raw'', ''xml'') and the layout chosen by the controllers

== Setting the controller ==
In the core code of Joomla, there is a class able to manage controllers: ''[http://api.joomla.org/Joomla-Platform/Application/JController.html JController]''. This class has to be extended to be used in our component. In the file ''site/helloworld.php'' (entry point of our ''Hello World'' component), put these lines


''site/helloworld.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');

// 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>

The ''[http://api.joomla.org/Joomla-Platform/Application/JController.html#getInstance getInstance]'' static method of the ''JController'' class will create a controller. In the code above, it will instantiate a controller object of a class named ''HelloWorldController''. Joomla will look for the declaration of that class in an aptly named file called ''controller.php'' (it's a default behavior).

Now, ''controller.php'' needs to be created and ''HelloWorldController'' needs to be declared and defined. So with your favorite file manager and editor, create a ''site/controller.php'' file containing


''site/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');

/**
* Hello World Component Controller
*/
class HelloWorldController extends JController
{
}
</source>


When no task is given in the request variables, the default task will be executed. It's the ''display'' task by default. The ''JController'' class has such a task. In our example, it will display a view named ''HelloWorld''.

So with ''task'' simply a public function display() of ''JController'' is refered to.

{{tip|Just a side note for completion, you could call another function aside from ''display()'' by using an URL like this one:

<pre>http://localhost/index.php?option=com_helloworld&task=insert</pre>

This would try to call a function ''insert()'' of our controller (which we would actually have to implement in ''HelloWorldController'' ).}}

== Setting the view ==

When JController wants to display a view, it will look for certain files in the ''component/com_[component_name]/views/[name of view]/'' folder.

The name of the folder of the default view is the name of the component itself. In our case the path is ''component/com_helloworld/views/helloworld/''.

So to give an example, one could call the view inside this folder by calling:

http://localhost/joomla/index.php?option=com_helloworld

(this would default to the ''helloworld'' folder somewhere in joomlas code)
or we could explicitly call the folder by calling

http://localhost/joomla/index.php?option=com_helloworld&view=helloworld

if we change ''&view=helloworld'' to e.g. ''&view=fluffy'' we would have to create a folder:

''component/com_helloworld/views/fluffy/''

The file that will contain the code of the view is called ''view.[view_mode].php''. The default view mode, and probably the only view a component might need is the ''html'' mode. So this give us our file name which is ''view.html.php''.

With your favorite file manager and editor, create a file ''site/views/helloworld/view.html.php'' able to display the default view and containing


''site/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');

/**
* 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 = 'Hello World';

// Display the view
parent::display($tpl);
}
}
</source>


The ''display'' method of the ''[http://api.joomla.org/Joomla-Platform/Application/JView.html JView]'' class is called with the ''display'' task of the JController class. In our case, this method will display data using the ''tmpl/default.php'' file. With your favorite file manager and editor, create a file ''site/views/helloworld/tmpl/default.php'' able to display the default view and containing


''site/views/helloworld/tmpl/default.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');
?>
<h1><?php echo $this->msg; ?></h1>
</source>

This template file will be included by the JView class. Therefore, here, $this refers to the HelloWorldViewHelloWorld class.

== 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]]''
* ''[[#site/helloworld.php|site/helloworld.php]]''
* ''[[#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]]''
* ''[[#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]]''
* ''[[#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|admin/index.html]]''
* ''[[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!2.5_-_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/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]]''

Create a compressed file of this directory or directly download the [http://joomlacode.org/gf/download/frsrelease/11394/58226/com_helloworld-1.6-part02.zip archive] and install it using the extension manager of Joomla. You can test this basic component by putting ''index.php?option=com_helloworld'' in your browser address.


''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>

<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.2</version>

<description>Description of the Hello World component ...</description>

<update> 
<schemas>
<schemapath type="mysql">sql/updates/mysql</schemapath>
</schemas>
</update>



<files folder="site">
<filename>index.html</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>
<folder>views</folder>
</files>

<administration>

<menu>Hello World!</menu>


<files folder="admin">

<filename>index.html</filename>
<filename>helloworld.php</filename>

<folder>sql</folder>
</files>
</administration>

</extension>
</source>


'''Result:'''
You will see by default the message contained in the variable ''$this->msg'' in the ''view.html.php'' file.

== Navigate ==

[[Developing a Model-View-Controller (MVC) Component for Joomla!2.5 - Part 01|Prev: Developing a Basic Component]] [[Developing a Model-View-Controller (MVC) Component for Joomla!2.5 - Part 03|Next: Adding a menu type to the site part]]

== Contributors ==
*[[User:cdemko|Christophe Demko]]
*[[User:oaksu|Ozgur Aksu]]

[[Category:Development]]
[[Category:Joomla! 1.6]]
[[Category:Joomla! 1.7]]
[[Category:Joomla! 2.5]]

Archived:Developing a MVC Component/Adding a view to the site part

2013-12-31T04:10:08Z

Jossnaz: /* Setting the view */

{{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.

In the Joomla!2.5 framework, third party component authors divide their code into three main parts:
* ''models'' They manage the data
* ''controllers'' They perform tasks, set and get the states of the models and ask the views to display
* ''views'' They display the content according to the type (''error'', ''feed'', ''html'', ''json'', ''raw'', ''xml'') and the layout chosen by the controllers

== Setting the controller ==
In the core code of Joomla, there is a class able to manage controllers: ''[http://api.joomla.org/Joomla-Platform/Application/JController.html JController]''. This class has to be extended to be used in our component. In the file ''site/helloworld.php'' (entry point of our ''Hello World'' component), put these lines


''site/helloworld.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');

// 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>

The ''[http://api.joomla.org/Joomla-Platform/Application/JController.html#getInstance getInstance]'' static method of the ''JController'' class will create a controller. In the code above, it will instantiate a controller object of a class named ''HelloWorldController''. Joomla will look for the declaration of that class in an aptly named file called ''controller.php'' (it's a default behavior).

Now, ''controller.php'' needs to be created and ''HelloWorldController'' needs to be declared and defined. So with your favorite file manager and editor, create a ''site/controller.php'' file containing


''site/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');

/**
* Hello World Component Controller
*/
class HelloWorldController extends JController
{
}
</source>


When no task is given in the request variables, the default task will be executed. It's the ''display'' task by default. The ''JController'' class has such a task. In our example, it will display a view named ''HelloWorld''.

So with ''task'' simply a public function display() of ''JController'' is refered to.

Just a side note for completion: you could call another function aside from ''display()'' by using an URL like this one:

http://localhost/index.php?option=com_helloworld&task=insert

This would try to call a function ''insert()'' of our controller (which we would actually have to implement in ''HelloWorldController'' ).

== Setting the view ==

When JController wants to display a view, it will look for certain files in the ''component/com_[component_name]/views/[name of view]/'' folder.

The name of the folder of the default view is the name of the component itself. In our case the path is ''component/com_helloworld/views/helloworld/''.

The file that will contain the code of the view is called ''view.[view_mode].php''. The default view mode, and probably the only view a component might need is the ''html'' mode. So this give us our file name which is ''view.html.php''.

With your favorite file manager and editor, create a file ''site/views/helloworld/view.html.php'' able to display the default view and containing


''site/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');

/**
* 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 = 'Hello World';

// Display the view
parent::display($tpl);
}
}
</source>


The ''display'' method of the ''[http://api.joomla.org/Joomla-Platform/Application/JView.html JView]'' class is called with the ''display'' task of the JController class. In our case, this method will display data using the ''tmpl/default.php'' file. With your favorite file manager and editor, create a file ''site/views/helloworld/tmpl/default.php'' able to display the default view and containing


''site/views/helloworld/tmpl/default.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');
?>
<h1><?php echo $this->msg; ?></h1>
</source>

This template file will be included by the JView class. Therefore, here, $this refers to the HelloWorldViewHelloWorld class.

== 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]]''
* ''[[#site/helloworld.php|site/helloworld.php]]''
* ''[[#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]]''
* ''[[#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]]''
* ''[[#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|admin/index.html]]''
* ''[[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!2.5_-_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/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]]''

Create a compressed file of this directory or directly download the [http://joomlacode.org/gf/download/frsrelease/11394/58226/com_helloworld-1.6-part02.zip archive] and install it using the extension manager of Joomla. You can test this basic component by putting ''index.php?option=com_helloworld'' in your browser address.


''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>

<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.2</version>

<description>Description of the Hello World component ...</description>

<update> 
<schemas>
<schemapath type="mysql">sql/updates/mysql</schemapath>
</schemas>
</update>



<files folder="site">
<filename>index.html</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>
<folder>views</folder>
</files>

<administration>

<menu>Hello World!</menu>


<files folder="admin">

<filename>index.html</filename>
<filename>helloworld.php</filename>

<folder>sql</folder>
</files>
</administration>

</extension>
</source>


'''Result:'''
You will see by default the message contained in the variable ''$this->msg'' in the ''view.html.php'' file.

== Navigate ==

[[Developing a Model-View-Controller (MVC) Component for Joomla!2.5 - Part 01|Prev: Developing a Basic Component]] [[Developing a Model-View-Controller (MVC) Component for Joomla!2.5 - Part 03|Next: Adding a menu type to the site part]]

== Contributors ==
*[[User:cdemko|Christophe Demko]]
*[[User:oaksu|Ozgur Aksu]]

[[Category:Development]]
[[Category:Joomla! 1.6]]
[[Category:Joomla! 1.7]]
[[Category:Joomla! 2.5]]

Archived:Developing a MVC Component/Adding a view to the site part

2013-12-31T03:52:54Z

Jossnaz: /* Setting the controller */

{{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.

In the Joomla!2.5 framework, third party component authors divide their code into three main parts:
* ''models'' They manage the data
* ''controllers'' They perform tasks, set and get the states of the models and ask the views to display
* ''views'' They display the content according to the type (''error'', ''feed'', ''html'', ''json'', ''raw'', ''xml'') and the layout chosen by the controllers

== Setting the controller ==
In the core code of Joomla, there is a class able to manage controllers: ''[http://api.joomla.org/Joomla-Platform/Application/JController.html JController]''. This class has to be extended to be used in our component. In the file ''site/helloworld.php'' (entry point of our ''Hello World'' component), put these lines


''site/helloworld.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');

// 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>

The ''[http://api.joomla.org/Joomla-Platform/Application/JController.html#getInstance getInstance]'' static method of the ''JController'' class will create a controller. In the code above, it will instantiate a controller object of a class named ''HelloWorldController''. Joomla will look for the declaration of that class in an aptly named file called ''controller.php'' (it's a default behavior).

Now, ''controller.php'' needs to be created and ''HelloWorldController'' needs to be declared and defined. So with your favorite file manager and editor, create a ''site/controller.php'' file containing


''site/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');

/**
* Hello World Component Controller
*/
class HelloWorldController extends JController
{
}
</source>


When no task is given in the request variables, the default task will be executed. It's the ''display'' task by default. The ''JController'' class has such a task. In our example, it will display a view named ''HelloWorld''.

So with ''task'' simply a public function display() of ''JController'' is refered to.

Just a side note for completion: you could call another function aside from ''display()'' by using an URL like this one:

http://localhost/index.php?option=com_helloworld&task=insert

This would try to call a function ''insert()'' of our controller (which we would actually have to implement in ''HelloWorldController'' ).

== Setting the view ==

When JController wants to display a view, it will look for certain files in the ''component/com_[component_name]/views/[name of view]/'' folder.

The name of the folder of the default view is the name of the component itself. In our case the path is ''component/com_helloworld/views/helloworld/''.

The file that will contain the code of the view is called ''view.[view_mode].php''. The default view mode, and probably the only view a component might need is the ''html'' mode. So this give us our file name which is ''view.html.php''.

With your favorite file manager and editor, create a file ''site/views/helloworld/view.html.php'' able to display the default view and containing


''site/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');

/**
* 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 = 'Hello World';

// Display the view
parent::display($tpl);
}
}
</source>


The ''display'' method of the ''[http://api.joomla.org/Joomla-Platform/Application/JView.html JView]'' class is called with the ''display'' task of the JController class. In our case, this method will display data using the ''tmpl/default.php'' file. With your favorite file manager and editor, create a file ''site/views/helloworld/tmpl/default.php'' able to display the default view and containing


''site/views/helloworld/tmpl/default.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');
?>
<h1><?php echo $this->msg; ?></h1>
</source>

This template file will be included by the JView class. Therefore, here, $this refers to the HelloWorldViewHelloWorld class.

== 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]]''
* ''[[#site/helloworld.php|site/helloworld.php]]''
* ''[[#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]]''
* ''[[#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]]''
* ''[[#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|admin/index.html]]''
* ''[[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!2.5_-_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/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]]''

Create a compressed file of this directory or directly download the [http://joomlacode.org/gf/download/frsrelease/11394/58226/com_helloworld-1.6-part02.zip archive] and install it using the extension manager of Joomla. You can test this basic component by putting ''index.php?option=com_helloworld'' in your browser address.


''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>

<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.2</version>

<description>Description of the Hello World component ...</description>

<update> 
<schemas>
<schemapath type="mysql">sql/updates/mysql</schemapath>
</schemas>
</update>



<files folder="site">
<filename>index.html</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>
<folder>views</folder>
</files>

<administration>

<menu>Hello World!</menu>


<files folder="admin">

<filename>index.html</filename>
<filename>helloworld.php</filename>

<folder>sql</folder>
</files>
</administration>

</extension>
</source>


'''Result:'''
You will see by default the message contained in the variable ''$this->msg'' in the ''view.html.php'' file.

== Navigate ==

[[Developing a Model-View-Controller (MVC) Component for Joomla!2.5 - Part 01|Prev: Developing a Basic Component]] [[Developing a Model-View-Controller (MVC) Component for Joomla!2.5 - Part 03|Next: Adding a menu type to the site part]]

== Contributors ==
*[[User:cdemko|Christophe Demko]]
*[[User:oaksu|Ozgur Aksu]]

[[Category:Development]]
[[Category:Joomla! 1.6]]
[[Category:Joomla! 1.7]]
[[Category:Joomla! 2.5]]

Archived talk:Developing a MVC Component/Adding a view to the site part

2013-12-31T03:31:53Z

Jossnaz: /* general comments in code are dublication */ new section

i got this error message when trying to install the archive here...

Error building Admin Menus

== Security issue?!!! ==

Hello,

it seems to me that calling:

$controller->execute(JRequest::getCmd('task'));

is quite insecure if one does not check the 'task' variable!

Please give your opinions and notice me at tomas.telensky (that at sign) gmail (dot) com.

JRequest::getCmd() filters the 'task' request variable so any bad characters will be removed. Furthermore, the controller execute() method will only execute methods that are flagged as public in the controller. How is that insecure? [[User:Chris Davenport|Chris Davenport]] 20:04, 17 March 2011 (UTC)

== Installer problem ==

When I try to install helloworld component I see this message:

JInstaller: :Install: Cannot find XML setup file
JInstaller: :Install: Cannot find XML setup file
Copy failed

== XML Installation Problem ==

To get the installation to work in the XML file, replace <name>Hello World!</name> with <name>com_helloworld</name>. This seems to work.

== general comments in code are dublication ==

e.g.

// import joomla controller library

jimport('joomla.application.component.controller');

// Perform the Request task

$input = JFactory::getApplication()->input;

$controller->execute($input->getCmd('task'));

// Redirect if set by the controller

$controller->redirect();

this is no help at all, when i am reading a hello world tutorial you cannot expect me to know what perform request task means. I can see it anyways that you are executing something having to do with a task in the code. It would be really cool if people could start giving explanations as to 'why' someone is doing something instead of duplicating the code with a comment. Just look at the other two. I can see there is a bloody import and that we try to redirect. I am assuming at this point, one has to always to try to redirect at this point, because that is how it works. If yes, write it in the comment, if not, write maybe as well why we dont always want to redirect.

Archived:Developing a MVC Component/Developing a Basic Component

2013-12-31T03:10:47Z

Jossnaz:

{{version/tutor|2.5}}
{{Chunk:Developing a Model-View-Controller (MVC) Component for Joomla!2.5 - Contents}}

This tutorial is part of the [[Developing a Model-View-Controller (MVC) Component for Joomla!2.5]] tutorial.

== The first basic component ==
Let's create a ''Hello World!'' component.
=== Public display ===
With your favorite file manager and editor, create a file ''yoursite/components/com_helloworld/helloworld.php'' containing
<source lang="php">
Hello world
</source>

You can test this basic component by putting ''index.php?option=com_helloworld'' in your browser address (don't forget to prefix this address with your Joomla!2.5 installation path) after installing this component.

=== Administrator management ===
With your favorite file manager and editor, create a file ''yoursite/administrator/components/com_helloworld/helloworld.php'' containing
<source lang="php">
Hello world administration
</source>

You can test this basic component by putting ''administrator/index.php?option=com_helloworld'' in your browser address after installing the component.

=== Packaging an installation zip file ===
If you have used Joomla before reading this tutorial, you have noticed that extensions are installed using a compressed file containing all the things which are needed for installing and uninstalling them.

With your favorite file manager, create a directory (outside your Joomla installation directory) containing
* ''[[#helloworld.xml|helloworld.xml]]''
* ''[[#site/helloworld.php|site/helloworld.php]]''
* ''[[#index.html|site/index.html]]''
* ''[[#index.html|admin/index.html]]''
* ''[[#admin/helloworld.php|admin/helloworld.php]]''
* ''[[#index.html|admin/sql/index.html]]''
* ''[[#index.html|admin/sql/updates/index.html]]''
* ''[[#index.html|admin/sql/updates/mysql/index.html]]''
* ''[[#admin/sql/updates/mysql/0.0.1.sql|admin/sql/updates/mysql/0.0.1.sql]]''

''admin/sql/updates/mysql/0.0.1.sql'' is an empty file allowing to initialise schema version of the com_helloworld component.


''admin/sql/updates/mysql/0.0.1.sql''
<source lang="sql">
</source>


Create a compressed file of this directory or directly download the [http://joomlacode.org/gf/download/frsrelease/11394/58225/com_helloworld-1.6-part01.zip archive] and install it using the extension manager of Joomla. You can test this basic component by putting ''index.php?option=com_helloworld'' or ''administrator/index.php?option=com_helloworld'' in your browser address. You can also notice that the ''Hello World!'' component is visible in the administrator site of your Joomla installation under the ''Components'' menu.

Note: '''<name>Hello World!</name>''' is tricking you into thinking that this is actually only a name, and you could call it 'fluffy' or 'bippo', but this is not true. As far as I understand the name in between the tags is getting automagically lowercased, white spaces and special characters are removed (the ! for example) and joomla starts to look for files/folders responding to this name. So the name you are giving there is actually very crucial for your component to work. In other words, if you would change "Hello World!" to "helloworld" everyhting would still work. If you would change it to "helloworld2" the component would be looking for different folders and file names.


''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>

<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.1</version>

<description>Description of the Hello World component ...</description>

<update> 
<schemas>
<schemapath type="mysql">sql/updates/mysql</schemapath>
</schemas>
</update>



<files folder="site">
<filename>index.html</filename>
<filename>helloworld.php</filename>
</files>

<administration>

<menu>Hello World!</menu>


<files folder="admin">

<filename>index.html</filename>
<filename>helloworld.php</filename>

<folder>sql</folder>
</files>
</administration>

</extension>
</source>



''site/helloworld.php''
<source lang="php">
Hello World
</source>



''admin/helloworld.php''
<source lang="php">
Hello World administration
</source>



''index.html'' common to all folders
<source lang="html4strict">
<html><body bgcolor="#FFFFFF"></body></html>
</source>


== Navigate ==

[[J2.5:Developing_a_MVC_Component/Adding_a_view_to_the_site_part|Next: Adding a view to the site part]]

== Contributors ==
*[[User:cdemko|Christophe Demko]]
*[[User:oaksu|Ozgur Aksu]]

[[Category:Component Development]]
[[Category:Joomla! 1.6]]
[[Category:Joomla! 1.7]]
[[Category:Joomla! 2.5]]

JDOC:How to Contribute to Joomla! Documentation

2013-12-31T02:06:24Z

Jossnaz:

Joomla! Documentation is powered by the same [[wp:wiki|software used by Wikipedia]]. It's growth and success is dependent on [[Special:ActiveUsers|individuals like you]]. Thank you for taking the first step towards contributing to the Joomla! Project. This page will show you how to get started and several ways of helping the documentation effort.

==Getting Started!==
There are a few things you will need to do first.
====Read the Wiki Policy====
:You need to review the Joomla! Docs '''[[JDOC:Wiki policy|Wiki policy]]''' before you start editing.
====Create a User Account====
:To edit the Joomla! Documentation Wiki, you will need a user account. You may '''[[Special:UserLogin|register for one here]]'''. Afterwards make sure to confirm your e-mail address. Confirmation of your e-mail address will give you permission to edit any page except for a few that are protected.
====Create a User Page====
:After you have created an account, confirmed your email address and logged in, you should create a user page. A quick cheat to start your user page:
*Click the actions drop down button{{-}}[[File:JDOCS-actions-create-page.png]]
*Click Create
*Add the code to editor <code><nowiki>{{subst:Newuser}}</nowiki></code>
*Fill in summary (e.g. ''This is my new user page''){{-}}[[File:JDOCS-summary-form-input.png]]
*Click the save

====Join the Documentation Mail List====
: You should join the '''[http://groups.google.com/group/joomla-docs Docs mail list]'''. It is not required but there are discussions you will miss out on which are relevant to documentation.

==What Should I Do First?==
There are several areas of documentation which always need attention. You can start by picking the one which is the most comfortable for you to work on or you may get more involved by working on several at a time. Once you have a wiki account, you are free to work on any aspect of the documentation that takes your fancy. Even the simplest contributions such as spelling corrections and grammar fixes are a tremendous help!
#[[#Help Manage Our Content|Help with documentation content]].
#[[#Wiki Maintenance|Maintenance Tasks]].
#[[#Documentation Project|Join or start documentation project]].
#[[#Help Screens|Help with Help Screens]].
===Help Manage Our Content===

#Editing, rewriting and reorganising pages. Check our [[:Category:Joomla!_Wiki_need_pages|Needs pages]] for areas needing immediate help. They are called 'Needs pages' because they are in need of small tasks to complete them. Some of them are as simple as reviewing content or adding an image. Others require more content or improvements. Pick a few, give them a little love. This is a tremendous help to Joomla! users who rely on our documentation.
#Have some fun and browse for articles which are redundant, out of version(i.e. 1.0 and 1.5), or need to be split up because of version specific information. Then feel free to make use of the {{tl|delete}}, {{tl|merge}} or {{tl|JSplit}} templates on the articles. ''Click the previous template links to see how to use and apply them to articles you think need these marker templates. Add them to the very top of a page and the page is marked.''
#[[JDOC:Creating New Content|Create a new page or tutorial]]. If you want to start a new page, do some extensive research first. Try not to create a new article if one already exists. Use the [[Special:GoogleCustomWikiSearch|search feature]] of the Docs Wiki to see if your topic is already in an article. '''Duplication will be merged and/or deleted'''. Don't be afraid to modify, reformat or improve someone else's work on the Joomla! Docs Wiki! This is a collaborative documentation wiki, just make sure you are following our [[JDOC:Policies and guidelines|policy and guidelines]].

===Wiki Maintenance===
:Maintaining a wiki and keeping it organised takes a lot of continuous work on the part of administrators, editors and users. There are always tasks needing attention such as: [[Special:UncategorizedPages|Categorisation]], [[:Category:Joomla!_Wiki_need_pages|attending to pages with needs]] or marking pages for [[Template:Delete|deletion]], [[Template:Merge|merging]] or [[Template:JSplit|splitting]]. For all maintenance tasks and ideas of how you can help, please visit our [[JDOC:Maintenance Tasks|Documentation Maintenance page]].

===Documentation Projects===
*The docs team is working on [[Tutorials:Beginners|Beginner Tutorials]]. Our goal is to make them easy to understand and navigate, something a Beginner can follow easily and learn basic concepts. Think back to when you were new to Joomla! and add a topic about something you struggled with as a beginner to the page. Better yet, join the [[JDOC:Beginners_Tutorial_Project|Beginner Tutorials Project]].
*Join the [[JDOC:Developer Tutorials Project|Developer Tutorials Project]] and share your knowledge. Sign your name using 4 tildes ( <nowiki>~~~~</nowiki> ) on the [[JDOC_talk:Developer Tutorials Project|Developer Tutorials Project]] page and list what you might be able to do. Feel free to add some [[JDOC:Developer Tutorials Project/Topics|tutorial topics]] to the suggested topics list.

===Help Screens===

Unknown to many, all [[Help screens|Help Screen]] pages are created and served to every Joomla! Installation worldwide from this wiki! They are necessary for beginners and even those with intermediate knowledge of Joomla!

:'''The Joomla! 2.5 Help Screens are complete''' but Joomla! 3.x are still being worked on! The contributions you give to them will be appreciated by many users worldwide. You can find the matrix of [[Help31:Help_screens|3.x Help Screens here]]. Some just need to be reviewed and marked complete in status, others need to be started, completed, have images uploaded(670px max width), etc. {{dablink|Please read the [[Help31:Help_screens_styleguide|3.x Help Screens Style Guide]]. Help Screens are seen by many users worldwide, so '''it is important to maintain a similar style'''. The Docs Team is also in the middle of automating the help screens. Please post on the [[Help32_talk:Help_screens|3.x Help Screens Page]] indicating you would like to help with the automation.}}

==Things to Remember==
Here a a few things to remember as a Joomla! Docs contributor.

*Don't be afraid to break a page, if you do and something has gone really wrong, revert your edit. Click the page's '''View History''' tab and you will see links to undo and revert.
*Write articles with a sense they will translated to another language. Using slang or local dialect may not translate to another language or its inferences be understood.
*Don't be afraid to download and read the general [http://help.joomla.org/files/Editorial%20Style%20Guide%20v1.0.5.pdf Editorial Style Guide] (PDF) that applies to all Joomla! Documentation. There are helpful hints on how to write for Joomla! Documentation.
*Words to watch when writing, [[Project:Words to watch|read the full guideline]] … or for instant feedback use Google Chrome or Mozilla Firefox browsers. They both have built-in spell checking which underlines a misspelled word.
*Don't forget to add the {{tl|inuse}} template to an article you are going to be working on for a long period of time, more than a minute. It helps to prevent editing conflicts.

==Help, I don't know Wiki Markup!==
If you are new to the use of '''''Wikis''''' and the simple markup to create pages, then you can use the following for help.
*New WikiEditor contains buttons and quick links to make building pages easier. Click the word ''''Advanced'''' for a drop down of more buttons and quick formatting links.
*Use the [[Help:Cheatsheet|JDOC's Wiki Cheatsheet]] to learn the basic syntax commands. There is also a drop down of the common markup in the editor. Just click the word ''''Help'''' once and it will appear.
*Still afraid? Try these tools to help you create great wiki pages.
:*[http://www.microsoft.com/en-us/download/details.aspx?id=12298 Microsoft Word Add-on for Wiki Markup], save Word Docs in Wiki Markup.
:*'''OpenOffice.org versions 2.4 and later''' have a MediaWiki export filter built in. Just open a Writer document and click File - Export. Then, change File format to MediaWiki.
:*Here is a [[wp:Wikipedia:Tools#Importing_.28converting.29_content_to_Wikipedia_.28MediaWiki.29_format|list of tools]] available to convert other formats to wiki markup, e.g. HTML, Excel, CSV. Some of them are online converters, cut and paste HTML for an output in wiki markup.
*Get help on the [http://groups.google.com/group/joomla-docs Joomla! Documentation Mail List] by posting a question.
*Post a question on an administrator's or editor's talk page.

[[Category:Documentation Wiki Information]]