You are here

Home » API reference » Radioactivity 4.0.x » RadioactivityEmitter.php

class RadioactivityEmitter in Radioactivity 4.0.x

Same name and namespace in other branches
  1. 8.3 src/Plugin/Field/FieldFormatter/RadioactivityEmitter.php \Drupal\radioactivity\Plugin\Field\FieldFormatter\RadioactivityEmitter

Plugin implementation of the 'radioactivity_emitter' formatter.

Plugin annotation


@FieldFormatter(
  id = "radioactivity_emitter",
  label = @Translation("Emitter"),
  field_types = {
    "radioactivity"
  }
)

Hierarchy

Expanded class hierarchy of RadioactivityEmitter

File

src/Plugin/Field/FieldFormatter/RadioactivityEmitter.php, line 24

Namespace

Drupal\radioactivity\Plugin\Field\FieldFormatter
View source 
class RadioactivityEmitter extends FormatterBase {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'energy' => 10,
      'display' => 'none',
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    return [
      // Implement settings form.
      'energy' => [
        '#title' => $this
          ->t('Energy'),
        '#type' => 'textfield',
        '#required' => TRUE,
        '#description' => $this
          ->t('The amount of energy to emit when this field is displayed. Examples: 0.5, 10.'),
        '#pattern' => '[0-9]+(\\.[0-9]+)?',
        '#default_value' => $this
          ->getSetting('energy'),
      ],
      'display' => [
        '#title' => $this
          ->t('Display'),
        '#type' => 'select',
        '#options' => [
          'none' => $this
            ->t('Only emit'),
          'raw' => $this
            ->t('Energy level + emit'),
        ],
        '#default_value' => $this
          ->getSetting('display'),
      ],
    ] + parent::settingsForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $summary[] = t('Emit: @energy', [
      '@energy' => $this
        ->getSetting('energy'),
    ]);
    switch ($this
      ->getSetting('display')) {
      case 'none':
        $summary[] = $this
          ->t('Only emit');
        break;
      case 'raw':
        $summary[] = $this
          ->t('Display energy level');
        break;
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    $shouldEmit = $this
      ->shouldEmit($items);
    foreach ($items as $delta => $item) {
      if ($shouldEmit) {
        $incident = Incident::createFromFieldItemsAndFormatter($items, $item, $this);
        $key = 'ra_emit_' . radioactivity_unique_emit_id();
        $elements[$delta] = [
          '#attached' => [
            'library' => [
              'radioactivity/triggers',
            ],
            'drupalSettings' => [
              $key => $incident
                ->toJson(),
            ],
          ],
        ];
      }
      switch ($this
        ->getSetting('display')) {
        case 'raw':
          $elements[$delta]['#markup'] = $this
            ->viewValue($item);
          break;
      }
    }
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function view(FieldItemListInterface $items, $langcode = NULL) {
    $build = parent::view($items, $langcode);

    // If 'none' is chosen (No value - only emit), we do not want this formatter
    // to be rendered as field (it would be rendered in an empty wrapper diff).
    // We only use the children which contain the energy emitter in "#attached".
    if ($this
      ->getSetting('display') == 'none') {
      $children = Element::children($build);
      $build = array_intersect_key($build, $children);
    }
    return $build;
  }

  /**
   * Generate the output appropriate for one field item.
   *
   * @param \Drupal\Core\Field\FieldItemInterface $item
   *   One field item.
   *
   * @return string
   *   The textual output generated.
   */
  protected function viewValue(FieldItemInterface $item) {
    return $item->energy;
  }

  /**
   * Determine if the field should emit energy.
   *
   * @param \Drupal\Core\Field\FieldItemListInterface $items
   *   The field item list of the field.
   *
   * @return bool
   *   True if so.
   */
  protected function shouldEmit(FieldItemListInterface $items) {
    $entity = $items
      ->getEntity();
    if (!$entity instanceof EntityPublishedInterface) {
      return TRUE;
    }
    return $entity
      ->isPublished();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
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 12
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::__construct public function Constructs a FormatterBase object. Overrides PluginBase::__construct 12
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
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 2
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::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
RadioactivityEmitter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
RadioactivityEmitter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
RadioactivityEmitter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
RadioactivityEmitter::shouldEmit protected function Determine if the field should emit energy.
RadioactivityEmitter::view public function Builds a renderable array for a fully themed field. Overrides FormatterBase::view
RadioactivityEmitter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
RadioactivityEmitter::viewValue protected function Generate the output appropriate for one field item.
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.