Skip to content

Update

Type
Class
Namespace
craft\models
Inherits
craft\models\Update » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject
Implements
ArrayAccess, IteratorAggregate, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface
Uses traits
craft\base\ClonefixTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
Since
3.0.0

Craft/plugin update model.

View source

Public Properties

PropertyDescription
abandonedboolean – Whether the package is abandoned
activeValidatorsyii\validators\Validator – The validators applicable to the current scenario.
attributesarray – Attribute values (name => value).
behaviorsyii\base\Behavior – List of behaviors attached to this component.
errorsarray – Errors for all attributes or the specified attribute.
firstErrorsarray – The first errors.
hasCriticalboolean – Whether any of the updates have a critical release available
hasReleasesboolean – Whether there are any releases available
iteratorArrayIterator – An iterator for traversing the items in the list.
latestcraft\models\UpdateRelease, null – The latest release (if any are available)
packageNamestring – The package name that should be used when updating
phpConstraintstring, null – The PHP version constraint required by this version
releasescraft\models\UpdateRelease[] – The available releases
renewalCurrencystring, null – The renewal price's currency
renewalPricefloat, null – The price to renew the license, if expired
renewalUrlstring, null – The URL that the Renew button should link to
replacementHandlestring, null – The handle of the suggested replacement package
replacementNamestring, null – The name of the suggested replacement package
replacementUrlstring, null – The URL of the suggested replacement package
scenariostring – The scenario that this model is in.
statusstring – The status of the update (eligible, breakpoint, or expired)
validatorsArrayObject, yii\validators\Validator – All the validators declared in the model.

abandoned

Type
boolean
Default value
false
Since
3.6.7

Whether the package is abandoned

View source

hasCritical

Type
boolean
Default value
null

Whether any of the updates have a critical release available

View source

hasReleases

Type
boolean
Default value
null

Whether there are any releases available

View source

latest

Type
craft\models\UpdateRelease, null
Default value
null

The latest release (if any are available)

View source

packageName

Type
string
Default value
null

The package name that should be used when updating

View source

phpConstraint

Type
string, null
Default value
null
Since
3.5.15

The PHP version constraint required by this version

View source

releases

Type
craft\models\UpdateRelease[]
Default value
[]

The available releases

View source

renewalCurrency

Type
string, null
Default value
null

The renewal price's currency

View source

renewalPrice

Type
float, null
Default value
null

The price to renew the license, if expired

View source

renewalUrl

Type
string, null
Default value
null

The URL that the Renew button should link to

View source

replacementHandle

Type
string, null
Default value
null
Since
3.6.7

The handle of the suggested replacement package

View source

replacementName

Type
string, null
Default value
null
Since
3.6.7

The name of the suggested replacement package

View source

replacementUrl

Type
string, null
Default value
null
Since
3.6.7

The URL of the suggested replacement package

View source

status

Type
string
Default value
self::STATUS_ELIGIBLE

The status of the update (eligible, breakpoint, or expired)

View source

Public Methods

MethodDescription
__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.
activeAttributes()Returns the attribute names that are subject to validation in the current scenario.
addError()Adds a new error to the specified attribute.
addErrors()Adds a list of errors.
addModelErrors()Adds errors from another model, with a given attribute name prefix.
afterValidate()This method is invoked after validation ends.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
attributeHints()Returns the attribute hints.
attributeLabels()Returns the attribute labels.
attributes()Returns the list of attribute names.
beforeValidate()This method is invoked before validation starts.
behaviors()Returns a list of behaviors that this component should behave as.
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.
clearErrors()Removes errors for all attributes or a single attribute.
createValidators()Creates validator objects based on the validation rules specified in rules().
datetimeAttributes()Returns the names of any attributes that should hold DateTime values.
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.
extraFields()Returns the list of fields that can be expanded further and returned by toArray().
fields()Returns the list of fields that should be returned by default by toArray() when no specific fields are specified.
formName()Returns the form name that this model class should use.
generateAttributeLabel()Generates a user friendly attribute label based on the give attribute name.
getActiveValidators()Returns the validators applicable to the current scenario.
getAttributeHint()Returns the text hint for the specified attribute.
getAttributeLabel()Returns the text label for the specified attribute.
getAttributes()Returns attribute values.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
getError()Returns the first error of the specified attribute.
getErrorSummary()Returns the errors for all attributes as a one-dimensional array.
getErrors()Returns the errors for all attributes or a single attribute.
getFirstError()Returns the first error of the specified attribute.
getFirstErrors()Returns the first error of every attribute in the model.
getHasCritical()Returns whether there are any critical releases available.
getHasReleases()Returns whether there are any releases available.
getIterator()Returns an iterator for traversing the attributes in the model.
getLatest()Returns the latest release (if any are available).
getScenario()Returns the scenario that this model is used in.
getValidators()Returns all the validators declared in rules().
hasErrors()Returns a value indicating whether there is any validation error.
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.
instance()Returns static class instance, which can be used to obtain meta information.
isAttributeActive()Returns a value indicating whether the attribute is active in the current scenario.
isAttributeRequired()Returns a value indicating whether the attribute is required.
isAttributeSafe()Returns a value indicating whether the attribute is safe for massive assignments.
load()Populates the model with input data.
loadMultiple()Populates a set of models with the data from end user.
off()Detaches an existing event handler from this component.
offsetExists()Returns whether there is an element at the specified offset.
offsetGet()Returns the element at the specified offset.
offsetSet()Sets the element at the specified offset.
offsetUnset()Sets the element value at the specified offset to null.
on()Attaches an event handler to an event.
onUnsafeAttribute()This method is invoked when an unsafe attribute is being massively assigned.
rules()Returns the validation rules for attributes.
safeAttributes()Returns the attribute names that are safe to be massively assigned in the current scenario.
scenarios()Returns a list of scenarios and the corresponding active attributes.
setAttributes()Sets the attribute values in a massive way.
setScenario()Sets the scenario for the model.
toArray()Converts the model into an array.
trigger()Triggers an event.
validate()Performs the data validation.
validateMultiple()Validates multiple models.

getHasCritical()

Returns whether there are any critical releases available.

View source

Returns

boolean

getHasReleases()

Returns whether there are any releases available.

View source

Returns

boolean

getLatest()

Returns the latest release (if any are available).

View source

Returns

craft\models\UpdateRelease, null

init()

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

View source

Protected Methods

MethodDescription
defineRules()Returns the validation rules for attributes.
extractFieldsFor()Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id".
extractRootFields()Extracts the root field names from nested fields.
resolveFields()Determines which fields can be returned by toArray().

Constants

ConstantDescription
SCENARIO_DEFAULTThe name of the default scenario.
STATUS_BREAKPOINT
STATUS_ELIGIBLE
STATUS_EXPIRED