Updates

Type: Class
Namespace: craft\services
Inherits: craft\services\Updates » yii\base\Component » yii\base\BaseObject
Implements: yii\base\Configurable
Since: 3.0.0

Updates service.

An instance of the service is available via Craft::$app->updates.

Public Properties

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

`areMigrationsPending`

Type: boolean
Default value: null
Access: Read-only
Since: 3.5.15

View source

`cacheKey`

Type: string
Default value: 'updates'

View source

`hasCraftVersionChanged`

Type: boolean
Default value: null
Access: Read-only

View source

`isCraftDbMigrationNeeded`

Type: boolean
Default value: null

Whether Craft needs to run any database migrations

View source

`isCraftSchemaVersionCompatible`

Type: boolean
Default value: null

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

View source

`isCriticalUpdateAvailable`

Type: boolean
Default value: null

Whether a critical update is available

View source

`isPluginDbUpdateNeeded`

Type: boolean
Default value: null

Whether a plugin needs to run a database update

View source

`isUpdateInfoCached`

Type: boolean
Default value: null

Whether the update info is cached

View source

`isUpdatePending`

Type: boolean
Default value: null
Access: Read-only
Since: 3.6.15

View source

`newPluginInfo`

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

View source

`pendingMigrationHandles`

Type: string[]
Default value: null
Access: Read-only

View source

`totalAvailableUpdates`

Type: integer
Default value: null
Access: Read-only

View source

`updates`

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

View source

`wasCraftBreakpointSkipped`

Type: boolean
Default value: null

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

View source

Public Methods

Method	Description
__call()	Calls the named method which is not a class method.
__clone()	This method is called after the object is created by cloning an existing one.
__construct()	Constructor.
__get()	Returns the value of a component property.
__isset()	Checks if a property is set, i.e. defined and not null.
__set()	Sets the value of a component property.
__unset()	Sets a component property to be null.
attachBehavior()	Attaches a behavior to this component.
attachBehaviors()	Attaches a list of behaviors to the component.
behaviors()	Returns a list of behaviors that this component should behave as.
cacheUpdates()	Caches new update info.
canGetProperty()	Returns a value indicating whether a property can be read.
canSetProperty()	Returns a value indicating whether a property can be set.
className()	Returns the fully qualified name of this class.
detachBehavior()	Detaches a behavior from the component.
detachBehaviors()	Detaches all behaviors from the component.
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.
getAreMigrationsPending()	Returns whether there are any pending migrations.
getBehavior()	Returns the named behavior object.
getBehaviors()	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.
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()	Returns a value indicating whether there is any handler attached to the named event.
hasMethod()	Returns a value indicating whether a method is defined.
hasProperty()	Returns a value indicating whether a property is defined for this component.
init()	Initializes the object.
off()	Detaches an existing event handler from this component.
on()	Attaches an event handler to an event.
runMigrations()	Runs the pending migrations for the given list of handles.
setNewPluginInfo()
trigger()	Triggers an event.
updateCraftVersionInfo()	Updates the Craft version info in the craft_info table.