class EmptyFieldText in Empty fields 8

Defines EmptyFieldText.

Plugin annotation

@EmptyField(
  id = "text",
  label = @Translation("Display custom text")
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\empty_fields\EmptyFieldPluginBase implements ConfigurableInterface, EmptyFieldPluginInterface
      • class \Drupal\empty_fields\Plugin\EmptyFields\EmptyFieldText

File

src/Plugin/EmptyFields/EmptyFieldText.php, line 16

Namespace

Drupal\empty_fields\Plugin\EmptyFields

class EmptyFieldText extends EmptyFieldPluginBase {

  /**
   * {@inheritdoc}
   */
  public function react(array $context) {
    $args = [
      $context['entity']
        ->getEntityTypeId() => $context['entity'],
      'user' => \Drupal::currentUser(),
    ];
    $text = \Drupal::token()
      ->replace($this->configuration['empty_text'], $args, [
      'clear' => TRUE,
    ]);
    return [
      '#markup' => $text,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form['empty_text'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Display Custom Text'),
      '#default_value' => $this->configuration['empty_text'],
      '#description' => $this
        ->t('Display text if the field is empty.'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    return $this
      ->t('Empty Text: @empty_text', [
      '@empty_text' => $this->configuration['empty_text'],
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'empty_text' => '',
    ] + parent::defaultConfiguration();
  }

}

Members

Name	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
EmptyFieldPluginBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
EmptyFieldPluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
EmptyFieldText::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides EmptyFieldPluginBase::defaultConfiguration
EmptyFieldText::react	public	function	Builds render array for empty field. Overrides EmptyFieldPluginBase::react
EmptyFieldText::settingsForm	public	function	Returns the configuration form elements specific to this plugin. Overrides EmptyFieldPluginBase::settingsForm
EmptyFieldText::settingsSummary	public	function	Returns a short summary line for the current formatter settings. Overrides EmptyFieldPluginBase::settingsSummary
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
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.