class DynamicLayout in Dynamic Layouts 8

Dynamically prepare the dynamic layout build.

Plugin annotation

@Layout(
  id = "dynamic_layout",
  admin_label = @Translation("Dynamic layout"),
  category = @Translation("Dynamic layout category"),
  deriver = "Drupal\dynamic_layouts\Plugin\Derivative\DynamicLayoutDeriver"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\Layout\LayoutDefault implements LayoutInterface, PluginFormInterface
      • class \Drupal\dynamic_layouts\Plugin\Layout\DynamicLayout implements ContainerFactoryPluginInterface

File

src/Plugin/Layout/DynamicLayout.php, line 20

Namespace

Drupal\dynamic_layouts\Plugin\Layout

class DynamicLayout extends LayoutDefault implements ContainerFactoryPluginInterface {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * @var \Drupal\dynamic_layouts\Entity\DynamicLayoutSettings
   */
  protected $settings;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entityTypeManager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->entityTypeManager = $entityTypeManager;
    $this->settings = $this->entityTypeManager
      ->getStorage('dynamic_layout_settings')
      ->load('settings');
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('entity_type.manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function build(array $regions) {

    // Get the layout config entity type & entity id from the plugin id.
    $plugin_id = $this
      ->getPluginId();
    list($entity_type, $entity_id) = explode(':', $plugin_id);

    /* @var \Drupal\dynamic_layouts\DynamicLayoutInterface $config_entity */
    $rows = [];
    if ($config_entity = $this->entityTypeManager
      ->getStorage($entity_type)
      ->load($entity_id)) {
      $rows = $config_entity
        ->getRows();
    }

    // Ensure $build only contains defined regions and in the order defined.
    $build = [];
    foreach ($this
      ->getPluginDefinition()
      ->getRegionNames() as $region_name) {
      if (array_key_exists($region_name, $regions)) {
        $build[$region_name] = $regions[$region_name];
      }
    }
    $build['#settings'] = $this
      ->getConfiguration();
    $build['#layout'] = $this->pluginDefinition;
    $build['#wrapperClasses'] = $this
      ->getWrapperClasses();
    $build['#theme'] = $this->pluginDefinition
      ->getThemeHook();
    if ($library = $this->pluginDefinition
      ->getLibrary()) {
      $build['#attached']['library'][] = $library;
    }
    if ($this->settings
      ->getFrontendLibrary() == 'custom') {
      $build['#attached']['library'][] = 'dynamic_layouts/dynamic_layouts_frontend';
    }
    $build['rows'] = [
      '#markup' => $rows,
    ];
    return $build;
  }

  /**
   * Get all the wrapper classes.
   */
  private function getWrapperClasses() {
    $frontend_library = $this->settings
      ->getFrontendLibrary();
    if ($column_count = $this->settings
      ->getGridColumnCount()) {
      return $frontend_library . '-' . $column_count;
    }
    return '';
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
DynamicLayout::$entityTypeManager	protected	property	The entity type manager.
DynamicLayout::$settings	protected	property
DynamicLayout::build	public	function	Build a render array for layout with regions. Overrides LayoutDefault::build
DynamicLayout::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
DynamicLayout::getWrapperClasses	private	function	Get all the wrapper classes.
DynamicLayout::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides LayoutDefault::__construct
LayoutDefault::$pluginDefinition	protected	property	The layout definition. Overrides PluginBase::$pluginDefinition
LayoutDefault::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm	2
LayoutDefault::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	2
LayoutDefault::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration	3
LayoutDefault::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
LayoutDefault::getPluginDefinition	public	function	Overrides PluginBase::getPluginDefinition
LayoutDefault::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
LayoutDefault::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm	2
LayoutDefault::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm	1
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.