UpdatesService
- Type
- Class
- Namespace
- Craft
- Inherits
- Craft\UpdatesService » Craft\BaseApplicationComponent » CApplicationComponent (opens new window) » CComponent (opens new window)
- Implements
IApplicationComponent- Since
- 1.0
Class UpdatesService
See also http://craftcms.com
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| $behaviors (opens new window) | array (opens new window) – The behaviors that should be attached to this component. |
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __get() (opens new window) | Returns a property value, an event handler list or a behavior based on its name. |
| __isset() (opens new window) | Checks if a property value is null. |
| __set() (opens new window) | Sets value of a component property. |
| __unset() (opens new window) | Sets a component property to be null. |
| asa() (opens new window) | Returns the named behavior object. |
| attachBehavior() (opens new window) | Attaches a behavior to this component. |
| attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
| attachEventHandler() (opens new window) | Attaches an event handler to an event. |
| backupDatabase() | |
| backupFiles() | |
| canGetProperty() (opens new window) | Determines whether a property can be read. |
| canSetProperty() (opens new window) | Determines whether a property can be set. |
| check() | |
| checkPluginReleaseFeeds() | Check plugins’ release feeds and include any pending updates in the given UpdateModel |
| criticalCraftUpdateAvailable() | |
| criticalPluginUpdateAvailable() | |
| detachBehavior() (opens new window) | Detaches a behavior from the component. |
| detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
| detachEventHandler() (opens new window) | Detaches an existing event handler. |
| disableBehavior() (opens new window) | Disables an attached behavior. |
| disableBehaviors() (opens new window) | Disables all behaviors attached to this component. |
| enableBehavior() (opens new window) | Enables an attached behavior. |
| enableBehaviors() (opens new window) | Enables all behaviors attached to this component. |
| evaluateExpression() (opens new window) | Evaluates a PHP expression or callback under the context of this component. |
| flushUpdateInfoFromCache() | |
| getEventHandlers() (opens new window) | Returns the list of attached event handlers for an event. |
| getIsInitialized() (opens new window) | Checks if this application component has been initialized. |
| getPluginsThatNeedDbUpdate() | Returns a list of plugins that are in need of a database update. |
| getTotalAvailableUpdates() | |
| getUnwritableFolders() | Checks to see if Craft can write to a defined set of folders/files that are needed for auto-update to work. |
| getUpdates() | |
| hasCraftVersionChanged() | Returns whether a different Craft version has been uploaded. |
| hasEvent() (opens new window) | Determines whether an event is defined. |
| hasEventHandler() (opens new window) | Checks whether the named event has attached handlers. |
| hasProperty() (opens new window) | Determines whether a property is defined. |
| init() (opens new window) | Initializes the application component. |
| isBreakpointUpdateNeeded() | Returns true if the version stored in craft_info is less than the minimum required version on the file system. This effectively makes sure that a user cannot manually update past a manual breakpoint. |
| isCraftDbMigrationNeeded() | Returns whether Craft needs to run any database migrations. |
| isCriticalUpdateAvailable() | |
| isInitialized() | Checks if this application component has been initialized yet, or not. |
| isManualUpdateRequired() | |
| isPluginDbUpdateNeeded() | Returns if a plugin needs to run a database update or not. |
| isSchemaVersionCompatible() | Returns whether the uploaded DB schema is equal to or greater than the installed schema |
| isUpdateInfoCached() | |
| onBeginUpdate() | Fires an 'onBeginUpdate' event. |
| onEndUpdate() | Fires an 'onEndUpdate' event. |
| prepareUpdate() | |
| processUpdateDownload() | |
| raiseEvent() (opens new window) | Raises an event. |
| rollbackUpdate() | |
| setNewPluginInfo() | |
| updateCleanUp() | |
| updateCraftVersionInfo() | Updates the Craft version info in the craft_info table. |
| updateDatabase() | |
| updateFiles() |
# backupDatabase()
Signature
public array backupDatabase ( )
# backupFiles()
View source (opens new window)
Arguments
$uid(string (opens new window))$handle(string (opens new window))
Returns
Signature
public array backupFiles ( $uid, $handle )
# check()
Signature
public Craft\UpdateModel check ( )
# checkPluginReleaseFeeds()
Check plugins’ release feeds and include any pending updates in the given UpdateModel
View source (opens new window)
Arguments
$updateModel(Craft\UpdateModel)
Signature
public void checkPluginReleaseFeeds ( Craft\UpdateModel $updateModel )
# criticalCraftUpdateAvailable()
Signature
public boolean criticalCraftUpdateAvailable ( $craftReleases )
# criticalPluginUpdateAvailable()
Signature
public boolean criticalPluginUpdateAvailable ( $plugins )
# flushUpdateInfoFromCache()
Signature
public boolean flushUpdateInfoFromCache ( )
# getPluginsThatNeedDbUpdate()
Returns a list of plugins that are in need of a database update.
View source (opens new window)
Returns
Signature
public array, null getPluginsThatNeedDbUpdate ( )
# getTotalAvailableUpdates()
Signature
public integer getTotalAvailableUpdates ( )
# getUnwritableFolders()
Checks to see if Craft can write to a defined set of folders/files that are needed for auto-update to work.
View source (opens new window)
Returns
Signature
public array, null getUnwritableFolders ( )
# getUpdates()
Signature
public Craft\UpdateModel, false getUpdates ( $forceRefresh = false )
# hasCraftVersionChanged()
Signature
public boolean hasCraftVersionChanged ( )
# isBreakpointUpdateNeeded()
Returns true if the version stored in craft_info is less than the minimum required version on the file system. This effectively makes sure that a user cannot manually update past a manual breakpoint.
View source (opens new window)
Returns
Signature
public boolean isBreakpointUpdateNeeded ( )
# isCraftDbMigrationNeeded()
Signature
public boolean isCraftDbMigrationNeeded ( )
# isCriticalUpdateAvailable()
Signature
public mixed isCriticalUpdateAvailable ( )
# isManualUpdateRequired()
Signature
public mixed isManualUpdateRequired ( )
# isPluginDbUpdateNeeded()
Signature
public boolean isPluginDbUpdateNeeded ( )
# isSchemaVersionCompatible()
Returns whether the uploaded DB schema is equal to or greater than the installed schema
View source (opens new window)
Returns
Signature
public boolean isSchemaVersionCompatible ( )
# isUpdateInfoCached()
Signature
public boolean isUpdateInfoCached ( )
# onBeginUpdate()
Fires an 'onBeginUpdate' event.
View source (opens new window)
Arguments
$event(Craft\Event)
Returns
Signature
public null onBeginUpdate ( Craft\Event $event )
# onEndUpdate()
Signature
public null onEndUpdate ( Craft\Event $event )
# prepareUpdate()
Signature
public array prepareUpdate ( $manual, $handle )
# processUpdateDownload()
View source (opens new window)
Arguments
$md5(string (opens new window))$handle(string (opens new window))
Returns
Signature
public array processUpdateDownload ( $md5, $handle )
# rollbackUpdate()
View source (opens new window)
Arguments
$uid(string (opens new window))$handle(string (opens new window))$dbBackupPath(boolean (opens new window))
Returns
Signature
public array rollbackUpdate ( $uid, $handle, $dbBackupPath = false )
# setNewPluginInfo()
Signature
public boolean setNewPluginInfo ( Craft\BasePlugin $plugin )
# updateCleanUp()
View source (opens new window)
Arguments
$uid(string (opens new window))$handle(string (opens new window))
Returns
Signature
public array updateCleanUp ( $uid, $handle )
# updateCraftVersionInfo()
Signature
public boolean updateCraftVersionInfo ( )
# updateDatabase()
Signature
public array updateDatabase ( $handle )
# updateFiles()
View source (opens new window)
Arguments
$uid(string (opens new window))$handle(string (opens new window))
Returns
Signature
public array updateFiles ( $uid, $handle )