Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe FOFUtilsUpdate
+ Graphe d'héritage de FOFUtilsUpdate:

Fonctions membres publiques

 __construct ($config=array())
 
 getUpdates ($force=false, $preferredMethod=null)
 
 findUpdates ($force, $preferredMethod=null)
 
 getUpdateSiteIds ()
 
 getVersion ()
 
 getComponentName ()
 
 getComponentDescription ()
 
 getExtensionId ()
 
 getUpdateSite ()
 
 getUpdateSiteName ()
 
 setVersion ($version)
 
 removeObsoleteUpdateSites ()
 
 getUpdateMethod ($preferred=null)
 
 doUpdateComponent ()
 
 downloadUpdate ()
 
 doSendNotificationEmail ($version, $email)
 
- Fonctions membres publiques hérités de FOFModel
 addBehavior ($name, $config=array())
 
 __construct ($config=array())
 
 setIDsFromRequest ()
 
 setId ($id=0)
 
 getId ()
 
 setIds ($idlist)
 
 getIds ()
 
 reset ()
 
 clearState ()
 
 clearInput ()
 
 setInput ($input)
 
 resetSavedState ()
 
 loadhistory ($version_id, FOFTable &$table, $alias)
 
getItem ($id=null)
 
getList ($overrideLimits=false, $group='')
 
getItemList ($overrideLimits=false, $group='')
 
getIterator ($overrideLimits=false, $tableClass=null)
 
getFirstItem ($overrideLimits=false)
 
 save ($data)
 
 copy ()
 
 getSavedTable ()
 
 delete ()
 
 publish ($publish=1, $user=null)
 
 checkout ()
 
 checkin ()
 
 isCheckedOut ()
 
 hit ()
 
 move ($dirn)
 
 reorder ()
 
 getPagination ()
 
 getTotal ()
 
 getState ($key=null, $default=null, $filter_type='raw')
 
 getHash ()
 
 getTable ($name='', $prefix=null, $options=array())
 
 getReorderWhere ()
 
 buildQuery ($overrideLimits=false)
 
 getTableFields ()
 
 getTableAlias ()
 
 buildCountQuery ()
 
getClone ()
 
 __get ($name)
 
 __set ($name, $value)
 
 __call ($name, $arguments)
 
savestate ($newState)
 
 populateSavestate ($defaultSaveState=-999)
 
 applyAccessFiltering ($userID=null)
 
 getForm ($data=array(), $loadData=true, $source=null)
 
 findFormFilename ($source, $paths=array())
 
 validateForm ($form, $data, $group=null)
 
 onBeforeLoadForm (&$name, &$source, &$options)
 
 onAfterLoadForm (FOFForm &$form, &$name, &$source, &$options)
 
 onBeforePreprocessForm (FOFForm &$form, &$data)
 
 onAfterPreprocessForm (FOFForm &$form, &$data)
 
 getDbo ()
 
 getName ()
 
 setDbo ($db)
 
 setState ($property, $value=null)
 
 setBehaviorParam ($name, $value)
 
 getBehaviorParam ($name, $default=null)
 
 blacklistFilters ($list=null, $reset=false)
 
- Fonctions membres publiques hérités de FOFUtilsObject
 __construct ($properties=null)
 
 __toString ()
 
 def ($property, $default=null)
 
 get ($property, $default=null)
 
 getProperties ($public=true)
 
 getError ($i=null, $toString=true)
 
 getErrors ()
 
 set ($property, $value=null)
 
 setProperties ($properties)
 
 setError ($error)
 

Fonctions membres protégées

 findUpdatesJoomla ($force=false)
 
 findUpdatesClassic ($force=false)
 
 loadUpdatesClassic ($force=false)
 
 getCommonParameter ($key, $default=null)
 
 setCommonParameter ($key, $value)
 
- Fonctions membres protégées hérités de FOFModel
 _getListCount ($query)
 
 _real_getState ($property=null, $default=null)
 
 getUserStateFromRequest ($key, $request, $default=null, $type='none', $setUserState=true)
 
_getList ($query, $limitstart=0, $limit=0, $group='')
 
_createTable ($name, $prefix='Table', $config=array())
 
 populateState ()
 
 loadForm ($name, $source, $options=array(), $clear=false, $xpath=false)
 
 loadFormData ()
 
 preprocessForm (FOFForm &$form, &$data, $group='content')
 
 onProcessList (&$resultArray)
 
 onAfterGetItem (&$record)
 
 onBeforeSave (&$data, &$table)
 
 onAfterSave (&$table)
 
 onBeforeDelete (&$id, &$table)
 
 onAfterDelete ($id)
 
 onBeforeCopy (&$table)
 
 onAfterCopy (&$table)
 
 onBeforePublish (&$table)
 
 onAfterPublish (&$table)
 
 onBeforeHit (&$table)
 
 onAfterHit (&$table)
 
 onBeforeMove (&$table)
 
 onAfterMove (&$table)
 
 onBeforeReorder (&$table)
 
 onAfterReorder (&$table)
 
 cleanCache ($group=null, $client_id=0)
 

Attributs protégés

 $updater = null
 
 $extension_id = 0
 
 $version = 'dev'
 
 $component = 'com_foobar'
 
 $componentDescription = 'Foobar'
 
 $updateSite = null
 
 $updateSiteName = null
 
 $extraQuery = null
 
 $commonKey = 'foobar'
 
 $commonTable = '#__akeeba_common'
 
 $updateEmailSubject = 'THIS EMAIL IS SENT FROM YOUR SITE "[SITENAME]" - Update available for [COMPONENT], new version [VERSION]'
 
 $updateEmailBody
 
- Attributs protégés hérités de FOFModel
 $__state_set = null
 
 $_db
 
 $event_after_delete = 'onContentAfterDelete'
 
 $event_after_save = 'onContentAfterSave'
 
 $event_before_delete = 'onContentBeforeDelete'
 
 $event_before_save = 'onContentBeforeSave'
 
 $event_change_state = 'onContentChangeState'
 
 $event_clean_cache = null
 
 $id_list = array()
 
 $id = null
 
 $input = array()
 
 $list = null
 
 $name
 
 $option = null
 
 $otable = null
 
 $pagination = null
 
 $record = null
 
 $state
 
 $table = null
 
 $total = null
 
 $_savestate = null
 
 $_forms = array()
 
 $_formData = array()
 
 $configProvider = null
 
 $modelDispatcher = null
 
 $default_behaviors = array('filters')
 
 $_behaviorParams = array()
 
- Attributs protégés hérités de FOFUtilsObject
 $_errors = array()
 

Fonctions membres privées

 updateComponent ()
 
 getFilenameFromURL ($url)
 
 sendNotificationEmail ($version, $email)
 

Membres hérités additionnels

- Fonctions membres publiques statiques hérités de FOFModel
static & getAnInstance ($type, $prefix='', $config=array())
 
static & getTmpInstance ($type, $prefix='', $config=array())
 
static addIncludePath ($path='', $prefix='')
 
static addTablePath ($path)
 
- Fonctions membres protégées statiques hérités de FOFModel
static _createFileName ($type, $parts=array())
 

Description détaillée

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

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $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)

Paramètres
array$config

Références $config, $data, $db, $description, $extension, $key, $query, et FOFPlatform\getInstance().

Documentation des fonctions membres

◆ doSendNotificationEmail()

doSendNotificationEmail (   $version,
  $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.

Paramètres
string$versionThe new version of our software
string$emailThe email address to send the notification to
Renvoie
mixed The result of JMail::send()

Références $version, et sendNotificationEmail().

◆ doUpdateComponent()

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.

Renvoie
string

Références updateComponent().

◆ downloadUpdate()

downloadUpdate ( )

Downloads the latest update package to Joomla!'s temporary directory

Renvoie
string The absolute path to the downloaded update package.

Références $config, $data, $message, $url, JFolder\exists(), getUpdates(), et JFile\write().

Référencé par updateComponent().

◆ findUpdates()

findUpdates (   $force,
  $preferredMethod = 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.

Paramètres
bool$forceShould I forcibly reload the updates from the server?
string$preferredMethodPreferred update method: 'joomla' or 'classic'
Renvoie
|null

Références findUpdatesClassic(), findUpdatesJoomla(), et getUpdateMethod().

Référencé par getUpdates().

◆ findUpdatesClassic()

findUpdatesClassic (   $force = false)
protected

Find the available update record object. If we're at the latest version return null.

Paramètres
bool$forceShould I forcibly reload the updates from the server?
Renvoie
|null

Références $extraQuery, $updateSite, $url, loadUpdatesClassic(), et null.

Référencé par findUpdates().

◆ findUpdatesJoomla()

findUpdatesJoomla (   $force = false)
protected

Find the available update record object. If we're at the latest version it will return null.

Paramètres
bool$forceShould I forcibly reload the updates from the server?
Renvoie
|null

Références $db, $extraQuery, $query, $url, FOFUtilsConfigHelper\getComponentConfigurationValue(), FOFPlatform\getInstance(), getUpdateSiteIds(), JLoader\import(), et null.

Référencé par findUpdates().

◆ getCommonParameter()

getCommonParameter (   $key,
  $default = null 
)
protected

Get a common parameter from the #__akeeba_common table

Paramètres
string$keyThe key to retrieve
mixed$defaultThe default value in case none is set
Renvoie
mixed The saved parameter value (or $default, if nothing is currently set)

Références $db, $default, $key, $query, et FOFPlatform\getInstance().

Référencé par loadUpdatesClassic().

◆ getComponentDescription()

getComponentDescription ( )

Returns the human readable component name, e.g. Foobar Component

Renvoie
string

Références $componentDescription.

◆ getComponentName()

getComponentName ( )

Returns the name of the component, e.g. com_foobar

Renvoie
string

Références $component.

◆ getExtensionId()

getExtensionId ( )

Returns the numeric extension ID for the component

Renvoie
int

Références $extension_id.

◆ getFilenameFromURL()

getFilenameFromURL (   $url)
private

Gets a file name out of a url

Paramètres
string$urlURL to get name from
Renvoie
mixed String filename or boolean false if failed

Références $parts, et $url.

◆ getUpdateMethod()

getUpdateMethod (   $preferred = null)

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.

Paramètres
string$preferredPreferred update method. One of 'joomla' or 'classic'.
Renvoie
string

Références FOFUtilsConfigHelper\getComponentConfigurationValue().

Référencé par findUpdates().

◆ getUpdates()

getUpdates (   $force = false,
  $preferredMethod = null 
)

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

Paramètres
bool$forceSet to true if you want to forcibly reload the update information
string$preferredMethodPreferred update method: 'joomla' or 'classic'
Renvoie
array See the method description for more information

Références findUpdates().

Référencé par downloadUpdate().

◆ getUpdateSite()

getUpdateSite ( )

Returns the update site URL, i.e. the URL to the XML update stream

Renvoie
string

Références $updateSite.

◆ getUpdateSiteIds()

getUpdateSiteIds ( )

Gets the update site Ids for our extension.

Renvoie
mixed An array of Ids or null if the query failed.

Références $db, $query, et FOFPlatform\getInstance().

Référencé par findUpdatesJoomla(), et removeObsoleteUpdateSites().

◆ getUpdateSiteName()

getUpdateSiteName ( )

Returns the human readable description of the update site

Renvoie
string

Références $updateSiteName.

◆ getVersion()

getVersion ( )

Get the currently installed version as reported by the #__extensions table

Renvoie
string

Références $version.

◆ loadUpdatesClassic()

loadUpdatesClassic (   $force = false)
protected

Load all available updates without going through JUpdate

Paramètres
bool$forceShould I forcibly reload the updates from the server?
Renvoie
array

Références getCommonParameter(), FOFUtilsConfigHelper\getComponentConfigurationValue(), json_encode, et setCommonParameter().

Référencé par findUpdatesClassic().

◆ removeObsoleteUpdateSites()

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.

Références $db, $query, FOFModel\getDbo(), et getUpdateSiteIds().

◆ sendNotificationEmail()

sendNotificationEmail (   $version,
  $email 
)
private

Sends an update notification email

Paramètres
string$versionThe new version of our software
string$emailThe email address to send the notification to
Renvoie
mixed The result of JMail::send()

Références $sitename, $updateEmailBody, $updateEmailSubject, et $version.

Référencé par doSendNotificationEmail().

◆ setCommonParameter()

setCommonParameter (   $key,
  $value 
)
protected

Set a common parameter from the #__akeeba_common table

Paramètres
string$keyThe key to set
mixed$valueThe value to set
Renvoie
void

Références $count, $data, $db, $key, $query, $value, et FOFPlatform\getInstance().

Référencé par loadUpdatesClassic().

◆ setVersion()

setVersion (   $version)

Override the currently installed version as reported by the #__extensions table

Paramètres
string$version

Références $version.

◆ updateComponent()

updateComponent ( )
private

Automatically install the extension update under Joomla! 1.5.5 or later (web) / 3.0 or later (CLI).

Renvoie
string The update message

Références JFile\delete(), JFolder\delete(), downloadUpdate(), JFolder\exists(), JFile\exists(), FOFPlatform\getInstance(), et jimport().

Référencé par doUpdateComponent().

Documentation des champs

◆ $commonKey

$commonKey = 'foobar'
protected

◆ $commonTable

$commonTable = '#__akeeba_common'
protected

◆ $component

$component = 'com_foobar'
protected

Référencé par getComponentName().

◆ $componentDescription

$componentDescription = 'Foobar'
protected

Référencé par getComponentDescription().

◆ $extension_id

$extension_id = 0
protected

Référencé par getExtensionId().

◆ $extraQuery

$extraQuery = null
protected

◆ $updateEmailBody

$updateEmailBody
protected

Référencé par sendNotificationEmail().

◆ $updateEmailSubject

$updateEmailSubject = 'THIS EMAIL IS SENT FROM YOUR SITE "[SITENAME]" - Update available for [COMPONENT], new version [VERSION]'
protected

Référencé par sendNotificationEmail().

◆ $updater

$updater = null
protected

◆ $updateSite

$updateSite = null
protected

Référencé par findUpdatesClassic(), et getUpdateSite().

◆ $updateSiteName

$updateSiteName = null
protected

Référencé par getUpdateSiteName().

◆ $version

$version = 'dev'
protected

La documentation de cette classe a été générée à partir du fichier suivant :