You are here

Home » API reference » Entity Extra Field 2.0.x » EntityExtraField.php

class EntityExtraField in Entity Extra Field 2.0.x

Same name and namespace in other branches
  1. 8 src/Entity/EntityExtraField.php \Drupal\entity_extra_field\Entity\EntityExtraField

Define entity extra field.

Plugin annotation


@ConfigEntityType(
  id = "entity_extra_field",
  label = @Translation("Extra Field"),
  admin_permission = "administer entity extra field",
  config_prefix = "extra_field",
  entity_keys = {
    "id" = "id",
    "label" = "label"
  },
  config_export = {
    "id",
    "label",
    "display_label",
    "name",
    "description",
    "base_entity_type_id",
    "base_bundle_type_id",
    "field_type_id",
    "field_type_config",
    "field_type_condition",
    "field_conditions_all_pass",
    "display"
  },
  handlers = {
    "form" = {
      "add" = "\Drupal\entity_extra_field\Form\EntityExtraFieldForm",
      "edit" = "\Drupal\entity_extra_field\Form\EntityExtraFieldForm",
      "delete" = "\Drupal\entity_extra_field\Form\EntityExtraFieldFormDelete"
    },
    "list_builder" = "\Drupal\entity_extra_field\Controller\EntityExtraFieldListBuilder"
  }
)

Hierarchy

Expanded class hierarchy of EntityExtraField

File

src/Entity/EntityExtraField.php, line 57

Namespace

Drupal\entity_extra_field\Entity
View source 
class EntityExtraField extends ConfigEntityBase implements EntityExtraFieldInterface {
  use StringTranslationTrait;
  use EntityExtraFieldContextTrait;

  /**
   * @var string
   */
  public $id;

  /**
   * @var string
   */
  public $name;

  /**
   * @var string
   */
  public $label;

  /**
   * @var string
   */
  public $description;

  /**
   * @var array
   */
  public $display = [];

  /**
   * @var string
   */
  public $field_type_id;

  /**
   * @var bool
   */
  public $display_label = FALSE;

  /**
   * @var array
   */
  public $field_type_config = [];

  /**
   * @var array
   */
  public $field_type_condition = [];

  /**
   * @var bool
   */
  public $field_conditions_all_pass = FALSE;

  /**
   * @var string
   */
  public $base_entity_type_id;

  /**
   * @var string
   */
  public $base_bundle_type_id;

  /**
   * @var array
   */
  protected $build_attachments = [];

  /**
   * {@inheritdoc}
   */
  public function id() : ?string {
    if (empty($this->name) || empty($this->base_entity_type_id) || empty($this->base_bundle_type_id)) {
      return NULL;
    }
    return "{$this->base_entity_type_id}.{$this->base_bundle_type_id}.{$this->name}";
  }

  /**
   * {@inheritdoc}
   */
  public function name() : ?string {
    return $this->name;
  }

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

  /**
   * {@inheritdoc}
   */
  public function displayLabel() : bool {
    return $this->display_label;
  }

  /**
   * {@inheritdoc}
   */
  public function getDisplay() : array {
    return $this->display;
  }

  /**
   * {@inheritdoc}
   */
  public function getDisplayType() : ?string {
    return $this
      ->getDisplay()['type'] ?? NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function getFieldTypeLabel() : string {
    return $this
      ->getFieldTypePlugin()
      ->label();
  }

  /**
   * {@inheritdoc}
   */
  public function getFieldTypePluginId() : string {
    return $this->field_type_id;
  }

  /**
   * {@inheritdoc}
   */
  public function getFieldTypePluginConfig() : array {
    return $this->field_type_config;
  }

  /**
   * {@inheritDoc}
   */
  public function getFieldTypeCondition() : array {
    return $this->field_type_condition;
  }

  /**
   * {@inheritDoc}
   */
  public function getFieldTypeConditionsAllPass() : bool {
    return $this->field_conditions_all_pass;
  }

  /**
   * {@inheritdoc}
   */
  public function getBaseEntityTypeId() : string {
    return $this->base_entity_type_id;
  }

  /**
   * {@inheritdoc}
   */
  public function getBaseBundleTypeId() : ?string {
    return $this->base_bundle_type_id;
  }

  /**
   * {@inheritdoc}
   */
  public function getBaseEntityType() : EntityTypeInterface {
    return $this
      ->entityTypeManager()
      ->getDefinition($this
      ->getBaseEntityTypeId());
  }

  /**
   * {@inheritdoc}
   */
  public function getBaseEntityTypeBundle() : EntityTypeInterface {
    $entity_type = $this
      ->getBaseEntityType();
    return $this
      ->entityTypeManager()
      ->getDefinition($entity_type
      ->getBundleEntityType());
  }

  /**
   * {@inheritDoc}
   */
  public function getBaseEntityContext() : EntityContext {
    $definition = $this
      ->getBaseEntityType();
    $label = $this
      ->t('@entity being viewed', [
      '@entity' => $definition
        ->getLabel(),
    ]);
    $entity_context = EntityContext::fromEntityType($definition, $label);
    $context_definition = $entity_context
      ->getContextDefinition();
    $context_definition
      ->addConstraint('Bundle', [
      $this
        ->getBaseBundleTypeId(),
    ]);
    return $entity_context;
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheDiscoveryId() : string {
    $langcode = $this
      ->languageManager()
      ->getCurrentLanguage()
      ->getId();
    return "entity_bundle_extra_fields:{$this->getBaseEntityTypeId()}:{$this->getBaseBundleTypeId()}:{$langcode}";
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheRenderTag() : string {
    return "entity_extra_field:{$this->getDisplayType()}.{$this->getBaseEntityTypeId()}.{$this->getBaseBundleTypeId()}";
  }

  /**
   * {@inheritDoc}
   */
  public function getBuildAttachments() : array {
    return $this->build_attachments;
  }

  /**
   * {@inheritDoc}
   */
  public function getActiveFieldTypeConditions() : array {
    return array_filter($this
      ->getFieldTypeCondition(), function ($value) {
      unset($value['id'], $value['negate'], $value['context_mapping']);
      return !$this
        ->isArrayEmpty($value);
    });
  }

  /**
   * {@inheritDoc}
   */
  public function setBuildAttachment($type, array $attachment) : self {
    if (!isset($this->build_attachments[$type])) {
      $this->build_attachments[$type] = [];
    }
    $this->build_attachments[$type] = array_replace_recursive($this->build_attachments[$type], $attachment);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function build(EntityInterface $entity, EntityDisplayInterface $display) : array {
    $field_type_plugin = $this
      ->getFieldTypePlugin();
    if (!$field_type_plugin instanceof ExtraFieldTypePluginInterface) {
      return [];
    }
    return [
      '#field' => $this,
      '#view_mode' => $display
        ->getMode(),
      '#theme' => 'entity_extra_field',
      'label' => [
        '#plain_text' => $this
          ->displayLabel() ? $this
          ->label() : NULL,
      ],
      'content' => $field_type_plugin
        ->build($entity, $display),
    ];
  }

  /**
   * {@inheritDoc}
   */
  public function hasDisplayComponent(EntityDisplayInterface $display) : bool {
    return $display
      ->getComponent($this
      ->name()) !== NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheContexts() : array {
    $contexts = parent::getCacheContexts();
    foreach ($this
      ->getActiveFieldTypeConditions() as $plugin_id => $configuration) {

      /** @var \Drupal\Core\Condition\ConditionPluginBase $condition */
      $condition = $this
        ->conditionPluginManager()
        ->createInstance($plugin_id, $configuration);
      $contexts = Cache::mergeContexts($contexts, $condition
        ->getCacheContexts());
    }
    return $contexts;
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheTagsToInvalidate() : array {
    $tags = parent::getCacheTagsToInvalidate();
    foreach ($this
      ->getActiveFieldTypeConditions() as $plugin_id => $configuration) {

      /** @var \Drupal\Core\Condition\ConditionPluginBase $condition */
      $condition = $this
        ->conditionPluginManager()
        ->createInstance($plugin_id, $configuration);
      $tags = Cache::mergeTags($tags, $condition
        ->getCacheTags());
    }
    return $tags;
  }

  /**
   * {@inheritDoc}
   */
  public function hasConditionsBeenMet(array $contexts, bool $all_must_pass = FALSE) : bool {
    $conditions = $this
      ->getActiveFieldTypeConditions();
    if (empty($conditions)) {
      return TRUE;
    }
    $verdicts = [];
    foreach ($conditions as $plugin_id => $configuration) {

      /** @var \Drupal\Core\Condition\ConditionPluginBase $condition */
      $condition = $this
        ->conditionPluginManager()
        ->createInstance($plugin_id, $configuration);
      if ($condition instanceof ContextAwarePluginInterface) {
        try {
          $this
            ->applyPluginRuntimeContexts($condition, [
            'entity_extra_field' => EntityContext::fromEntity($this),
          ] + $contexts);
        } catch (\Exception $exception) {
          return FALSE;
        }
      }
      $verdict = $condition
        ->evaluate();
      if ($verdict && !$all_must_pass) {
        return TRUE;
      }
      $verdicts[] = $verdict;
    }
    $verdicts = array_unique($verdicts);
    return count($verdicts) === 1 && current($verdicts) === TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function exists($name) : bool {
    return (bool) $this
      ->getQuery()
      ->condition('id', "{$this->getBaseEntityTypeId()}.{$this->getBaseBundleTypeId()}.{$name}")
      ->execute();
  }

  /**
   * {@inheritdoc}
   */
  public function toUrl($rel = 'edit-form', array $options = []) : Url {
    $base_route_name = $this
      ->getBaseRouteName();
    $route_parameters = $this
      ->urlRouteParameters($rel);
    switch ($rel) {
      case 'collection':
        return URL::fromRoute($base_route_name, $route_parameters, $options);
      case 'add-form':
        return Url::fromRoute("{$base_route_name}.add", $route_parameters, $options);
      case 'edit-form':
        return Url::fromRoute("{$base_route_name}.edit", $route_parameters, $options);
      case 'delete-form':
        return Url::fromRoute("{$base_route_name}.delete", $route_parameters, $options);
    }
    throw new \RuntimeException(sprintf('Unable to find %s to built a URL.', $rel));
  }

  /**
   * {@inheritDoc}
   */
  public function calculateDependencies() : self {
    parent::calculateDependencies();
    if ($field_type_plugin = $this
      ->getFieldTypePlugin()) {
      $this
        ->calculatePluginDependencies($field_type_plugin);
    }
    return $this;
  }

  /**
   * Determine if the array is completely empty.
   *
   * @param array $array
   *   A single or multidimensional array.
   *
   * @return bool
   *   Return TRUE if empty, otherwise FALSE.
   */
  protected function isArrayEmpty(array $array) : bool {
    foreach (NestedArray::filter($array) as $value) {
      if (!empty($value)) {
        return FALSE;
      }
      if (is_array($value)) {
        $this
          ->isArrayEmpty($value);
      }
    }
    return TRUE;
  }

  /**
   * Get field type plugin instance.
   *
   * @return \Drupal\entity_extra_field\ExtraFieldTypePluginInterface
   *   The extra field type plugin.
   */
  protected function getFieldTypePlugin() : ExtraFieldTypePluginInterface {
    return \Drupal::service('plugin.manager.extra_field_type')
      ->createInstance($this
      ->getFieldTypePluginId(), $this
      ->getFieldTypePluginConfig());
  }

  /**
   * {@inheritdoc}
   */
  protected function urlRouteParameters($rel) : array {
    $base_bundle_type_id = $this
      ->getBaseEntityTypeBundle()
      ->id();
    $uri_route_parameters = [];
    $uri_route_parameters[$base_bundle_type_id] = $this
      ->getBaseBundleTypeId();
    switch ($rel) {
      case 'edit-form':
      case 'delete-form':
        $uri_route_parameters[$this
          ->getEntityTypeId()] = $this
          ->id();
        break;
    }
    return $uri_route_parameters;
  }

  /**
   * {@inheritdoc}
   */
  protected function linkTemplates() : array {
    $templates = [];
    $ui_base_path = $this
      ->getBaseEntityBundleUiPath();
    $entity_type = $this
      ->getEntityType();
    $entity_handlers = $entity_type
      ->getHandlerClasses();
    if (isset($entity_handlers['form'])) {
      foreach (array_keys($entity_handlers['form']) as $rel) {
        $template_path = "{$ui_base_path}/extra-fields";
        switch ($rel) {
          case 'add':
            $template_path = "{$template_path}/{$rel}";
            break;
          case 'edit':
          case 'delete':
            $template_path = "{$template_path}/{" . $entity_type
              ->id() . "}/{$rel}";
            break;
        }
        $templates[$rel . '-form'] = $template_path;
      }
    }
    $templates['collection'] = "{$ui_base_path}/extra-fields";
    return $templates;
  }

  /**
   * Get base entity bundle UI path.
   *
   * @return string|null
   *   The base entity bundle UI path.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  protected function getBaseEntityBundleUiPath() : ?string {
    $base_route = $this
      ->getBaseEntityType()
      ->get('field_ui_base_route');
    if (!isset($base_route)) {
      return NULL;
    }
    $base_route_rel = strtr(substr($base_route, strrpos($base_route, '.') + 1), [
      '_' => '-',
    ]);
    $base_entity_bundle = $this
      ->getBaseEntityTypeBundle();
    if (!$base_entity_bundle
      ->hasLinkTemplate($base_route_rel)) {
      return NULL;
    }
    return $base_entity_bundle
      ->getLinkTemplate($base_route_rel);
  }

  /**
   * Get base entity route name.
   *
   * @return string
   *   The base entity route.
   */
  protected function getBaseRouteName() : string {
    return "entity.{$this->getBaseEntityTypeId()}.extra_fields";
  }

  /**
   * Get entity storage query.
   *
   * @return \Drupal\Core\Entity\Query\QueryInterface
   *   The entity storage query.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  protected function getQuery() : QueryInterface {
    return $this
      ->getStorage()
      ->getQuery();
  }

  /**
   * Get entity storage.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   *
   * @return \Drupal\Core\Entity\EntityStorageInterface
   *   The entity storage interface.
   */
  protected function getStorage() : EntityStorageInterface {
    return $this
      ->entityTypeManager()
      ->getStorage($this
      ->getEntityTypeId());
  }

  /**
   * Condition plugin manager service.
   *
   * @return \Drupal\Component\Plugin\PluginManagerInterface
   *   The condition plugin manager service.
   */
  protected function conditionPluginManager() : PluginManagerInterface {
    return \Drupal::service('plugin.manager.condition');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CacheableDependencyTrait::$cacheContexts protected property Cache contexts.
CacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
CacheableDependencyTrait::$cacheTags protected property Cache tags.
CacheableDependencyTrait::setCacheability protected function Sets cacheability; useful for value object constructors.
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::$status protected property The enabled/disabled status of the configuration entity. 4
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::$_core protected property
ConfigEntityBase::addDependency protected function Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides EntityBase::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::getConfigDependencyName public function Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager protected static function Gets the configuration manager.
ConfigEntityBase::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies public function Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId public function Gets the original ID. Overrides EntityBase::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 EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave protected function Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides EntityBase::invalidateTagsOnSave
ConfigEntityBase::isInstallable public function Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable 2
ConfigEntityBase::isNew public function Overrides Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling public function Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval 8
ConfigEntityBase::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete 8
ConfigEntityBase::preSave public function Acts on an entity before the presave hook is invoked. Overrides EntityBase::preSave 13
ConfigEntityBase::save public function Saves an entity permanently. Overrides EntityBase::save 1
ConfigEntityBase::set public function Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId public function Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus public function Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
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 4
ConfigEntityBase::toArray public function Gets an array of all property values. Overrides EntityBase::toArray 2
ConfigEntityBase::trustData public function Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::__construct public function Constructs an Entity object. Overrides EntityBase::__construct 10
ConfigEntityBase::__sleep public function Overrides EntityBase::__sleep 4
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function Aliased as: traitSleep 2
DependencySerializationTrait::__wakeup public function 2
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency. Aliased as: addDependencyTrait
EntityBase::$enforceIsNew protected property Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId protected property The entity type.
EntityBase::$typedData protected property A typed data object wrapping this entity.
EntityBase::access public function Checks data value access. Overrides AccessibleInterface::access 1
EntityBase::bundle public function Gets the bundle of the entity. Overrides EntityInterface::bundle 1
EntityBase::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
EntityBase::delete public function Deletes an entity permanently. Overrides EntityInterface::delete 2
EntityBase::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityTypeBundleInfo protected function Gets the entity type bundle info service.
EntityBase::entityTypeManager protected function Gets the entity type manager.
EntityBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getEntityType public function Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityBase::getEntityTypeId public function Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate protected function The list cache tags to invalidate for this entity.
EntityBase::getTypedData public function Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::label public function Gets the label of the entity. Overrides EntityInterface::label 6
EntityBase::language public function Gets the language of the entity. Overrides EntityInterface::language 1
EntityBase::languageManager protected function Gets the language manager.
EntityBase::load public static function Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple public static function Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate 4
EntityBase::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete 18
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 2
EntityBase::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave 14
EntityBase::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 7
EntityBase::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities 1
EntityBase::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid 1
EntityBase::uuidGenerator protected function Gets the UUID generator.
EntityExtraField::$base_bundle_type_id public property
EntityExtraField::$base_entity_type_id public property
EntityExtraField::$build_attachments protected property
EntityExtraField::$description public property
EntityExtraField::$display public property
EntityExtraField::$display_label public property
EntityExtraField::$field_conditions_all_pass public property
EntityExtraField::$field_type_condition public property
EntityExtraField::$field_type_config public property
EntityExtraField::$field_type_id public property
EntityExtraField::$id public property
EntityExtraField::$label public property
EntityExtraField::$name public property
EntityExtraField::build public function Build the extra field. Overrides EntityExtraFieldInterface::build
EntityExtraField::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityBase::calculateDependencies
EntityExtraField::conditionPluginManager protected function Condition plugin manager service.
EntityExtraField::description public function Get the extra field description. Overrides EntityExtraFieldInterface::description
EntityExtraField::displayLabel public function Should display the extra field label. Overrides EntityExtraFieldInterface::displayLabel
EntityExtraField::exists public function Check if entity identifier exist. Overrides EntityExtraFieldInterface::exists
EntityExtraField::getActiveFieldTypeConditions public function Get active field type conditions. Overrides EntityExtraFieldInterface::getActiveFieldTypeConditions
EntityExtraField::getBaseBundleTypeId public function Get base bundle type id. Overrides EntityExtraFieldInterface::getBaseBundleTypeId
EntityExtraField::getBaseEntityBundleUiPath protected function Get base entity bundle UI path.
EntityExtraField::getBaseEntityContext public function Get the base entity context. Overrides EntityExtraFieldInterface::getBaseEntityContext
EntityExtraField::getBaseEntityType public function Get base entity type instance. Overrides EntityExtraFieldInterface::getBaseEntityType
EntityExtraField::getBaseEntityTypeBundle public function Get base entity type bundle instance. Overrides EntityExtraFieldInterface::getBaseEntityTypeBundle
EntityExtraField::getBaseEntityTypeId public function Get base entity type id. Overrides EntityExtraFieldInterface::getBaseEntityTypeId
EntityExtraField::getBaseRouteName protected function Get base entity route name.
EntityExtraField::getBuildAttachments public function Get the build attachments. Overrides EntityExtraFieldInterface::getBuildAttachments
EntityExtraField::getCacheContexts public function The cache contexts associated with this object. Overrides EntityBase::getCacheContexts
EntityExtraField::getCacheDiscoveryId public function Get the cache discovery identifier. Overrides EntityExtraFieldInterface::getCacheDiscoveryId
EntityExtraField::getCacheRenderTag public function Get the cache render tag. Overrides EntityExtraFieldInterface::getCacheRenderTag
EntityExtraField::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides ConfigEntityBase::getCacheTagsToInvalidate
EntityExtraField::getDisplay public function Get extra field display. Overrides EntityExtraFieldInterface::getDisplay
EntityExtraField::getDisplayType public function Get extra field display type. Overrides EntityExtraFieldInterface::getDisplayType
EntityExtraField::getFieldTypeCondition public function Get field type condition. Overrides EntityExtraFieldInterface::getFieldTypeCondition
EntityExtraField::getFieldTypeConditionsAllPass public function Get field type conditions all pass. Overrides EntityExtraFieldInterface::getFieldTypeConditionsAllPass
EntityExtraField::getFieldTypeLabel public function Get field type plugin label. Overrides EntityExtraFieldInterface::getFieldTypeLabel
EntityExtraField::getFieldTypePlugin protected function Get field type plugin instance.
EntityExtraField::getFieldTypePluginConfig public function Get field type plugin configuration. Overrides EntityExtraFieldInterface::getFieldTypePluginConfig
EntityExtraField::getFieldTypePluginId public function Get field type plugin identifier. Overrides EntityExtraFieldInterface::getFieldTypePluginId
EntityExtraField::getQuery protected function Get entity storage query.
EntityExtraField::getStorage protected function Get entity storage.
EntityExtraField::hasConditionsBeenMet public function Has extra field conditions been met. Overrides EntityExtraFieldInterface::hasConditionsBeenMet
EntityExtraField::hasDisplayComponent public function Extra field has display component. Overrides EntityExtraFieldInterface::hasDisplayComponent
EntityExtraField::id public function Gets the identifier. Overrides EntityBase::id
EntityExtraField::isArrayEmpty protected function Determine if the array is completely empty.
EntityExtraField::linkTemplates protected function Gets an array link templates. Overrides EntityBase::linkTemplates
EntityExtraField::name public function Get extra field machine name. Overrides EntityExtraFieldInterface::name
EntityExtraField::setBuildAttachment public function Set a build attachment. Overrides EntityExtraFieldInterface::setBuildAttachment
EntityExtraField::toUrl public function Gets the URL object for the entity. Overrides ConfigEntityBase::toUrl
EntityExtraField::urlRouteParameters protected function Gets an array of placeholders for this entity. Overrides EntityBase::urlRouteParameters
EntityExtraFieldContextTrait::applyPluginRuntimeContexts protected function Apply the plugin runtime contexts.
EntityExtraFieldContextTrait::getContextHandler protected function Get the context handler service.
EntityExtraFieldContextTrait::getContextRepository protected function Get the context repository service.
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance. 1
PluginDependencyTrait::getPluginDependencies protected function Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler protected function Wraps the module handler. 1
PluginDependencyTrait::themeHandler protected function Wraps the theme handler. 1
RefinableCacheableDependencyTrait::addCacheableDependency public function 1
RefinableCacheableDependencyTrait::addCacheContexts public function
RefinableCacheableDependencyTrait::addCacheTags public function
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
SynchronizableEntityTrait::$isSyncing protected property Whether this entity is being created, updated or deleted through a synchronization process.
SynchronizableEntityTrait::isSyncing public function
SynchronizableEntityTrait::setSyncing public function