You are here

Home » API reference » Entity Construction Kit (ECK) 8 » EckEntityType.php

class EckEntityType in Entity Construction Kit (ECK) 8

Same name in this branch
  1. 8 src/Entity/EckEntityType.php \Drupal\eck\Entity\EckEntityType
  2. 8 src/Plugin/migrate/source/d7/EckEntityType.php \Drupal\eck\Plugin\migrate\source\d7\EckEntityType

Defines the ECK Entity Type config entities.

Plugin annotation


@ConfigEntityType(
  id = "eck_entity_type",
  label = @Translation("ECK entity type"),
  handlers = {
    "list_builder" = "Drupal\eck\Controller\EckEntityTypeListBuilder",
    "form" = {
      "add" = "Drupal\eck\Form\EntityType\EckEntityTypeAddForm",
      "edit" = "Drupal\eck\Form\EntityType\EckEntityTypeEditForm",
      "delete" = "Drupal\eck\Form\EntityType\EckEntityTypeDeleteForm"
    }
  },
  admin_permission = "administer eck entities",
  entity_keys = {
    "id" = "id",
    "label" = "label"
  },
  links = {
    "edit-form" = "/admin/structure/eck/{eck_entity_type}",
    "delete-form" = "/admin/structure/eck/{eck_entity_type}/delete"
  },
  config_export = {
    "id",
    "uuid",
    "label",
    "created",
    "changed",
    "uid",
    "title",
    "status"
  }
)

Hierarchy

Expanded class hierarchy of EckEntityType

9 files declare their use of EckEntityType
eck.module in ./eck.module
Contains hook implementations.
EckEntityContentLocalTask.php in src/Plugin/Derivative/EckEntityContentLocalTask.php
EckEntityTest.php in tests/src/Unit/EckEntityTest.php
EckEntityTest.php in tests/src/Kernel/EckEntityTest.php
EckRoutes.php in src/Routing/EckRoutes.php

... See full list

File

src/Entity/EckEntityType.php, line 47

Namespace

Drupal\eck\Entity
View source 
class EckEntityType extends ConfigEntityBase implements EckEntityTypeInterface {
  use StringTranslationTrait;

  /**
   * If this entity type has an "Author" base field.
   *
   * @var bool
   */
  protected $uid;

  /**
   * If this entity type has a "Title" base field.
   *
   * @var bool
   */
  protected $title;

  /**
   * If this entity type has a "Created" base field.
   *
   * @var bool
   */
  protected $created;

  /**
   * If this entity type has a "Changed" base field.
   *
   * @var bool
   */
  protected $changed;

  /**
   * If this entity type has a "Status" base field.
   *
   * @var bool
   */
  protected $status;

  /**
   * {@inheritdoc}
   */
  public function preSave(EntityStorageInterface $storage) {

    // Entity ids are limited to 32 characters, but since eck adds '_type' to
    // the id of it's bundle storage, that id would be too long. we therefore
    // limit the id to 27 characters.
    if (\strlen($this
      ->id()) > ECK_ENTITY_ID_MAX_LENGTH) {
      throw new \RuntimeException("Entity id has more than " . ECK_ENTITY_ID_MAX_LENGTH . " characters.");
    }
    parent::preSave($storage);
  }

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

    // Clear the router cache to prevent RouteNotFoundException while creating
    // the edit link.
    \Drupal::service('router.builder')
      ->rebuild();
    $edit_link = $this
      ->toLink($this
      ->t('Edit entity type'), 'edit-form')
      ->toString();
    if ($update) {
      $this
        ->logger($this
        ->id())
        ->notice('Entity type %label has been updated.', [
        '%label' => $this
          ->label(),
        'link' => $edit_link,
      ]);
    }
    else {
      $this
        ->logger($this
        ->id())
        ->notice('Entity type %label has been added.', [
        '%label' => $this
          ->label(),
        'link' => $edit_link,
      ]);
    }
    \Drupal::service('eck.entity.entity_update_service')
      ->applyUpdates($this
      ->id());
  }

  /**
   * Load all reference fields with provided target type.
   *
   * @param string $target_entity_type_id
   *   The entity type id created by ECK.
   *
   * @return \Drupal\field\FieldConfigInterface[]
   *   Returns loaded config fields entities.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   */
  public static function loadReferenceFieldsByType($target_entity_type_id) {
    $entity_manager = \Drupal::entityTypeManager();
    $fields_array = \Drupal::service('entity_field.manager')
      ->getFieldMapByFieldType('entity_reference');
    $field_storage = $entity_manager
      ->getStorage('field_config');

    /** @var \Drupal\field\FieldConfigInterface[] $fields_list */
    $fields_list = $list = [];

    // Get list of fields with type entity_reference.
    foreach ($fields_array as $entity_type_id => $fields) {
      foreach ($fields as $field_name => $info) {
        foreach ($info['bundles'] as $bundle) {
          if ($field = $field_storage
            ->load($entity_type_id . '.' . $bundle . '.' . $field_name)) {
            $fields_list[] = $field;
          }
        }
      }
    }
    foreach ($fields_list as $field) {
      if ($field
        ->getSetting('target_type') == $target_entity_type_id) {
        $list[] = $field;
      }
    }
    return $list;
  }

  /**
   * {@inheritdoc}
   */
  public static function preDelete(EntityStorageInterface $storage, array $entities) {
    parent::preDelete($storage, $entities);

    // Remove all reference fields.
    foreach (array_keys($entities) as $entity_type_id) {
      if ($fields = static::loadReferenceFieldsByType($entity_type_id)) {
        foreach ($fields as $field) {
          $field
            ->delete();
          field_purge_field($field);
        }
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function postDelete(EntityStorageInterface $storage, array $entities) {
    parent::postDelete($storage, $entities);
    $entity_update_manager = \Drupal::entityDefinitionUpdateManager();
    foreach ($entities as $entity) {
      $entity_type = $entity_update_manager
        ->getEntityType($entity
        ->id());
      $entity_update_manager
        ->uninstallEntityType($entity_type);
    }
  }

  /**
   * Gets the logger for a specific channel.
   *
   * @param string $channel
   *   The name of the channel.
   *
   * @return \Psr\Log\LoggerInterface
   *   The logger for this channel.
   */
  protected function logger($channel) {
    return \Drupal::getContainer()
      ->get('logger.factory')
      ->get($channel);
  }

  /**
   * {@inheritdoc}
   */
  public function hasAuthorField() {
    return isset($this->uid) && $this->uid;
  }

  /**
   * {@inheritdoc}
   */
  public function hasChangedField() {
    return isset($this->changed) && $this->changed;
  }

  /**
   * {@inheritdoc}
   */
  public function hasCreatedField() {
    return isset($this->created) && $this->created;
  }

  /**
   * {@inheritdoc}
   */
  public function hasTitleField() {
    return isset($this->title) && $this->title;
  }

  /**
   * {@inheritdoc}
   */
  public function hasStatusField() {
    return isset($this->status) && $this->status;
  }

}

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::$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 Information maintained by Drupal core about configuration.
ConfigEntityBase::addDependency protected function Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface::calculateDependencies 13
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::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides EntityBase::getCacheTagsToInvalidate 1
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::link public function Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase::link
ConfigEntityBase::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval 7
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::toUrl public function Gets the URL object for the entity. Overrides EntityBase::toUrl
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::url public function Gets the public URL for this entity. Overrides EntityBase::url
ConfigEntityBase::urlInfo public function Gets the URL object for the entity. Overrides EntityBase::urlInfo
ConfigEntityBase::__construct public function Constructs an Entity object. Overrides EntityBase::__construct 10
ConfigEntityBase::__sleep public function Overrides EntityBase::__sleep 4
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
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.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency. Aliased as: addDependencyTrait
EckEntityType::$changed protected property If this entity type has a "Changed" base field.
EckEntityType::$created protected property If this entity type has a "Created" base field.
EckEntityType::$status protected property If this entity type has a "Status" base field. Overrides ConfigEntityBase::$status
EckEntityType::$title protected property If this entity type has a "Title" base field.
EckEntityType::$uid protected property If this entity type has an "Author" base field.
EckEntityType::hasAuthorField public function Determines if the entity type has an 'author' field. Overrides EckEntityTypeInterface::hasAuthorField
EckEntityType::hasChangedField public function Determines if the entity type has a 'changed' field. Overrides EckEntityTypeInterface::hasChangedField
EckEntityType::hasCreatedField public function Determines if the entity type has a 'created' field. Overrides EckEntityTypeInterface::hasCreatedField
EckEntityType::hasStatusField public function Determines if the entity type has a 'status' field. Overrides EckEntityTypeInterface::hasStatusField
EckEntityType::hasTitleField public function Determines if the entity type has a 'title' field. Overrides EckEntityTypeInterface::hasTitleField
EckEntityType::loadReferenceFieldsByType public static function Load all reference fields with provided target type.
EckEntityType::logger protected function Gets the logger for a specific channel.
EckEntityType::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityBase::postDelete
EckEntityType::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityBase::postSave
EckEntityType::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides ConfigEntityBase::preDelete
EckEntityType::preSave public function Acts on an entity before the presave hook is invoked. Overrides ConfigEntityBase::preSave
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::entityManager Deprecated protected function Gets the entity manager.
EntityBase::entityTypeBundleInfo protected function Gets the entity type bundle info service.
EntityBase::entityTypeManager protected function Gets the entity type manager.
EntityBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
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::id public function Gets the identifier. Overrides EntityInterface::id 11
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::linkTemplates protected function Gets an array link templates. 1
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::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 2
EntityBase::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 5
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::urlRouteParameters protected function Gets an array of placeholders for this entity. 2
EntityBase::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid 1
EntityBase::uuidGenerator protected function Gets the UUID generator.
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. 1
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