abstract class MediaFinderBase in Group Media 8.2

Class MediaFinderBase.

@package Drupal\groupmedia\Plugin\MediaFinder

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\groupmedia\Plugin\MediaFinder\MediaFinderBase implements ContainerFactoryPluginInterface, MediaFinderInterface

File

src/Plugin/MediaFinder/MediaFinderBase.php, line 19

Namespace

Drupal\groupmedia\Plugin\MediaFinder

abstract class MediaFinderBase extends PluginBase implements MediaFinderInterface, ContainerFactoryPluginInterface {

  /**
   * The module handler service.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * MediaFinderBase constructor.
   *
   * @param array $configuration
   *   Plugin configuration.
   * @param string $plugin_id
   *   Plugin Id.
   * @param mixed $plugin_definition
   *   Plugin definition.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $moduleHandler
   *   The module handler service for alter hooks.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ModuleHandlerInterface $moduleHandler) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->moduleHandler = $moduleHandler;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('module_handler'));
  }

  /**
   * {@inheritdoc}
   */
  public function getApplicableFieldTypes() {
    return $this->pluginDefinition['field_types'] ?: [];
  }

  /**
   * {@inheritdoc}
   */
  public function applies(EntityInterface $entity) {
    if ($entity instanceof FieldableEntityInterface) {
      return TRUE;
    }
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function shouldBeAdded(MediaInterface $media, EntityInterface $entity, $field_name) {
    $return = [];
    $context = [
      'entity' => $entity,
      'field_name' => $field_name,
    ];
    $this->moduleHandler
      ->alter('groupmedia_finder_add', $return, $media, $context);
    if (!is_array($return)) {
      return FALSE;
    }

    // If at least 1 module says "No", the media will not be attached.
    foreach ($return as $item) {
      if (!$item) {
        return FALSE;
      }
    }

    // Otherwise - process.
    return TRUE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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		1
DependencySerializationTrait::__wakeup	public	function		2
MediaFinderBase::$moduleHandler	protected	property	The module handler service.
MediaFinderBase::applies	public	function	Checks if the plugin can be applied. Overrides MediaFinderInterface::applies
MediaFinderBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	1
MediaFinderBase::getApplicableFieldTypes	public	function	Returns the field types this plugin is capable of tracking. Overrides MediaFinderInterface::getApplicableFieldTypes
MediaFinderBase::shouldBeAdded	public	function	Checks whether media item should be considered as group content. Overrides MediaFinderInterface::shouldBeAdded
MediaFinderBase::__construct	public	function	MediaFinderBase constructor. Overrides PluginBase::__construct
MediaFinderInterface::process	public	function	Search for the attached media entities.	2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
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.