abstract class FieldConfigBase in Zircon Profile 8.0

Same name and namespace in other branches

8 core/lib/Drupal/Core/Field/FieldConfigBase.php \Drupal\Core\Field\FieldConfigBase

Base class for configurable field definitions.

Hierarchy

class \Drupal\Core\Entity\Entity implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses PluginDependencyTrait
  - class \Drupal\Core\Field\FieldConfigBase implements FieldConfigInterface

Expanded class hierarchy of FieldConfigBase

2 files declare their use of FieldConfigBase

BaseFieldOverride.php in core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php: Contains \Drupal\Core\Field\Entity\BaseFieldOverride.
FieldConfig.php in core/modules/field/src/Entity/FieldConfig.php: Contains \Drupal\field\Entity\FieldConfig.

File

core/lib/Drupal/Core/Field/FieldConfigBase.php, line 18: Contains \Drupal\Core\Field\FieldConfigBase.

Namespace

Drupal\Core\Field

View source

abstract class FieldConfigBase extends ConfigEntityBase implements FieldConfigInterface {

  /**
   * The field ID.
   *
   * The ID consists of 3 parts: the entity type, bundle and the field name.
   *
   * Example: node.article.body, user.user.field_main_image.
   *
   * @var string
   */
  protected $id;

  /**
   * The field name.
   *
   * @var string
   */
  protected $field_name;

  /**
   * The field type.
   *
   * This property is denormalized from the field storage for optimization of
   * the "entity and render cache hits" critical paths. If not present in the
   * $values passed to create(), it is populated from the field storage in
   * postCreate(), and saved in config records so that it is present on
   * subsequent loads.
   *
   * @var string
   */
  protected $field_type;

  /**
   * The name of the entity type the field is attached to.
   *
   * @var string
   */
  protected $entity_type;

  /**
   * The name of the bundle the field is attached to.
   *
   * @var string
   */
  protected $bundle;

  /**
   * The human-readable label for the field.
   *
   * This will be used as the title of Form API elements for the field in entity
   * edit forms, or as the label for the field values in displayed entities.
   *
   * If not specified, this defaults to the field_name (mostly useful for fields
   * created in tests).
   *
   * @var string
   */
  protected $label;

  /**
   * The field description.
   *
   * A human-readable description for the field when used with this bundle.
   * For example, the description will be the help text of Form API elements for
   * this field in entity edit forms.
   *
   * @var string
   */
  protected $description = '';

  /**
   * Field-type specific settings.
   *
   * An array of key/value pairs. The keys and default values are defined by the
   * field type.
   *
   * @var array
   */
  protected $settings = array();

  /**
   * Flag indicating whether the field is required.
   *
   * TRUE if a value for this field is required when used with this bundle,
   * FALSE otherwise. Currently, required-ness is only enforced at the Form API
   * level in entity edit forms, not during direct API saves.
   *
   * @var bool
   */
  protected $required = FALSE;

  /**
   * Flag indicating whether the field is translatable.
   *
   * Defaults to TRUE.
   *
   * @var bool
   */
  protected $translatable = TRUE;

  /**
   * Default field value.
   *
   * The default value is used when an entity is created, either:
   * - through an entity creation form; the form elements for the field are
   *   prepopulated with the default value.
   * - through direct API calls (i.e. $entity->save()); the default value is
   *   added if the $entity object provides no explicit entry (actual values or
   *   "the field is empty") for the field.
   *
   * The default value is expressed as a numerically indexed array of items,
   * each item being an array of key/value pairs matching the set of 'columns'
   * defined by the "field schema" for the field type, as exposed in
   * hook_field_schema(). If the number of items exceeds the cardinality of the
   * field, extraneous items will be ignored.
   *
   * This property is overlooked if the $default_value_callback is non-empty.
   *
   * Example for a integer field:
   * @code
   * array(
   *   array('value' => 1),
   *   array('value' => 2),
   * )
   * @endcode
   *
   * @var array
   */
  protected $default_value = array();

  /**
   * The name of a callback function that returns default values.
   *
   * The function will be called with the following arguments:
   * - \Drupal\Core\Entity\FieldableEntityInterface $entity
   *   The entity being created.
   * - \Drupal\Core\Field\FieldDefinitionInterface $definition
   *   The field definition.
   * It should return an array of default values, in the same format as the
   * $default_value property.
   *
   * This property takes precedence on the list of fixed values specified in the
   * $default_value property.
   *
   * @var string
   */
  protected $default_value_callback = '';

  /**
   * The field storage object.
   *
   * @var \Drupal\Core\Field\FieldStorageDefinitionInterface
   */
  protected $fieldStorage;

  /**
   * The data definition of a field item.
   *
   * @var \Drupal\Core\Field\TypedData\FieldItemDataDefinition
   */
  protected $itemDefinition;

  /**
   * Array of constraint options keyed by constraint plugin ID.
   *
   * @var array
   */
  protected $constraints = [];

  /**
   * {@inheritdoc}
   */
  public function id() {
    return $this->entity_type . '.' . $this->bundle . '.' . $this->field_name;
  }

  /**
   * {@inheritdoc}
   */
  public function getName() {
    return $this->field_name;
  }

  /**
   * {@inheritdoc}
   */
  public function getType() {
    return $this->field_type;
  }

  /**
   * {@inheritdoc}
   */
  public function getTargetEntityTypeId() {
    return $this->entity_type;
  }

  /**
   * {@inheritdoc}
   */
  public function getTargetBundle() {
    return $this->bundle;
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    parent::calculateDependencies();

    // Add dependencies from the field type plugin. We can not use
    // self::calculatePluginDependencies() because instantiation of a field item
    // plugin requires a parent entity.

    /** @var $field_type_manager \Drupal\Core\Field\FieldTypePluginManagerInterface */
    $field_type_manager = \Drupal::service('plugin.manager.field.field_type');
    $definition = $field_type_manager
      ->getDefinition($this
      ->getType());
    $this
      ->addDependency('module', $definition['provider']);

    // Plugins can declare additional dependencies in their definition.
    if (isset($definition['config_dependencies'])) {
      $this
        ->addDependencies($definition['config_dependencies']);
    }

    // Let the field type plugin specify its own dependencies.
    // @see \Drupal\Core\Field\FieldItemInterface::calculateDependencies()
    $this
      ->addDependencies($definition['class']::calculateDependencies($this));

    // Create dependency on the bundle.
    $bundle_config_dependency = $this
      ->entityManager()
      ->getDefinition($this->entity_type)
      ->getBundleConfigDependency($this->bundle);
    $this
      ->addDependency($bundle_config_dependency['type'], $bundle_config_dependency['name']);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function onDependencyRemoval(array $dependencies) {
    $changed = parent::onDependencyRemoval($dependencies);
    $field_type_manager = \Drupal::service('plugin.manager.field.field_type');
    $definition = $field_type_manager
      ->getDefinition($this
      ->getType());
    if ($definition['class']::onDependencyRemoval($this, $dependencies)) {
      $changed = TRUE;
    }
    return $changed;
  }

  /**
   * {@inheritdoc}
   */
  public function postCreate(EntityStorageInterface $storage) {
    parent::postCreate($storage);

    // If it was not present in the $values passed to create(), (e.g. for
    // programmatic creation), populate the denormalized field_type property
    // from the field storage, so that it gets saved in the config record.
    if (empty($this->field_type)) {
      $this->field_type = $this
        ->getFieldStorageDefinition()
        ->getType();
    }
  }

  /**
   * {@inheritdoc}
   */
  public function postSave(EntityStorageInterface $storage, $update = TRUE) {

    // Clear the cache.
    $this
      ->entityManager()
      ->clearCachedFieldDefinitions();

    // Invalidate the render cache for all affected entities.
    $entity_type = $this
      ->getFieldStorageDefinition()
      ->getTargetEntityTypeId();
    if ($this
      ->entityManager()
      ->hasHandler($entity_type, 'view_builder')) {
      $this
        ->entityManager()
        ->getViewBuilder($entity_type)
        ->resetCache();
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getLabel() {
    return $this
      ->label();
  }

  /**
   * {@inheritdoc}
   */
  public function setLabel($label) {
    $this->label = $label;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return $this->description;
  }

  /**
   * {@inheritdoc}
   */
  public function setDescription($description) {
    $this->description = $description;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function isTranslatable() {

    // A field can be enabled for translation only if translation is supported.
    return $this->translatable && $this
      ->getFieldStorageDefinition()
      ->isTranslatable();
  }

  /**
   * {@inheritdoc}
   */
  public function setTranslatable($translatable) {
    $this->translatable = $translatable;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getSettings() {
    return $this->settings + $this
      ->getFieldStorageDefinition()
      ->getSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function setSettings(array $settings) {
    $this->settings = $settings + $this->settings;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getSetting($setting_name) {
    if (array_key_exists($setting_name, $this->settings)) {
      return $this->settings[$setting_name];
    }
    else {
      return $this
        ->getFieldStorageDefinition()
        ->getSetting($setting_name);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function setSetting($setting_name, $value) {
    $this->settings[$setting_name] = $value;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function isRequired() {
    return $this->required;
  }

  /**
   * [@inheritdoc}
   */
  public function setRequired($required) {
    $this->required = $required;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getDefaultValue(FieldableEntityInterface $entity) {

    // Allow custom default values function.
    if ($callback = $this
      ->getDefaultValueCallback()) {
      $value = call_user_func($callback, $entity, $this);
    }
    else {
      $value = $this
        ->getDefaultValueLiteral();
    }

    // Allow the field type to process default values.
    $field_item_list_class = $this
      ->getClass();
    return $field_item_list_class::processDefaultValue($value, $entity, $this);
  }

  /**
   * {@inheritdoc}
   */
  public function getDefaultValueLiteral() {
    return $this->default_value;
  }

  /**
   * {@inheritdoc}
   */
  public function setDefaultValue($value) {
    if (!is_array($value)) {
      if ($value === NULL) {
        $value = [];
      }
      $key = $this
        ->getFieldStorageDefinition()
        ->getPropertyNames()[0];

      // Convert to the multi value format to support fields with a cardinality
      // greater than 1.
      $value = array(
        array(
          $key => $value,
        ),
      );
    }
    $this->default_value = $value;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getDefaultValueCallback() {
    return $this->default_value_callback;
  }

  /**
   * {@inheritdoc}
   */
  public function setDefaultValueCallback($callback) {
    $this->default_value_callback = $callback;
    return $this;
  }

  /**
   * Implements the magic __sleep() method.
   *
   * Using the Serialize interface and serialize() / unserialize() methods
   * breaks entity forms in PHP 5.4.
   * @todo Investigate in https://www.drupal.org/node/2074253.
   */
  public function __sleep() {

    // Only serialize necessary properties, excluding those that can be
    // recalculated.
    $properties = get_object_vars($this);
    unset($properties['fieldStorage'], $properties['itemDefinition'], $properties['original']);
    return array_keys($properties);
  }

  /**
   * {@inheritdoc}
   */
  public static function createFromItemType($item_type) {

    // Forward to the field definition class for creating new data definitions
    // via the typed manager.
    return BaseFieldDefinition::createFromItemType($item_type);
  }

  /**
   * {@inheritdoc}
   */
  public static function createFromDataType($type) {

    // Forward to the field definition class for creating new data definitions
    // via the typed manager.
    return BaseFieldDefinition::createFromDataType($type);
  }

  /**
   * {@inheritdoc}
   */
  public function getDataType() {
    return 'list';
  }

  /**
   * {@inheritdoc}
   */
  public function isList() {
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function getClass() {

    // Derive list class from the field type.
    $type_definition = \Drupal::service('plugin.manager.field.field_type')
      ->getDefinition($this
      ->getType());
    return $type_definition['list_class'];
  }

  /**
   * {@inheritdoc}
   */
  public function getConstraints() {
    return \Drupal::typedDataManager()
      ->getDefaultConstraints($this) + $this->constraints;
  }

  /**
   * {@inheritdoc}
   */
  public function getConstraint($constraint_name) {
    $constraints = $this
      ->getConstraints();
    return isset($constraints[$constraint_name]) ? $constraints[$constraint_name] : NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function getItemDefinition() {
    if (!isset($this->itemDefinition)) {
      $this->itemDefinition = FieldItemDataDefinition::create($this)
        ->setSettings($this
        ->getSettings());
    }
    return $this->itemDefinition;
  }

  /**
   * {@inheritdoc}
   */
  public function getConfig($bundle) {
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function setConstraints(array $constraints) {
    $this->constraints = $constraints;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function addConstraint($constraint_name, $options = NULL) {
    $this->constraints[$constraint_name] = $options;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function setPropertyConstraints($name, array $constraints) {
    $item_constraints = $this
      ->getItemDefinition()
      ->getConstraints();
    $item_constraints['ComplexData'][$name] = $constraints;
    $this
      ->getItemDefinition()
      ->setConstraints($item_constraints);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function addPropertyConstraints($name, array $constraints) {
    $item_constraints = $this
      ->getItemDefinition()
      ->getConstraint('ComplexData') ?: [];
    if (isset($item_constraints[$name])) {

      // Add the new property constraints, overwriting as required.
      $item_constraints[$name] = $constraints + $item_constraints[$name];
    }
    else {
      $item_constraints[$name] = $constraints;
    }
    $this
      ->getItemDefinition()
      ->addConstraint('ComplexData', $item_constraints);
    return $this;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigEntityBase::$isSyncing	private	property	Whether the config is being created, updated or deleted through the import process.
ConfigEntityBase::$isUninstalling	private	property	Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode	protected	property	The language code of the entity's default language.
ConfigEntityBase::$originalId	protected	property	The original ID of the configuration entity.
ConfigEntityBase::$pluginConfigKey	protected	property	The name of the property that is used to store plugin configuration.
ConfigEntityBase::$status	protected	property	The enabled/disabled status of the configuration entity.	2
ConfigEntityBase::$third_party_settings	protected	property	Third party entity settings.
ConfigEntityBase::$trustedData	protected	property	Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid	protected	property	The UUID for this entity.
ConfigEntityBase::addDependency	protected	function	Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::createDuplicate	public	function	Creates a duplicate of the entity. Overrides Entity::createDuplicate	1
ConfigEntityBase::disable	public	function	Disables the configuration entity. Overrides ConfigEntityInterface::disable	1
ConfigEntityBase::enable	public	function	Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get	public	function	Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate	public	function	Returns the cache tags that should be used to invalidate caches. Overrides Entity::getCacheTagsToInvalidate	1
ConfigEntityBase::getConfigDependencyName	public	function	Gets the configuration dependency name. Overrides Entity::getConfigDependencyName
ConfigEntityBase::getConfigManager	protected static	function	Gets the configuration manager.
ConfigEntityBase::getConfigTarget	public	function	Gets the configuration target identifier for the entity. Overrides Entity::getConfigTarget
ConfigEntityBase::getDependencies	public	function	Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId	public	function	Gets the original ID. Overrides Entity::getOriginalId
ConfigEntityBase::getThirdPartyProviders	public	function	Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting	public	function	Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings	public	function	Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig	protected	function	Gets the typed config manager.
ConfigEntityBase::hasTrustedData	public	function	Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete	protected static	function	Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Overrides Entity::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave	protected	function	Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides Entity::invalidateTagsOnSave
ConfigEntityBase::isInstallable	public	function	Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable	2
ConfigEntityBase::isNew	public	function	Overrides Entity::isNew(). Overrides Entity::isNew
ConfigEntityBase::isSyncing	public	function	Returns whether this entity is being changed as part of an import process. Overrides ConfigEntityInterface::isSyncing
ConfigEntityBase::isUninstalling	public	function	Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::link	public	function	Deprecated way of generating a link to the entity. See toLink(). Overrides Entity::link
ConfigEntityBase::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked. Overrides Entity::preDelete	7
ConfigEntityBase::preSave	public	function	Acts on an entity before the presave hook is invoked. Overrides Entity::preSave	12
ConfigEntityBase::save	public	function	Saves an entity permanently. Overrides Entity::save	1
ConfigEntityBase::set	public	function	Sets the value of a property. Overrides ConfigEntityInterface::set	1
ConfigEntityBase::setOriginalId	public	function	Sets the original ID. Overrides Entity::setOriginalId
ConfigEntityBase::setStatus	public	function	Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus	1
ConfigEntityBase::setSyncing	public	function	Sets the status of the isSyncing flag. Overrides ConfigEntityInterface::setSyncing
ConfigEntityBase::setThirdPartySetting	public	function	Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling	public	function
ConfigEntityBase::sort	public static	function	Helper callback for uasort() to sort configuration entities by weight and label.	6
ConfigEntityBase::status	public	function	Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status	2
ConfigEntityBase::toArray	public	function	Gets an array of all property values. Overrides Entity::toArray	2
ConfigEntityBase::toUrl	public	function	Gets the URL object for the entity. Overrides Entity::toUrl
ConfigEntityBase::trustData	public	function	Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData	1
ConfigEntityBase::unsetThirdPartySetting	public	function	Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::url	public	function	Gets the public URL for this entity. Overrides Entity::url
ConfigEntityBase::urlInfo	public	function	Gets the URL object for the entity. Overrides Entity::urlInfo
ConfigEntityBase::__construct	public	function	Constructs an Entity object. Overrides Entity::__construct	10
DataDefinitionInterface::isComputed	public	function	Determines whether the data value is computed.	3
DataDefinitionInterface::isReadOnly	public	function	Determines whether the data is read-only.	3
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function	Aliased as: traitSleep	1
DependencySerializationTrait::__wakeup	public	function		2
DependencyTrait::$dependencies	protected	property	The object's dependencies.	1
DependencyTrait::addDependencies	protected	function	Adds multiple dependencies.
DependencyTrait::addDependency	protected	function	Adds a dependency. Aliased as: addDependencyTrait
Entity::$enforceIsNew	protected	property	Boolean indicating whether the entity should be forced to be new.
Entity::$entityTypeId	protected	property	The entity type.
Entity::$typedData	protected	property	A typed data object wrapping this entity.
Entity::access	public	function	Checks data value access. Overrides AccessibleInterface::access	1
Entity::bundle	public	function	Gets the bundle of the entity. Overrides EntityInterface::bundle	1
Entity::create	public static	function	Overrides EntityInterface::create
Entity::delete	public	function	Deletes an entity permanently. Overrides EntityInterface::delete	2
Entity::enforceIsNew	public	function	Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
Entity::entityManager Deprecated	protected	function	Gets the entity manager.
Entity::entityTypeManager	protected	function	Gets the entity type manager.
Entity::getCacheContexts	public	function	The cache contexts associated with this object. Overrides RefinableCacheableDependencyTrait::getCacheContexts
Entity::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides RefinableCacheableDependencyTrait::getCacheMaxAge
Entity::getCacheTags	public	function	The cache tags associated with this object. Overrides RefinableCacheableDependencyTrait::getCacheTags
Entity::getConfigDependencyKey	public	function	Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
Entity::getEntityType	public	function	Gets the entity type definition. Overrides EntityInterface::getEntityType
Entity::getEntityTypeId	public	function	Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
Entity::getTypedData	public	function	Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
Entity::hasLinkTemplate	public	function	Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
Entity::label	public	function	Gets the label of the entity. Overrides EntityInterface::label	5
Entity::language	public	function	Gets the language of the entity. Overrides EntityInterface::language	1
Entity::languageManager	protected	function	Gets the language manager.
Entity::linkTemplates	protected	function	Gets an array link templates.	1
Entity::load	public static	function	Overrides EntityInterface::load
Entity::loadMultiple	public static	function	Overrides EntityInterface::loadMultiple
Entity::postDelete	public static	function	Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete	14
Entity::postLoad	public static	function	Acts on loaded entities. Overrides EntityInterface::postLoad	2
Entity::preCreate	public static	function	Changes the values of an entity before it is created. Overrides EntityInterface::preCreate	6
Entity::referencedEntities	public	function	Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities	1
Entity::toLink	public	function	Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
Entity::uriRelationships	public	function	Returns a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
Entity::urlRouteParameters	protected	function	Gets an array of placeholders for this entity.	1
Entity::uuid	public	function	Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid	1
Entity::uuidGenerator	protected	function	Gets the UUID generator.
FieldConfigBase::$bundle	protected	property	The name of the bundle the field is attached to.
FieldConfigBase::$constraints	protected	property	Array of constraint options keyed by constraint plugin ID.
FieldConfigBase::$default_value	protected	property	Default field value.
FieldConfigBase::$default_value_callback	protected	property	The name of a callback function that returns default values.
FieldConfigBase::$description	protected	property	The field description.
FieldConfigBase::$entity_type	protected	property	The name of the entity type the field is attached to.
FieldConfigBase::$fieldStorage	protected	property	The field storage object.	1
FieldConfigBase::$field_name	protected	property	The field name.
FieldConfigBase::$field_type	protected	property	The field type.
FieldConfigBase::$id	protected	property	The field ID.
FieldConfigBase::$itemDefinition	protected	property	The data definition of a field item.
FieldConfigBase::$label	protected	property	The human-readable label for the field.
FieldConfigBase::$required	protected	property	Flag indicating whether the field is required.
FieldConfigBase::$settings	protected	property	Field-type specific settings.
FieldConfigBase::$translatable	protected	property	Flag indicating whether the field is translatable.
FieldConfigBase::addConstraint	public	function	Adds a validation constraint to the FieldItemList. Overrides FieldConfigInterface::addConstraint
FieldConfigBase::addPropertyConstraints	public	function	Adds constraints for a given field item property. Overrides FieldConfigInterface::addPropertyConstraints
FieldConfigBase::calculateDependencies	public	function	Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityBase::calculateDependencies	1
FieldConfigBase::createFromDataType	public static	function	Creates a new data definition object. Overrides DataDefinitionInterface::createFromDataType
FieldConfigBase::createFromItemType	public static	function	Creates a new list data definition for items of the given data type. Overrides ListDataDefinitionInterface::createFromItemType
FieldConfigBase::getClass	public	function	Returns the class used for creating the typed data object. Overrides DataDefinitionInterface::getClass
FieldConfigBase::getConfig	public	function	Gets an object that can be saved in configuration. Overrides FieldDefinitionInterface::getConfig
FieldConfigBase::getConstraint	public	function	Returns a validation constraint. Overrides DataDefinitionInterface::getConstraint
FieldConfigBase::getConstraints	public	function	Returns an array of validation constraints. Overrides DataDefinitionInterface::getConstraints
FieldConfigBase::getDataType	public	function	Returns the data type of the data. Overrides DataDefinitionInterface::getDataType
FieldConfigBase::getDefaultValue	public	function	Returns the default value for the field in a newly created entity. Overrides FieldDefinitionInterface::getDefaultValue
FieldConfigBase::getDefaultValueCallback	public	function	Returns the default value callback for the field. Overrides FieldDefinitionInterface::getDefaultValueCallback
FieldConfigBase::getDefaultValueLiteral	public	function	Returns the default value literal for the field. Overrides FieldDefinitionInterface::getDefaultValueLiteral
FieldConfigBase::getDescription	public	function	Returns a human readable description. Overrides DataDefinitionInterface::getDescription
FieldConfigBase::getItemDefinition	public	function	Gets the data definition of an item of the list. Overrides ListDataDefinitionInterface::getItemDefinition
FieldConfigBase::getLabel	public	function	Returns a human readable label. Overrides DataDefinitionInterface::getLabel
FieldConfigBase::getName	public	function	Returns the machine name of the field. Overrides FieldDefinitionInterface::getName
FieldConfigBase::getSetting	public	function	Returns the value of a given setting. Overrides DataDefinitionInterface::getSetting
FieldConfigBase::getSettings	public	function	Returns the array of settings, as required by the used class. Overrides DataDefinitionInterface::getSettings
FieldConfigBase::getTargetBundle	public	function	Gets the bundle the field is attached to. Overrides FieldDefinitionInterface::getTargetBundle
FieldConfigBase::getTargetEntityTypeId	public	function	Returns the ID of the entity type the field is attached to. Overrides FieldDefinitionInterface::getTargetEntityTypeId
FieldConfigBase::getType	public	function	Returns the field type. Overrides FieldDefinitionInterface::getType
FieldConfigBase::id	public	function	Gets the identifier. Overrides Entity::id
FieldConfigBase::isList	public	function	Returns whether the data is multi-valued, i.e. a list of data items. Overrides DataDefinitionInterface::isList
FieldConfigBase::isRequired	public	function	Returns whether the field can be empty. Overrides FieldDefinitionInterface::isRequired
FieldConfigBase::isTranslatable	public	function	Returns whether the field is translatable. Overrides FieldDefinitionInterface::isTranslatable
FieldConfigBase::onDependencyRemoval	public	function	Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityBase::onDependencyRemoval
FieldConfigBase::postCreate	public	function	Acts on a created entity before hooks are invoked. Overrides Entity::postCreate	1
FieldConfigBase::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked. Overrides Entity::postSave
FieldConfigBase::setConstraints	public	function	Sets the array of validation constraints for the FieldItemList. Overrides FieldConfigInterface::setConstraints
FieldConfigBase::setDefaultValue	public	function	Sets a default value. Overrides FieldConfigInterface::setDefaultValue
FieldConfigBase::setDefaultValueCallback	public	function	Sets a custom default value callback. Overrides FieldConfigInterface::setDefaultValueCallback
FieldConfigBase::setDescription	public	function	Sets a human readable description. Overrides FieldConfigInterface::setDescription
FieldConfigBase::setLabel	public	function	Sets the field definition label. Overrides FieldConfigInterface::setLabel
FieldConfigBase::setPropertyConstraints	public	function	Sets constraints for a given field item property. Overrides FieldConfigInterface::setPropertyConstraints
FieldConfigBase::setRequired	public	function	[@inheritdoc} Overrides FieldConfigInterface::setRequired
FieldConfigBase::setSetting	public	function	Sets the value for a field setting by name. Overrides FieldConfigInterface::setSetting
FieldConfigBase::setSettings	public	function	Sets field settings. Overrides FieldConfigInterface::setSettings
FieldConfigBase::setTranslatable	public	function	Sets whether the field is translatable. Overrides FieldConfigInterface::setTranslatable
FieldConfigBase::__sleep	public	function	Implements the magic __sleep() method. Overrides Entity::__sleep	1
FieldDefinitionInterface::getDisplayOptions	public	function	Returns the default display options for the field.	3
FieldDefinitionInterface::getFieldStorageDefinition	public	function	Returns the field storage definition.	3
FieldDefinitionInterface::isDisplayConfigurable	public	function	Returns whether the display for the field can be configured.	3
PluginDependencyTrait::calculatePluginDependencies	protected	function	Calculates and adds dependencies of a specific plugin instance.	1
RefinableCacheableDependencyTrait::$cacheContexts	protected	property	Cache contexts.
RefinableCacheableDependencyTrait::$cacheMaxAge	protected	property	Cache max-age.
RefinableCacheableDependencyTrait::$cacheTags	protected	property	Cache tags.
RefinableCacheableDependencyTrait::addCacheableDependency	public	function		1
RefinableCacheableDependencyTrait::addCacheContexts	public	function
RefinableCacheableDependencyTrait::addCacheTags	public	function
RefinableCacheableDependencyTrait::mergeCacheMaxAge	public	function

You are here

abstract class FieldConfigBase in Zircon Profile 8.0

Hierarchy

File

Namespace

Members

API Navigation