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 service is available via Craft::$app->updates.

# Public Properties

Property	Description
areMigrationsPending	boolean (opens new window)
behaviors (opens new window)	yii\base\Behavior (opens new window) – List of behaviors attached to this component.
cacheKey	string (opens new window)
hasCraftVersionChanged	boolean (opens new window)
isCraftDbMigrationNeeded	boolean (opens new window) – Whether Craft needs to run any database migrations
isCraftSchemaVersionCompatible	boolean (opens new window) – Whether the uploaded DB schema is equal to or greater than the installed schema
isCraftUpdatePending	boolean (opens new window)
isCriticalUpdateAvailable	boolean (opens new window) – Whether a critical update is available
isPluginDbUpdateNeeded	boolean (opens new window) – Whether a plugin needs to run a database update
isPluginUpdatePending	boolean (opens new window)
isUpdateInfoCached	boolean (opens new window) – Whether the update info is cached
isUpdatePending	boolean (opens new window)
newPluginInfo	craft\base\PluginInterface
pendingMigrationHandles	string (opens new window)[]
totalAvailableUpdates	integer (opens new window)
updates	craft\models\Updates
wasCraftBreakpointSkipped	boolean (opens new window) – Whether the build stored in craft_info is less than the minimum required build on the file system

# `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

Whether Craft needs to run any database migrations

View source (opens new window)

# `isCraftSchemaVersionCompatible`

Type: boolean (opens new window)
Default value: null

Whether the uploaded DB schema is equal to or greater than the installed schema

View source (opens new window)

# `isCraftUpdatePending`

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

View source (opens new window)

# `isCriticalUpdateAvailable`

Type: boolean (opens new window)
Default value: null

Whether a critical update is available

View source (opens new window)

# `isPluginDbUpdateNeeded`

Type: boolean (opens new window)
Default value: null

Whether a plugin needs to run a database update

View source (opens new window)

# `isPluginUpdatePending`

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

View source (opens new window)

# `isUpdateInfoCached`

Type: boolean (opens new window)
Default value: null

Whether the update info is cached

View source (opens new window)

# `isUpdatePending`

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

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

Whether the build stored in craft_info is less than the minimum required build on the file system

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 a component property.
__isset() (opens new window)	Checks if a property is set, i.e. defined and not null.
__set() (opens new window)	Sets the value of a component property.
__unset() (opens new window)	Sets a component property to be 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.
getIsCraftSchemaVersionCompatible()	Returns whether the uploaded DB schema is equal to or greater than the installed schema.
getIsCraftUpdatePending()	Returns whether Craft needs to run any database migrations.
getIsCriticalUpdateAvailable()	Returns whether a critical update is available.
getIsPluginUpdatePending()	Returns whether a plugin needs to run a database update.
getIsUpdateInfoCached()	Returns whether the update info is cached.
getIsUpdatePending()	Returns whether any Craft or plugin updates are pending.
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 for this component.
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.