J3.x:Creating a simple module/Developing a Basic Module - Revision history

Pe7er: Added a note about using the zip format for modules

2020-07-17T14:45:36Z

Added a note about using the zip format for modules

← Older revision		Revision as of 14:45, 17 July 2020
Line 193:		Line 193:
	<translate>		<translate>
	<!--T:43-->		<!--T:43-->
	To install the module, zip up the parent directory of your source files, to create a file called <tt>mod_helloworld.zip</tt>. </translate>		To install the module, zip up the parent directory of your source files, to create a file called <tt>mod_helloworld.zip</tt>. Note that it needs to be a .zip file because the server needs to be able to extract it using Apache's mod_zlib library.</translate>
	<translate>		<translate>
	<!--T:44-->		<!--T:44-->

MartijnM at 14:24, 1 April 2020

2020-04-01T14:24:52Z

← Older revision		Revision as of 14:24, 1 April 2020
Line 201:		Line 201:
	To make the module visible on your site web pages go into the Extensions / Modules listing and click on the Hello World module to edit it.		To make the module visible on your site web pages go into the Extensions / Modules listing and click on the Hello World module to edit it.
	# set the Status to Published		# set the Status to Published
	# select the Position where the module should appear (if you're unsure about which Position to set, then navigate to Extensions / Templates / Styles, check which template is assigned on your web pages, then follow [[Finding module positions on any given page\|this guide]] to finding the module positions).		# select the Position where the module should appear (if you're unsure about which Position to set, then navigate to Extensions / Templates / Styles, check which template is assigned on your web pages, then follow [[S:MyLanguage/Finding module positions on any given page\|this guide]] to finding the module positions).
	# on the Menu Assignment tab set the Module Assignment to "On all pages"		# on the Menu Assignment tab set the Module Assignment to "On all pages"
	Save and Close your edit form.</translate>		Save and Close your edit form.</translate>

MartijnM: Marked this version for translation

2020-04-01T13:58:50Z

Marked this version for translation

← Older revision		Revision as of 13:58, 1 April 2020
Line 190:		Line 190:

	<translate>		<translate>
	== Installing and Viewing the Module ==</translate>		== Installing and Viewing the Module == <!--T:42--></translate>
	<translate>		<translate>
			<!--T:43-->
	To install the module, zip up the parent directory of your source files, to create a file called <tt>mod_helloworld.zip</tt>. </translate>		To install the module, zip up the parent directory of your source files, to create a file called <tt>mod_helloworld.zip</tt>. </translate>
	<translate>		<translate>
			<!--T:44-->
	Go into Joomla admin, to the Extensions / Manage / Install form, click on the Update Package File tab, and upload your zip file. You should find that the module installs ok. If it doesn't, then compare carefully your code with the code above, and ensure your source code files are named correctly.</translate>		Go into Joomla admin, to the Extensions / Manage / Install form, click on the Update Package File tab, and upload your zip file. You should find that the module installs ok. If it doesn't, then compare carefully your code with the code above, and ensure your source code files are named correctly.</translate>
	<translate>		<translate>
			<!--T:45-->
	To make the module visible on your site web pages go into the Extensions / Modules listing and click on the Hello World module to edit it.		To make the module visible on your site web pages go into the Extensions / Modules listing and click on the Hello World module to edit it.
	# set the Status to Published		# set the Status to Published
Line 202:		Line 205:
	Save and Close your edit form.</translate>		Save and Close your edit form.</translate>
	<translate>		<translate>
			<!--T:46-->
	Now if you navigate to your site you should see "Hello, World!" displayed in your chosen module position. </translate>		Now if you navigate to your site you should see "Hello, World!" displayed in your chosen module position. </translate>

MartijnM at 13:58, 1 April 2020

2020-04-01T13:58:15Z

← Older revision		Revision as of 13:58, 1 April 2020
Line 183:		Line 183:

	<translate><!--T:35-->		<translate><!--T:35-->
	which will display an empty page.		which will display an empty page.</translate>

			<translate>
	<!--T:36-->		<!--T:36-->
	Since our module does not use any [[S:MyLanguage/Form_field\|form fields]], the config section is empty.</translate>		Since our module does not use any [[S:MyLanguage/Form_field\|form fields]], the config section is empty.</translate>

	== Installing and Viewing the Module ==		<translate>
			== Installing and Viewing the Module ==</translate>
	To install the module, zip up the parent directory of your source files, to create a file called <tt>mod_helloworld.zip</tt>.		<translate>
			To install the module, zip up the parent directory of your source files, to create a file called <tt>mod_helloworld.zip</tt>. </translate>
	Go into Joomla admin, to the Extensions / Manage / Install form, click on the Update Package File tab, and upload your zip file. You should find that the module installs ok. If it doesn't, then compare carefully your code with the code above, and ensure your source code files are named correctly.		<translate>
			Go into Joomla admin, to the Extensions / Manage / Install form, click on the Update Package File tab, and upload your zip file. You should find that the module installs ok. If it doesn't, then compare carefully your code with the code above, and ensure your source code files are named correctly.</translate>
			<translate>
	To make the module visible on your site web pages go into the Extensions / Modules listing and click on the Hello World module to edit it.		To make the module visible on your site web pages go into the Extensions / Modules listing and click on the Hello World module to edit it.
	# set the Status to Published		# set the Status to Published
	# select the Position where the module should appear (if you're unsure about which Position to set, then navigate to Extensions / Templates / Styles, check which template is assigned on your web pages, then follow [[Finding module positions on any given page\|this guide]] to finding the module positions).		# select the Position where the module should appear (if you're unsure about which Position to set, then navigate to Extensions / Templates / Styles, check which template is assigned on your web pages, then follow [[Finding module positions on any given page\|this guide]] to finding the module positions).
	# on the Menu Assignment tab set the Module Assignment to "On all pages"		# on the Menu Assignment tab set the Module Assignment to "On all pages"
	Save and Close your edit form.		Save and Close your edit form.</translate>
			<translate>
	Now if you navigate to your site you should see "Hello, World!" displayed in your chosen module position.		Now if you navigate to your site you should see "Hello, World!" displayed in your chosen module position. </translate>

	<translate>== Conclusion == <!--T:37-->		<translate>== Conclusion == <!--T:37-->
			</translate>
			<translate>
	<!--T:38-->		<!--T:38-->
	Module development for Joomla! is a fairly simple, straightforward process. Using the techniques described in this tutorial, an endless variety of modules can be developed with little hassle.</translate>		Module development for Joomla! is a fairly simple, straightforward process. Using the techniques described in this tutorial, an endless variety of modules can be developed with little hassle.</translate>

Robbiej: Added instructions on installing and viewing the module

2019-08-16T16:55:30Z

Added instructions on installing and viewing the module

@@ Line 187: / Line 187: @@
 <!--T:36-->
 Since our module does not use any [[S:MyLanguage/Form_field|form fields]], the config section is empty.</translate>
 <translate>== Conclusion == <!--T:37-->

Cmb: Changed 'plugin' to 'component.' Clarified the 'defined('_JEXEC') or die' statement Some minor grammatical edits.

2019-06-19T18:18:09Z

Changed 'plugin' to 'component.' Clarified the 'defined('_JEXEC') or die' statement Some minor grammatical edits.

← Older revision		Revision as of 18:18, 19 June 2019
Line 33:		Line 33:
	* include the helper.php file which contains the class to be used to collect the necessary data		* include the helper.php file which contains the class to be used to collect the necessary data
	* invoke the appropriate helper class method to retrieve the data		* invoke the appropriate helper class method to retrieve the data
	* include the template to display the output.</translate>		* include the template to display the output</translate>

	<translate><!--T:13-->		<translate><!--T:13-->
Line 44:		Line 44:

	<translate><!--T:15-->		<translate><!--T:15-->
	Our helper class has not been defined yet, but when it is, it will contain one method: getHello(). For our basic example, it is not really necessary to do ~~this - the~~ “Hello, World” message that this method returns could simply be included in the template. We use a helper class here to demonstrate this basic technique.</translate>		Our helper class has not been defined yet, but when it is, it will contain one method: getHello(). For our basic example, it is not really necessary to do this—the “Hello, World” message that this method returns could simply be included in the template. We use a helper class here to demonstrate this basic technique.</translate>

	<translate><!--T:16-->		<translate><!--T:16-->
Line 80:		Line 80:
	$hello = modHelloWorldHelper::getHello($params);		$hello = modHelloWorldHelper::getHello($params);
	require JModuleHelper::getLayoutPath('mod_helloworld');		require JModuleHelper::getLayoutPath('mod_helloworld');

	</source>		</source>

	<translate><!--T:20-->		<translate><!--T:20-->
	The one line that we haven’t explained so far is the ~~first~~ line. This line ~~checks to make sure~~ that this file is being ~~included~~ from the Joomla! application. This is necessary to prevent variable injection and other ~~potential~~ security ~~concerns~~.</translate>		The one line that we haven’t explained so far is the <tt>defined('_JEXEC') or die;</tt> line. This line ensures that this file is being invoked from the Joomla! application. This is necessary to prevent variable injection and other security vulnerabilities.</translate>

	<translate>== Creating helper.php == <!--T:21--></translate>		<translate>== Creating helper.php == <!--T:21--></translate>
Line 121:		Line 120:
	}		}
	}		}

	</source>		</source>

	<translate><!--T:24-->		<translate><!--T:24-->
	There is no rule stating that we must name our helper class as we have, but it is helpful to do this so that ~~it is~~ easily ~~identifiable~~ and ~~locatable~~. Note that it is required to be in this format if you plan to use the com_ajax ~~plugin~~.</translate>		There is no rule stating that we must name our helper class as we have, but it is helpful to do this so that can be easily identified and located. Note that it is required to be in this format if you plan to use the com_ajax component.</translate>

	<translate><!--T:25-->		<translate><!--T:25-->

Chiessyer: grammar

2017-05-31T15:18:31Z

grammar

← Older revision		Revision as of 15:18, 31 May 2017
Line 3:		Line 3:
	en</translate>}}		en</translate>}}
	<translate><!--T:2-->		<translate><!--T:2-->
	~~A module is a~~ lightweight and flexible ~~extension~~. They are used for small bits of the page that are generally less complex and are able to be seen across different components.</translate>		Modules are lightweight and flexible extensions. They are used for small bits of the page that are generally less complex and are able to be seen across different components.</translate>

	<translate><!--T:3-->		<translate><!--T:3-->

Vlado.repic at 14:55, 22 May 2017

2017-05-22T14:55:27Z

← Older revision		Revision as of 14:55, 22 May 2017
Line 89:		Line 89:

	<translate><!--T:22-->		<translate><!--T:22-->
	The <tt>helper.php</tt> file contains ~~that~~ helper class that is used to retrieve the data to be displayed in the module output. As stated earlier, our helper class will have one method: getHello(). This method will return the ‘Hello, World’ message.</translate>		The <tt>helper.php</tt> file contains the helper class that is used to retrieve the data to be displayed in the module output. As stated earlier, our helper class will have one method: getHello(). This method will return the ‘Hello, World’ message.</translate>

	<translate><!--T:23-->		<translate><!--T:23-->

MATsxm: Marked this version for translation

2015-08-28T16:30:59Z

Marked this version for translation

← Older revision		Revision as of 16:30, 28 August 2015
Line 27:		Line 27:
	* <code>tmpl/default.php</code> - This is the module template. This file will take the data collected by mod_helloworld.php and generate the HTML to be displayed on the page.</translate>		* <code>tmpl/default.php</code> - This is the module template. This file will take the data collected by mod_helloworld.php and generate the HTML to be displayed on the page.</translate>

	<translate>== Creating mod_helloworld.php ==<!--T:11--></translate>		<translate>== Creating mod_helloworld.php == <!--T:11--></translate>

	<translate><!--T:12-->		<translate><!--T:12-->

Abulafia at 15:57, 28 August 2015

2015-08-28T15:57:31Z

← Older revision		Revision as of 15:57, 28 August 2015
Line 27:		Line 27:
	* <code>tmpl/default.php</code> - This is the module template. This file will take the data collected by mod_helloworld.php and generate the HTML to be displayed on the page.</translate>		* <code>tmpl/default.php</code> - This is the module template. This file will take the data collected by mod_helloworld.php and generate the HTML to be displayed on the page.</translate>

	<translate><!--T:11-->		<translate>== Creating mod_helloworld.php ==<!--T:11--></translate>
	~~== Creating mod_helloworld.php ==~~</translate>

	<translate><!--T:12-->		<translate><!--T:12-->