class EntityDeriver in Drupal 9

Provides a resource plugin definition for every entity type.

Hierarchy

• class \Drupal\rest\Plugin\Deriver\EntityDeriver implements ContainerDeriverInterface

See also

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

File

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

Namespace

Drupal\rest\Plugin\Deriver

class EntityDeriver implements ContainerDeriverInterface {

  /**
   * 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

Name	Modifiers	Type	Description	Overrides
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.