class LayoutFlexibleTemplate

layout_autoload_info in core/modules/layout/layout.module

Implements hook_autoload_info().

class LayoutFlexibleTemplate {
  /**
   * The name of the layout template.
   *
   * @var string
   */
  var $name = '';

  /**
   * The human readable name of the layout template.
   *
   * @var string
   */
  var $title = '';

  /**
   * The description of the layout template.
   *
   * @var string
   */
  var $description;

  /**
   * The module providing the layout template.
   *
   * @var string
   */
  public $module = 'layout';

  /**
   * Configuration of the rows for this layout template.
   *
   * Each row contains the following values:
   * - contains: The layout structure of the row.
   * - element: The type of element, such as "header", "div", etc.
   * - classes: Additional classes to be added to the row.
   * - container: The type of container such as "container" or "container-flex".
   * - region_names: An array of region names within this row.
   *
   * @var array
   */
  var $rows = array();

  /**
   * @var bool
   */
  public $is_new;

  /**
   * @var string
   */
  public $preview;

  /**
   * @var string
   */
  public $layout_template_type = 'flexible';

  /**
   * Whether this layout is a full page layout (for example, with a header and
   * footer, optional page title) or not.
   *
   * @var bool
   */
  public $is_full_page = TRUE;

  /**
   * Constructor for a LayoutFlexibleTemplate class.
   *
   * @param array $config
   *   An array of configuration data.
   */
  function __construct(array $config = array()) {
    foreach ($config as $property => $property_value) {
      $this->{$property} = $property_value;
    }
    if ($this->is_full_page === NULL) {
      $this->is_full_page = TRUE;
    }

    _layout_standardize_template_type($this->layout_template_type);

    if (empty($this->rows)) {
      $uuid = new Uuid();
      if ($this->is_full_page) {
        $this->rows[$uuid->generate()] = array(
          'contains' => 'region_12',
          'element' => 'header',
          'classes' => '',
          'container' => 'container',
          'region_names' => array(
            'region_0' => array(
              'label' => t('Header'),
              'name' => 'header',
              'classes' => '',
            ),
          ),
        );
      }
      $this->rows[$uuid->generate()] = array(
        'contains' => 'region_12',
        'element' => '',
        'classes' => '',
        'container' => 'container',
        'region_names' => array(
          'region_0' => array(
            'label' => t('Content'),
            'name' => 'content',
            'classes' => '',
          ),
        ),
      );
      if ($this->is_full_page) {
        $this->rows[$uuid->generate()] = array(
          'contains' => 'region_12',
          'element' => 'footer',
          'classes' => '',
          'container' => 'container',
          'region_names' => array(
            'region_0' => array(
              'label' => t('Footer'),
              'name' => 'footer',
              'classes' => '',
            ),
          ),
        );
      }

    }
  }

  /**
   * Save a flexible layout template to config.
   */
  function save() {
    $data = array(
      'name' => $this->name,
      'layout_template_type' => $this->layout_template_type,
      'title' => $this->title,
      'description' => $this->description,
      'rows' => $this->rows,
      'preview' => $this->preview,
      'is_full_page' => $this->is_full_page,
    );

    config('layout.' . $this->layout_template_type . '.' . $this->name)
      ->setData($data)
      ->save();

    if (isset($this->is_new)) {
      unset($this->is_new);
    }

    layout_reset_caches();
    layout_flexible_reset_caches();
    backdrop_theme_rebuild();
  }

  /**
   * Delete this layout template.
   */
  function delete() {
    config('layout.' . $this->layout_template_type . '.' . $this->name)->delete();

    layout_reset_caches();
    layout_flexible_reset_caches($this->layout_template_type);
    backdrop_theme_rebuild();
  }
}