Class craft\fields\Entries

Inheritance: craft\fields\Entries » craft\fields\BaseRelationField » craft\base\Field » craft\base\SavableComponent » craft\base\Component » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject
Implements: ArrayAccess, IteratorAggregate, craft\base\ComponentInterface, craft\base\EagerLoadingFieldInterface, craft\base\FieldInterface, craft\base\PreviewableFieldInterface, craft\base\SavableComponentInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface
Uses Traits: craft\base\FieldTrait, craft\base\SavableComponentTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
Available since version: 3.0
Source Code: https://github.com/craftcms/cms/blob/master/src/fields/Entries.php

Entries represents an Entries field.

Public Properties
Property	Type	Description	Defined By
`$allowLimit`	boolean	Whether to allow the Limit setting	craft\fields\BaseRelationField
`$allowMultipleSources`	boolean	Whether to allow multiple source selection in the settings	craft\fields\BaseRelationField
`$columnPrefix`	string, null	The field’s content column prefix	craft\base\FieldTrait
`$context`	string, null	The field’s context	craft\base\FieldTrait
`$dateCreated`	DateTime, null	The date that the component was created	craft\base\SavableComponentTrait
`$dateUpdated`	DateTime, null	The date that the component was last updated	craft\base\SavableComponentTrait
`$groupId`	integer, null	The field’s group’s ID	craft\base\FieldTrait
`$handle`	string, null	The field’s handle	craft\base\FieldTrait
`$id`	integer, string, null	The component’s ID (could be a temporary one: "new:X")	craft\base\SavableComponentTrait
`$instructions`	string, null	The field’s instructions	craft\base\FieldTrait
`$layoutId`	integer, null	The ID of the field layout that the field was fetched from	craft\base\FieldTrait
`$limit`	integer, null	The maximum number of relations this field can have (used if $allowLimit is set to true)	craft\fields\BaseRelationField
`$localizeRelations`	integer	Whether each site should get its own unique set of relations	craft\fields\BaseRelationField
`$name`	string, null	The field’s name	craft\base\FieldTrait
`$oldHandle`	string, null	The field’s previous handle	craft\base\FieldTrait
`$required`	boolean, null	Whether the field is required in the field layout it was fetched from	craft\base\FieldTrait
`$selectionLabel`	string, null	The label that should be used on the selection input	craft\fields\BaseRelationField
`$sortOrder`	integer, null	The field’s sort position in the field layout it was fetched from	craft\base\FieldTrait
`$source`	string, null	The source key that this field can relate elements from (used if $allowMultipleSources is set to false)	craft\fields\BaseRelationField
`$sources`	string, string[], null	The source keys that this field can relate elements from (used if $allowMultipleSources is set to true)	craft\fields\BaseRelationField
`$tabId`	integer, null	The tab ID of the field layout that the field was fetched from	craft\base\FieldTrait
`$targetSiteId`	integer, null	The site that this field should relate elements from	craft\fields\BaseRelationField
`$translationKeyFormat`	string, null	The field’s translation key format, if $translationMethod is "custom"	craft\base\FieldTrait
`$translationMethod`	string	The field’s translation method	craft\base\FieldTrait
`$viewMode`	string, null	The view mode	craft\fields\BaseRelationField

Protected Properties
Property	Type	Description	Defined By
`$allowLargeThumbsView`	boolean	Whether to allow the “Large Thumbnails” view mode	craft\fields\BaseRelationField
`$inputJsClass`	string, null	The JS class that should be initialized for the input	craft\fields\BaseRelationField
`$inputTemplate`	string	Template to use for field rendering	craft\fields\BaseRelationField
`$settingsTemplate`	string	Temlpate to use for settings rendering	craft\fields\BaseRelationField
`$sortable`	boolean	Whether the elements have a custom sort order	craft\fields\BaseRelationField

Public Methods
Method	Description	Defined By
`__call()`	Calls the named method which is not a class method.	yii\base\BaseObject
`__clone()`	This method is called after the object is created by cloning an existing one.	yii\base\Component
`__construct()`	Constructor.	craft\fields\BaseRelationField
`__get()`	Returns the value of an object property.	yii\base\BaseObject
`__isset()`	Checks if a property is set, i.e. defined and not null.	yii\base\BaseObject
`__set()`	Sets value of an object property.	yii\base\BaseObject
`__toString()`		craft\base\Field
`__unset()`	Sets an object property to null.	yii\base\BaseObject
`activeAttributes()`	Returns the attribute names that are subject to validation in the current scenario.	yii\base\Model
`addError()`	Adds a new error to the specified attribute.	yii\base\Model
`addErrors()`	Adds a list of errors.	yii\base\Model
`addModelErrors()`	Adds errors from another model, with a given attribute name prefix.	craft\base\Model
`afterDelete()`	Performs actions after a component is deleted.	craft\base\SavableComponentInterface
`afterElementDelete()`	Performs actions after the element has been deleted.	craft\base\FieldInterface
`afterElementSave()`	Performs actions after the element has been saved.	craft\fields\BaseRelationField
`afterSave()`	Performs actions after a component is saved.	craft\fields\BaseRelationField
`afterValidate()`	This method is invoked after validation ends.	yii\base\Model
`attachBehavior()`	Attaches a behavior to this component.	yii\base\Component
`attachBehaviors()`	Attaches a list of behaviors to the component.	yii\base\Component
`attributeHints()`	Returns the attribute hints.	yii\base\Model
`attributeLabels()`	Returns the attribute labels.	yii\base\Model
`attributes()`	Returns the list of attribute names.	yii\base\Model
`beforeDelete()`	Performs actions before a component is deleted.	craft\base\SavableComponentInterface
`beforeElementDelete()`	Performs actions before an element is deleted.	craft\base\FieldInterface
`beforeElementSave()`	Performs actions before an element is saved.	craft\base\FieldInterface
`beforeSave()`	Performs actions before a component is saved.	craft\fields\BaseRelationField
`beforeValidate()`	This method is invoked before validation starts.	yii\base\Model
`behaviors()`	Returns a list of behaviors that this component should behave as.	craft\base\Component
`canGetProperty()`	Returns a value indicating whether a property can be read.	yii\base\BaseObject
`canSetProperty()`	Returns a value indicating whether a property can be set.	yii\base\BaseObject
`className()`	Returns the fully qualified name of this class.	yii\base\BaseObject
`clearErrors()`	Removes errors for all attributes or a single attribute.	yii\base\Model
`createValidators()`	Creates validator objects based on the validation rules specified in rules().	yii\base\Model
`datetimeAttributes()`	Returns the names of any attributes that should hold DateTime values.	craft\base\Model
`defaultSelectionLabel()`	Returns the default $selectionLabel value.	craft\fields\Entries
`detachBehavior()`	Detaches a behavior from the component.	yii\base\Component
`detachBehaviors()`	Detaches all behaviors from the component.	yii\base\Component
`displayName()`	Returns the display name of this class.	craft\fields\Entries
`ensureBehaviors()`	Makes sure that the behaviors declared in behaviors() are attached to this component.	yii\base\Component
`extraFields()`	Returns the list of fields that can be expanded further and returned by toArray().	yii\base\ArrayableTrait
`fields()`	Returns the list of fields that should be returned by default by toArray() when no specific fields are specified.	yii\base\ArrayableTrait
`formName()`	Returns the form name that this model class should use.	yii\base\Model
`generateAttributeLabel()`	Generates a user friendly attribute label based on the give attribute name.	yii\base\Model
`getActiveValidators()`	Returns the validators applicable to the current \yii\base\scenario.	yii\base\Model
`getAttributeHint()`	Returns the text hint for the specified attribute.	yii\base\Model
`getAttributeLabel()`	Returns the text label for the specified attribute.	yii\base\Model
`getAttributes()`	Returns attribute values.	yii\base\Model
`getBehavior()`	Returns the named behavior object.	yii\base\Component
`getBehaviors()`	Returns all behaviors attached to this component.	yii\base\Component
`getContentColumnType()`	Returns the column type that this field should get within the content table.	craft\base\FieldInterface
`getEagerLoadingMap()`	Returns an array that maps source-to-target element IDs based on this custom field.	craft\fields\BaseRelationField
`getElementValidationRules()`	Returns the validation rules for an element with this field.	craft\fields\BaseRelationField
`getError()`	Returns the first error of the specified attribute.	craft\base\Model
`getErrorSummary()`	Returns the errors for all attributes as a one-dimensional array.	yii\base\Model
`getErrors()`	Returns the errors for all attributes or a single attribute.	yii\base\Model
`getFirstError()`	Returns the first error of the specified attribute.	yii\base\Model
`getFirstErrors()`	Returns the first error of every attribute in the model.	yii\base\Model
`getGroup()`	Returns the field’s group.	craft\base\FieldInterface
`getInputHtml()`	Returns the field’s input HTML.	craft\fields\BaseRelationField
`getIsNew()`	Returns whether the component is new (unsaved).	craft\base\SavableComponentInterface
`getIsTranslatable()`	Returns whether the field should be shown as translatable in the UI.	craft\fields\BaseRelationField
`getIterator()`	Returns an iterator for traversing the attributes in the model.	yii\base\Model
`getScenario()`	Returns the scenario that this model is used in.	yii\base\Model
`getSearchKeywords()`	Returns the search keywords that should be associated with this field.	craft\fields\BaseRelationField
`getSettings()`	Returns an array of the component’s settings.	craft\base\SavableComponentInterface
`getSettingsHtml()`	Returns the component’s settings HTML.	craft\fields\BaseRelationField
`getSourceOptions()`	Normalizes the available sources into select input options.	craft\fields\BaseRelationField
`getStaticHtml()`	Returns a static (non-editable) version of the field’s input HTML.	craft\fields\BaseRelationField
`getTableAttributeHtml()`	Returns the HTML that should be shown for this field in Table View.	craft\fields\BaseRelationField
`getTargetSiteFieldHtml()`	Returns the HTML for the Target Site setting.	craft\fields\BaseRelationField
`getTranslationKey()`	Returns the field’s translation key, based on a given element.	craft\base\FieldInterface
`getValidators()`	Returns all the validators declared in rules().	yii\base\Model
`getViewModeFieldHtml()`	Returns the HTML for the View Mode setting.	craft\fields\BaseRelationField
`hasContentColumn()`	Returns whether this field has a column in the content table.	craft\fields\BaseRelationField
`hasErrors()`	Returns a value indicating whether there is any validation error.	yii\base\Model
`hasEventHandlers()`	Returns a value indicating whether there is any handler attached to the named event.	yii\base\Component
`hasMethod()`	Returns a value indicating whether a method is defined.	yii\base\BaseObject
`hasProperty()`	Returns a value indicating whether a property is defined.	yii\base\BaseObject
`init()`	Initializes the object.	craft\fields\BaseRelationField
`instance()`	Returns static class instance, which can be used to obtain meta information.	yii\base\StaticInstanceTrait
`isAttributeActive()`	Returns a value indicating whether the attribute is active in the current scenario.	yii\base\Model
`isAttributeRequired()`	Returns a value indicating whether the attribute is required.	yii\base\Model
`isAttributeSafe()`	Returns a value indicating whether the attribute is safe for massive assignments.	yii\base\Model
`isEmpty()`		craft\base\Field
`isSelectable()`	Returns whether the component should be selectable in component Type selects.	craft\base\SavableComponentInterface
`isValueEmpty()`	Returns whether the given value should be considered “empty” to a validator.	craft\fields\BaseRelationField
`load()`	Populates the model with input data.	yii\base\Model
`loadMultiple()`	Populates a set of models with the data from end user.	yii\base\Model
`modifyElementsQuery()`	Modifies an element query.	craft\fields\BaseRelationField
`normalizeValue()`	Normalizes the field’s value for use.	craft\fields\BaseRelationField
`off()`	Detaches an existing event handler from this component.	yii\base\Component
`offsetExists()`	Returns whether there is an element at the specified offset.	yii\base\Model
`offsetGet()`	Returns the element at the specified offset.	yii\base\Model
`offsetSet()`	Sets the element at the specified offset.	yii\base\Model
`offsetUnset()`	Sets the element value at the specified offset to null.	yii\base\Model
`on()`	Attaches an event handler to an event.	yii\base\Component
`onUnsafeAttribute()`	This method is invoked when an unsafe attribute is being massively assigned.	yii\base\Model
`rules()`	Returns the validation rules for attributes.	craft\base\Field
`safeAttributes()`	Returns the attribute names that are safe to be massively assigned in the current scenario.	yii\base\Model
`scenarios()`	Returns a list of scenarios and the corresponding active attributes.	yii\base\Model
`serializeValue()`	Prepares the field’s value to be stored somewhere, like the content table or JSON-encoded in an entry revision table.	craft\fields\BaseRelationField
`setAttributes()`	Sets the attribute values in a massive way.	yii\base\Model
`setIsFresh()`	Sets whether the field is fresh.	craft\base\FieldInterface
`setScenario()`	Sets the scenario for the model.	yii\base\Model
`settingsAttributes()`	Returns the list of settings attribute names.	craft\fields\BaseRelationField
`supportedTranslationMethods()`	Returns which translation methods the field supports.	craft\fields\BaseRelationField
`toArray()`	Converts the model into an array.	yii\base\ArrayableTrait
`trigger()`	Triggers an event.	yii\base\Component
`validate()`	Validates the component.	craft\base\SavableComponentInterface
`validateMultiple()`	Validates multiple models.	yii\base\Model

Protected Methods
Method	Description	Defined By
`availableSources()`	Returns the sources that should be available to choose from within the field's settings	craft\fields\BaseRelationField
`elementType()`	Returns the element class associated with this field type.	craft\fields\Entries
`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".	yii\base\ArrayableTrait
`extractRootFields()`	Extracts the root field names from nested fields.	yii\base\ArrayableTrait
`inputSelectionCriteria()`	Returns any additional criteria parameters limiting which elements the field should be able to select.	craft\fields\BaseRelationField
`inputSources()`	Returns an array of the source keys the field should be able to select elements from.	craft\fields\BaseRelationField
`inputTemplateVariables()`	Returns an array of variables that should be passed to the input template.	craft\fields\BaseRelationField
`isFresh()`	Returns whether this is the first time the element's content has been edited.	craft\base\Field
`requestParamName()`	Returns the field’s param name on the request.	craft\base\Field
`resolveFields()`	Determines which fields can be returned by toArray().	yii\base\ArrayableTrait
`supportedViewModes()`	Returns the field’s supported view modes.	craft\fields\BaseRelationField
`targetSiteId()`	Returns the site ID that target elements should have.	craft\fields\BaseRelationField
`viewMode()`	Returns the field’s current view mode.	craft\fields\BaseRelationField

Events
Event	Type	Description	Defined By
`EVENT_AFTER_DELETE`	yii\base\Event	The event that is triggered after the component is deleted	craft\base\SavableComponent
`EVENT_AFTER_ELEMENT_DELETE`	craft\events\FieldElementEvent	The event that is triggered after the element is deleted	craft\base\Field
`EVENT_AFTER_ELEMENT_SAVE`	craft\events\FieldElementEvent	The event that is triggered after the element is saved	craft\base\Field
`EVENT_AFTER_SAVE`	craft\events\ModelEvent	The event that is triggered after the component is saved	craft\base\SavableComponent
`EVENT_AFTER_VALIDATE`	yii\base\Event	An event raised at the end of validate()	yii\base\Model
`EVENT_BEFORE_DELETE`	craft\events\ModelEvent	The event that is triggered before the component is deleted You may set craft\events\ModelEvent::$isValid to `false` to prevent the component from getting deleted.	craft\base\SavableComponent
`EVENT_BEFORE_ELEMENT_DELETE`	craft\events\FieldElementEvent	The event that is triggered before the element is deleted You may set craft\events\FieldElementEvent::$isValid to `false` to prevent the element from getting deleted.	craft\base\Field
`EVENT_BEFORE_ELEMENT_SAVE`	craft\events\FieldElementEvent	The event that is triggered before the element is saved You may set craft\events\FieldElementEvent::$isValid to `false` to prevent the element from getting saved.	craft\base\Field
`EVENT_BEFORE_SAVE`	craft\events\ModelEvent	The event that is triggered before the component is saved You may set craft\events\ModelEvent::$isValid to `false` to prevent the component from getting saved.	craft\base\SavableComponent
`EVENT_BEFORE_VALIDATE`	yii\base\ModelEvent	An event raised at the beginning of validate().	yii\base\Model
`EVENT_DEFINE_BEHAVIORS`	craft\events\DefineBehaviorsEvent	The event that is triggered when defining the class behaviors	craft\base\Component
`EVENT_INIT`	yii\base\Event	The event that is triggered after the component's init cycle	craft\base\Component

Constants
Constant	Value	Description	Defined By
`SCENARIO_DEFAULT`	'default'	The name of the default scenario.	yii\base\Model
`TRANSLATION_METHOD_CUSTOM`	'custom'		craft\base\Field
`TRANSLATION_METHOD_LANGUAGE`	'language'		craft\base\Field
`TRANSLATION_METHOD_NONE`	'none'		craft\base\Field
`TRANSLATION_METHOD_SITE`	'site'		craft\base\Field
`TRANSLATION_METHOD_SITE_GROUP`	'siteGroup'		craft\base\Field

Method Details

`defaultSelectionLabel()` public static method #

Returns the default $selectionLabel value.

public static string defaultSelectionLabel ( )

return	string	The default selection label

`displayName()` public static method #

Returns the display name of this class.

public static string displayName ( )

return	string	The display name of this class.

`elementType()` protected static method #

Returns the element class associated with this field type.

protected static string elementType ( )

return	string	The Element class name
throws	yii\base\NotSupportedException	if the method hasn't been implemented by the subclass

Method Details

defaultSelectionLabel() public static method #

displayName() public static method #

elementType() protected static method #

`defaultSelectionLabel()` public static method #

`displayName()` public static method #

`elementType()` protected static method #