Joomla! Documentation - User contributions [en]

User talk:Scionescire

2015-02-25T15:26:01Z

Nenomaz:

==Hello!==
Why you have undone statements added by me in the two lessons of "Adding a Model to the site part" and "Adding a view" in the Component Development Tutorial? --[[User:Nenomaz|Nenomaz]] ([[User talk:Nenomaz|talk]]) 04:48, 12 February 2015 (CST)

== Hello!! ==

Which statements are you talking about?

I updated the guide parts 1 to 11 following the github updated code from the lesson 10 step.

[[User:Scionescire|Scionescire]] ([[User talk:Scionescire|talk]]) 05:01, 12 February 2015 (CST)

==Contribution==
If you watch the history of these two lessons:
*[[J3.x:Developing a MVC Component/Adding a model to the site part]]
*[[J3.x:Developing a MVC Component/Adding a view to the site part]]
You can see my recent contribution, I had added some content important for make "View and Model" work in a component that before there wasn't... --[[User:Nenomaz|Nenomaz]] ([[User talk:Nenomaz|talk]]) 05:38, 12 February 2015 (CST)

== Hello world meets coding standards ==
I haven't noticed your contribution before, sorry!

I have followed the step-10 lesson github code.
That code removed some ininfluent parts, probably they were good for the 2.5 version of Joomla but not for the 3.x one.
I've personally tested the whole code so I'm sure that the parts I've removed are irrilevant (e.g. some jimports, that in 3.x are automatically done).

Once I've updated the github code from 10 to 1 to follow that standard, I updated the guide too (that was quite a fast part, so that's why I missed other contributions).

Hope it's clear now, but if it's not, don't esitate to ask ;)

P.S. If I'm correct, and you are italian too, we can answer in our language =D

[[User:Scionescire|Scionescire]] ([[User talk:Scionescire|talk]]) 05:57, 12 February 2015 (CST)

==Github code?==

Could you explain me what is "github code"? I think GitHub is a server to share code, not wiki content.. but I don't know Joomla Policies... could you explain these to me?

P.S. Si sono italiano :-) cerco di usare l'inglese perchè voglio impararlo ;-)

== Yes, github! ==

Yes, github is exactly what you know, a server to share code!
But, as you know, its code can be forked, so you can provide corrections, improvements and so on, and that's what happened.
Someone corrected the code (that was the same as the wiki), but not the wiki, so the updated and correct version was only in the github code.
While revisiting it (I'm trying to understand how to develop a 3.x Joomla MVC component) I stumbled upon that version so I decided to update the wiki too.

As for now I'm trying to update step 12 ;)

[[User:Scionescire|Scionescire]] ([[User talk:Scionescire|talk]]) 12:06, 12 February 2015 (CST)

==Sorry==

Sorry but I'm not able to understand this method of track the wiki development through GitHub... However, I will reinsert the content I'd added before, I hope you help me to understand this approach of using github for the wiki by the Joomla Community.
--[[User:Nenomaz|Nenomaz]] ([[User talk:Nenomaz|talk]]) 04:23, 16 February 2015 (CST)

== Github ==

The Joomla Wiki about the MVC in version 3.x was more like a copy of the one for the 2.5 version.
In fact some code was redundant or unnecessary.
For example a lot of jimport listed in the 2.5 guide are now automatically done in the 3.x one, so there is the need to remove them from the code.
Same thing for the overloading of the display method you posted.
If you notice the code works both ways, with and without the declaration of the display method (I guess those lines are now done by default following an exact name pattern (eg. HelloWorldMODEL, HelloWorldCONTROLLER, so if you are in a HelloWorld class and you need its controller the program will search for NAME+CONTROLLER thing.

Hence in github someone with a more knowledge about the new version standars cleaned up the code.

For this reason I followed those hints and rewrited the code in the guide to follow those standards. ;)

P.S. I reverted your change ;)

[[User:Scionescire|Scionescire]] ([[User talk:Scionescire|talk]]) 09:09, 16 February 2015 (CST)

==Sure?==
Meanwhile I needed to put those statements in the display method of the controller to trigger the view... because before didn't work!
I think this manner of explain developers the joomla framework is wrong, also keeping track of the wiki through GitHub is wrong... --[[User:Nenomaz|Nenomaz]] ([[User talk:Nenomaz|talk]]) 09:38, 16 February 2015 (CST)

== Sure! ==

I tested each part of the guide I updated and it's working (I don't think the guy accepted the merge on github would rather accept it either).
Maybe some mispelled names or missing files?
Sometimes some lines missing from the main xml could give a really bad headache ;)

I used github as a 'source' but other than testing, I searched for the reasons of the editing, so I'm pretty sure that code is good enough to be on the wiki =D

[[User:Scionescire|Scionescire]] ([[User talk:Scionescire|talk]]) 10:08, 16 February 2015 (CST)

== Main xml ==
Could you give me some guidelines about the main xml? Thanks in advance!
--[[User:Nenomaz|Nenomaz]] ([[User talk:Nenomaz|talk]]) 04:53, 18 February 2015 (CST)

== Main ==

Are you following the J3.x Guide?

If you are following that guide you can use programs (on Windows I use ''Diffuse'') or online tools (https://www.diffchecker.com) to compare the files you have with the new inserted to discover the changes.

Sometimes I found myself in trouble because I have forgotten to update the helloworld.xml xD

I suggest to read the step by step J3.x guide from the beginning using the diff program/site to see the changes.

At step 14 I started to highlight in the guide code the new added lines, when I'll have some time I'll add this useful feature (I discovered recently as in the cheatsheet there is no word!) to the previous steps too!

[[User:Scionescire|Scionescire]] ([[User talk:Scionescire|talk]]) 05:28, 18 February 2015 (CST)

== Solved ==
You are right! I've solved being more careful with the main xml file. --[[User:Nenomaz|Nenomaz]] ([[User talk:Nenomaz|talk]]) 09:26, 25 February 2015 (CST)

User talk:Scionescire

2015-02-18T10:53:01Z

Nenomaz:

User talk:Scionescire

2015-02-16T15:38:11Z

Nenomaz:

J3.x:Developing an MVC Component/Adding a view to the site part

2015-02-16T10:26:34Z

Nenomaz: /* Setting the controller */ Trigger the view from the controller

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

== Introduction ==
This tutorial is part of the [[J3.2:Developing_a_MVC_Component|Developing a Model-View-Controller (MVC) Component for Joomla! 3.x]] tutorial. You are encouraged to read the previous parts of the tutorial before reading this.

In the Joomla!3.x 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: ''[https://api.joomla.org/cms-3/classes/JControllerLegacy.html JControllerLegacy]''. This class has to be extended to be used in our component. In the file ''yoursite/components/com_helloworld/helloworld.php'' (entry point of our ''Hello World'' component), put these lines:

{{vanchor|site/helloworld.php}}
<source lang="php">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// Get an instance of the controller prefixed by HelloWorld
$controller = JControllerLegacy::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 ''[https://api.joomla.org/cms-3/classes/JControllerLegacy.html#method_getInstance getInstance]'' static method of the ''JControllerLegacy'' 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 ''yoursite/components/com_helloworld/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 ''yoursite/components/com_helloworld/controller.php'' file containing

{{vanchor|site/controller.php}}
<source lang="php">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// No direct access to this file
defined('_JEXEC') or die('Restricted access');

/**
* Hello World Component Controller
*
* @since 0.0.1
*/
class HelloWorldController extends JControllerLegacy
{
public function display() {
$document = JFactory::getDocument();
$viewName = $this->input->getCmd('view', 'login');
$viewFormat = $document->getType();
$view = $this->getView($viewName, $viewFormat);
$view->display();
parent::__construct();
}
}
</source>

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

So with ''task'' simply a public function display() of ''JControllerLegacy'' 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 JControllerLegacy wants to display a view, it will look for certain files in the ''yoursite/components/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 ''yoursite/components/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 ''yoursite/components/com_helloworld/views/helloworld/view.html.php'' able to display the default view and containing:

<source lang="php">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// No direct access to this file
defined('_JEXEC') or die('Restricted access');

/**
* HTML View class for the HelloWorld Component
*
* @since 0.0.1
*/
class HelloWorldViewHelloWorld extends JViewLegacy
{
/**
* Display the Hello World view
*
* @param string $tpl The name of the template file to parse; automatically searches through the template paths.
*
* @return void
*/
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 ''[https://api.joomla.org/cms-3/classes/JViewLegacy.html JViewLegacy]'' class is called with the ''display'' task of the JControllerLegacy 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 ''yoursite/components/com_helloworld/views/helloworld/tmpl/default.php'' able to display the default view and containing:

<source lang="php">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// 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 JViewLegacy class. Therefore, here, $this refers to the HelloWorldViewHelloWorld class.

So to give an example, one could call the view inside the ''yoursite/components/com_[component_name]/views/[name of view]/'' folder by calling <code>index.php?option=com_helloworld</code> (this would default to the ''yoursite/components/com_helloworld/views/helloworld/'' folder) or we could explicitly call the folder by calling: <code>index.php?option=com_helloworld&view=helloworld</code>

if we change <code>&view=helloworld</code> to something else, e.g. <code>&view=fluffy</code> we would have to create a folder <code>components/com_helloworld/views/fluffy/</code>.

Copy the contents of <code>views/helloworld</code> to <code>views/fluffy</code>

The classname of the file <code>view.html.php</code> 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 <code>index.php?option=com_helloworld&view=fluffy</code>

== Packaging the component ==

Content of your code directory
* ''[[#helloworld.xml|helloworld.xml]]''
* ''[[#site/helloworld.php|site/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/index.html]]''
* ''[[#site/controller.php|site/controller.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/index.html]]''
* ''[[#site/views/helloworld/view.html.php|site/views/helloworld/view.html.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/tmpl/index.html]]''
* ''[[#site/views/helloworld/tmpl/default.php|site/views/helloworld/tmpl/default.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#admin/helloworld.php|admin/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/mysql/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#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 [https://github.com/scionescire/Joomla-3.2-Hello-World-Component/archive/step-2-adding-a-site-view.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.

<span id="helloworld.xml">
''helloworld.xml''
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="3.2.0" method="upgrade">

<name>Hello World!</name>

<creationDate>December 2013</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 link='index.php?option=com_helloworld'>Hello World!</menu>


<files folder="admin">

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

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

</extension>
</source>
</span>

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

{{notice|Please create a pull request or issue at https://github.com/joomla/Joomla-3.2-Hello-World-Component for any code descprepancies or if editing any of the source code on this page.}}

{{:J3.2:Developing a MVC Component/Navigate|prev=Developing a Basic Component|next=Adding a menu type to the site part}}

<noinclude>[[Category:Component Development]] [[Category:Joomla! 3.0]] [[Category:Joomla! 3.1]][[Category:Joomla! 3.2]]</noinclude>

== Contributors ==

*[[User:Gunjanpatel|Gunjan Patel]]
*[[User:cdemko|Christophe Demko]]
*[[User:oaksu|Ozgur Aksu]]
*[[User:Scionescire|Scionescire]]

[[Category:Development]]
[[Category:Joomla! 3.0]]
[[Category:Joomla! 3.1]]
[[Category:Joomla! 3.2]]

User talk:Scionescire

2015-02-16T10:23:48Z

Nenomaz:

User talk:Scionescire

2015-02-12T16:15:58Z

Nenomaz:

User talk:Scionescire

2015-02-12T11:38:47Z

Nenomaz:

User:Nenomaz

2015-02-12T10:53:03Z

Nenomaz: Created page with "Hi! I'm an Italian Junior Web Developer."

Hi!

I'm an Italian Junior Web Developer.

User talk:Scionescire

2015-02-12T10:48:23Z

Nenomaz: Created page with "==Hello!== Why you have undone statements added by me in the two lessons of "Adding a Model to the site part" and "Adding a view" in the Component Development Tutorial? --~~~~"

J3.x:Developing an MVC Component/Adding a view to the site part

2015-02-05T17:03:09Z

Nenomaz: /* Setting the controller */ code of controller's display method to trigger the view

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

== Introduction ==
This tutorial is part of the [[J3.2:Developing_a_MVC_Component|Developing a Model-View-Controller (MVC) Component for Joomla! 3.x]] tutorial. You are encouraged to read the previous parts of the tutorial before reading this.

In the Joomla!3.x 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: ''[https://api.joomla.org/cms-3/classes/JControllerLegacy.html JControllerLegacy]''. This class has to be extended to be used in our component. In the file ''yoursite/components/com_helloworld/helloworld.php'' (entry point of our ''Hello World'' component), put these lines:

{{vanchor|site/helloworld.php}}
<source lang="php">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// Get an instance of the controller prefixed by HelloWorld
$controller = JControllerLegacy::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 ''[https://api.joomla.org/cms-3/classes/JControllerLegacy.html#method_getInstance getInstance]'' static method of the ''JControllerLegacy'' 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 ''yoursite/components/com_helloworld/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 ''yoursite/components/com_helloworld/controller.php'' file containing

{{vanchor|site/controller.php}}
<source lang="php">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// No direct access to this file
defined('_JEXEC') or die('Restricted access');

/**
* Hello World Component Controller
*
* @since 0.0.1
*/
class HelloWorldController extends JControllerLegacy
{
public function display() {
$document = JFactory::getDocument();
$viewName = $this->input->getCmd('view', 'login');
$viewFormat = $document->getType();
$view = $this->getView($viewName, $viewFormat);
$view->display();
parent::__construct();
}

}
</source>

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

So with ''task'' simply a public function display() of ''JControllerLegacy'' 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 JControllerLegacy wants to display a view, it will look for certain files in the ''yoursite/components/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 ''yoursite/components/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 ''yoursite/components/com_helloworld/views/helloworld/view.html.php'' able to display the default view and containing:

<source lang="php">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// No direct access to this file
defined('_JEXEC') or die('Restricted access');

/**
* HTML View class for the HelloWorld Component
*
* @since 0.0.1
*/
class HelloWorldViewHelloWorld extends JViewLegacy
{
/**
* Display the Hello World view
*
* @param string $tpl The name of the template file to parse; automatically searches through the template paths.
*
* @return void
*/
public 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 ''[https://api.joomla.org/cms-3/classes/JViewLegacy.html JViewLegacy]'' class is called with the ''display'' task of the JControllerLegacy 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 ''yoursite/components/com_helloworld/views/helloworld/tmpl/default.php'' able to display the default view and containing:

<source lang="php">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// 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 JViewLegacy class. Therefore, here, $this refers to the HelloWorldViewHelloWorld class.

So to give an example, one could call the view inside the ''yoursite/components/com_[component_name]/views/[name of view]/'' folder by calling <code>index.php?option=com_helloworld</code> (this would default to the ''yoursite/components/com_helloworld/views/helloworld/'' folder) or we could explicitly call the folder by calling: <code>index.php?option=com_helloworld&view=helloworld</code>

if we change <code>&view=helloworld</code> to something else, e.g. <code>&view=fluffy</code> we would have to create a folder <code>components/com_helloworld/views/fluffy/</code>.

Copy the contents of <code>views/helloworld</code> to <code>views/fluffy</code>

The classname of the file <code>view.html.php</code> 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 <code>index.php?option=com_helloworld&view=fluffy</code>

== Packaging the component ==

Content of your code directory
* ''[[#helloworld.xml|helloworld.xml]]''
* ''[[#site/helloworld.php|site/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/index.html]]''
* ''[[#site/controller.php|site/controller.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/index.html]]''
* ''[[#site/views/helloworld/view.html.php|site/views/helloworld/view.html.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/tmpl/index.html]]''
* ''[[#site/views/helloworld/tmpl/default.php|site/views/helloworld/tmpl/default.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#admin/helloworld.php|admin/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/mysql/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#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.

<span id="helloworld.xml">
''helloworld.xml''
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="3.2" method="upgrade">

<name>Hello World!</name>

<creationDate>December 2013</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 link='index.php?option=com_helloworld'>Hello World!</menu>


<files folder="admin">

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

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

</extension>
</source>
</span>

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

{{notice|Please create a pull request or issue at https://github.com/joomla/Joomla-3.2-Hello-World-Component for any code descprepancies or if editing any of the source code on this page.}}

{{:J3.2:Developing a MVC Component/Navigate|prev=Developing a Basic Component|next=Adding a menu type to the site part}}

<noinclude>[[Category:Component Development]] [[Category:Joomla! 3.0]] [[Category:Joomla! 3.1]][[Category:Joomla! 3.2]]</noinclude>

== Contributors ==

*[[User:Gunjanpatel|Gunjan Patel]]
*[[User:cdemko|Christophe Demko]]
*[[User:oaksu|Ozgur Aksu]]
*[[User:Scionescire|Scionescire]]

[[Category:Development]]
[[Category:Joomla! 3.0]]
[[Category:Joomla! 3.1]]
[[Category:Joomla! 3.2]]

J3.x:Developing an MVC Component/Adding a model to the site part

2015-02-05T16:46:36Z

Nenomaz: /* Adding a model */ set the model for the view in the controller

{{:J3.1:Developing a MVC Component}}

== Introduction ==
This tutorial is part of the [[J3.2:Developing a MVC Component | Developing a MVC Component for Joomla! 3.2]] tutorial. You are encouraged to read the previous parts of the tutorial before reading this.

== Adding 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:

<span id="site/models/helloworld.php">
''site/models/helloworld.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

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

Open the site/controller.php file and inject the model to the view:
<source lang="php">
<?php

// No direct access to this file
defined('_JEXEC') or die('Restricted access');

class HelloWorldController extends JControllerLegacy {

public function display() {
$document = JFactory::getDocument();
$vName = $this->input->getCmd('view', 'login');
$vFormat = $document->getType();
$model = $this->getModel($vName);
$view = $this->getView($vName, $vFormat);
$view->setModel($model, true);
$view->display();
parent::__construct();
}
}
</source>
The ''HelloWorldViewHelloWorld'' class asks the model for data using the ''get'' method of the ''JViewLegacy'' class:

<span id="site/views/helloworld/view.html.php">
''site/views/helloworld/view.html.php''
<source lang="php">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// No direct access to this file
defined('_JEXEC') or die('Restricted access');

/**
* HTML View class for the HelloWorld Component
*
* @since 0.0.1
*/
class HelloWorldViewHelloWorld extends JViewLegacy
{
/**
* Display the Hello World view
*
* @param string $tpl The name of the template file to parse; automatically searches through the template paths.
*
* @return void
*/
// Overwriting JViewLegacy display method
public 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('<br />', $errors), JLog::WARNING, 'jerror');
return false;
}

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

Note: $this->get() is a member of JViewLegacy::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:

<span id="helloworld.xml">
''helloworld.xml''
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="3.2" method="upgrade">

<name>Hello World!</name>

<creationDate>January 2014</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 link='index.php?option=com_helloworld'>Hello World!</menu>


<files folder="admin">

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

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

</extension>
</source>
</span>

== Packaging the component ==

Content of your code directory
* ''[[#helloworld.xml|helloworld.xml]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/helloworld.php|site/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/controller.php|site/controller.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/views/helloworld/view.html.php|site/views/helloworld/view.html.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/tmpl/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_a_menu_type_to_the_site_part#site/views/helloworld/tmpl/default.xml|site/views/helloworld/tmpl/default.xml]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/views/helloworld/tmpl/default.php|site/views/helloworld/tmpl/default.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/models/index.html]]''
* ''[[#site/models/helloworld.php|site/models/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#admin/helloworld.php|admin/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/mysql/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#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 [https://github.com/joomla/Joomla-3.2-Hello-World-Component/archive/step-4-adding-a-site-model.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.

{{notice|Please create a pull request or issue at https://github.com/joomla/Joomla-3.2-Hello-World-Component for any code descprepancies or if editing any of the source code on this page.}}

{{:J3.2:Developing a MVC Component/Navigate
|prev=Adding a menu type to the site part 
|next=Adding a variable request in the menu type }}

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

[[Category:Joomla! 3.0]]
[[Category:Joomla! 3.1]]
[[Category:Joomla! 3.2]]
[[Category:Beginner Development]]
[[Category:Component Development]]