class ReplaceTitleCommand

Same name in other branches
  1. 8.9.x core/modules/views/src/Ajax/ReplaceTitleCommand.php \Drupal\views\Ajax\ReplaceTitleCommand
  2. 10 core/modules/views/src/Ajax/ReplaceTitleCommand.php \Drupal\views\Ajax\ReplaceTitleCommand
  3. 11.x core/modules/views/src/Ajax/ReplaceTitleCommand.php \Drupal\views\Ajax\ReplaceTitleCommand

Provides an AJAX command for replacing the page title.

This command is implemented in Drupal.AjaxCommands.prototype.viewsReplaceTitle.

Hierarchy

Expanded class hierarchy of ReplaceTitleCommand

1 file declares its use of ReplaceTitleCommand
ViewsFormBase.php in core/modules/views_ui/src/Form/Ajax/ViewsFormBase.php

File

core/modules/views/src/Ajax/ReplaceTitleCommand.php, line 12

Namespace

Drupal\views\Ajax
View source 
class ReplaceTitleCommand implements CommandInterface {
    
    /**
     * The page title to replace.
     *
     * @var string
     */
    protected $title;
    
    /**
     * Constructs a \Drupal\views\Ajax\ReplaceTitleCommand object.
     *
     * @param string $title
     *   The title of the page.
     */
    public function __construct($title) {
        $this->title = $title;
    }
    
    /**
     * {@inheritdoc}
     */
    public function render() {
        return [
            'command' => 'viewsReplaceTitle',
            'title' => $this->title,
            'siteName' => \Drupal::config('system.site')->get('name'),
        ];
    }

}

Members

Title Modifiers Object type Summary Overriden Title
ReplaceTitleCommand::$title protected property The page title to replace.
ReplaceTitleCommand::render public function Return an array to be run through json_encode and sent to the client. Overrides CommandInterface::render
ReplaceTitleCommand::__construct public function Constructs a \Drupal\views\Ajax\ReplaceTitleCommand object.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.