View source for Developing an MVC Component/Adding a model to the site part

<noinclude><languages /></noinclude>
{{:J3.1:Developing an MVC Component/<translate><!--T:23-->
en</translate>}}

<translate>
== Note == <!--T:28-->
</translate>
<translate><!--T:29-->
* This tutorial is part of the [[S:MyLanguage/J3.x:Developing_an_MVC_Component/Introduction|Developing a MVC Component for Joomla! 3.x]] tutorial. You are encouraged to read the previous parts of the tutorial before reading this.</translate>

<translate><!--T:30-->
* You can follow the steps below to add a model to the Hello World! component, or you can directly download the [https://github.com/scionescire/Joomla-3.2-Hello-World-Component/archive/step-4-adding-a-site-model.zip archive]</translate>

<translate><!--T:66--> * You can watch a video associated with this step in the tutorial at [https://www.youtube.com/watch?v=ezUEbKEr8lw Step 4, Adding a Model].</translate>

{{#widget:YouTube|id=ezUEbKEr8lw}}

<translate>
== Adding a Model to Hello World! == <!--T:31-->
</translate> 
<translate><!--T:32-->
In this article we will cover how to add a model to a basic Joomla! component. For this example we will be continuing our work on the [[S:MyLanguage/J3.x:Developing_an_MVC_Component/Developing_a_Basic_Component| Hello World!]] component.</translate>

<translate><!--T:33-->
There are several ways to update a Joomla! component. As with the last tutorial, we will focus option 2.</translate>
{| border=1
 | 1
 | <translate><!--T:34-->
Manually add the files into <tt><path_to_joomla>/</tt></translate>
 |-
 | 2
 | <translate><!--T:35-->
Update using the Joomla! Extension Manager and the original directory, non-compressed, used for the component install</translate>
 |-
 |3
 | <translate><!--T:36-->
Update using the Joomla! Extension Manager and an [[S:MyLanguage/Deploying_an_Update_Server| Update Server]]</translate>
 |}

<translate><!--T:37-->
To add a model you will need to navigate to <tt>com_helloworld</tt>, which is the original directory we made for our component. You must use the updated directory structure from the last [[S:MyLanguage/J3.x:Developing_an_MVC_Component/Adding_a_menu_type_to_the_site_part | tutorial]]. Using your preferred file manager, create or update the following files; as you create or update the files, add the source code for each file which is found in [[#File Details|File Details]].</translate>

{| border=1
 | 1
 | <translate><!--T:67--> Create:</translate> [[#site/models/helloworld.php| helloworld.php]]
 | <tt><path_to_com_helloworld>/site/models/helloworld.php<tt>
 |-
 | 2
 | <translate><!--T:68--> Create:</translate> [[#site/models/index.html| index.html]]
 | <tt><path_to_com_helloworld>/site/models/index.html</tt>
 |-
 | 3
 | <translate><!--T:69--> Update:</translate> [[#site/views/helloworld/view.html.php| view.html.php]]
 | <tt><path_to_com_helloworld>/site/views/helloworld/view.html.php</tt>
 |-
 | 4
 | <translate><!--T:70--> Update:</translate> [[#helloworld.xml| helloworld.xml]]
 | <tt><path_to_com_helloworld>/helloworld.xml</tt>
 |}

<translate>
=== Updating the Hello World! Component === <!--T:38-->
</translate>
<translate><!--T:39-->
To update the Hello World! Component in the Joomla! website, please follow the same steps for the [[S:MyLanguage/J3.x:Developing_an_MVC_Component/Developing_a_Basic_Component#Installing the Hello World! Component |original installation]].</translate>

<translate>
== File Details == <!--T:40-->
</translate>
{{vanchor|site/models/helloworld.php}}
<source lang="php">
<?php
/**
 * @package     Joomla.Administrator
 * @subpackage  com_helloworld
 *
 * @copyright   Copyright (C) 2005 - 2018 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');

/**
 * HelloWorld Model
 *
 * @since  0.0.1
 */
class HelloWorldModelHelloWorld extends JModelItem
{
	/**
	 * @var string message
	 */
	protected $message;

	/**
	 * Get the message
         *
	 * @return  string  The message to be displayed to the user
	 */
	public function getMsg()
	{
		if (!isset($this->message))
		{
			$this->message = 'Hello World!';
		}

		return $this->message;
	}
}
</source>

{{vanchor|site/views/helloworld/view.html.php}}
<source lang="php" highlight="30-38">
<?php
/**
 * @package     Joomla.Administrator
 * @subpackage  com_helloworld
 *
 * @copyright   Copyright (C) 2005 - 2018 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 = $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>

{{vanchor|helloworld.xml}}
<source lang="xml" highlight="13,32">
<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="3.0" method="upgrade">

	<name>Hello World!</name>
	<!-- The following elements are optional and free of formatting constraints -->
	<creationDate>January 2018</creationDate>
	<author>John Doe</author>
	<authorEmail>john.doe@example.org</authorEmail>
	<authorUrl>http://www.example.org</authorUrl>
	<copyright>Copyright Info</copyright>
	<license>License Info</license>
	<!--  The version string is recorded in the components table -->
	<version>0.0.4</version>
	<!-- The description is optional and defaults to the name -->
	<description>Description of the Hello World component ...</description>

	<update> <!-- Runs on update; New since J2.5 -->
		<schemas>
			<schemapath type="mysql">sql/updates/mysql</schemapath>
		</schemas>
	</update>

	<!-- Site Main File Copy Section -->
	<!-- Note the folder attribute: This attribute describes the folder
		to copy FROM in the package to install therefore files copied
		in this section are copied from /site/ in the package -->
	<files folder="site">
		<filename>index.html</filename>
		<filename>helloworld.php</filename>
		<filename>controller.php</filename>
		<folder>views</folder>
		<folder>models</folder>
	</files>

	<administration>
		<!-- Administration Menu Section -->
		<menu link='index.php?option=com_helloworld'>Hello World!</menu>
		<!-- Administration Main File Copy Section -->
		<!-- Note the folder attribute: This attribute describes the folder
			to copy FROM in the package to install therefore files copied
			in this section are copied from /admin/ in the package -->
		<files folder="admin">
			<!-- Admin Main File Copy Section -->
			<filename>index.html</filename>
			<filename>helloworld.php</filename>
			<!-- SQL files section -->
			<folder>sql</folder>
		</files>
	</administration>

</extension>
</source>

<translate>

== Code Explanation == <!--T:41-->
</translate>
<translate><!--T:42-->
In case you were curious as to why this works the way it does.</translate>

=== helloworld.php ===

<source lang="php">
class HelloWorldModelHelloWorld extends JModelItem
{
</source>

<translate><!--T:43-->
This class will be called by the class HelloWorldViewHelloWorld.</translate>

<translate>
=== view.html.php === <!--T:44-->
</translate>

<source lang="php">
$this->msg = $this->get('Msg');
</source>

<translate><!--T:45-->
The ''HelloWorldViewHelloWorld'' class asks the model for data using the ''get'' method of the ''JViewLegacy''. This ''get'' method converts the <tt>get('Msg')</tt> call into a <tt>getMsg()</tt> call on the model, which is the function which we have had to provide.</translate>

<translate>
== Component Contents == <!--T:46-->
</translate>
<translate><!--T:47-->
At this point in the tutorial, your component should contain the following files:</translate>
{| border=1
 | 1
 | ''[[#helloworld.xml|helloworld.xml]]''
 | <translate><!--T:48-->
this is an XML (manifest) file that tells Joomla! how to install our component.</translate>
 |-
 | 2
 | ''[[#site/helloworld.php|site/helloworld.php]]''
 | <translate><!--T:49-->
this is the site entry point to the Hello World! component</translate>
 |-
 | 3
 | ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/index.html]]''
 | <translate><!--T:50-->
prevents web server from listing directory content</translate>
 |-
 | 4
 | ''[[#site/controller.php|site/controller.php]]''
 | <translate><!--T:51-->
file representing the controller</translate>
 |-
 | 5
 | ''[[#site/models/helloworld.php|site/models/helloworld.php]]''
 | <translate><!--T:52-->
file representing the model</translate>
 |-
 |6
 | ''[[#site/models/index.html|site/models/index.html]]''
 | <translate><!--T:53-->
prevents web server from listing directory content</translate>
 |-
 | 7
 | ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/views/index.html]]''
 | <translate><!--T:54-->
prevents web server from listing directory content</translate>
 |-
 | 8
 | ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/index.html]]''
 | <translate><!--T:55-->
prevents web server from listing directory content</translate>
 |-
 | 9
 | ''[[#site/views/helloworld/view.html.php|site/views/helloworld/view.html.php]]''
 | <translate><!--T:56-->
file representing the view</translate>
 |-
 | 10
 | ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/tmpl/index.html]]''
 | <translate><!--T:57-->
prevents web server from listing directory content</translate>
 |-
 | 11
 | ''[[#site/views/helloworld/tmpl/default.php|site/views/helloworld/tmpl/default.php]]'' 
 | <translate><!--T:58-->
the default view</translate>
 |-
 | 12
 | ''[[#site/views/helloworld/tmpl/default.xml|site/views/helloworld/tmpl/default.xml]]''
 | <translate><!--T:59-->
file that adds menu item</translate>
 |-
 | 13
 | ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/index.html]]''
 | <translate><!--T:60-->
prevents web server from listing directory content</translate>
 |-
 | 14
 | ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#admin/helloworld.php|admin/helloworld.php]]''
 | <translate><!--T:61-->
this is the administrator entry point to the Hello World! component</translate>
 |-
 | 15
 | ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/index.html]]''
 | <translate><!--T:62-->
prevents web server from listing directory content</translate>
 |-
 | 16
 | ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/index.html]]''
 | <translate><!--T:63-->
prevents web server from listing directory content</translate>
 |-
 | 17
 | ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/mysql/index.html]]''
 | <translate><!--T:64-->
prevents web server from listing directory content</translate>
 |-
 | 18
 | ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#admin/sql/updates/mysql/0.0.1.sql|admin/sql/updates/mysql/0.0.1.sql]]''
 | <translate><!--T:65-->
file allowing to initialise schema version of the com_helloworld component.</translate>
 |}

{{notice|<translate><!--T:18-->
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.</translate>}}

<div class="row"> 
<div class="large-6 columns">{{Basic button|<translate><!--T:24-->
S:MyLanguage/J3.x:Developing_an_MVC_Component/Adding a menu type to the site part|Prev: Adding a menu type to the site part</translate>|class=expand success}}</div>
<div class="large-6 columns">{{Basic button|<translate><!--T:25-->
S:MyLanguage/J3.x:Developing_an_MVC_Component/Adding a variable request in the menu type|Next: Adding a variable request in the menu type</translate>|class=expand}}</div>
</div>
__NOTOC__

<noinclude>
[[Category:Joomla! 3.x{{#translation:}}]]
[[Category:Joomla! 3.0{{#translation:}}]]
[[Category:Joomla! 3.1{{#translation:}}]]
[[Category:Joomla! 3.2{{#translation:}}]]
[[Category:Joomla! 3.3{{#translation:}}]]
[[Category:Joomla! 3.4{{#translation:}}]]
[[Category:Beginner Development{{#translation:}}]]
[[Category:Component Development{{#translation:}}]]
[[Category:Tutorials{{#translation:}}]]
[[Category:Tutorials in a Series{{#translation:}}]]
</noinclude>