You are here

Home » API reference » Library 8 » LibraryItemFieldFormatter.php

class LibraryItemFieldFormatter in Library 8

Plugin implementation of the 'library_item_field_formatter' formatter.

Plugin annotation


@FieldFormatter(
  id = "library_item_field_formatter",
  label = @Translation("Library item formatter"),
  field_types = {
    "library_item_field_type"
  }
)

Hierarchy

Expanded class hierarchy of LibraryItemFieldFormatter

File

src/Plugin/Field/FieldFormatter/LibraryItemFieldFormatter.php, line 25

Namespace

Drupal\library\Plugin\Field\FieldFormatter
View source 
class LibraryItemFieldFormatter extends FormatterBase {

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) : array {
    $elements = [
      '#type' => 'table',
      '#title' => $this
        ->t('Library items'),
      '#header' => [
        'Barcode',
        'Library status',
        'Notes',
        'Actions',
      ],
    ];
    $rows = [];
    foreach ($items as $delta => $target) {

      /** @var \Drupal\library\Entity\LibraryItem $item */
      $item = \Drupal::entityTypeManager()
        ->getStorage('library_item')
        ->load($target
        ->getValue()['target_id']);
      if ($item
        ->get('barcode')->value || $item
        ->get('in_circulation')->value) {
        $rows[$delta]['barcode'] = nl2br(new HtmlEscapedText($item
          ->get('barcode')->value));
        $rows[$delta]['library_status'] = $this
          ->checkAvailability($item
          ->get('in_circulation')->value, $item
          ->get('library_status')->value);
        $rows[$delta]['notes'] = nl2br(new HtmlEscapedText($item
          ->get('notes')->value));
        $actions = $this
          ->getActions($item
          ->get('in_circulation')->value, $item
          ->get('library_status')->value, $target
          ->getValue()['target_id']);
        if ($actions) {
          $actions = [
            '#type' => 'operations',
            '#links' => $actions,
          ];
          $rows[$delta]['actions'] = \Drupal::service('renderer')
            ->render($actions);
        }
        else {
          unset($elements['#header'][3]);
        }
      }
    }
    $elements['#rows'] = $rows;
    return $elements;
  }

  /**
   * Check availability of item.
   *
   * @param int $in_circulation
   *   Circulation parameter.
   * @param int $status
   *   Status parameter.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup
   *   Formatted response for user.
   */
  protected function checkAvailability($in_circulation, $status) : TranslatableMarkup {
    if ($in_circulation == LibraryItemInterface::REFERENCE_ONLY) {
      return $this
        ->t('Reference only');
    }
    if ($status == LibraryItemInterface::ITEM_AVAILABLE) {
      return $this
        ->t('Item available');
    }
    return $this
      ->t('Item unavailable');
  }

  /**
   * Get actions.
   *
   * @param int $in_circulation
   *   Circulation parameter.
   * @param int $status
   *   Status parameter.
   * @param int $item
   *   Item.
   *
   * @return array
   *   Actions.
   */
  protected function getActions($in_circulation, $status, $item) : array {
    $actions = [];
    if ($in_circulation == LibraryItemInterface::IN_CIRCULATION) {
      if ($status == LibraryItemInterface::ITEM_AVAILABLE) {
        $availableActions = \Drupal::entityQuery('library_action')
          ->condition('action', LibraryAction::CHANGE_TO_UNAVAILABLE)
          ->execute();
        $actions = $this
          ->renderAction($availableActions, $item);
      }
      else {
        $query = \Drupal::entityQuery('library_action');
        $group = $query
          ->orConditionGroup()
          ->condition('action', LibraryAction::CHANGE_TO_AVAILABLE)
          ->condition('action', LibraryAction::NO_CHANGE);
        $availableActions = $query
          ->condition($group)
          ->execute();
        $actions = $this
          ->renderAction($availableActions, $item);
        $actions['edit'] = $this
          ->renderEditAction($item);
      }
    }
    return $actions;
  }

  /**
   * Render the available actions.
   *
   * @param \Drupal\library\Entity\LibraryAction[] $actions
   *   Actions to render.
   * @param int $item
   *   Item by ID.
   *
   * @return array
   *   Markup to render.
   */
  private function renderAction(array $actions, $item) : array {
    $output = [];
    foreach ($actions as $action) {
      $actionEntity = LibraryAction::load($action);
      if ($actionEntity) {
        $output[$actionEntity
          ->id()] = [
          'title' => $actionEntity
            ->label(),
          'url' => Url::fromRoute('library.single_transaction', [
            'action' => $actionEntity
              ->id(),
            'item' => $item,
          ]),
        ];
      }
    }
    return $output;
  }

  /**
   * Render the edit action.
   *
   * Separate, because conditional on existing transactions.
   *
   * @param int $item
   *   Item by ID.
   *
   * @return array
   *   Markup to render.
   */
  private function renderEditAction($item) : array {
    $output = [];
    $itemEntity = LibraryItem::load($item);
    if ($itemEntity) {
      $transaction = $itemEntity
        ->getLatestTransaction();
      if (!empty($transaction)) {
        $output = [
          'title' => 'Edit note',
          'url' => Url::fromRoute('library.edit_transaction', [
            'transaction' => array_shift($transaction),
          ]),
        ];
      }
    }
    return $output;
  }

}

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
FormatterBase::$fieldDefinition protected property The field definition.
FormatterBase::$label protected property The label display setting.
FormatterBase::$settings protected property The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode protected property The view mode.
FormatterBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 11
FormatterBase::getFieldSetting protected function Returns the value of a field setting.
FormatterBase::getFieldSettings protected function Returns the array of field settings.
FormatterBase::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable 14
FormatterBase::prepareView public function Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView 2
FormatterBase::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterInterface::settingsForm 24
FormatterBase::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterInterface::settingsSummary 22
FormatterBase::view public function Builds a renderable array for a fully themed field. Overrides FormatterInterface::view 1
FormatterBase::__construct public function Constructs a FormatterBase object. Overrides PluginBase::__construct 11
LibraryItemFieldFormatter::checkAvailability protected function Check availability of item.
LibraryItemFieldFormatter::getActions protected function Get actions.
LibraryItemFieldFormatter::renderAction private function Render the available actions.
LibraryItemFieldFormatter::renderEditAction private function Render the edit action.
LibraryItemFieldFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
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.