You are here

Home » API reference » Library 8 » LibraryItemFieldWidget.php

class LibraryItemFieldWidget in Library 8

Plugin implementation of the 'library_item_field_widget' widget.

Plugin annotation


@FieldWidget(
  id = "library_item_field_widget",
  label = @Translation("Library item widget"),
  field_types = {
    "library_item_field_type"
  }
)

Hierarchy

Expanded class hierarchy of LibraryItemFieldWidget

1 file declares its use of LibraryItemFieldWidget
WidgetSubmit.php in src/WidgetSubmit.php

File

src/Plugin/Field/FieldWidget/LibraryItemFieldWidget.php, line 28

Namespace

Drupal\library\Plugin\Field\FieldWidget
View source 
class LibraryItemFieldWidget extends WidgetBase {

  /**
   * The entity type bundle info.
   *
   * @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface
   */
  protected $entityTypeBundleInfo;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The inline entity from handler.
   *
   * @var \Drupal\inline_entity_form\InlineFormInterface
   */
  protected $inlineFormHandler;

  /**
   * The entity display repository.
   *
   * @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface
   */
  protected $entityDisplayRepository;

  /**
   * Constructs an InlineEntityFormBase object.
   *
   * @param string $plugin_id
   *   The plugin_id for the widget.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The definition of the field to which the widget is associated.
   * @param array $settings
   *   The widget settings.
   * @param array $third_party_settings
   *   Any third party settings.
   * @param \Drupal\Core\Entity\EntityTypeBundleInfoInterface $entity_type_bundle_info
   *   The entity type bundle info.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Entity\EntityDisplayRepositoryInterface $entity_display_repository
   *   The entity display repository.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, array $third_party_settings, EntityTypeBundleInfoInterface $entity_type_bundle_info, EntityTypeManagerInterface $entity_type_manager, EntityDisplayRepositoryInterface $entity_display_repository) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $third_party_settings);
    $this->entityTypeBundleInfo = $entity_type_bundle_info;
    $this->entityTypeManager = $entity_type_manager;
    $this->entityDisplayRepository = $entity_display_repository;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['third_party_settings'], $container
      ->get('entity_type.bundle.info'), $container
      ->get('entity_type.manager'), $container
      ->get('entity_display.repository'));
  }

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $item = $items
      ->get($delta);
    $form_state
      ->set('library_item', TRUE);
    if ($item->target_id && !$item->entity) {
      $element['warning']['#markup'] = $this
        ->t('Unable to load the referenced entity.');
      return $element;
    }

    /** @var \Drupal\library\Entity\LibraryItem $entity */
    $entity = $item->entity;
    $element['library'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Item'),
      '#attributes' => [
        'class' => [
          'container-inline',
        ],
      ],
    ];
    if ($entity) {
      $element['library']['item_id'] = [
        '#type' => 'hidden',
        '#value' => $entity
          ->id(),
      ];
      $element['library']['#entity'] = [
        '#type' => 'hidden',
        '#value' => $entity,
      ];
    }
    $element['library']['barcode'] = [
      '#type' => 'textfield',
      '#size' => 22,
      '#default_value' => $entity ? $entity
        ->get('barcode')->value : '',
      '#maxlength' => $this
        ->getFieldSetting('max_length'),
      '#title' => $this
        ->t('Barcode'),
    ];
    if ($this
      ->generateBarcode()) {
      $element['library']['barcode']['#disabled'] = 'true';
      $element['library']['barcode']['#placeholder'] = $this
        ->t('Automatically generated');
    }
    $element['library']['in_circulation'] = [
      '#type' => 'checkbox',
      '#default_value' => $entity ? $entity
        ->get('in_circulation')->value : 0,
      '#title' => $this
        ->t('Reference only'),
    ];
    $element['library']['library_status'] = [
      '#type' => 'hidden',
      '#default_value' => $entity ? $entity
        ->get('library_status')->value : 0,
    ];
    $element['library']['notes'] = [
      '#type' => 'textfield',
      '#default_value' => $entity ? $entity
        ->get('notes')->value : NULL,
      '#size' => '22',
      '#maxlength' => $this
        ->getFieldSetting('max_length'),
      '#title' => $this
        ->t('Notes'),
    ];
    if (isset($item)) {
      $element['remove'] = [
        '#type' => 'checkbox',
        '#default_value' => 0,
        '#title' => $this
          ->t('Remove'),
      ];
    }
    return $element;
  }

  /**
   * Return whether to generate barcodes from config.
   *
   * @return bool
   *   Generate barcode.
   */
  protected function generateBarcode() {
    return $this->fieldDefinition
      ->getSetting('barcode_generation');
  }

  /**
   * Find the highest barcode number.
   *
   * Fetches default if not in database.
   *
   * @return int
   *   Barcode.
   */
  public static function findHighestBarcode() {
    $databaseValue = NULL;
    $results = \Drupal::EntityQuery('library_item')
      ->sort('barcode', 'DESC')
      ->range(0, 1)
      ->execute();
    foreach ($results as $item) {
      $entity = LibraryItem::load($item);
      $databaseValue = $entity
        ->get('barcode')->value;
    }
    if ($databaseValue && $databaseValue > 1) {
      return $databaseValue;
    }
    else {
      return \Drupal::config('library.settings')
        ->get('barcode_starting_point');
    }
  }

  /**
   * {@inheritdoc}
   */
  public function extractFormValues(FieldItemListInterface $items, array $form, FormStateInterface $form_state) {
    if ($this
      ->isDefaultValueWidget($form_state)) {
      $items
        ->filterEmptyItems();
      return;
    }
    $field_name = $this->fieldDefinition
      ->getName();
    $submittedValues = $form_state
      ->getValue($field_name);
    $sortedEntityReferences = [];
    foreach ($items as $delta => $value) {
      $formElement = NestedArray::getValue($form, [
        $field_name,
        'widget',
        $delta,
      ]);

      /** @var \Drupal\Core\Entity\EntityInterface $entity */
      if (isset($formElement['library']['#entity'], $formElement['library']['#entity']['#value'])) {
        $entity = $formElement['library']['#entity']['#value'];
        $sortedEntityReferences[$submittedValues[$delta]['_weight']] = [
          'target_id' => $entity
            ->id(),
          'entity' => $entity,
        ];
      }
    }
    ksort($sortedEntityReferences);
    $sortedEntityReferences = array_values($sortedEntityReferences);
    $items
      ->setValue($sortedEntityReferences);
    $items
      ->filterEmptyItems();
    $widget_state = [
      'instance' => $this->fieldDefinition,
      'delete' => [],
      'entities' => [],
    ];
    foreach ($items as $delta => $value) {
      $widget_state['entities'][$delta] = [
        'entity' => $value->entity,
        'needs_save' => FALSE,
      ];
    }
    $form_state
      ->set('library_item', $widget_state);
  }

  /**
   * {@inheritdoc}
   */
  public static function isApplicable(FieldDefinitionInterface $field_definition) {
    $target_entity_type_id = $field_definition
      ->getFieldStorageDefinition()
      ->getSetting('target_type');
    if ($target_entity_type_id === 'library_item') {
      return TRUE;
    }
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  protected function formMultipleElements(FieldItemListInterface $items, array &$form, FormStateInterface $form_state) : array {

    // Taken from inline_entity_form.
    $element = parent::formMultipleElements($items, $form, $form_state);

    // If we're using ulimited cardinality we don't display one empty item. Form
    // validation will kick in if left empty which esentially means people won't
    // be able to submit w/o creating another entity.
    if (!$form_state
      ->isSubmitted() && $element['#cardinality'] == FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED && $element['#max_delta'] > 0) {
      $max = $element['#max_delta'];
      unset($element[$max]);
      $element['#max_delta'] = $max - 1;
      $items
        ->removeItem($max);

      // Decrement the items count.
      $field_name = $element['#field_name'];
      $parents = $element[0]['#field_parents'];
      $field_state = static::getWidgetState($parents, $field_name, $form_state);
      $field_state['items_count']--;
      static::setWidgetState($parents, $field_name, $form_state, $field_state);
    }
    return $element;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AllowedTagsXssTrait::allowedTags public function Returns a list of tags allowed by AllowedTagsXssTrait::fieldFilterXss().
AllowedTagsXssTrait::displayAllowedTags public function Returns a human-readable list of allowed tags for display in help texts.
AllowedTagsXssTrait::fieldFilterXss public function Filters an HTML string to prevent XSS vulnerabilities.
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
LibraryItemFieldWidget::$entityDisplayRepository protected property The entity display repository.
LibraryItemFieldWidget::$entityTypeBundleInfo protected property The entity type bundle info.
LibraryItemFieldWidget::$entityTypeManager protected property The entity type manager.
LibraryItemFieldWidget::$inlineFormHandler protected property The inline entity from handler.
LibraryItemFieldWidget::create public static function Creates an instance of the plugin. Overrides WidgetBase::create
LibraryItemFieldWidget::extractFormValues public function Extracts field values from submitted form values. Overrides WidgetBase::extractFormValues
LibraryItemFieldWidget::findHighestBarcode public static function Find the highest barcode number.
LibraryItemFieldWidget::formElement public function Returns the form for a single field widget. Overrides WidgetInterface::formElement
LibraryItemFieldWidget::formMultipleElements protected function Special handling to create form elements for multiple values. Overrides WidgetBase::formMultipleElements
LibraryItemFieldWidget::generateBarcode protected function Return whether to generate barcodes from config.
LibraryItemFieldWidget::isApplicable public static function Returns if the widget can be used for the provided field. Overrides WidgetBase::isApplicable
LibraryItemFieldWidget::__construct public function Constructs an InlineEntityFormBase object. Overrides WidgetBase::__construct
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.
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsInterface::defaultSettings 42
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
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.
WidgetBase::$fieldDefinition protected property The field definition.
WidgetBase::$settings protected property The widget settings. Overrides PluginSettingsBase::$settings
WidgetBase::addMoreAjax public static function Ajax callback for the "Add another item" button.
WidgetBase::addMoreSubmit public static function Submission handler for the "Add another item" button.
WidgetBase::afterBuild public static function After-build handler for field elements in a form.
WidgetBase::errorElement public function Assigns a field-level validation error to the right widget sub-element. Overrides WidgetInterface::errorElement 8
WidgetBase::flagErrors public function Reports field-level validation errors against actual form elements. Overrides WidgetBaseInterface::flagErrors 2
WidgetBase::form public function Creates a form element for a field. Overrides WidgetBaseInterface::form 3
WidgetBase::formSingleElement protected function Generates the form element for a single copy of the widget.
WidgetBase::getFieldSetting protected function Returns the value of a field setting.
WidgetBase::getFieldSettings protected function Returns the array of field settings.
WidgetBase::getFilteredDescription protected function Returns the filtered field description.
WidgetBase::getWidgetState public static function Retrieves processing information about the widget from $form_state. Overrides WidgetBaseInterface::getWidgetState
WidgetBase::getWidgetStateParents protected static function Returns the location of processing information within $form_state.
WidgetBase::handlesMultipleValues protected function Returns whether the widget handles multiple values.
WidgetBase::isDefaultValueWidget protected function Returns whether the widget used for default value form.
WidgetBase::massageFormValues public function Massages the form values into the format expected for field values. Overrides WidgetInterface::massageFormValues 7
WidgetBase::settingsForm public function Returns a form to configure settings for the widget. Overrides WidgetInterface::settingsForm 16
WidgetBase::settingsSummary public function Returns a short summary for the current widget settings. Overrides WidgetInterface::settingsSummary 15
WidgetBase::setWidgetState public static function Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState