J3.x

Difference between revisions of "Developing an MVC Component/Introduction"

From Joomla! Documentation

< J3.x:Developing an MVC Component
m (NOTOC)
(33 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{:Developing a Model-View-Controller Component/3.0}}
+
<noinclude><languages /></noinclude>
==Notes==
+
{{:J3.1:Developing an MVC Component/<translate><!--T:1-->
 +
en</translate>}}
 +
<translate>==Notes== <!--T:2-->
 
This tutorial is adapted from [[User:Cdemko|Christophe Demko]]:  
 
This tutorial is adapted from [[User:Cdemko|Christophe Demko]]:  
*[[Developing a Model-View-Controller Component/2.5]]
+
*[[S:MyLanguage/Developing a Model-View-Controller Component/2.5|Developing a Model-View-Controller Component/2.5]]</translate>
 +
<translate><!--T:3-->
 +
'''WARNING:''' this tutorial will not repeat the comments of Demko. To see them, please have a look to the original tutorial for Joomla! 2.5:
 +
*[[S:MyLanguage/Developing_a_Model-View-Controller_Component/2.5/Introduction|Developing an MVC Component for Joomla! 2.5 - Introduction]]</translate>
 +
<translate>== Requirements == <!--T:7--></translate>
 +
<translate><!--T:8-->
 +
You need Joomla! 3.0 (with PHP, MySQL and Apache/Microsoft IIS) or greater for this tutorial.</translate>
 +
<translate><!--T:9-->
 +
I gathered a lot of information and then I started to migrate the component of the new Joomla! 2.5 to 3.0.
 +
Below is some important information used for migration. Please see also all the information about migration [[S:MyLanguage/Portal:Upgrading_Versions|Upgrading Versions]].</translate>
 +
<translate><!--T:10-->
 +
Use "display_errors On" to help with debugging errors.</translate>
  
WARNING: this tutorial will not repeat the comments Demko, to see them see your tutorial:
+
<translate>== Migrating Joomla! 2.5 to Joomla! 3.0: == <!--T:11--></translate>
*[[Developing_a_Model-View-Controller_Component/2.5/Introduction|2.5 - Introduction]]
+
<translate><!--T:12-->
 
+
Remember that you need to add Legacy at any place where you are directly extending JModel, JView or JController.  If it is indirect (like through JModelList) you don't have to, it's already taken care of.</translate>
Here only the part 17, this:
+
<translate><!--T:13-->
*[[Developing_a_Model-View-Controller_Component/2.5/Adding_an_update_server|2.5 - Adding_an_update_server]] migrated to Joomla 3.0 and your final zip.
+
Other than that and the fact that, as announced long ago, deprecated code has been removed (I'd guess that JParameter is the biggest impact), extensions should only need minor changes ... Although you will want to look at the output changes that Kyle is working on.</translate>
 
+
<translate><!--T:14-->
This is my first sample component to Joomla 3.0.
+
Of course, if you are building standalone platform applications, the new MVC and JApplicationWeb/JApplicationCLI are completely the way you should work and the nice thing about the way we have done this is that the new packages are already right there on your server having arrived with the CMS.
 
+
(Elin in development list)</translate>
== My contributions: ==
 
* Migration to Joomla 3.0
 
* Add language pt-BR
 
 
 
----
 
== Requirements ==
 
You need Joomla! 3.0 Beta1 (with PHP, MySQL, Apache and Microsoft II) or greater for this tutorial.
 
 
 
Introduction
 
I gathered a lot of information and then I started to migrate the component of the new Joomla 2.5 to 3.0 (still in beta1).
 
Below is some important information used for migration:
 
 
 
Use "display_errors On" to help in errors debug.
 
 
 
== Migrating Joomla 2.5 to Joomla 3.0: ==
 
 
 
Remember that you need to add Legacy any place you are directly extending JModel, JView or JController.  If it is indirect (like through JModellist) you don't have to, it's already taken care of.
 
Other than that and the fact that as announced long ago deprecated code has been removed (I'd guess that JParameter is the biggest impact )   extensions should only need minor changes ... although you will want to look at the output changes that Kyle is working on.
 
Of course if you are building stand alone platform applications the new MVC and jApplicationWeb/JApplicationCLI are completely the way you should work and the nice thing about the way we have done this is that the new packages are already right there on your server having arrived with the CMS.
 
(Elin in development list)
 
 
 
Samples:
 
  
 +
<translate><!--T:15-->
 +
Samples:</translate>
 
DS
 
DS
 
+
<translate><!--T:16-->
Since we've removed the DS constant in 3.0, we need to replace the uses of the constant in com_media.  The most unobtrusive change is to simply replace it with PHP's DIRECTORY_SEPARATOR constant since DS is an alias to that.
+
Since we've removed the DS constant in 3.0, we need to replace the uses of the constant in com_media.  The most unobtrusive change is to simply replace it with PHP's DIRECTORY_SEPARATOR constant since DS is an alias to that.</translate>
  
 
(joomlacode)
 
(joomlacode)
Line 59: Line 52:
 
JRegistry::getValue() now is JRegistry::get()
 
JRegistry::getValue() now is JRegistry::get()
  
//Convert sample to JRegistry with LoadJSON - Sample from Joomla 3.0 sourcecode
+
//Convert sample to JRegistry with LoadJSON - Sample from Joomla! 3.0 sourcecode
  
 
// $params = new JRegistry;
 
// $params = new JRegistry;
Line 70: Line 63:
 
</source>
 
</source>
  
== Source code from a Model-View-Controller Component to Joomla 3.0 ==
+
<translate><!--T:17-->
 +
Here source code:</translate>
 +
http://joomlacode.org/gf/project/hellojoomla3/frs/
 +
 
 +
<translate>== New MVC in Joomla! 3.0 == <!--T:18--></translate>
 +
<translate><!--T:19-->
 +
"Version 12.1 of the platform introduced a new format for the model-view-controller paradigm. In principle, the classes JModel, JView and JController are now interfaces and the base abstract classes are now JModelBase, JViewBase and JControllerBase, respectively. In addition, all classes have been simplified, removing a lot of coupling with the Joomla! CMS, that was unnecessary for standalone Joomla! Platform applications." ...
 +
[http://developer.joomla.org/manual/chap-Joomla_Platform_Manual-MVC.html Joomla! Platform Manual MVC]</translate>
  
[[http://ribafs.org/sites/cursodephp/down/joomla/com_ola_j3.zip|Download]]
+
<translate>== Contributors == <!--T:22--></translate>
== Contributors ==
+
* [[User:Ribafs|Ribafs]]
*[[User:cdemko|Christophe Demko]]
 
* User:ribafs - Ribamar FS - [http://docs.joomla.org/User:Ribafs]
 
  
[[Category:Development]]
+
<div class="row">
[[Category:Joomla! 1.6]]
+
<div class="large-6 columns">{{Basic button|<translate>
[[Category:Joomla! 1.7]]
+
<!--T:24-->
[[Category:Joomla! 2.5]]
+
S:MyLanguage/J3.x:Developing_an_MVC_Component/Introduction|Prev: Introduction</translate>|class=expand success}}</div>
 +
<div class="large-6 columns">{{Basic button|<translate>
 +
<!--T:25-->
 +
S:MyLanguage/J3.x:Developing_an_MVC_Component/Developing_a_Basic_Component|Next: Developing a Basic Component</translate>|class=expand}}</div>
 +
</div>
 +
__NOTOC__
 +
<noinclude>
 +
<translate>
 +
<!--T:26-->
 +
[[Category:Joomla! 3.x]]
 
[[Category:Joomla! 3.0]]
 
[[Category:Joomla! 3.0]]
[[Category:Manual]]
+
[[Category:Joomla! 3.1]]
 +
[[Category:Joomla! 3.2]]
 +
[[Category:Joomla! 3.3]]
 +
[[Category:Joomla! 3.4]]
 +
[[Category:Beginner Development]]
 +
[[Category:Component Development]]
 +
[[Category:Tutorials]]
 +
[[Category:Tutorials in a Series]]
 +
</translate>
 +
</noinclude>

Revision as of 08:15, 10 July 2015

Other languages:
Deutsch • ‎English • ‎Nederlands • ‎español • ‎français • ‎italiano • ‎polski • ‎português do Brasil • ‎العربية • ‎中文(中国大陆)‎ • ‎中文(台灣)‎
Joomla! 
3.x
Tutorial
Developing an MVC Component



This is a multiple-article series of tutorials on how to develop a Model-View-Controller Component for Joomla! VersionJoomla 3.x.

Begin with the Introduction, and navigate the articles in this series by using the navigation button at the bottom or the box to the right (the Articles in this series).



Notes[edit]

This tutorial is adapted from Christophe Demko:

WARNING: this tutorial will not repeat the comments of Demko. To see them, please have a look to the original tutorial for Joomla! 2.5:

Requirements[edit]

You need Joomla! 3.0 (with PHP, MySQL and Apache/Microsoft IIS) or greater for this tutorial. I gathered a lot of information and then I started to migrate the component of the new Joomla! 2.5 to 3.0. Below is some important information used for migration. Please see also all the information about migration Upgrading Versions. Use "display_errors On" to help with debugging errors.

Migrating Joomla! 2.5 to Joomla! 3.0:[edit]

Remember that you need to add Legacy at any place where you are directly extending JModel, JView or JController. If it is indirect (like through JModelList) you don't have to, it's already taken care of. Other than that and the fact that, as announced long ago, deprecated code has been removed (I'd guess that JParameter is the biggest impact), extensions should only need minor changes ... Although you will want to look at the output changes that Kyle is working on. Of course, if you are building standalone platform applications, the new MVC and JApplicationWeb/JApplicationCLI are completely the way you should work and the nice thing about the way we have done this is that the new packages are already right there on your server having arrived with the CMS. (Elin in development list)

Samples: DS Since we've removed the DS constant in 3.0, we need to replace the uses of the constant in com_media. The most unobtrusive change is to simply replace it with PHP's DIRECTORY_SEPARATOR constant since DS is an alias to that.

(joomlacode)

if(!defined('DS')){
define('DS',DIRECTORY_SEPARATOR);
}

//$controller = JController::getInstance('HelloWorld');
$controller = JControllerLegacy::getInstance('HelloWorld');

//class HelloWorldViewHelloWorlds extends JView
class HelloWorldViewHelloWorlds extends JViewLegacy

class HelloWorldController extends JControllerLegacy

class HelloWorldModelHelloWorld extends JModelItemLegacy

class HelloWorldModelUpdHelloWorld extends JModelFormLegacy

JRegistry::getValue() now is JRegistry::get()

//Convert sample to JRegistry with LoadJSON - Sample from Joomla! 3.0 sourcecode

//				$params = new JRegistry;
//				$params->loadJSON($this->item->params);
//				$this->item->params = $params;

				$params = new JRegistry;
				$params->loadString($item->params);
				$item->params = $params;

Here source code: http://joomlacode.org/gf/project/hellojoomla3/frs/

New MVC in Joomla! 3.0[edit]

"Version 12.1 of the platform introduced a new format for the model-view-controller paradigm. In principle, the classes JModel, JView and JController are now interfaces and the base abstract classes are now JModelBase, JViewBase and JControllerBase, respectively. In addition, all classes have been simplified, removing a lot of coupling with the Joomla! CMS, that was unnecessary for standalone Joomla! Platform applications." ... Joomla! Platform Manual MVC

Contributors[edit]