Drupal\Driver\Plugin\DriverEntityPluginDrupal8Base

Complexity

Total Complexity

29

Size/Duplication

Total Lines	260
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

18 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
A	delete()	0	4	1
A	getBundleKey()	0	6	1
A	getBundleKeyLabels()	0	11	2
A	getBundles()	0	10	2
A	getEntity()	0	8	2
A	getLabelKeys()	0	12	2
A	id()	0	4	1
A	isNew()	0	7	3
A	label()	0	4	1
A	load()	0	9	3
A	reload()	0	10	2
A	save()	0	5	1
A	set()	0	7	2
A	url()	0	4	1
A	getNewDriverField()	0	12	1
A	getStorage()	0	4	1
A	getNewEntity()	0	12	2

<?php

namespace Drupal\Driver\Plugin;

use Drupal\Component\Plugin\PluginBase;
use Drupal\Driver\Exception\Exception;
use Drupal\Driver\Wrapper\Field\DriverFieldInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Driver\Wrapper\Field\DriverFieldDrupal8;
use Drupal\Driver\Wrapper\Entity\DriverEntityInterface;

/**
 * Provides a base class for the Driver's entity plugins.
 */
class DriverEntityPluginDrupal8Base extends DriverEntityPluginBase implements DriverEntityPluginInterface, DriverEntityInterface
{

  /**
   * The id of the attached entity.
   *
   * @var integer|string;
   *
   * @deprecated Use id() instead.
   */
    public $id;

  /**
   * Entity type definition.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
    protected $storage;

  /**
   * The saved Drupal entity this object is wrapping for the Driver.
   *
   * @var \Drupal\Core\Entity\EntityInterface;
   */
    protected $entity;

  /**
   * The driver field plugin manager.
   *
   * @var \Drupal\Driver\Plugin\DriverPluginManagerInterface;
   */
    protected $fieldPluginManager;


  /**
   * The drupal entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface;
   */
    protected $entityTypeManager;

  /**
   * {@inheritdoc}
   */
    public function __construct(
        array $configuration,
        $plugin_id,
        $plugin_definition
    ) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->entityTypeManager = \Drupal::entityTypeManager();
        $this->storage = $this->entityTypeManager->getStorage($this->type);
    }

  /**
   * {@inheritdoc}
   */
    public function delete()
    {
        $this->getEntity()->delete();
    }

  /**
   * {@inheritdoc}
   */
    public function getBundleKey()
    {
        return $this->entityTypeManager
        ->getDefinition($this->type)
        ->getKey('bundle');
    }

  /**
   * {@inheritdoc}
   */
    public function getBundleKeyLabels()
    {
        $bundleKeyLabel = null;
        $bundleKey = $this->getBundleKey();
        if (!empty($bundleKey)) {
            $definitions = \Drupal::service('entity_field.manager')
            ->getBaseFieldDefinitions($this->type);
            $bundleKeyLabel = $definitions[$bundleKey]->getLabel();
        }
        return [(string) $bundleKeyLabel];
    }

  /**
   * {@inheritdoc}
   */
    public function getBundles()
    {
        $bundleInfo = \Drupal::service('entity_type.bundle.info')->getBundleInfo($this->type);
        // Parse into array structure used by DriverNameMatcher.
        $bundles = [];
        foreach ($bundleInfo as $machineName => $bundleSettings) {
            $bundles[$bundleSettings['label']] = $machineName;
        }
        return $bundles;
    }

  /**
   * {@inheritdoc}
   */
    public function getEntity()
    {
        $entity = parent::getEntity();
        if (!$entity instanceof EntityInterface) {

The class Drupal\Core\Entity\EntityInterface does not exist. Did you forget a USE statement, or did you not list all dependencies?

            throw new \Exception("Failed to obtain valid entity");
        }
        return $this->entity;
    }

  /**
   * {@inheritdoc}
   */
    public function getLabelKeys()
    {
        $labelKeys = parent::getLabelKeys();
        if (empty($labelKeys)) {
            $labelKeys = [
            $this->entityTypeManager
              ->getDefinition($this->type)
              ->getKey('label')
            ];
        }
        return $labelKeys;
    }

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

  /**
   * {@inheritdoc}
   */
    public function isNew()
    {
        if ($this->hasEntity() && !$this->entity->isNew()) {
            return false;
        }
        return true;
    }

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

  /**
   * {@inheritdoc}
   */
    public function load($entityId)
    {
        if ($this->hasEntity()) {
            throw new \Exception("A Drupal entity is already attached to this plugin");
        }
        $this->entity = $this->getStorage()->load($entityId);
        $this->id = is_null($this->entity) ? NULL : $this->id();

The property Drupal\Driver\Plugin\DriverEntityPluginDrupal8Base::$id has been deprecated with message: Use id() instead.

        return $this->entity;
    }

  /**
   * {@inheritdoc}
   */
    public function reload()
    {
        if (!$this->hasEntity()) {
            throw new \Exception("There is no attached entity so it cannot be reloaded");
        }
        $entityId = $this->getEntity()->id();
        $this->getStorage()->resetCache([$entityId]);
        $this->entity = $this->getStorage()->load($entityId);
        return $this->entity;
    }

  /**
   * {@inheritdoc}
   */
    public function save()
    {
        $this->getEntity()->save();
        $this->id = $this->id();

The property Drupal\Driver\Plugin\DriverEntityPluginDrupal8Base::$id has been deprecated with message: Use id() instead.

    }

  /**
   * {@inheritdoc}
   */
    public function set($identifier, $field)
    {
        if (!($field instanceof DriverFieldInterface)) {
            $field = $this->getNewDriverField($identifier, $field);
        }
        $this->getEntity()->set($field->getName(), $field->getProcessedValues());
    }

  /**
   * {@inheritdoc}
   */
    public function url($rel = 'canonical', $options = [])
    {
        return $this->getEntity()->url($rel, $options);
    }

  /**
   * Get a new driver field with values.
   *
   * @param string $fieldName
   *   A string identifying an entity field.
   * @param string|array $values
   *   An input that can be transformed into Driver field values.
   */
    protected function getNewDriverField($fieldName, $values)
    {
        $field = new DriverFieldDrupal8(
            $values,
            $fieldName,
            $this->type,
            $this->bundle,
            $this->projectPluginRoot,
            $this->fieldPluginManager
        );
        return $field;
    }

  /**
   * Get the entity type storage.
   *
   * @return \Drupal\Core\Entity\EntityStorageInterface
   */
    protected function getStorage()
    {
        return $this->storage;
    }

  /**
   * Get a new entity object.
   *
   * @return \Drupal\Core\Entity\EntityInterface
   */
    protected function getNewEntity()
    {
        $values = [];
        // Set the bundle as a field if not simply using the default for
        // a bundle-less entity type.
        if ($this->type !== $this->bundle) {
            $bundleKey = $this->getBundleKey();
            $values[$bundleKey] = $this->bundle;
        }
        $entity = $this->getStorage()->create($values);
        return $entity;
    }
}