J1.5:Creating a simple module - Revision history

Wilsonge: Merge in Creating a Hello World Module tutorial

2013-04-29T22:11:35Z

Merge in Creating a Hello World Module tutorial

@@ Line 1: / Line 1: @@
 {{version/tutor|1.5}}
 == Basic Hello World Module ==
@@ Line 293: / Line 309: @@
 This is meant as an example and it can be extended in various ways.
 However - If you do that, you should also ask yourself if this is the right way to do things. Components do have real installers and this could be the best solution even though a module can be quicker to do.
 [[Category:Archived version Joomla! 1.5]]

Tom Hutchison: added Category:Archived version Joomla! 1.5 using HotCat

2013-04-29T20:58:32Z

added Category:Archived version Joomla! 1.5 using HotCat

← Older revision		Revision as of 20:58, 29 April 2013
Line 293:		Line 293:
	This is meant as an example and it can be extended in various ways.		This is meant as an example and it can be extended in various ways.
	However - If you do that, you should also ask yourself if this is the right way to do things. Components do have real installers and this could be the best solution even though a module can be quicker to do.		However - If you do that, you should also ask yourself if this is the right way to do things. Components do have real installers and this could be the best solution even though a module can be quicker to do.

			[[Category:Archived version Joomla! 1.5]]

Tom Hutchison: removing review

2013-04-29T20:58:20Z

removing review

← Older revision		Revision as of 20:58, 29 April 2013
Line 1:		Line 1:
	{{version/tutor\|1.5~~}}{{review~~}}		{{version/tutor\|1.5}}
	== Basic Hello World Module ==		== Basic Hello World Module ==

Line 293:		Line 293:
	This is meant as an example and it can be extended in various ways.		This is meant as an example and it can be extended in various ways.
	However - If you do that, you should also ask yourself if this is the right way to do things. Components do have real installers and this could be the best solution even though a module can be quicker to do.		However - If you do that, you should also ask yourself if this is the right way to do things. Components do have real installers and this could be the best solution even though a module can be quicker to do.

	~~[[Category:Tutorials]]~~
	~~[[Category:Module Development]]~~

Wilsonge: Wilsonge moved page Creating a simple module to J1.5:Creating a simple module: Move to 1.5 namespace

2013-04-29T20:30:59Z

Wilsonge moved page Creating a simple module to J1.5:Creating a simple module: Move to 1.5 namespace

← Older revision	Revision as of 20:30, 29 April 2013
(No difference)

Tom Hutchison: version tutorial template

2012-09-18T17:45:27Z

version tutorial template

← Older revision		Revision as of 17:45, 18 September 2012
Line 1:		Line 1:
	{{review}}		{{version/tutor\|1.5}}{{review}}
	== Basic Hello World Module ==		== Basic Hello World Module ==

Mvangeest: Removed category

2011-01-16T00:12:59Z

Removed category

← Older revision		Revision as of 00:12, 16 January 2011
Line 294:		Line 294:
	However - If you do that, you should also ask yourself if this is the right way to do things. Components do have real installers and this could be the best solution even though a module can be quicker to do.		However - If you do that, you should also ask yourself if this is the right way to do things. Components do have real installers and this could be the best solution even though a module can be quicker to do.

			[[Category:Tutorials]]
	~~<noinclude>~~[[Category:~~Development~~]]~~</noinclude>~~		[[Category:Module Development]]
	~~[[Category:Tutorials]]~~ [[Category:Module Development]]

Mvangeest: How to create a module moved to Creating a simple module: Adapted page title to the continuous tense used in most tutorial titles.

2011-01-16T00:12:14Z

How to create a module moved to Creating a simple module: Adapted page title to the continuous tense used in most tutorial titles.

← Older revision	Revision as of 00:12, 16 January 2011
(No difference)

Littlejohn: /* Joomla! 1.5 Database installation usage */

2010-10-27T10:53:46Z

Joomla! 1.5 Database installation usage

← Older revision		Revision as of 10:53, 27 October 2010
Line 274:		Line 274:


	Then you can use the parameter to switch the state ~~and since~~ parameters is already loaded from database, any overhead is not noticable.		Then you can use the parameter to switch the state.
			Since the module parameters is already loaded from the database at this point, any overhead should not be noticable this way.
	<source lang="php">		<source lang="php">
	// put this in the module function.		// put this in the module function.
Line 280:		Line 281:
	if (!$params->get('is_installed')) {		if (!$params->get('is_installed')) {
	$database =& JFactory::getDBO();		$database =& JFactory::getDBO();
	$query = "CREATE TABLE example ( id INT, data VARCHAR(100) );";		$query = "CREATE TABLE IF NOT EXISTS `example` ( `id` INT, `data` VARCHAR(100) );";

	$database->setQuery($query);		$database->setQuery($query);
Line 289:		Line 290:
	}		}
	</source>		</source>

			This is meant as an example and it can be extended in various ways.
			However - If you do that, you should also ask yourself if this is the right way to do things. Components do have real installers and this could be the best solution even though a module can be quicker to do.


	<noinclude>[[Category:Development]]</noinclude>		<noinclude>[[Category:Development]]</noinclude>
	[[Category:Tutorials]] [[Category:Module Development]]		[[Category:Tutorials]] [[Category:Module Development]]

Littlejohn at 10:44, 27 October 2010

2010-10-27T10:44:45Z

@@ Line 256: / Line 256: @@
 The resulting mod_hello_world2.zip file is ready for installation and distribution. When the ZIP file is installed, the en-GB.mod_hello_world2.ini file is copied to /language/en-GB/en-GB.mod_hello_world2.ini and is loaded each time the module is loaded. All of the other files are copied to the /modules/mod_hello_world2 subfolder of the Joomla! installation.
 <noinclude>[[Category:Development]]</noinclude>
 [[Category:Tutorials]] [[Category:Module Development]]

Littlejohn: /* Basic Hello World Module */

2010-10-27T10:42:36Z

Basic Hello World Module

← Older revision		Revision as of 10:42, 27 October 2010
Line 73:		Line 73:

	This really just helps to ensure that a default page is displayed if direct access to the directory is attempted without listing all of the other files in the directory. It's not necessary, but is good practice.		This really just helps to ensure that a default page is displayed if direct access to the directory is attempted without listing all of the other files in the directory. It's not necessary, but is good practice.

	~~Modules should in general not interact with the database except for normal operations (SELECT, UPDATE, INSERT, DELETE).~~
	~~But in some cases it might be needed to ALTER or even CREATE tables, even though it is not recommended.~~
	~~There is no common practice to this, but here is one way of doing just that:~~

	~~Add a module parameter that to the manifest:~~
	~~<source lang="xml">~~
	~~<params group="advanced">~~
	~~<param name="is_installed" type="radio" default="0" label="Is module installed?" description="Only use this if you know the consequences! Click No to recreate database">~~
	~~<option value="0">No</option>~~
	~~<option value="1">Yes</option>~~
	~~</param>~~
	~~</params>~~
	~~</source>~~


	~~Then you can use the parameter to switch the state and since parameters is already loaded from database, any overhead is not noticable.~~
	~~<source lang="php">~~
	~~// put this in the module function.~~
	~~function myModuleReInstall() {~~
	~~if (!$params->get('is_installed')) {~~
	~~$database =& JFactory::getDBO();~~
	~~$query = "CREATE TABLE example ( id INT, data VARCHAR(100) );";~~

	~~$database->setQuery($query);~~
	~~$result = $database->query();~~

	~~$params->set('is_installed', 1);~~
	}
	}
	~~</source>~~

	To package this module for distribution and installation, simply zip the files together, e.g.,		To package this module for distribution and installation, simply zip the files together, e.g.,