You are here

Home » API reference » farmOS 2.x » HideableBoolean.php

class HideableBoolean in farmOS 2.x

Plugin implementation of the 'hideable_boolean' formatter.

Extends the core BooleanFormatter to provide settings to conditionally hide a field.

Plugin annotation


@FieldFormatter(
  id = "hideable_boolean",
  label = @Translation("Hideable Boolean"),
  field_types = {
    "boolean",
  }
)

Hierarchy

Expanded class hierarchy of HideableBoolean

File

modules/core/field/src/Plugin/Field/FieldFormatter/HideableBoolean.php, line 23

Namespace

Drupal\farm_field\Plugin\Field\FieldFormatter
View source 
class HideableBoolean extends BooleanFormatter {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    $settings = parent::defaultSettings();
    $settings['hide_if_true'] = FALSE;
    $settings['hide_if_false'] = FALSE;
    return $settings;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form = parent::settingsForm($form, $form_state);
    $form['hide_if_true'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Hide if TRUE'),
      '#default_value' => $this
        ->getSetting('hide_if_true'),
      '#return_value' => TRUE,
    ];
    $form['hide_if_false'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Hide if FALSE'),
      '#default_value' => $this
        ->getSetting('hide_if_false'),
      '#return_value' => TRUE,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    $formats = $this
      ->getOutputFormats();
    foreach ($items as $delta => $item) {
      $format = $this
        ->getSetting('format');
      $hide_if_true = (bool) $this
        ->getSetting('hide_if_true');
      $hide_if_false = (bool) $this
        ->getSetting('hide_if_false');

      // If the item should be hidden, skip it.
      if ($item->value && $hide_if_true || !$item->value && $hide_if_false) {
        continue;
      }
      if ($format == 'custom') {
        $elements[$delta] = [
          '#markup' => $item->value ? $this
            ->getSetting('format_custom_true') : $this
            ->getSetting('format_custom_false'),
        ];
      }
      else {
        $elements[$delta] = [
          '#markup' => $item->value ? $formats[$format][0] : $formats[$format][1],
        ];
      }
    }
    return $elements;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BooleanFormatter::getOutputFormats protected function Gets the available format options.
BooleanFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
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::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 12
HideableBoolean::defaultSettings public static function Defines the default settings for this plugin. Overrides BooleanFormatter::defaultSettings
HideableBoolean::settingsForm public function Returns a form to configure settings for the formatter. Overrides BooleanFormatter::settingsForm
HideableBoolean::viewElements public function Builds a renderable array for a field value. Overrides BooleanFormatter::viewElements
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
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.