MissingField

Type

Class

Namespace

craft\fields

Inherits

craft\fields\MissingField » craft\base\Field » craft\base\SavableComponent » craft\base\ConfigurableComponent » craft\base\Component » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject

Implements

ArrayAccess, IteratorAggregate, craft\base\ComponentInterface, craft\base\ConfigurableComponentInterface, craft\base\FieldInterface, craft\base\MissingComponentInterface, craft\base\SavableComponentInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface

Uses traits

craft\base\ClonefixTrait, craft\base\FieldTrait, craft\base\MissingComponentTrait, craft\base\SavableComponentTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait

Since

3.0.0

MissingField represents a field with an invalid class.

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.
columnPrefix	string, null – The field’s content column prefix
columnSuffix	string, null – The field’s content column suffix
contentColumnType	string, string[] – The column type(s).
contentGqlMutationArgumentType	\GraphQL\Type\Definition\Type, array
contentGqlQueryArgumentType	\GraphQL\Type\Definition\Type, array
contentGqlType	\GraphQL\Type\Definition\Type, array
context	string, null – The field’s context
dateCreated	DateTime, null – The date that the component was created
dateUpdated	DateTime, null – The date that the component was last updated
describedBy	string, null – The aria-describedby attribute value that should be set on the focusable input(s).
eagerLoadingGqlConditions	array, false
elementValidationRules	array
errorMessage	string, null – The exception message that explains why the component class was invalid
errors	array – Errors for all attributes or the specified attribute.
expectedType	string, craft\base\Component, null – The expected component class name.
firstErrors	array – The first errors.
group	craft\models\FieldGroup, null
groupId	integer, null – The field’s group’s ID
handle	string, null – The field’s handle
id	integer, string, null – The component’s ID (could be a temporary one: "new:X")
inputId	string
instructions	string, null – The field’s instructions
isNew	boolean – Whether the component is new (unsaved)
isTranslatable	boolean
iterator	ArrayIterator – An iterator for traversing the items in the list.
layoutId	integer, null – The ID of the field layout that the field was fetched from
name	string, null – The field’s name
oldHandle	string, null – The field’s previous handle
oldSettings	array, null – The field’s previous settings
placeholderHtml	string
required	boolean, null – Whether the field is required in the field layout it was fetched from
scenario	string – The scenario that this model is in.
searchable	boolean – Whether the field's values should be registered as search keywords on the elements.
settings	array – The component’s settings
settingsHtml	string, null
sortOption	array
sortOrder	integer, null – The field’s sort position in the field layout it was fetched from
tabId	integer, null – The tab ID of the field layout that the field was fetched from
translationDescription	string, null
translationKeyFormat	string, null – The field’s translation key format, if translationMethod is "custom"
translationMethod	string – The field’s translation method
uid	string, null – The field's UID
validators	ArrayObject, yii\validators\Validator – All the validators declared in the model.

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.
__toString()	Use the translated field name as the string representation.
__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.
afterDelete()	Performs actions after a component is deleted.
afterElementDelete()	Performs actions after the element has been deleted.
afterElementPropagate()	Performs actions after the element has been fully saved and propagated to other sites.
afterElementRestore()	Performs actions after the element has been restored.
afterElementSave()	Performs actions after the element has been saved.
afterSave()	Performs actions after a component is saved.
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.
beforeApplyDelete()	Performs actions before a component delete is applied to the database.
beforeDelete()	Performs actions before a component is deleted.
beforeElementDelete()	Performs actions before an element is deleted.
beforeElementRestore()	Performs actions before an element is restored.
beforeElementSave()	Performs actions before an element is saved.
beforeSave()	Performs actions before a component is saved.
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.
copyValue()	Copies the field’s value from one element to another.
createFallback()	Creates a new component of a given type based on this one’s properties.
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.
getContentColumnType()	Returns the column type(s) that this field should get within the content table.
getContentGqlMutationArgumentType()	Returns the GraphQL type to be used as an argument in mutations for this field type.
getContentGqlQueryArgumentType()	Returns the GraphQL type to be used as an argument in queries for this field type.
getContentGqlType()	Returns the GraphQL type to be used for this field type.
getEagerLoadingGqlConditions()	Returns an array that lists the scopes this custom field allows when eager-loading or false if eager-loading should not be allowed in the GraphQL context.
getElementValidationRules()	Returns the validation rules for an element with this field.
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.
getGroup()	Returns the field’s group.
getInputHtml()	Returns the field’s input HTML.
getInputId()	Returns the input’s ID, which the <label>’s for attribute should reference.
getIsNew()	Returns whether the component is new (unsaved).
getIsTranslatable()	Returns whether the field should be shown as translatable in the UI.
getIterator()	Returns an iterator for traversing the attributes in the model.
getOrientation()	Returns the orientation the field should use (ltr or rtl).
getPlaceholderHtml()	Displays an error message (and possibly a plugin install button) in place of the normal component UI.
getScenario()	Returns the scenario that this model is used in.
getSearchKeywords()	Returns the search keywords that should be associated with this field.
getSettings()	Returns an array of the component’s settings.
getSettingsHtml()	Returns the component’s settings HTML.
getSortOption()	Returns the sort option array that should be included in the element’s sortOptions() response.
getStaticHtml()	Returns a static (non-editable) version of the field’s input HTML.
getStatus()	Returns the status of the field for a given element.
getTableAttributeHtml()	Returns the HTML that should be shown for this field in Table View.
getTranslationDescription()	Returns the description of this field’s translation support.
getTranslationKey()	Returns the field’s translation key, based on a given element.
getValidators()	Returns all the validators declared in rules().
hasContentColumn()	Returns whether this field has a column in the content table.
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.
includeInGqlSchema()	Returns whether the field should be included in the given GraphQL schema.
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.
isEmpty()
isSelectable()	Returns whether the component should be selectable in component Type selects.
isValueEmpty()	Returns whether the given value should be considered “empty” to a validator.
load()	Populates the model with input data.
loadMultiple()	Populates a set of models with the data from end user.
modifyElementIndexQuery()	Modifies an element index query.
modifyElementsQuery()	Modifies an element query.
normalizeValue()	Normalizes the field’s value for use.
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.
serializeValue()	Prepares the field’s value to be stored somewhere, like the content table.
setAttributes()	Sets the attribute values in a massive way.
setIsFresh()	Sets whether the field is fresh.
setScenario()	Sets the scenario for the model.
settingsAttributes()	Returns the list of settings attribute names.
supportedTranslationMethods()	Returns which translation methods the field supports.
toArray()	Converts the model into an array.
trigger()	Triggers an event.
useFieldset()	Returns whether the field should use a <fieldset> + <legend> instead of a <div> + <label>.
validate()	Performs the data validation.
validateMultiple()	Validates multiple models.
valueType()	Returns the PHPDoc type this field’s values will have.

hasContentColumn()

Returns whether this field has a column in the content table.

WARNING

If you set this to false, you will be on your own in terms of saving and retrieving your field values.

View source

Returns

boolean

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.
inputHtml()	Returns the field’s input HTML.
isFresh()	Returns whether this is the first time the element's content has been edited.
requestParamName()	Returns the field’s param name on the request.
resolveFields()	Determines which fields can be returned by toArray().
searchKeywords()	Returns the search keywords that should be associated with this field.

inputHtml()

Since

3.5.0

Returns the field’s input HTML.

View source

Arguments

• $value (mixed) – The field’s value. This will either be the normalized value, raw POST data (i.e. if there was a validation error), or null
• $element (craft\base\ElementInterface, null) – The element the field is associated with, if there is one

Returns

string – The input HTML.

Constants

Constant	Description
SCENARIO_DEFAULT	The name of the default scenario.
TRANSLATION_METHOD_CUSTOM
TRANSLATION_METHOD_LANGUAGE
TRANSLATION_METHOD_NONE
TRANSLATION_METHOD_SITE
TRANSLATION_METHOD_SITE_GROUP