class TextCustom in Drupal 10

Views area text handler.

Plugin annotation

@ViewsArea("text_custom");

Hierarchy

• class \Drupal\views\Plugin\views\area\AreaPluginBase extends \Drupal\views\Plugin\views\HandlerBase
  • class \Drupal\views\Plugin\views\area\TokenizeAreaPluginBase
    • class \Drupal\views\Plugin\views\area\TextCustom

Related topics

Views area handler plugins

Plugins governing areas of views, such as header, footer, and empty text.

File

core/modules/views/src/Plugin/views/area/TextCustom.php, line 15

Namespace

Drupal\views\Plugin\views\area

class TextCustom extends TokenizeAreaPluginBase {

  /**
   * {@inheritdoc}
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['content'] = [
      'default' => '',
    ];
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    $form['content'] = [
      '#title' => $this
        ->t('Content'),
      '#type' => 'textarea',
      '#description' => $this
        ->t('You may enter data from this view as per the "Available global token replacements" above. You may include the following allowed HTML tags: <code>@tags</code>', [
        '@tags' => '<' . implode('> <', Xss::getAdminTagList()) . '>',
      ]),
      '#default_value' => $this->options['content'],
      '#rows' => 6,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function render($empty = FALSE) {
    if (!$empty || !empty($this->options['empty'])) {
      return [
        '#markup' => $this
          ->renderTextarea($this->options['content']),
      ];
    }
    return [];
  }

  /**
   * Render a text area with \Drupal\Component\Utility\Xss::filterAdmin().
   */
  public function renderTextarea($value) {
    if ($value) {
      return $this
        ->sanitizeValue($this
        ->tokenizeValue($value), 'xss_admin');
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AreaPluginBase::$areaType	public	property	The type of this area handler, i.e. 'header', 'footer', or 'empty'.
AreaPluginBase::adminSummary	public	function
AreaPluginBase::init	public	function	Overrides Drupal\views\Plugin\views\HandlerBase::init().	1
AreaPluginBase::isEmpty	public	function	Does that area have nothing to show.	1
AreaPluginBase::preRender	public	function	Performs any operations needed before full rendering.	1
AreaPluginBase::usesGroupBy	public	function
TextCustom::buildOptionsForm	public	function	Overrides TokenizeAreaPluginBase::buildOptionsForm
TextCustom::defineOptions	protected	function	Overrides TokenizeAreaPluginBase::defineOptions
TextCustom::render	public	function	Render the area. Overrides AreaPluginBase::render
TextCustom::renderTextarea	public	function	Render a text area with \Drupal\Component\Utility\Xss::filterAdmin().
TokenizeAreaPluginBase::tokenForm	public	function	Adds tokenization form elements.
TokenizeAreaPluginBase::tokenizeValue	public	function	Replaces value with special views tokens and global tokens.