www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/media_entity/src/MediaTypeBase.php

   1 <?php
   2
   3 namespace Drupal\media_entity;
   4
   5 use Drupal\Component\Plugin\PluginBase;
   6 use Drupal\Core\Config\Config;
   7 use Drupal\Core\Entity\EntityFieldManagerInterface;
   8 use Drupal\Core\Entity\EntityTypeManagerInterface;
   9 use Drupal\Core\StringTranslation\StringTranslationTrait;
  10 use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
  11 use Drupal\Component\Utility\NestedArray;
  12 use Symfony\Component\DependencyInjection\ContainerInterface;
  13 use Drupal\Core\Form\FormStateInterface;
  14
  15 /**
  16  * Base implementation of media type plugin.
  17  */
  18 abstract class MediaTypeBase extends PluginBase implements MediaTypeInterface, ContainerFactoryPluginInterface {
  19   use StringTranslationTrait;
  20
  21   /**
  22    * Plugin label.
  23    *
  24    * @var string
  25    */
  26   protected $label;
  27
  28   /**
  29    * The entity type manager service.
  30    *
  31    * @var \Drupal\Core\Entity\EntityTypeManagerInterface;
  32    */
  33   protected $entityTypeManager;
  34
  35   /**
  36    * The entity field manager service.
  37    *
  38    * @var \Drupal\Core\Entity\EntityFieldManagerInterface;
  39    */
  40   protected $entityFieldManager;
  41
  42   /**
  43    * Media entity image config object.
  44    *
  45    * @var \Drupal\Core\Config\Config
  46    */
  47   protected $config;
  48
  49   /**
  50    * Constructs a new class instance.
  51    *
  52    * @param array $configuration
  53    *   A configuration array containing information about the plugin instance.
  54    * @param string $plugin_id
  55    *   The plugin_id for the plugin instance.
  56    * @param mixed $plugin_definition
  57    *   The plugin implementation definition.
  58    * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
  59    *   Entity type manager service.
  60    * @param \Drupal\Core\Entity\EntityFieldManagerInterface $entity_field_manager
  61    *   Entity field manager service.
  62    * @param \Drupal\Core\Config\Config $config
  63    *   Media entity config object.
  64    */
  65   public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, EntityFieldManagerInterface $entity_field_manager, Config $config) {
  66     parent::__construct($configuration, $plugin_id, $plugin_definition);
  67     $this->entityTypeManager = $entity_type_manager;
  68     $this->entityFieldManager = $entity_field_manager;
  69     $this->config = $config;
  70     $this->setConfiguration($configuration);
  71   }
  72
  73   /**
  74    * {@inheritdoc}
  75    */
  76   public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
  77     return new static(
  78       $configuration,
  79       $plugin_id,
  80       $plugin_definition,
  81       $container->get('entity_type.manager'),
  82       $container->get('entity_field.manager'),
  83       $container->get('config.factory')->get('media_entity.settings')
  84     );
  85   }
  86
  87   /**
  88    * {@inheritdoc}
  89    */
  90   public function setConfiguration(array $configuration) {
  91     $this->configuration = NestedArray::mergeDeep(
  92       $this->defaultConfiguration(),
  93       $configuration
  94     );
  95   }
  96
  97   /**
  98    * {@inheritdoc}
  99    */
 100   public function getConfiguration() {
 101     return $this->configuration;
 102   }
 103
 104   /**
 105    * {@inheritdoc}
 106    */
 107   public function defaultConfiguration() {
 108     return [];
 109   }
 110
 111   /**
 112    * {@inheritdoc}
 113    */
 114   public function getDefaultThumbnail() {
 115     return '';
 116   }
 117
 118   /**
 119    * {@inheritdoc}
 120    */
 121   public function label() {
 122     return $this->label;
 123   }
 124
 125   /**
 126    * {@inheritdoc}
 127    */
 128   public function attachConstraints(MediaInterface $media) {}
 129
 130   /**
 131    * {@inheritdoc}
 132    */
 133   public function calculateDependencies() {
 134     return [];
 135   }
 136
 137   /**
 138    * {@inheritdoc}
 139    */
 140   public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
 141     return [];
 142   }
 143
 144   /**
 145    * {@inheritdoc}
 146    */
 147   public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {}
 148
 149   /**
 150    * {@inheritdoc}
 151    */
 152   public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {}
 153
 154   /**
 155    * {@inheritdoc}
 156    */
 157   public function getDefaultName(MediaInterface $media) {
 158     return 'media:' . $media->bundle() . ':' . $media->uuid();
 159   }
 160
 161 }