User:Rvsjoen/tutorial/Developing a Module/Part 05 - Revision history

Rvsjoen: /* Testing your component */

2012-03-13T22:47:29Z

Testing your component

← Older revision		Revision as of 22:47, 13 March 2012
Line 139:		Line 139:
	* <tt>[[#helper.php\|helper.php]]</tt>		* <tt>[[#helper.php\|helper.php]]</tt>

	== Testing your ~~component~~ ==		== Testing your module ==

	For details on how to install the module into your Joomla! site, refer to the information provided in		For details on how to install the module into your Joomla! site, refer to the information provided in

Rvsjoen: /* Download this part */

2012-03-13T17:38:53Z

Download this part

← Older revision		Revision as of 17:38, 13 March 2012
Line 146:		Line 146:
	== Download this part ==		== Download this part ==

	~~To be continued.~~..		[https://github.com/downloads/rvsjoen/joomla-tutorials/mod_helloworld-part05.zip Download example package]

	{{:Chunks:Developing_a_Module_Contents}}		{{:Chunks:Developing_a_Module_Contents}}

Rvsjoen: /* Adding a helper */

2012-03-13T17:28:47Z

Adding a helper

← Older revision		Revision as of 17:28, 13 March 2012
Line 55:		Line 55:

	The highlighted line takes care of loading the class. We could have used the '''require()''' function call to do this, but JLoader offers additional advantages such as lazy loading (The class is not actually loaded unless it is needed). The first argument is the name of the class, and the second argument is the path to the file. '''JPATH_BASE''' is a macro which always points to the root of the Joomla! application, in this case the frontend.		The highlighted line takes care of loading the class. We could have used the '''require()''' function call to do this, but JLoader offers additional advantages such as lazy loading (The class is not actually loaded unless it is needed). The first argument is the name of the class, and the second argument is the path to the file. '''JPATH_BASE''' is a macro which always points to the root of the Joomla! application, in this case the frontend.

			<span id="tmpl/default.php">
			'''<tt>tmpl/default.php</tt>'''
			<source lang="php" highlight="15">
			<?php

			/**
			* @package Joomla.Tutorials
			* @subpackage Module
			* @copyright Copyright (C) 2005 - 2010 Open Source Matters, Inc. All rights reserved.
			* @license License GNU General Public License version 2 or later; see LICENSE.txt
			*/

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

			<p><?php echo $params->get('greeting', JText::_('MOD_HELLOWORLD_GREETING_DEFAULT')); ?></p>
			<p><?php echo modHelloWorldHelper::getGreeting(); ?></p>
			</source>
			</span>

			Here we modify the module template to call the helper function '''getGreeting()''' in our helper class and render the string it returns in a new paragraph in addition to the original greeting.

	With your favorite editor, edit the following file		With your favorite editor, edit the following file

Rvsjoen: /* File listing */

2012-03-13T17:25:15Z

File listing

← Older revision		Revision as of 17:25, 13 March 2012
Line 112:		Line 112:
	* <tt>[[#mod_helloworld.php\|mod_helloworld.php]]</tt>		* <tt>[[#mod_helloworld.php\|mod_helloworld.php]]</tt>
	* <tt>[[#tmpl/default.php\|tmpl/default.php]]</tt>		* <tt>[[#tmpl/default.php\|tmpl/default.php]]</tt>
			* <tt>[[User:Rvsjoen/tutorial/Developing_a_Module/Part_04#language/en-GB.mod_helloworld.ini\|language/en-GB.mod_helloworld.ini]]</tt>
			* <tt>[[User:Rvsjoen/tutorial/Developing_a_Module/Part_04#language/en-GB.mod_helloworld.sys.ini\|language/en-GB.mod_helloworld.sys.ini]]</tt>
			* <tt>[[#helper.php\|helper.php]]</tt>

	== Testing your component ==		== Testing your component ==

Rvsjoen: /* Adding a helper */

2012-03-13T17:14:57Z

Adding a helper

← Older revision		Revision as of 17:14, 13 March 2012
Line 1:		Line 1:
	= Adding a helper =		= Adding a helper =

			A helper in the context of a Joomla! extension is usually just a class providing various static helper functions to perform operations. A helper could be used to accomplish a lot of things but common examples are to get a list of items from a database, get the number of currently logged in users, etc... To illustrate how this works, we are going to implement a helper to the module which simple provides the module with yet another string.

	With your favorite editor, create the following file		With your favorite editor, create the following file
Line 26:		Line 28:
	</source>		</source>
	</span>		</span>

			As you can see, this is nothing more than a class with a static function in it. The class will need to be loaded in the module entry point.

	With your favorite editor, edit the following file		With your favorite editor, edit the following file
Line 49:		Line 53:
	</source>		</source>
	</span>		</span>

			The highlighted line takes care of loading the class. We could have used the '''require()''' function call to do this, but JLoader offers additional advantages such as lazy loading (The class is not actually loaded unless it is needed). The first argument is the name of the class, and the second argument is the path to the file. '''JPATH_BASE''' is a macro which always points to the root of the Joomla! application, in this case the frontend.

	With your favorite editor, edit the following file		With your favorite editor, edit the following file
Line 98:		Line 104:
	</source>		</source>
	</span>		</span>

			Here we simply add '''helper.php''' to the list of files to be copied when the extension is installed.

	== File listing ==		== File listing ==

Rvsjoen at 16:55, 13 March 2012

2012-03-13T16:55:07Z

← Older revision		Revision as of 16:55, 13 March 2012
Line 104:		Line 104:
	* <tt>[[#mod_helloworld.php\|mod_helloworld.php]]</tt>		* <tt>[[#mod_helloworld.php\|mod_helloworld.php]]</tt>
	* <tt>[[#tmpl/default.php\|tmpl/default.php]]</tt>		* <tt>[[#tmpl/default.php\|tmpl/default.php]]</tt>

			== Testing your component ==

			For details on how to install the module into your Joomla! site, refer to the information provided in
			[[User:Rvsjoen/tutorial/Developing_a_Module/Part_01#Installation_and_Testing\|Part 01]].

	== Download this part ==		== Download this part ==

Rvsjoen: /* Adding a helper */

2012-03-13T16:42:02Z

Adding a helper

← Older revision		Revision as of 16:42, 13 March 2012
Line 31:		Line 31:
	<span id="mod_helloworld.php">		<span id="mod_helloworld.php">
	'''<tt>mod_helloworld.php</tt>'''		'''<tt>mod_helloworld.php</tt>'''
	<source lang="php">		<source lang="php" highlight="13">
	<?php		<?php

Line 54:		Line 54:
	<span id="mod_helloworld.xml">		<span id="mod_helloworld.xml">
	'''<tt>mod_helloworld.xml</tt>'''		'''<tt>mod_helloworld.xml</tt>'''
	<source lang="xml">		<source lang="xml" highlight="22">
	<?xml version="1.0" encoding="utf-8"?>		<?xml version="1.0" encoding="utf-8"?>
	<extension type="module" version="2.5.0" method="upgrade">		<extension type="module" version="2.5.0" method="upgrade">

Rvsjoen: /* Adding a helper */

2012-03-13T16:40:01Z

Adding a helper

← Older revision		Revision as of 16:40, 13 March 2012
Line 2:		Line 2:

	With your favorite editor, create the following file		With your favorite editor, create the following file

	<span id="helper.php">		<span id="helper.php">
	'''<tt>helper.php</tt>'''		'''<tt>helper.php</tt>'''

Rvsjoen: /* Adding a helper */

2012-03-13T16:39:48Z

Adding a helper

@@ Line 1: / Line 1: @@
 = Adding a helper =
 With your favorite editor, edit the following file
@@ Line 6: / Line 31: @@
 '''<tt>mod_helloworld.php</tt>'''
 <source lang="php">
 </source>
 </span>

Rvsjoen: /* Adding a helper */

2012-03-13T16:21:14Z

Adding a helper

@@ Line 15: / Line 15: @@
 <source lang="xml">
 <?xml version="1.0" encoding="utf-8"?>
 </source>
 </span>

← Older revision		Revision as of 17:25, 13 March 2012
Line 112:		Line 112:
	* <tt>[[#mod_helloworld.php\|mod_helloworld.php]]</tt>		* <tt>[[#mod_helloworld.php\|mod_helloworld.php]]</tt>
	* <tt>[[#tmpl/default.php\|tmpl/default.php]]</tt>		* <tt>[[#tmpl/default.php\|tmpl/default.php]]</tt>
			* <tt>[[User:Rvsjoen/tutorial/Developing_a_Module/Part_04#language/en-GB.mod_helloworld.ini\|language/en-GB.mod_helloworld.ini]]</tt>
			* <tt>[[User:Rvsjoen/tutorial/Developing_a_Module/Part_04#language/en-GB.mod_helloworld.sys.ini\|language/en-GB.mod_helloworld.sys.ini]]</tt>
			* <tt>[[#helper.php\|helper.php]]</tt>

	== Testing your component ==		== Testing your component ==