class Reference in FileField Sources 8

A FileField source plugin to allow referencing of existing files.

Plugin annotation


@FilefieldSource(
  id = "reference",
  name = @Translation("Autocomplete reference textfield"),
  label = @Translation("Reference existing"),
  description = @Translation("Reuse an existing file by entering its file name."),
  weight = 1
)

Hierarchy

class \Drupal\filefield_sources\Plugin\FilefieldSource\Reference implements FilefieldSourceInterface

Expanded class hierarchy of Reference

File

src/Plugin/FilefieldSource/Reference.php, line 26

Namespace

Drupal\filefield_sources\Plugin\FilefieldSource

View source

class Reference implements FilefieldSourceInterface {

  /**
   * {@inheritdoc}
   */
  public static function value(array &$element, &$input, FormStateInterface $form_state) {
    if (isset($input['filefield_reference']['autocomplete']) && strlen($input['filefield_reference']['autocomplete']) > 0 && $input['filefield_reference']['autocomplete'] != FILEFIELD_SOURCE_REFERENCE_HINT_TEXT) {
      $matches = [];
      if (preg_match('/\\[fid:(\\d+)\\]/', $input['filefield_reference']['autocomplete'], $matches)) {
        $fid = $matches[1];
        if ($file = File::load($fid)) {

          // Remove file size restrictions, since the file already exists on
          // disk.
          if (isset($element['#upload_validators']['file_validate_size'])) {
            unset($element['#upload_validators']['file_validate_size']);
          }

          // Check that the user has access to this file through
          // hook_download().
          if (!$file
            ->access('download')) {
            $form_state
              ->setError($element, t('You do not have permission to use the selected file.'));
          }
          elseif (filefield_sources_element_validate($element, (object) $file, $form_state)) {
            if (!in_array($file
              ->id(), $input['fids'])) {
              $input['fids'][] = $file
                ->id();
            }
          }
        }
        else {
          $form_state
            ->setError($element, t('The referenced file could not be used because the file does not exist in the database.'));
        }
      }

      // No matter what happens, clear the value from the autocomplete.
      $input['filefield_reference']['autocomplete'] = '';
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function process(array &$element, FormStateInterface $form_state, array &$complete_form) {
    $element['filefield_reference'] = [
      '#weight' => 100.5,
      '#theme' => 'filefield_sources_element',
      '#source_id' => 'reference',
      // Required for proper theming.
      '#filefield_source' => TRUE,
      '#filefield_sources_hint_text' => FILEFIELD_SOURCE_REFERENCE_HINT_TEXT,
    ];
    $autocomplete_route_parameters = [
      'entity_type' => $element['#entity_type'],
      'bundle_name' => $element['#bundle'],
      'field_name' => $element['#field_name'],
    ];
    $element['filefield_reference']['autocomplete'] = [
      '#type' => 'textfield',
      '#autocomplete_route_name' => 'filefield_sources.autocomplete',
      '#autocomplete_route_parameters' => $autocomplete_route_parameters,
      '#description' => filefield_sources_element_validation_help($element['#upload_validators']),
    ];
    $class = '\\Drupal\\file\\Element\\ManagedFile';
    $ajax_settings = [
      'callback' => [
        $class,
        'uploadAjaxCallback',
      ],
      'options' => [
        'query' => [
          'element_parents' => implode('/', $element['#array_parents']),
        ],
      ],
      'wrapper' => $element['upload_button']['#ajax']['wrapper'],
      'effect' => 'fade',
    ];
    $element['filefield_reference']['select'] = [
      '#name' => implode('_', $element['#parents']) . '_autocomplete_select',
      '#type' => 'submit',
      '#value' => t('Select'),
      '#validate' => [],
      '#submit' => [
        'filefield_sources_field_submit',
      ],
      '#limit_validation_errors' => [
        $element['#parents'],
      ],
      '#ajax' => $ajax_settings,
    ];
    return $element;
  }

  /**
   * Theme the output of the reference element.
   */
  public static function element($variables) {
    $element = $variables['element'];
    $element['autocomplete']['#field_suffix'] = \Drupal::service('renderer')
      ->render($element['select']);
    return '<div class="filefield-source filefield-source-reference clear-block">' . \Drupal::service('renderer')
      ->render($element['autocomplete']) . '</div>';
  }

  /**
   * Menu callback; autocomplete.js callback to return a list of files.
   */
  public static function autocomplete(Request $request, $entity_type, $bundle_name, $field_name) {
    $matches = [];
    $string = mb_strtolower($request->query
      ->get('q'));
    if (isset($string)) {
      $widget = \Drupal::service('entity_display.repository')
        ->getFormDisplay($entity_type, $bundle_name, 'default')
        ->getComponent($field_name);
      if ($widget) {

        // // If we are looking at a single field, cache its settings, in case we want to search all fields.
        $setting_autocomplete = $widget['third_party_settings']['filefield_sources']['filefield_sources']['source_reference']['autocomplete'];
        $setting_search_all_fields = $widget['third_party_settings']['filefield_sources']['filefield_sources']['source_reference']['search_all_fields'];
      }
      $field_definition = \Drupal::entityTypeManager()
        ->getStorage('field_config')
        ->load($entity_type . '.' . $bundle_name . '.' . $field_name);
      if (!isset($field_definition) || $setting_search_all_fields) {
        $field_definitions = \Drupal::entityTypeManager()
          ->getStorage('field_config')
          ->loadByProperties([
          'type' => [
            'file',
            'image',
          ],
        ]);
      }
      else {
        $field_definitions = [
          $field_definition,
        ];
      }
      foreach ($field_definitions as $field_definition) {
        $handler = \Drupal::getContainer()
          ->get('plugin.manager.entity_reference_selection')
          ->getSelectionHandler($field_definition);

        // If we are searching all fields, use the autocomplete settings from the source field.
        $match_operator = empty($setting_autocomplete) ? 'STARTS_WITH' : 'CONTAINS';

        // Get an array of matching entities.
        $entity_labels = $handler
          ->getReferenceableEntities($string, $match_operator, 10);

        // Loop through the entities and convert them into autocomplete output.
        foreach ($entity_labels as $values) {
          foreach ($values as $entity_id => $label) {
            $key = "{$label} [fid:{$entity_id}]";

            // Strip things like starting/trailing white spaces, line breaks and
            // tags.
            $key = preg_replace('/\\s\\s+/', ' ', str_replace("\n", '', trim(Html::decodeEntities(strip_tags($key)))));

            // Names containing commas or quotes must be wrapped in quotes.
            $matches[] = [
              'value' => $key,
              'label' => $label,
            ];
          }
        }
      }
    }
    return new JsonResponse($matches);
  }

  /**
   * Define routes for Reference source.
   *
   * @return array
   *   Array of routes.
   */
  public static function routes() {
    $routes = [];
    $routes['filefield_sources.autocomplete'] = new Route('/file/reference/{entity_type}/{bundle_name}/{field_name}', [
      '_controller' => get_called_class() . '::autocomplete',
    ], [
      '_access_filefield_sources_field' => 'TRUE',
    ]);
    return $routes;
  }

  /**
   * Implements hook_filefield_source_settings().
   */
  public static function settings(WidgetInterface $plugin) {
    $settings = $plugin
      ->getThirdPartySetting('filefield_sources', 'filefield_sources', [
      'source_reference' => [
        'autocomplete' => FILEFIELD_SOURCE_REFERENCE_MATCH_STARTS_WITH,
        'search_all_fields' => FILEFIELD_SOURCE_REFERENCE_SEARCH_ALL_NO,
      ],
    ]);
    $return['source_reference'] = [
      '#title' => t('Autocomplete reference options'),
      '#type' => 'details',
    ];
    $return['source_reference']['autocomplete'] = [
      '#title' => t('Match file name'),
      '#options' => [
        FILEFIELD_SOURCE_REFERENCE_MATCH_STARTS_WITH => t('Starts with'),
        FILEFIELD_SOURCE_REFERENCE_MATCH_CONTAINS => t('Contains'),
      ],
      '#type' => 'radios',
      '#default_value' => isset($settings['source_reference']['autocomplete']) ? $settings['source_reference']['autocomplete'] : FILEFIELD_SOURCE_REFERENCE_MATCH_STARTS_WITH,
    ];
    $return['source_reference']['search_all_fields'] = [
      '#title' => t('Search all file fields'),
      '#options' => [
        FILEFIELD_SOURCE_REFERENCE_SEARCH_ALL_NO => t('No (only fields with the same field base will be searched)'),
        FILEFIELD_SOURCE_REFERENCE_SEARCH_ALL_YES => t('Yes (all file fields will be searched, regardless of type)'),
      ],
      '#type' => 'radios',
      '#default_value' => isset($settings['source_reference']['search_all_fields']) ? $settings['source_reference']['search_all_fields'] : FILEFIELD_SOURCE_REFERENCE_SEARCH_ALL_NO,
    ];
    return $return;
  }

}

Members

Name	Modifiers	Type	Description
Reference::autocomplete	public static	function	Menu callback; autocomplete.js callback to return a list of files.
Reference::element	public static	function	Theme the output of the reference element.
Reference::process	public static	function	Process callback for file field source plugin. Overrides FilefieldSourceInterface::process
Reference::routes	public static	function	Define routes for Reference source.
Reference::settings	public static	function	Implements hook_filefield_source_settings().
Reference::value	public static	function	Value callback for file field source plugin. Overrides FilefieldSourceInterface::value

You are here

class Reference in FileField Sources 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation