class ExampleNodeLabelFormatted in Extra Field Settings Provider 8

Example Node Label Extra field with formatted output.

Plugin annotation

@ExtraFieldDisplay(
  id = "example_node_label_formatted",
  label = @Translation("Node label formatted"),
  bundles = {
    "node.*",
  },
  visible = false
)

Hierarchy

• class \Drupal\extra_field_plus\Plugin\ExtraFieldPlusDisplayBase extends \Drupal\extra_field\Plugin\ExtraFieldDisplayBase implements ExtraFieldPlusDisplayInterface uses StringTranslationTrait
  • class \Drupal\extra_field_plus\Plugin\ExtraFieldPlusDisplayFormattedBase implements \Drupal\extra_field\Plugin\ExtraFieldDisplayFormattedInterface, ExtraFieldPlusDisplayInterface
    • class \Drupal\extra_field_plus_example\Plugin\ExtraField\Display\ExampleNodeLabelFormatted

File

modules/extra_field_plus_example/src/Plugin/ExtraField/Display/ExampleNodeLabelFormatted.php, line 20

Namespace

Drupal\extra_field_plus_example\Plugin\ExtraField\Display

class ExampleNodeLabelFormatted extends ExtraFieldPlusDisplayFormattedBase {

  /**
   * {@inheritdoc}
   */
  public function getLabel() {
    return $this
      ->t('Node label');
  }

  /**
   * {@inheritdoc}
   */
  public function getLabelDisplay() {
    return 'above';
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(ContentEntityInterface $entity) {
    $settings = $this
      ->getSettings();
    $link_to_entity = $settings['link_to_entity'];
    $wrapper = $settings['wrapper'];
    $label = $entity
      ->label();
    $url = NULL;
    if ($link_to_entity) {
      $url = $entity
        ->toUrl()
        ->setAbsolute();
    }
    if ($url) {
      $element = [
        '#type' => 'html_tag',
        '#tag' => $wrapper,
        [
          '#type' => 'link',
          '#title' => $label,
          '#url' => $url,
        ],
      ];
    }
    else {
      $element = [
        '#type' => 'html_tag',
        '#tag' => $wrapper,
        '#value' => $label,
      ];
    }
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm() {
    $form = parent::settingsForm();
    $form['link_to_entity'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Link to the entity'),
    ];
    $form['wrapper'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Wrapper'),
      '#options' => [
        'span' => 'span',
        'p' => 'p',
        'h1' => 'h1',
        'h2' => 'h2',
        'h3' => 'h3',
        'h4' => 'h4',
        'h5' => 'h5',
      ],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultFormValues() {
    $values = parent::defaultFormValues();
    $values += [
      'link_to_entity' => FALSE,
      'wrapper' => 'span',
    ];
    return $values;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ExampleNodeLabelFormatted::defaultFormValues	public	function	Provides field settings form default values. Overrides ExtraFieldPlusDisplayBase::defaultFormValues
ExampleNodeLabelFormatted::getLabel	public	function	Overrides ExtraFieldPlusDisplayFormattedBase::getLabel
ExampleNodeLabelFormatted::getLabelDisplay	public	function	Overrides ExtraFieldPlusDisplayFormattedBase::getLabelDisplay
ExampleNodeLabelFormatted::settingsForm	public	function	Provides field settings form. Overrides ExtraFieldPlusDisplayBase::settingsForm
ExampleNodeLabelFormatted::viewElements	public	function
ExtraFieldPlusDisplayBase::getDefaultFormValues	public	function	Returns field settings form default values. Overrides ExtraFieldPlusDisplayInterface::getDefaultFormValues
ExtraFieldPlusDisplayBase::getSetting	public	function	Returns field setting. Overrides ExtraFieldPlusDisplayInterface::getSetting
ExtraFieldPlusDisplayBase::getSettings	public	function	Returns field settings. Overrides ExtraFieldPlusDisplayInterface::getSettings
ExtraFieldPlusDisplayBase::getSettingsForm	public	function	Returns field settings form. Overrides ExtraFieldPlusDisplayInterface::getSettingsForm
ExtraFieldPlusDisplayFormattedBase::$isEmpty	protected	property	Flag to indicate that the extra field has no content.
ExtraFieldPlusDisplayFormattedBase::$langcode	protected	property	The langcode of the field values.
ExtraFieldPlusDisplayFormattedBase::getFieldName	public	function
ExtraFieldPlusDisplayFormattedBase::getFieldType	public	function
ExtraFieldPlusDisplayFormattedBase::getLangcode	public	function
ExtraFieldPlusDisplayFormattedBase::isEmpty	public	function
ExtraFieldPlusDisplayFormattedBase::isTranslatable	public	function
ExtraFieldPlusDisplayFormattedBase::setLangcode	public	function
ExtraFieldPlusDisplayFormattedBase::view	public	function
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.