class HideIfEmpty in Field Formatter Condition 8

The plugin for check empty fields.

Plugin annotation

@FieldFormatterCondition(
  id = "hide_if_empty",
  label = @Translation("Hide when target field is empty"),
  dsFields = TRUE,
  types = {
    "all"
  }
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\fico\Plugin\FieldFormatterConditionBase implements FieldFormatterConditionInterface
    • class \Drupal\fico\Plugin\Field\FieldFormatter\Condition\HideIfEmpty

File

src/Plugin/Field/FieldFormatter/Condition/HideIfEmpty.php, line 19

Namespace

Drupal\fico\Plugin\Field\FieldFormatter\Condition

class HideIfEmpty extends FieldFormatterConditionBase {

  /**
   * {@inheritdoc}
   */
  public function alterForm(&$form, $settings) {
    $options = [];
    $fields = $this
      ->getEntityFields($settings['entity_type'], $settings['bundle']);
    $not_allowed = [
      "list_string",
      "boolean",
    ];
    foreach ($fields as $field_name => $field) {
      if ($field_name != $settings['field_name']) {
        if (!in_array($field
          ->getType(), $not_allowed)) {
          $options[$field_name] = $field
            ->getLabel();
        }
      }
    }
    $default_value = isset($settings['settings']['target_field']) ? $settings['settings']['target_field'] : NULL;
    $form['target_field'] = [
      '#type' => 'select',
      '#title' => t('Field'),
      '#options' => $options,
      '#default_value' => $default_value,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function access(&$build, $field, $settings) {
    if (isset($build[$settings['settings']['target_field']]['#items'])) {
      $fields = $build[$settings['settings']['target_field']]['#items'];
      if (is_object($fields)) {
        $field_storage = FieldStorageConfig::loadByName($settings['entity_type'], $settings['settings']['target_field']);
        $values = $fields
          ->getValue();
        switch ($field_storage
          ->getType()) {
          case 'comment':
            if ($values[0]['comment_count'] == 0) {
              $build[$field]['#access'] = FALSE;
            }
            break;
          case 'image':
          case 'entity_reference':
            if (!isset($values[0]['target_id'])) {
              $build[$field]['#access'] = FALSE;
            }
            break;
          case 'link':
            if (!isset($values[0]['uri'])) {
              $build[$field]['#access'] = FALSE;
            }
            break;
          default:
            if (!isset($values[0]['value'])) {
              $build[$field]['#access'] = FALSE;
            }
        }
      }
    }
    else {
      if ($entity = $this
        ->getEntity($build)) {
        if ($entity
          ->get($settings['settings']['target_field'])
          ->isEmpty()) {
          $build[$field]['#access'] = FALSE;
        }
      }
      else {
        $build[$field]['#access'] = FALSE;
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function summary($settings) {
    $options = [];
    $fields = $this
      ->getEntityFields($settings['entity_type'], $settings['bundle']);
    foreach ($fields as $field_name => $field) {
      if ($field_name != $settings['field_name']) {
        $options[$field_name] = $field
          ->getLabel();
      }
    }
    return t("Condition: %condition (%settings)", [
      "%condition" => t('Hide when target field is empty'),
      '%settings' => $options[$settings['settings']['target_field']],
    ]);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FieldFormatterConditionBase::createInstance	public	function	Creates a pre-configured instance of a plugin. Overrides FactoryInterface::createInstance
FieldFormatterConditionBase::getDefinition	public	function	Gets a specific plugin definition. Overrides DiscoveryInterface::getDefinition
FieldFormatterConditionBase::getDefinitions	public	function	Gets the definition of all plugins for this type. Overrides DiscoveryInterface::getDefinitions
FieldFormatterConditionBase::getEntity	protected	function	Check for entity in build.
FieldFormatterConditionBase::getEntityFields	protected	function	Load fields from a entity.
FieldFormatterConditionBase::getEntityType	protected	function	Check for entity_type in build.
FieldFormatterConditionBase::getInstance	public	function	Gets a preconfigured instance of a plugin. Overrides MapperInterface::getInstance
FieldFormatterConditionBase::hasDefinition	public	function	Indicates if a specific plugin definition exists. Overrides DiscoveryInterface::hasDefinition
HideIfEmpty::access	public	function	Access control function. Overrides FieldFormatterConditionBase::access
HideIfEmpty::alterForm	public	function	Alter the condition form. Overrides FieldFormatterConditionBase::alterForm
HideIfEmpty::summary	public	function	Return the summary string. Overrides FieldFormatterConditionBase::summary
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92