Class FOFUtilsUpdate

A helper Model to interact with Joomla!'s extensions update feature

FOFModel

FOFUtilsUpdate

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

Methods summary

`public`	# `__construct( array $config = array() )` Public constructor. Initialises the protected members as well. Useful $config keys: update_component The component name, e.g. com_foobar update_version The default version if the manifest cache is unreadable update_site The URL to the component's update XML stream update_extraquery The extra query to append to (commercial) components' download URLs update_sitename The update site's name (description) Public constructor. Initialises the protected members as well. Useful $config keys: update_component The component name, e.g. com_foobar update_version The default version if the manifest cache is unreadable update_site The URL to the component's update XML stream update_extraquery The extra query to append to (commercial) components' download URLs update_sitename The update site's name (description) Parameters `$config` `array` - $config Overrides `FOFModel::__construct`
`public array`	# `getUpdates( boolean $force = false, string $preferredMethod = null )` Retrieves the update information of the component, returning an array with the following keys: Retrieves the update information of the component, returning an array with the following keys: hasUpdate True if an update is available version The version of the available update infoURL The URL to the download page of the update Parameters `$force` `boolean` - $force Set to true if you want to forcibly reload the update information `$preferredMethod` `string` - $preferredMethod Preferred update method: 'joomla' or 'classic' Returns `array` - See the method description for more information
`public stdClass\|null`	# `findUpdates( boolean $force, string $preferredMethod = null )` Find the available update record object. If we're at the latest version it will return null. Find the available update record object. If we're at the latest version it will return null. Please see getUpdateMethod for information on how the $preferredMethod is handled and what it means. Parameters `$force` `boolean` - $force Should I forcibly reload the updates from the server? `$preferredMethod` `string` - $preferredMethod Preferred update method: 'joomla' or 'classic' Returns `stdClass\|null`
`public mixed`	# `getUpdateSiteIds( )` Gets the update site Ids for our extension. Gets the update site Ids for our extension. Returns `mixed` - An array of Ids or null if the query failed.
`public string`	# `getVersion( )` Get the currently installed version as reported by the #__extensions table Get the currently installed version as reported by the #__extensions table Returns `string`
`public string`	# `getComponentName( )` Returns the name of the component, e.g. com_foobar Returns the name of the component, e.g. com_foobar Returns `string`
`public string`	# `getComponentDescription( )` Returns the human readable component name, e.g. Foobar Component Returns the human readable component name, e.g. Foobar Component Returns `string`
`public integer`	# `getExtensionId( )` Returns the numeric extension ID for the component Returns the numeric extension ID for the component Returns `integer`
`public string`	# `getUpdateSite( )` Returns the update site URL, i.e. the URL to the XML update stream Returns the update site URL, i.e. the URL to the XML update stream Returns `string`
`public string`	# `getUpdateSiteName( )` Returns the human readable description of the update site Returns the human readable description of the update site Returns `string`
`public`	# `setVersion( string $version )` Override the currently installed version as reported by the #__extensions table Override the currently installed version as reported by the #__extensions table Parameters `$version` `string` - $version
`public`	# `refreshUpdateSite( )` Refreshes the Joomla! update sites for this extension as needed Refreshes the Joomla! update sites for this extension as needed
`public`	# `removeObsoleteUpdateSites( )` Removes any update sites which go by the same name or the same location as our update site but do not match the extension ID. Removes any update sites which go by the same name or the same location as our update site but do not match the extension ID.
`public string`	# `getUpdateMethod( string $preferred = null )` Get the update method we should use, 'joomla' or 'classic' Get the update method we should use, 'joomla' or 'classic' You can defined the preferred update method: 'joomla' uses JUpdater whereas 'classic' handles update caching and parsing internally. If you are on Joomla! 3.1 or earlier this option is forced to 'classic' since these old Joomla! versions couldn't handle updates of commercial components correctly (that's why I contributed the fix to that problem, the extra_query field that's present in Joomla! 3.2 onwards). If 'classic' is defined then it will be used in all Joomla! versions. It's the most stable method for fetching update information. Parameters `$preferred` `string` - $preferred Preferred update method. One of 'joomla' or 'classic'. Returns `string`
`protected stdClass\|null`	# `findUpdatesJoomla( boolean $force = false )` Find the available update record object. If we're at the latest version it will return null. Find the available update record object. If we're at the latest version it will return null. Parameters `$force` `boolean` - $force Should I forcibly reload the updates from the server? Returns `stdClass\|null`
`protected stdClass\|null`	# `findUpdatesClassic( boolean $force = false )` Find the available update record object. If we're at the latest version return null. Find the available update record object. If we're at the latest version return null. Parameters `$force` `boolean` - $force Should I forcibly reload the updates from the server? Returns `stdClass\|null`
`protected array`	# `loadUpdatesClassic( boolean $force = false )` Load all available updates without going through JUpdate Load all available updates without going through JUpdate Parameters `$force` `boolean` - $force Should I forcibly reload the updates from the server? Returns `array`
`protected mixed`	# `getCommonParameter( string $key, mixed $default = null )` Get a common parameter from the #__akeeba_common table Get a common parameter from the #__akeeba_common table Parameters `$key` `string` - $key The key to retrieve `$default` `mixed` - $default The default value in case none is set Returns `mixed` - The saved parameter value (or $default, if nothing is currently set)
`protected`	# `setCommonParameter( string $key, mixed $value )` Set a common parameter from the #__akeeba_common table Set a common parameter from the #__akeeba_common table Parameters `$key` `string` - $key The key to set `$value` `mixed` - $value The value to set
`public string`	# `doUpdateComponent( )` Proxy to updateComponent(). Required since old versions of our software had an updateComponent method declared private. If we set the updateComponent() method public we cause a fatal error. Proxy to updateComponent(). Required since old versions of our software had an updateComponent method declared private. If we set the updateComponent() method public we cause a fatal error. Returns `string`
`public string`	# `downloadUpdate( )` Downloads the latest update package to Joomla!'s temporary directory Downloads the latest update package to Joomla!'s temporary directory Returns `string` - The absolute path to the downloaded update package.
`public mixed`	# `doSendNotificationEmail( string $version, string $email )` Proxy to sendNotificationEmail(). Required since old versions of our software had a sendNotificationEmail method declared private. If we set the sendNotificationEmail() method public we cause a fatal error. Proxy to sendNotificationEmail(). Required since old versions of our software had a sendNotificationEmail method declared private. If we set the sendNotificationEmail() method public we cause a fatal error. Parameters `$version` `string` - $version The new version of our software `$email` `string` - $email The email address to send the notification to Returns `mixed` - The result of JMail::send()

Methods inherited from FOFModel

__call(), __get(), __set(), _createFileName(), _createTable(), _getList(), _getListCount(), _real_getState(), addBehavior(), addIncludePath(), addTablePath(), applyAccessFiltering(), blacklistFilters(), buildCountQuery(), buildQuery(), checkin(), checkout(), cleanCache(), clearInput(), clearState(), copy(), delete(), findFormFilename(), getAnInstance(), getBehaviorParam(), getClone(), getDbo(), getFirstItem(), getForm(), getHash(), getId(), getIds(), getItem(), getItemList(), getIterator(), getList(), getName(), getPagination(), getReorderWhere(), getSavedTable(), getState(), getTable(), getTableAlias(), getTableFields(), getTmpInstance(), getTotal(), getUserStateFromRequest(), hit(), isCheckedOut(), loadForm(), loadFormData(), loadhistory(), move(), onAfterCopy(), onAfterDelete(), onAfterGetItem(), onAfterHit(), onAfterLoadForm(), onAfterMove(), onAfterPreprocessForm(), onAfterPublish(), onAfterReorder(), onAfterSave(), onBeforeCopy(), onBeforeDelete(), onBeforeHit(), onBeforeLoadForm(), onBeforeMove(), onBeforePreprocessForm(), onBeforePublish(), onBeforeReorder(), onBeforeSave(), onProcessList(), populateSavestate(), populateState(), preprocessForm(), publish(), reorder(), reset(), resetSavedState(), save(), savestate(), setBehaviorParam(), setDbo(), setIDsFromRequest(), setId(), setIds(), setInput(), setState(), validateForm()

Methods inherited from FOFUtilsObject

__toString(), def(), get(), getError(), getErrors(), getProperties(), set(), setError(), setProperties()

Magic methods summary

Properties summary

`protected JUpdater`	`$updater`	# The Joomla! updater object The Joomla! updater object
`protected integer`	`$extension_id`	# The extension_id of this component The extension_id of this component
`protected string`	`$version`	# The currently installed version, as reported by the #__extensions table The currently installed version, as reported by the #__extensions table
`protected string`	`$component`	# The machine readable name of the component e.g. com_something The machine readable name of the component e.g. com_something
`protected string`	`$componentDescription`	# The human readable name of the component e.g. Your Component's Name. Used for emails. The human readable name of the component e.g. Your Component's Name. Used for emails.
`protected string`	`$updateSite`	# The URL to the component's update XML stream The URL to the component's update XML stream
`protected string`	`$updateSiteName`	# The name to the component's update site (description of the update XML stream) The name to the component's update site (description of the update XML stream)
`protected string`	`$extraQuery`	# The extra query to append to (commercial) components' download URLs The extra query to append to (commercial) components' download URLs
`protected string`	`$commonKey`	# The common parameters' key, used for storing data in the #__akeeba_common table The common parameters' key, used for storing data in the #__akeeba_common table
`protected string`	`$commonTable`	# The common parameters table. It's a simple table with key(VARCHAR) and value(LONGTEXT) fields. Here is an example MySQL CREATE TABLE command to make this kind of table: The common parameters table. It's a simple table with key(VARCHAR) and value(LONGTEXT) fields. Here is an example MySQL CREATE TABLE command to make this kind of table: CREATE TABLE `#__akeeba_common` ( `key` varchar(255) NOT NULL, `value` longtext NOT NULL, PRIMARY KEY (`key`) ) DEFAULT COLLATE utf8_general_ci CHARSET=utf8;
`protected string`	`$updateEmailSubject`	# Subject of the component update emails Subject of the component update emails
`protected string`	`$updateEmailBody`	# Body of the component update email Body of the component update email

Properties inherited from FOFModel

$__state_set, $_behaviorParams, $_db, $_formData, $_forms, $_savestate, $configProvider, $default_behaviors, $event_after_delete, $event_after_save, $event_before_delete, $event_before_save, $event_change_state, $event_clean_cache, $id, $id_list, $input, $list, $modelDispatcher, $name, $option, $otable, $pagination, $record, $state, $table, $total

Properties inherited from FOFUtilsObject

$_errors

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class FOFUtilsUpdate

Methods summary

Parameters

Overrides

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Methods inherited from FOFModel

Methods inherited from FOFUtilsObject

Magic methods summary

Properties summary

Properties inherited from FOFModel

Properties inherited from FOFUtilsObject