ElementMutationResolver

Type

Abstract Class

Namespace

craft\gql\base

Inherits

craft\gql\base\ElementMutationResolver » craft\gql\base\MutationResolver » craft\base\Component » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject

Implements

ArrayAccess, IteratorAggregate, craft\base\ComponentInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface

Uses traits

craft\base\ClonefixTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait

Extended by

craft\gql\resolvers\mutations\Asset, craft\gql\resolvers\mutations\Category, craft\gql\resolvers\mutations\Entry, craft\gql\resolvers\mutations\GlobalSet, craft\gql\resolvers\mutations\Tag

Since

3.5.0

Class MutationResolver

View source

Public Properties

Property	Description
activeValidators	yii\validators\Validator – The validators applicable to the current scenario.
attributes	array – Attribute values (name => value).
behaviors	yii\base\Behavior – List of behaviors attached to this component.
errors	array – Errors for all attributes or the specified attribute.
firstErrors	array – The first errors.
iterator	ArrayIterator – An iterator for traversing the items in the list.
scenario	string – The scenario that this model is in.
validators	ArrayObject, yii\validators\Validator – All the validators declared in the model.
valueNormalizer	string

Protected Properties

Property	Description
argumentTypeDefsByName	\GraphQL\Type\Definition\Type[] – Argument type definitions by name.
immutableAttributes	string[]

argumentTypeDefsByName

Type

\GraphQL\Type\Definition\Type[]

Default value

[]

Argument type definitions by name.

View source

immutableAttributes

Type

string[]

Default value

[ 'id', 'uid', ]

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()	Construct a mutation resolver and store the resolution data as well as normalizers, if any provided.
__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.
displayName()	Returns the display name of this class.
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.
getIterator()	Returns an iterator for traversing the attributes in the model.
getResolutionData()	Return stored resolution data.
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.
isSelectable()	Returns whether the component should be selectable in component Type selects.
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.
setResolutionData()	Set a piece of data to be used by the resolver when resolving.
setScenario()	Sets the scenario for the model.
setValueNormalizer()	Set a data normalizer for an argument to use for data normalization during resolving.
toArray()	Converts the model into an array.
trigger()	Triggers an event.
validate()	Performs the data validation.
validateMultiple()	Validates multiple models.

Protected Methods

Method	Description
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.
normalizeValue()	Normalize a value according to stored normalizers.
populateElementWithData()	Populate the element with submitted data.
recursivelyNormalizeArgumentValues()	Normalize argument values in a recursive manner
requireSchemaAction()	Check if schema can perform the action on a scope and throw an Exception if not.
resolveFields()	Determines which fields can be returned by toArray().
saveElement()	Save an element.

populateElementWithData()

Populate the element with submitted data.

View source

Arguments

• $element (craft\base\Element)
• $arguments (array)
• $resolveInfo (\GraphQL\Type\Definition\ResolveInfo)

Returns

craft\elements\Entry

Throws

• craft\errors\GqlException
  if data not found.

recursivelyNormalizeArgumentValues()

Normalize argument values in a recursive manner

View source

Arguments

• $resolveInfo (\GraphQL\Type\Definition\ResolveInfo)
• $mutationArguments (array)

Returns

array

saveElement()

Save an element.

View source

Arguments

• $element (craft\base\ElementInterface)

Throws

• \GraphQL\Error\UserError
  if validation errors.

Constants

Constant	Description
CONTENT_FIELD_KEY	Constant used to reference content fields in resolution data storage.
SCENARIO_DEFAULT	The name of the default scenario.

Events

EVENT_AFTER_POPULATE_ELEMENT

Type

craft\events\MutationPopulateElementEvent

The event that is triggered after populating an element when resolving a mutation

Plugins get a chance to modify the element before it gets saved to the database.

---

Example

php

use craft\events\MutationPopulateElementEvent;
use craft\gql\resolvers\mutations\Asset as AssetMutationResolver;
use yii\base\Event;

Event::on(AssetMutationResolver::class, AssetMutationResolver::EVENT_AFTER_POPULATE_ELEMENT, function(MutationPopulateElementEvent $event) {
    // Always set the focal point to top left corner for new files just because it's funny.
    if (empty($event->element->id)) {
        $event->element->focalpoint = ['x' => 0, 'y' => 0];
    }
});

EVENT_BEFORE_POPULATE_ELEMENT

Type

craft\events\MutationPopulateElementEvent

The event that is triggered before populating an element when resolving a mutation

Plugins get a chance to modify the arguments used to populate an element as well as the element itself before it gets populated with data.

---

Example

php

use craft\events\MutationPopulateElementEvent;
use craft\gql\resolvers\mutations\Asset as AssetMutationResolver;
use craft\helpers\DateTimeHelper;
use yii\base\Event;

Event::on(AssetMutationResolver::class, AssetMutationResolver::EVENT_BEFORE_POPULATE_ELEMENT, function(MutationPopulateElementEvent $event) {
    // Add the timestamp to the element's title
    $event->arguments['title'] = ($event->arguments['title'] ?? '') . '[' . DateTimeHelper::currentTimeStamp() . ']';
});