Updates

Type
Class
Namespace
craft\services
Inherits
craft\services\Updates » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
Implements
yii\base\Configurable (opens new window)
Since
3.0.0

Updates service.

An instance of the Updates service is globally accessible in Craft via Craft::$app->updates.

View source (opens new window)

# Public Properties

# areMigrationsPending

Type
boolean (opens new window)
Default value
null
Access
Read-only
Since
3.5.15

View source (opens new window)

# cacheKey

Type
string (opens new window)
Default value
'updates'

View source (opens new window)

# hasCraftVersionChanged

Type
boolean (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# isCraftDbMigrationNeeded

Type
boolean (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# isCraftSchemaVersionCompatible

Type
boolean (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# isCriticalUpdateAvailable

Type
boolean (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# isPluginDbUpdateNeeded

Type
boolean (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# isUpdateInfoCached

Type
boolean (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# newPluginInfo

Type
craft\base\PluginInterface
Default value
null
Access
Write-only

View source (opens new window)

# pendingMigrationHandles

Type
string (opens new window)[]
Default value
null
Access
Read-only

View source (opens new window)

# totalAvailableUpdates

Type
integer (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# updates

Type
craft\models\Updates
Default value
null
Access
Read-only

View source (opens new window)

# wasCraftBreakpointSkipped

Type
boolean (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# Public Methods

Method Description
__call() (opens new window) Calls the named method which is not a class method.
__clone() (opens new window) This method is called after the object is created by cloning an existing one.
__construct() (opens new window) Constructor.
__get() (opens new window) Returns the value of an object property.
__isset() (opens new window) Checks if a property is set, i.e. defined and not null.
__set() (opens new window) Sets value of an object property.
__unset() (opens new window) Sets an object property to null.
attachBehavior() (opens new window) Attaches a behavior to this component.
attachBehaviors() (opens new window) Attaches a list of behaviors to the component.
behaviors() (opens new window) Returns a list of behaviors that this component should behave as.
cacheUpdates() Caches new update info.
canGetProperty() (opens new window) Returns a value indicating whether a property can be read.
canSetProperty() (opens new window) Returns a value indicating whether a property can be set.
className() (opens new window) Returns the fully qualified name of this class.
detachBehavior() (opens new window) Detaches a behavior from the component.
detachBehaviors() (opens new window) Detaches all behaviors from the component.
ensureBehaviors() (opens new window) Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component.
getAreMigrationsPending() Returns whether there are any pending migrations.
getBehavior() (opens new window) Returns the named behavior object.
getBehaviors() (opens new window) Returns all behaviors attached to this component.
getHasCraftVersionChanged() Returns whether a different Craft version has been uploaded.
getIsCraftDbMigrationNeeded() Returns whether Craft needs to run any database migrations.
getIsCraftSchemaVersionCompatible() Returns whether the uploaded DB schema is equal to or greater than the installed schema.
getIsCriticalUpdateAvailable() Returns whether a critical update is available.
getIsPluginDbUpdateNeeded() Returns whether a plugin needs to run a database update.
getIsUpdateInfoCached() Returns whether the update info is cached.
getPendingMigrationHandles() Returns a list of things with updated schema versions.
getTotalAvailableUpdates()
getUpdates()
getWasCraftBreakpointSkipped() Returns true if the version stored in craft_info is less than the minimum required version on the file system.
hasEventHandlers() (opens new window) Returns a value indicating whether there is any handler attached to the named event.
hasMethod() (opens new window) Returns a value indicating whether a method is defined.
hasProperty() (opens new window) Returns a value indicating whether a property is defined.
init() (opens new window) Initializes the object.
off() (opens new window) Detaches an existing event handler from this component.
on() (opens new window) Attaches an event handler to an event.
runMigrations() Runs the pending migrations for the given list of handles.
setNewPluginInfo()
trigger() (opens new window) Triggers an event.
updateCraftVersionInfo() Updates the Craft version info in the craft_info table.

# cacheUpdates()

Since
3.3.16

Caches new update info.

View source (opens new window)

Arguments

Returns

craft\models\Updates

# getAreMigrationsPending()

Since
3.5.15

Returns whether there are any pending migrations.

View source (opens new window)

Arguments

Returns

boolean (opens new window)

# getHasCraftVersionChanged()

Returns whether a different Craft version has been uploaded.

View source (opens new window)

Returns

boolean (opens new window)

# getIsCraftDbMigrationNeeded()

Returns whether Craft needs to run any database migrations.

View source (opens new window)

Returns

boolean (opens new window)

# getIsCraftSchemaVersionCompatible()

Returns whether the uploaded DB schema is equal to or greater than the installed schema.

View source (opens new window)

Returns

boolean (opens new window)

# getIsCriticalUpdateAvailable()

Returns whether a critical update is available.

View source (opens new window)

Arguments

Returns

boolean (opens new window)

# getIsPluginDbUpdateNeeded()

Returns whether a plugin needs to run a database update.

View source (opens new window)

Returns

boolean (opens new window)

# getIsUpdateInfoCached()

Returns whether the update info is cached.

View source (opens new window)

Returns

boolean (opens new window)

# getPendingMigrationHandles()

Returns a list of things with updated schema versions.

Craft CMS will be represented as "craft", plugins will be represented by their handles, and content will be represented as "content".

See also runMigrations() View source (opens new window)

Arguments

Returns

string (opens new window)[]

# getTotalAvailableUpdates()

View source (opens new window)

Arguments

Returns

integer (opens new window)

# getUpdates()

View source (opens new window)

Arguments

Returns

craft\models\Updates

# getWasCraftBreakpointSkipped()

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

boolean (opens new window)

# runMigrations()

Runs the pending migrations for the given list of handles.

See also getPendingMigrationHandles() View source (opens new window)

Arguments

Throws

# setNewPluginInfo()

View source (opens new window)

Arguments

Returns

boolean (opens new window)

# updateCraftVersionInfo()

Updates the Craft version info in the craft_info table.

View source (opens new window)

Returns

boolean (opens new window)