Class FOFUtilsUpdateCollection

A helper class to read and parse "collection" update XML files over the web

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/collection.php

Methods summary

`public array`	# `getAllUpdates( string $url, string $jVersion = null )` Reads a "collection" XML update source and returns the complete tree of categories and extensions applicable for platform version $jVersion Reads a "collection" XML update source and returns the complete tree of categories and extensions applicable for platform version $jVersion 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 `array` - A list of update sources applicable to $jVersion
`public array`	# `getCategories( string $url, string $jVersion = null )` Returns only the category definitions of a collection Returns only the category definitions of a collection Parameters `$url` `string` - $url The URL of the collection update source `$jVersion` `string` - $jVersion Joomla! version to fetch updates for, or null to use JVERSION Returns `array` - An array of category update definitions
`public string\|null`	# `getCategoryUpdateSource( string $url, string $category, string $jVersion = null )` Returns the update source for a specific category Returns the update source for a specific category Parameters `$url` `string` - $url The URL of the collection update source `$category` `string` - $category The category name you want to get the update source URL of `$jVersion` `string` - $jVersion Joomla! version to fetch updates for, or null to use JVERSION Returns `string\|null` - The update stream URL, or null if it's not found
`public array\|null`	# `getExtensions( string $url, string $type = null, string $jVersion = null )` Get a list of updates for extensions only, optionally of a specific type Get a list of updates for extensions only, optionally of a specific type Parameters `$url` `string` - $url The URL of the collection update source `$type` `string` - $type The extension type you want to get the update source URL of, empty to get all extension types `$jVersion` `string` - $jVersion Joomla! version to fetch updates for, or null to use JVERSION Returns `array\|null` - An array of extension update definitions or null if none is found
`public string\|null`	# `getExtensionUpdateSource( string $url, string $type, string $element, string $jVersion = null )` Get the update source URL for a specific extension, based on the type and element, e.g. type=file and element=joomla is Joomla! itself. Get the update source URL for a specific extension, based on the type and element, e.g. type=file and element=joomla is Joomla! itself. Parameters `$url` `string` - $url The URL of the collection update source `$type` `string` - $type The extension type you want to get the update source URL of `$element` `string` - $element The extension element you want to get the update source URL of `$jVersion` `string` - $jVersion Joomla! version to fetch updates for, or null to use JVERSION Returns `string\|null` - The update source URL or null if the extension is not found

`public array`	# `getAllUpdates( string $url, string $jVersion = null )` Reads a "collection" XML update source and returns the complete tree of categories and extensions applicable for platform version $jVersion Reads a "collection" XML update source and returns the complete tree of categories and extensions applicable for platform version $jVersion 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 `array` - A list of update sources applicable to $jVersion
`public array`	# `getCategories( string $url, string $jVersion = null )` Returns only the category definitions of a collection Returns only the category definitions of a collection Parameters `$url` `string` - $url The URL of the collection update source `$jVersion` `string` - $jVersion Joomla! version to fetch updates for, or null to use JVERSION Returns `array` - An array of category update definitions
`public string\|null`	# `getCategoryUpdateSource( string $url, string $category, string $jVersion = null )` Returns the update source for a specific category Returns the update source for a specific category Parameters `$url` `string` - $url The URL of the collection update source `$category` `string` - $category The category name you want to get the update source URL of `$jVersion` `string` - $jVersion Joomla! version to fetch updates for, or null to use JVERSION Returns `string\|null` - The update stream URL, or null if it's not found
`public array\|null`	# `getExtensions( string $url, string $type = null, string $jVersion = null )` Get a list of updates for extensions only, optionally of a specific type Get a list of updates for extensions only, optionally of a specific type Parameters `$url` `string` - $url The URL of the collection update source `$type` `string` - $type The extension type you want to get the update source URL of, empty to get all extension types `$jVersion` `string` - $jVersion Joomla! version to fetch updates for, or null to use JVERSION Returns `array\|null` - An array of extension update definitions or null if none is found
`public string\|null`	# `getExtensionUpdateSource( string $url, string $type, string $element, string $jVersion = null )` Get the update source URL for a specific extension, based on the type and element, e.g. type=file and element=joomla is Joomla! itself. Get the update source URL for a specific extension, based on the type and element, e.g. type=file and element=joomla is Joomla! itself. Parameters `$url` `string` - $url The URL of the collection update source `$type` `string` - $type The extension type you want to get the update source URL of `$element` `string` - $element The extension element you want to get the update source URL of `$jVersion` `string` - $jVersion Joomla! version to fetch updates for, or null to use JVERSION Returns `string\|null` - The update source URL or null if the extension is not found

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class FOFUtilsUpdateCollection

Methods summary

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Magic methods summary