Class FOFUtilsUpdateJoomla

A helper class which provides update information for the Joomla! CMS itself. This is slightly different than the regular "extension" files as we need to know if a Joomla! version is STS, LTS, testing, current and so on.

FOFUtilsUpdateExtension

FOFUtilsUpdateJoomla

Package: FrameworkOnFramework\utils
Copyright: Copyright (C) 2010-2016 Nicholas K. Dionysopoulos / Akeeba Ltd. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Located at fof/utils/update/joomla.php

Methods summary

`public array`	# `getUpdatesFromExtension( string $url )` Reads an "extension" XML update source and returns all listed update entries. Reads an "extension" XML update source and returns all listed update entries. If you have a "collection" XML update source you should do something like this: $collection = new CmsupdateHelperCollection(); $extensionUpdateURL = $collection->getExtensionUpdateSource($url, 'component', 'com_foobar', JVERSION); $extension = new CmsupdateHelperExtension(); $updates = $extension->getUpdatesFromExtension($extensionUpdateURL); Parameters `$url` `string` - $url The extension XML update source URL to read from Returns `array` - An array of update entries Overrides `FOFUtilsUpdateExtension::getUpdatesFromExtension`
`public string`	# `getUpdateSourceFromCollection( string $url, string $jVersion = null )` Reads a "collection" XML update source and picks the correct source URL for the extension update source. Reads a "collection" XML update source and picks the correct source URL for the extension update source. Parameters `$url` `string` - $url The collection XML update source URL to read from `$jVersion` `string` - $jVersion Joomla! version to fetch updates for, or null to use JVERSION Returns `string` - The URL of the extension update source, or empty if no updates are provided / fetching failed
`public array`	# `getVersionProperties( string $jVersion, string $currentVersion = null )` Determines the properties of a version: STS/LTS, normal or testing Determines the properties of a version: STS/LTS, normal or testing Parameters `$jVersion` `string` - $jVersion The version number to check `$currentVersion` `string` - $currentVersion The current Joomla! version number Returns `array` - The properties analysis
`public array`	# `filterApplicableUpdates( array $updates, string $jVersion = null )` Filters a list of updates, making sure they apply to the specifed CMS release. Filters a list of updates, making sure they apply to the specifed CMS release. Parameters `$updates` `array` - $updates A list of update records returned by the getUpdatesFromExtension method `$jVersion` `string` - $jVersion The current Joomla! version number Returns `array` - A filtered list of updates. Each update record also includes version relevance information.
`public string`	# `sanitiseVersion( string $version )` Joomla! has a lousy track record in naming its alpha, beta and release candidate releases. The convention used seems to be "what the hell the current package maintainer thinks looks better". This method tries to figure out what was in the mind of the maintainer and translate the funky version number to an actual PHP-format version string. Joomla! has a lousy track record in naming its alpha, beta and release candidate releases. The convention used seems to be "what the hell the current package maintainer thinks looks better". This method tries to figure out what was in the mind of the maintainer and translate the funky version number to an actual PHP-format version string. Parameters `$version` `string` - $version The whatever-format version number Returns `string` - A standard formatted version number
`public array`	# `getUpdates( array $sources = array(), string $jVersion = null )` Reloads the list of all updates available for the specified Joomla! version from the network. Reloads the list of all updates available for the specified Joomla! version from the network. Parameters `$sources` `array` - $sources The enabled sources to look into `$jVersion` `string` - $jVersion The Joomla! version we are checking updates for Returns `array` - A list of updates for the installed, current, lts and sts versions

Magic methods summary

Properties summary

`protected static string`	`$lts_url`	# The source for LTS updates The source for LTS updates
`protected static string`	`$sts_url`	# The source for STS updates The source for STS updates
`protected static string`	`$test_url`	# The source for test release updates The source for test release updates

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class FOFUtilsUpdateJoomla

Methods summary

Parameters

Returns

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Magic methods summary

Properties summary