You are here

Home » API reference » File metadata manager 8 » FileMetadataCaching.php

class FileMetadataCaching in File metadata manager 8

Same name and namespace in other branches
  1. 8.2 src/Element/FileMetadataCaching.php \Drupal\file_mdm\Element\FileMetadataCaching

Implements a form element to enable capturing cache information for file_mdm.

Plugin annotation

@FormElement("file_mdm_caching");

Hierarchy

Expanded class hierarchy of FileMetadataCaching

2 #type uses of FileMetadataCaching
FileMetadataPluginBase::buildConfigurationForm in src/Plugin/FileMetadata/FileMetadataPluginBase.php
Form constructor.
SettingsForm::buildForm in src/Form/SettingsForm.php
Form constructor.

File

src/Element/FileMetadataCaching.php, line 13

Namespace

Drupal\file_mdm\Element
View source 
class FileMetadataCaching extends FormElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#input' => TRUE,
      '#process' => [
        [
          $class,
          'processCaching',
        ],
      ],
      '#element_validate' => [
        [
          $class,
          'validateCaching',
        ],
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
    if ($input !== FALSE && $input !== NULL) {
      $disallowed_paths = $input['disallowed_paths'];
      if (!empty($disallowed_paths)) {
        $disallowed_paths = preg_replace('/\\r/', '', $disallowed_paths);
        $disallowed_paths = explode("\n", $disallowed_paths);
        while (empty($disallowed_paths[count($disallowed_paths) - 1])) {
          array_pop($disallowed_paths);
        }
        $input['disallowed_paths'] = $disallowed_paths ?: [];
      }
      else {
        $input['disallowed_paths'] = [];
      }
      return $input;
    }
    return NULL;
  }

  /**
   * Processes a 'file_mdm_caching' form element.
   *
   * @param array $element
   *   The form element to process.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   * @param array $complete_form
   *   The complete form structure.
   *
   * @return array
   *   The processed element.
   */
  public static function processCaching(array &$element, FormStateInterface $form_state, array &$complete_form) {
    $element['enabled'] = [
      '#type' => 'checkbox',
      '#title' => t('Cache metadata'),
      '#default_value' => $element['#default_value']['enabled'],
      '#description' => t("If selected, metadata retrieved from files will be cached for further access."),
    ];
    $options = [
      86400,
      172800,
      604800,
      1209600,
      3024000,
      7862400,
    ];
    $options = array_map([
      \Drupal::service('date.formatter'),
      'formatInterval',
    ], array_combine($options, $options));
    $options = [
      -1 => t('Never'),
    ] + $options;
    $element['expiration'] = [
      '#type' => 'select',
      '#title' => t('Cache expires'),
      '#default_value' => $element['#default_value']['expiration'],
      '#options' => $options,
      '#description' => t("Specify the required lifetime of cached entries. Longer times may lead to increased cache sizes."),
      '#states' => [
        'visible' => [
          ':input[name="' . $element['#name'] . '[enabled]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $element['disallowed_paths'] = [
      '#type' => 'textarea',
      '#title' => t('Excluded paths'),
      '#rows' => 3,
      '#default_value' => implode("\n", $element['#default_value']['disallowed_paths']),
      '#description' => t("Only files prefixed by a valid URI scheme will be cached, like for example <kbd>public://</kbd>. Files in the <kbd>temporary://</kbd> scheme will never be cached. Specify here if there are any paths to be additionally <strong>excluded</strong> from caching, one per line. Use wildcard patterns when entering the path. For example, <kbd>public://styles/*</kbd>."),
      '#states' => [
        'visible' => [
          ':input[name="' . $element['#name'] . '[enabled]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    return $element;
  }

  /**
   * Form element validation handler.
   */
  public static function validateCaching(&$element, FormStateInterface $form_state, &$complete_form) {

    // Validate cache exclusion paths.
    foreach ($element['#value']['disallowed_paths'] as $path) {
      if (!file_valid_uri($path)) {
        $form_state
          ->setError($element['disallowed_paths'], t("'@path' is an invalid URI path", [
          '@path' => $path,
        ]));
      }
    }
  }

}

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
FileMetadataCaching::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
FileMetadataCaching::processCaching public static function Processes a 'file_mdm_caching' form element.
FileMetadataCaching::validateCaching public static function Form element validation handler.
FileMetadataCaching::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElement::valueCallback
FormElement::processAutocomplete public static function Adds autocomplete functionality to elements.
FormElement::processPattern public static function #process callback for #pattern form element property.
FormElement::validatePattern public static function #element_validate callback for #pattern form element property.
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.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 92
RenderElement::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup public static function Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm public static function Form element processing handler for the #ajax form property. 1
RenderElement::processGroup public static function Arranges elements into groups.
RenderElement::setAttributes public static function Sets a form element's class attribute. Overrides ElementInterface::setAttributes
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.