You are here

Home » API reference » Linkit 8.4 » FileMatcher.php

class FileMatcher in Linkit 8.4

Same name and namespace in other branches
  1. 8.5 src/Plugin/Linkit/Matcher/FileMatcher.php \Drupal\linkit\Plugin\Linkit\Matcher\FileMatcher

Plugin annotation


@Matcher(
  id = "entity:file",
  target_entity = "file",
  label = @Translation("File"),
  provider = "file"
)

Hierarchy

Expanded class hierarchy of FileMatcher

File

src/Plugin/Linkit/Matcher/FileMatcher.php, line 22
Contains \Drupal\linkit\Plugin\Linkit\Matcher\FileMatcher.

Namespace

Drupal\linkit\Plugin\Linkit\Matcher
View source 
class FileMatcher extends EntityMatcher {

  /**
   * {@inheritdoc}
   */
  public function getSummary() {
    $summery = parent::getSummary();
    $summery[] = $this
      ->t('Show image dimensions: @show_image_dimensions', [
      '@show_image_dimensions' => $this->configuration['images']['show_dimensions'] ? $this
        ->t('Yes') : $this
        ->t('No'),
    ]);
    $summery[] = $this
      ->t('Show image thumbnail: @show_image_thumbnail', [
      '@show_image_thumbnail' => $this->configuration['images']['show_thumbnail'] ? $this
        ->t('Yes') : $this
        ->t('No'),
    ]);
    if ($this->moduleHandler
      ->moduleExists('image') && $this->configuration['images']['show_thumbnail']) {
      $image_style = ImageStyle::load($this->configuration['images']['thumbnail_image_style']);
      if (!is_null($image_style)) {
        $summery[] = $this
          ->t('Thumbnail style: @thumbnail_style', [
          '@thumbnail_style' => $image_style
            ->label(),
        ]);
      }
    }
    return $summery;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return parent::defaultConfiguration() + [
      'images' => [
        'show_dimensions' => FALSE,
        'show_thumbnail' => FALSE,
        'thumbnail_image_style' => 'linkit_result_thumbnail',
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    $dependencies = parent::calculateDependencies() + [
      'module' => [
        'file',
      ],
    ];
    if ($this->configuration['images']['show_thumbnail']) {
      $dependencies['module'][] = 'image';
      $dependencies['config'][] = 'image.style.' . $this->configuration['images']['thumbnail_image_style'];
    }
    return $dependencies;
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildConfigurationForm($form, $form_state);
    $form['images'] = array(
      '#type' => 'details',
      '#title' => t('Image file settings'),
      '#description' => t('Extra settings for image files in the result.'),
      '#tree' => TRUE,
    );
    $form['images']['show_dimensions'] = [
      '#title' => t('Show pixel dimensions'),
      '#type' => 'checkbox',
      '#default_value' => $this->configuration['images']['show_dimensions'],
    ];
    if ($this->moduleHandler
      ->moduleExists('image')) {
      $form['images']['show_thumbnail'] = [
        '#title' => t('Show thumbnail'),
        '#type' => 'checkbox',
        '#default_value' => $this->configuration['images']['show_thumbnail'],
      ];
      $form['images']['thumbnail_image_style'] = [
        '#title' => t('Thumbnail image style'),
        '#type' => 'select',
        '#default_value' => $this->configuration['images']['thumbnail_image_style'],
        '#options' => image_style_options(FALSE),
        '#states' => [
          'visible' => [
            ':input[name="images[show_thumbnail]"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
      ];
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    $values = $form_state
      ->getValue('images');
    if (!$values['show_thumbnail']) {
      $values['thumbnail_image_style'] = NULL;
    }
    $this->configuration['images'] = $values;
  }

  /**
   * {@inheritdoc}
   */
  protected function buildEntityQuery($match) {
    $query = parent::buildEntityQuery($match);
    $query
      ->condition('status', FILE_STATUS_PERMANENT);
    return $query;
  }

  /**
   * {@inheritdoc}
   */
  protected function buildDescription($entity) {
    $description_array = array();
    $description_array[] = parent::buildDescription($entity);

    /** @var \Drupal\file\FileInterface $entity */
    $file = $entity
      ->getFileUri();

    /** @var \Drupal\Core\Image\ImageInterface $image */
    $image = \Drupal::service('image.factory')
      ->get($file);
    if ($image
      ->isValid()) {
      if ($this->configuration['images']['show_dimensions']) {
        $description_array[] = $image
          ->getWidth() . 'x' . $image
          ->getHeight() . 'px';
      }
      if ($this->configuration['images']['show_thumbnail'] && $this->moduleHandler
        ->moduleExists('image')) {
        $image_element = array(
          '#weight' => -10,
          '#theme' => 'image_style',
          '#style_name' => $this->configuration['images']['thumbnail_image_style'],
          '#uri' => $entity
            ->getFileUri(),
        );
        $description_array[] = (string) \Drupal::service('renderer')
          ->render($image_element);
      }
    }
    $description = implode('<br />', $description_array);
    return LinkitXss::descriptionFilter($description);
  }

  /**
   * {@inheritdoc}
   *
   * The file entity still uses url() even though it's deprecated in the
   * entity interface.
   */
  protected function buildPath($entity) {

    /** @var \Drupal\file\FileInterface $entity */
    return file_url_transform_relative(file_create_url($entity
      ->getFileUri()));
  }

}

Members

Namesort descending 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
EntityMatcher::$currentUser protected property The current user.
EntityMatcher::$database protected property The database connection.
EntityMatcher::$entityManager protected property The entity manager.
EntityMatcher::$moduleHandler protected property The module handler service.
EntityMatcher::$target_type protected property The target entity type id
EntityMatcher::buildGroup protected function Builds the group string used in the match array.
EntityMatcher::buildLabel protected function Builds the label string used in the match array.
EntityMatcher::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
EntityMatcher::elementValidateFilter public static function Form element validation handler; Filters the #value property of an element.
EntityMatcher::getMatches public function Gets an array with search matches that will be presented in the autocomplete widget. Overrides MatcherInterface::getMatches
EntityMatcher::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
EntityMatcher::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides MatcherBase::__construct
FileMatcher::buildConfigurationForm public function Form constructor. Overrides EntityMatcher::buildConfigurationForm
FileMatcher::buildDescription protected function Builds the description string used in the match array. Overrides EntityMatcher::buildDescription
FileMatcher::buildEntityQuery protected function Builds an EntityQuery to get entities. Overrides EntityMatcher::buildEntityQuery
FileMatcher::buildPath protected function The file entity still uses url() even though it's deprecated in the entity interface. Overrides EntityMatcher::buildPath
FileMatcher::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides MatcherBase::calculateDependencies
FileMatcher::defaultConfiguration public function Gets default configuration for this plugin. Overrides EntityMatcher::defaultConfiguration
FileMatcher::getSummary public function Returns the summarized configuration of the matcher. Overrides EntityMatcher::getSummary
FileMatcher::submitConfigurationForm public function Form submission handler. Overrides EntityMatcher::submitConfigurationForm
MatcherBase::$uuid protected property The matcher ID.
MatcherBase::$weight protected property The weight of the matcher compared to others in a matcher collection.
MatcherBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurablePluginInterface::getConfiguration
MatcherBase::getLabel public function Returns the matcher label. Overrides MatcherInterface::getLabel
MatcherBase::getUuid public function Returns the unique ID representing the matcher. Overrides MatcherInterface::getUuid
MatcherBase::getWeight public function Returns the weight of the matcher. Overrides MatcherInterface::getWeight
MatcherBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurablePluginInterface::setConfiguration
MatcherBase::setWeight public function Sets the weight for the matcher. Overrides MatcherInterface::setWeight
MatcherTokensTrait::getAvailableTokens public function Gets all available tokens.
MatcherTokensTrait::insertTokenList public function Inserts a form element with a list of available tokens.
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.