class EntityDeriver

Same name in this branch
  1. 8.9.x core/lib/Drupal/Core/Entity/Plugin/DataType/Deriver/EntityDeriver.php \Drupal\Core\Entity\Plugin\DataType\Deriver\EntityDeriver
Same name in other branches
  1. 9 core/modules/rest/src/Plugin/Deriver/EntityDeriver.php \Drupal\rest\Plugin\Deriver\EntityDeriver
  2. 9 core/lib/Drupal/Core/Entity/Plugin/DataType/Deriver/EntityDeriver.php \Drupal\Core\Entity\Plugin\DataType\Deriver\EntityDeriver
  3. 10 core/modules/rest/src/Plugin/Deriver/EntityDeriver.php \Drupal\rest\Plugin\Deriver\EntityDeriver
  4. 10 core/lib/Drupal/Core/Entity/Plugin/DataType/Deriver/EntityDeriver.php \Drupal\Core\Entity\Plugin\DataType\Deriver\EntityDeriver
  5. 11.x core/modules/rest/src/Plugin/Deriver/EntityDeriver.php \Drupal\rest\Plugin\Deriver\EntityDeriver
  6. 11.x core/lib/Drupal/Core/Entity/Plugin/DataType/Deriver/EntityDeriver.php \Drupal\Core\Entity\Plugin\DataType\Deriver\EntityDeriver

Provides a resource plugin definition for every entity type.

Hierarchy

Expanded class hierarchy of EntityDeriver

See also

\Drupal\rest\Plugin\rest\resource\EntityResource

File

core/modules/rest/src/Plugin/Deriver/EntityDeriver.php, line 15

Namespace

Drupal\rest\Plugin\Deriver
View source
class EntityDeriver implements ContainerDeriverInterface {
    use DeprecatedServicePropertyTrait;
    
    /**
     * {@inheritdoc}
     */
    protected $deprecatedProperties = [
        'entityManager' => 'entity.manager',
    ];
    
    /**
     * List of derivative definitions.
     *
     * @var array
     */
    protected $derivatives;
    
    /**
     * The entity type manager.
     *
     * @var \Drupal\Core\Entity\EntityTypeManagerInterface
     */
    protected $entityTypeManager;
    
    /**
     * Constructs an EntityDeriver object.
     *
     * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
     *   The entity type manager.
     */
    public function __construct(EntityTypeManagerInterface $entity_type_manager) {
        $this->entityTypeManager = $entity_type_manager;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, $base_plugin_id) {
        return new static($container->get('entity_type.manager'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function getDerivativeDefinition($derivative_id, $base_plugin_definition) {
        if (!isset($this->derivatives)) {
            $this->getDerivativeDefinitions($base_plugin_definition);
        }
        if (isset($this->derivatives[$derivative_id])) {
            return $this->derivatives[$derivative_id];
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function getDerivativeDefinitions($base_plugin_definition) {
        if (!isset($this->derivatives)) {
            // Add in the default plugin configuration and the resource type.
            foreach ($this->entityTypeManager
                ->getDefinitions() as $entity_type_id => $entity_type) {
                if ($entity_type->isInternal()) {
                    continue;
                }
                $this->derivatives[$entity_type_id] = [
                    'id' => 'entity:' . $entity_type_id,
                    'entity_type' => $entity_type_id,
                    'serialization_class' => $entity_type->getClass(),
                    'label' => $entity_type->getLabel(),
                ];
                $default_uris = [
                    'canonical' => "/entity/{$entity_type_id}/" . '{' . $entity_type_id . '}',
                    'create' => "/entity/{$entity_type_id}",
                ];
                foreach ($default_uris as $link_relation => $default_uri) {
                    // Check if there are link templates defined for the entity type and
                    // use the path from the route instead of the default.
                    if ($link_template = $entity_type->getLinkTemplate($link_relation)) {
                        $this->derivatives[$entity_type_id]['uri_paths'][$link_relation] = $link_template;
                    }
                    else {
                        $this->derivatives[$entity_type_id]['uri_paths'][$link_relation] = $default_uri;
                    }
                }
                $this->derivatives[$entity_type_id] += $base_plugin_definition;
            }
        }
        return $this->derivatives;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
DeprecatedServicePropertyTrait::__get public function Allows to access deprecated/removed properties.
EntityDeriver::$deprecatedProperties protected property
EntityDeriver::$derivatives protected property List of derivative definitions.
EntityDeriver::$entityTypeManager protected property The entity type manager.
EntityDeriver::create public static function Creates a new class instance. Overrides ContainerDeriverInterface::create
EntityDeriver::getDerivativeDefinition public function Gets the definition of a derivative plugin. Overrides DeriverInterface::getDerivativeDefinition
EntityDeriver::getDerivativeDefinitions public function Gets the definition of all derivatives of a base plugin. Overrides DeriverInterface::getDerivativeDefinitions
EntityDeriver::__construct public function Constructs an EntityDeriver object.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.