Code Coverage
 
Lines
Branches
Paths
Functions and Methods
Classes and Traits
Total
n/a
0 / 0
n/a
0 / 0
n/a
0 / 0
n/a
0 / 0
CRAP
n/a
0 / 0
1<?php
2
3declare(strict_types=1);
4
5namespace Drupal\display_builder_page_layout;
6
7use Drupal\Core\Condition\ConditionPluginCollection;
8use Drupal\Core\Config\Entity\ConfigEntityInterface;
9use Drupal\Core\Entity\EntityWithPluginCollectionInterface;
10use Drupal\display_builder\ProfileInterface;
11
12/**
13 * Provides an interface defining a page layout entity type.
14 */
15interface PageLayoutInterface extends ConfigEntityInterface, EntityWithPluginCollectionInterface {
16
17  /**
18   * Get conditions plugins.
19   *
20   * @return \Drupal\Core\Condition\ConditionPluginCollection
21   *   A collection of conditions plugins attached to the page layout.
22   */
23  public function getConditions(): ConditionPluginCollection;
24
25  /**
26   * Get display builder profile config entity.
27   *
28   * If NULL, the Display Builder is not activated for this entity.
29   *
30   * @return ?ProfileInterface
31   *   The display builder profile config entity.
32   */
33  public function getProfile(): ?ProfileInterface;
34
35  /**
36   * Get sources tree.
37   *
38   * @return array
39   *   A list of nestable sources.
40   */
41  public function getSources(): array;
42
43  /**
44   * Save sources tree retrieved from the Instance entity to config or content.
45   *
46   * Triggered by a DisplayBuilderEvents::ON_SAVE event.
47   *
48   * @param array $sources
49   *   A list of nestable sources.
50   */
51  public function setSources(array $sources): void;
52
53}