LayoutOption.php in Bootstrap Layout Builder 1.x

Namespace

Drupal\bootstrap_layout_builder\Entity

File

src/Entity/LayoutOption.php

<?php

namespace Drupal\bootstrap_layout_builder\Entity;

use Drupal\Core\Config\Entity\ConfigEntityBase;
use Drupal\bootstrap_layout_builder\LayoutOptionInterface;

/**
 * Defines the layout option entity class.
 *
 * @ConfigEntityType(
 *   id = "blb_layout_option",
 *   label = @Translation("Bootstrap Layout Builder Layout option"),
 *   label_collection = @Translation("Bootstrap Layout Builder Layout Options"),
 *   label_plural = @Translation("Bootstrap Layout Builder Layout Option"),
 *   handlers = {
 *     "route_provider" = {
 *       "html" = "Drupal\Core\Entity\Routing\AdminHtmlRouteProvider"
 *     },
 *     "form" = {
 *       "default" = "Drupal\bootstrap_layout_builder\Form\LayoutOptionForm",
 *       "add" = "Drupal\bootstrap_layout_builder\Form\LayoutOptionForm",
 *       "edit" = "Drupal\bootstrap_layout_builder\Form\LayoutOptionForm",
 *       "delete" = "Drupal\bootstrap_layout_builder\Form\LayoutOptionDeleteForm"
 *     },
 *   },
 *   config_prefix = "layout_option",
 *   admin_permission = "administer site configuration",
 *   entity_keys = {
 *     "id" = "id",
 *     "uuid" = "uuid",
 *     "layout_id" = "layout_id",
 *     "label" = "label",
 *     "structure" = "structure",
 *     "breakpoints" = "breakpoints",
 *     "weight" = "weight",
 *   },
 *   config_export = {
 *     "id" = "id",
 *     "uuid" = "uuid",
 *     "layout_id" = "layout_id",
 *     "label" = "label",
 *     "structure" = "structure",
 *     "breakpoints" = "breakpoints",
 *     "weight" = "weight",
 *   },
 *   links = {
 *     "delete-form" = "/admin/config/bootstrap-layout-builder/layouts/options/{blb_layout_option}/delete",
 *     "edit-form" = "/admin/config/bootstrap-layout-builder/layouts/options/{blb_layout_option}/edit",
 *     "add-form" = "/admin/config/bootstrap-layout-builder/layouts/{blb_layout}/options/add"
 *   },
 * )
 */
class LayoutOption extends ConfigEntityBase implements LayoutOptionInterface {

  /**
   * The machine name for the configuration entity.
   *
   * @var string
   */
  protected $id;

  /**
   * The human-readable name of the configuration entity.
   *
   * @var string
   */
  protected $label;

  /**
   * The layout id.
   *
   * @var string
   */
  protected $layout_id;

  /**
   * The structure of option columns.
   *
   * @var string
   */
  protected $structure;

  /**
   * The enabled breakpoints for this option.
   *
   * @var array
   */
  protected $breakpoints;

  /**
   * Order of options on the config page & Layout Builder add/update forms.
   *
   * @var int
   */
  protected $weight = 0;

  /**
   * {@inheritdoc}
   */
  public function getLayoutId() {
    return $this->layout_id;
  }

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

  /**
   * {@inheritdoc}
   */
  public function getStructure() {
    return $this->structure;
  }

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

  /**
   * {@inheritdoc}
   */
  public function getStructureId() {
    return 'blb_col_' . str_replace(' ', '_', $this->structure);
  }

  /**
   * {@inheritdoc}
   */
  public function getWeight() {
    return $this->weight;
  }

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

  /**
   * {@inheritdoc}
   */
  public function getBreakpointsIds() {
    $ids = [];
    if ($this->breakpoints) {
      foreach ($this->breakpoints as $key => $value) {
        if ($value) {
          $ids[] = $key;
        }
      }
    }
    return $ids;
  }

  /**
   * {@inheritdoc}
   */
  public function getBreakpointsLabels() {
    $labels = [];
    foreach ($this->breakpoints as $breakpoint_id) {
      $breakpoint = $this
        ->entityTypeManager()
        ->getStorage('blb_breakpoint')
        ->load($breakpoint_id);
      if ($breakpoint) {
        $labels[] = $breakpoint
          ->label();
      }
    }
    return $labels;
  }

  /**
   * {@inheritdoc}
   */
  public function getLayout() {
    $layout = $this
      ->entityTypeManager()
      ->getStorage('blb_layout')
      ->load($this->layout_id);
    return $layout;
  }

  /**
   * {@inheritdoc}
   */
  public function getLayoutById($layout_id) {
    $layout = $this
      ->entityTypeManager()
      ->getStorage('blb_layout')
      ->load($layout_id);
    return $layout;
  }

}

Classes

Name	Description
LayoutOption	Defines the layout option entity class.