Archived:Managing Component Updates (Script.php) - Revision history

M-b-o: M-b-o moved page J2.5:Managing Component Updates (Script.php) to Archived:Managing Component Updates (Script.php)

2022-04-26T22:21:11Z

M-b-o moved page J2.5:Managing Component Updates (Script.php) to Archived:Managing Component Updates (Script.php)

← Older revision	Revision as of 22:21, 26 April 2022
(No difference)

Tom Hutchison: Hutchy68 moved page Managing Component Updates with Joomla!2.5 - Part 3 to J2.5:Managing Component Updates (Script.php): namespacing for version

2013-05-24T12:04:24Z

Hutchy68 moved page Managing Component Updates with Joomla!2.5 - Part 3 to J2.5:Managing Component Updates (Script.php): namespacing for version

← Older revision	Revision as of 12:04, 24 May 2013
(No difference)

Wilsonge: Remove 1.6 and 1.7 tags

2013-04-29T13:03:13Z

Remove 1.6 and 1.7 tags

← Older revision		Revision as of 13:03, 29 April 2013
Line 1:		Line 1:
	{{version/tutor\|~~1.6,1.7,~~2.5}}{{Chunk:Managing Component Updates - Contents}}{{review}}		{{version/tutor\|2.5}}{{Chunk:Managing Component Updates - Contents}}{{review}}

	== Script.php ==		== Script.php ==

Wilsonge: Wilsonge moved page Managing Component Updates with Joomla!1.6 - Part 3 to Managing Component Updates with Joomla!2.5 - Part 3: Joomla 2.5 is the LTS release

2013-02-01T00:59:31Z

Wilsonge moved page Managing Component Updates with Joomla!1.6 - Part 3 to Managing Component Updates with Joomla!2.5 - Part 3: Joomla 2.5 is the LTS release

← Older revision	Revision as of 00:59, 1 February 2013
(No difference)

Tom Hutchison: page update for series

2012-09-18T14:05:51Z

page update for series

@@ Line 1: / Line 1: @@
-{{review}}
+{{version/tutor|1.6,1.7,2.5}}{{Chunk:Managing Component Updates - Contents}}{{review}}
 == Script.php ==
@@ Line 261: / Line 252: @@
 [[Category:Joomla! 1.7]]
 [[Category:Joomla! 2.5]]
 [[Category:Component Development]]

Sm990: /* Script.php */

2012-07-01T01:56:33Z

Script.php

← Older revision		Revision as of 01:56, 1 July 2012
Line 12:		Line 12:
	== Script.php ==		== Script.php ==
	This file contains the component-specific methods preflight, install, update, postflight and uninstall. This file is where the component developer implements all of the unique code for these actions.		This file contains the component-specific methods preflight, install, update, postflight and uninstall. This file is where the component developer implements all of the unique code for these actions.
	For this example, in addition to various checks, HTML is inserted into the back-end output to show which code has been executed. You may choose to display different HTML, or to display none for your component.		For this example, in addition to various checks, HTML is inserted into the back-end output to show which code has been executed and several component parameters are created and maintained. You may choose to display different HTML, or to display none for your component.

	=== preflight ===		=== preflight ===

Sm990: /* The entire script.php file */

2012-06-10T21:20:12Z

The entire script.php file

← Older revision		Revision as of 21:20, 10 June 2012
Line 116:		Line 116:

	== The entire script.php file ==		== The entire script.php file ==
	This is the entire script.php file. It is the same for al versions of com_democompupdate.		This is the entire script.php file. It is the same for all versions of com_democompupdate.
	<source lang="php">		<source lang="php">
	<?php		<?php

Sm990: /* The entire script.php file */

2012-06-10T21:19:59Z

The entire script.php file

← Older revision		Revision as of 21:19, 10 June 2012
Line 116:		Line 116:

	== The entire script.php file ==		== The entire script.php file ==
	This is the entire script.php file for ~~version 1.0~~.		This is the entire script.php file. It is the same for al versions of com_democompupdate.
	<source lang="php">		<source lang="php">
	<?php		<?php

Sm990: /* The entire script.php file */

2012-06-10T21:19:07Z

The entire script.php file

← Older revision		Revision as of 21:19, 10 June 2012
Line 117:		Line 117:
	== The entire script.php file ==		== The entire script.php file ==
	This is the entire script.php file for version 1.0.		This is the entire script.php file for version 1.0.
	~~Note the definition of the variable ''$release''.~~
	<source lang="php">		<source lang="php">
	<?php		<?php

Sm990: /* The entire script.php file */

2012-06-10T21:18:47Z

The entire script.php file

← Older revision		Revision as of 21:18, 10 June 2012
Line 122:		Line 122:
	// No direct access to this file		// No direct access to this file
	defined('_JEXEC') or die('Restricted access');		defined('_JEXEC') or die('Restricted access');

	//the name of the class must be the name of your component + InstallerScript		//the name of the class must be the name of your component + InstallerScript
	//for example: com_contentInstallerScript for com_content.		//for example: com_contentInstallerScript for com_content.
	class com_democompupdateInstallerScript		class com_democompupdateInstallerScript
	{		{
	/*
	* The release value to be displayed and checked against throughout this file.
	*/
	~~private $release = '1.0';~~

	/*
	* Find mimimum required joomla version for this extension. It will be read from the version attribute (install tag) in the manifest file
	*/
	~~private $minimum_joomla_release = '1.6.0';~~

	/*		/*
	* $parent is the class calling this method.		* $parent is the class calling this method.
Line 144:		Line 134:
	*/		*/
	function preflight( $type, $parent ) {		function preflight( $type, $parent ) {
	~~// this component does not work with Joomla releases prior to 1.6~~
	~~// abort if the current Joomla release is older~~
	$jversion = new JVersion();		$jversion = new JVersion();

	// ~~Extract the~~ version ~~number from the manifest. This will overwrite the 1.0 value set above~~		// Installing component manifest file version
	$this->release=$parent->get("manifest")->version;		$this->release = $parent->get( "manifest" )->version;

	// ~~Find mimimum required joomla~~ version		// Manifest file minimum Joomla version
	$this->minimum_joomla_release=$parent->get("manifest")->attributes()->version;		$this->minimum_joomla_release = $parent->get( "manifest" )->attributes()->version;

			// Show the essential information at the install/update back-end
			echo '<p>Installing component manifest file version = ' . $this->release;
			echo '<br />Current manifest cache commponent version = ' . $this->getParam('version');
			echo '<br />Installing component manifest file minimum Joomla version = ' . $this->minimum_joomla_release;
			echo '<br />Current Joomla version = ' . $jversion->getShortVersion();

			// abort if the current Joomla release is older
	if( version_compare( $jversion->getShortVersion(), $this->minimum_joomla_release, 'lt' ) ) {		if( version_compare( $jversion->getShortVersion(), $this->minimum_joomla_release, 'lt' ) ) {
	Jerror::raiseWarning(null, 'Cannot install com_democompupdate in a Joomla release prior to '.$this->minimum_joomla_release);		Jerror::raiseWarning(null, 'Cannot install com_democompupdate in a Joomla release prior to '.$this->minimum_joomla_release);
	return false;		return false;
	}		}

	// abort if the component being installed is not newer than the currently installed version		// abort if the component being installed is not newer than the currently installed version
	if ( $type == 'update' ) {		if ( $type == 'update' ) {
Line 169:		Line 164:
	}		}
	else { $rel = $this->release; }		else { $rel = $this->release; }

	echo '<p>' . JText::_('COM_DEMOCOMPUPDATE_PREFLIGHT_' . $type . ' ' . $rel) . '</p>';		echo '<p>' . JText::_('COM_DEMOCOMPUPDATE_PREFLIGHT_' . $type . ' ' . $rel) . '</p>';
	}		}

	/*		/*
	* $parent is the class calling this method.		* $parent is the class calling this method.
Line 184:		Line 179:
	// $parent->getParent()->setRedirectURL('index.php?option=com_democompupdate');		// $parent->getParent()->setRedirectURL('index.php?option=com_democompupdate');
	}		}

	/*		/*
	* $parent is the class calling this method.		* $parent is the class calling this method.
Line 193:		Line 188:
	function update( $parent ) {		function update( $parent ) {
	echo '<p>' . JText::_('COM_DEMOCOMPUPDATE_UPDATE_ to ' . $this->release) . '</p>';		echo '<p>' . JText::_('COM_DEMOCOMPUPDATE_UPDATE_ to ' . $this->release) . '</p>';
			// You can have the backend jump directly to the newly updated component configuration page
			// $parent->getParent()->setRedirectURL('index.php?option=com_democompupdate');
	}		}

	/*		/*
	* $parent is the class calling this method.		* $parent is the class calling this method.
Line 223:		Line 220:
	echo '<p>' . JText::_('COM_DEMOCOMPUPDATE_UNINSTALL ' . $this->release) . '</p>';		echo '<p>' . JText::_('COM_DEMOCOMPUPDATE_UNINSTALL ' . $this->release) . '</p>';
	}		}

	/*		/*
	* get a variable from the manifest file (actually, from the manifest cache).		* get a variable from the manifest file (actually, from the manifest cache).
Line 229:		Line 226:
	function getParam( $name ) {		function getParam( $name ) {
	$db = JFactory::getDbo();		$db = JFactory::getDbo();
	$db->setQuery('SELECT manifest_cache FROM #__extensions WHERE name = ~~'.$db->quote('~~com_democompupdate'));		$db->setQuery('SELECT manifest_cache FROM #__extensions WHERE name = "com_democompupdate"');
	$manifest = json_decode( $db->loadResult(), true );		$manifest = json_decode( $db->loadResult(), true );
	return $manifest[ $name ];		return $manifest[ $name ];
	}		}

	/*		/*
	* sets parameter values in the component's row of the extension table		* sets parameter values in the component's row of the extension table
Line 241:		Line 238:
	// read the existing component value(s)		// read the existing component value(s)
	$db = JFactory::getDbo();		$db = JFactory::getDbo();
	$db->setQuery('SELECT params FROM #__extensions WHERE name = ~~'.$db->quote('~~com_democompupdate'));		$db->setQuery('SELECT params FROM #__extensions WHERE name = "com_democompupdate"');
	$params = json_decode( $db->loadResult(), true );		$params = json_decode( $db->loadResult(), true );
	// add the new variable(s) to the existing one(s)		// add the new variable(s) to the existing one(s)
Line 251:		Line 248:
	$db->setQuery('UPDATE #__extensions SET params = ' .		$db->setQuery('UPDATE #__extensions SET params = ' .
	$db->quote( $paramsString ) .		$db->quote( $paramsString ) .
	' WHERE name = ~~'.$db->quote('~~com_democompupdate'));		' WHERE name = "com_democompupdate"' );
	$db->query();		$db->query();
	}		}
	}		}
	}		}

	</source>		</source>