You are here

class SimplePageVariant in Drupal 10

Same name and namespace in other branches
  1. 8 core/lib/Drupal/Core/Render/Plugin/DisplayVariant/SimplePageVariant.php \Drupal\Core\Render\Plugin\DisplayVariant\SimplePageVariant
  2. 9 core/lib/Drupal/Core/Render/Plugin/DisplayVariant/SimplePageVariant.php \Drupal\Core\Render\Plugin\DisplayVariant\SimplePageVariant

Provides a page display variant that simply renders the main content.

Plugin annotation


@PageDisplayVariant(
  id = "simple_page",
  admin_label = @Translation("Simple page")
)

Hierarchy

  • class \Drupal\Core\Render\Plugin\DisplayVariant\SimplePageVariant extends \Drupal\Core\Display\VariantBase implements \Drupal\Core\Display\PageVariantInterface

Expanded class hierarchy of SimplePageVariant

File

core/lib/Drupal/Core/Render/Plugin/DisplayVariant/SimplePageVariant.php, line 16

Namespace

Drupal\Core\Render\Plugin\DisplayVariant
View source
class SimplePageVariant extends VariantBase implements PageVariantInterface {

  /**
   * The render array representing the main content.
   *
   * @var array
   */
  protected $mainContent;

  /**
   * The page title: a string (plain title) or a render array (formatted title).
   *
   * @var string|array
   */
  protected $title = '';

  /**
   * {@inheritdoc}
   */
  public function setMainContent(array $main_content) {
    $this->mainContent = $main_content;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function setTitle($title) {
    $this->title = $title;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    $build = [
      'content' => [
        'messages' => [
          '#type' => 'status_messages',
          '#weight' => -1000,
          '#include_fallback' => TRUE,
        ],
        'page_title' => [
          '#type' => 'page_title',
          '#title' => $this->title,
          '#weight' => -900,
        ],
        'main_content' => [
          '#weight' => -800,
        ] + $this->mainContent,
      ],
    ];
    return $build;
  }

}

Members