Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
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;
6
7use Drupal\Core\Config\Entity\ConfigEntityInterface;
8
9/**
10 * Provides an interface defining a Pattern preset entity type.
11 */
12interface PatternPresetInterface extends ConfigEntityInterface {
13
14  /**
15   * Return the ready to use sources.
16   *
17   * This is not the same as DisplayBuildableInterface::getSources() because
18   * the root level is a single nestable source plugin instead of a list.
19   *
20   * @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
21   *   (Optional) Contexts for the sources.
22   * @param bool $fillNodeId
23   *   (Optional) Set instance_id on all children. Default to TRUE.
24   *
25   * @return array
26   *   The preset data.
27   */
28  public function getSources(array $contexts = [], bool $fillNodeId = TRUE): array;
29
30  /**
31   * Get summary.
32   *
33   * The summary of a preset is the summary of its root source.
34   *
35   * @return string
36   *   The summary
37   */
38  public function getSummary(): string;
39
40}