1	<?php
2
3	declare(strict_types=1);
4
5	namespace Drupal\display_builder\Entity;
6
7	use Drupal\Core\Config\Entity\ConfigEntityInterface;
8
9	/**
10	* Provides an interface defining a display builder entity type.
11	*/
12	interface ProfileInterface extends ConfigEntityInterface {
13
14	/**
15	* Get enabled islands for this config.
16	*
17	* @return array
18	*   The islands as island ID => weight.
19	*/
20	public function getEnabledIslands(): array;
21
22	/**
23	* Get configuration of all islands.
24	*
25	* @return array
26	*   Configuration keyed by island ID.
27	*/
28	public function getIslandConfigurations(): array;
29
30	/**
31	* Gets configuration for an island.
32	*
33	* @param string $island_id
34	*   The island ID.
35	*
36	* @return array
37	*   The island configuration.
38	*/
39	public function getIslandConfiguration(string $island_id): array;
40
41	/**
42	* Set configuration for an island.
43	*
44	* @param string $island_id
45	*   The island ID.
46	* @param array $configuration
47	*   The island configuration.
48	*/
49	public function setIslandConfiguration(string $island_id, array $configuration = []): void;
50
51	/**
52	* Returns the machine-readable permission name for the display builder.
53	*
54	* @return string
55	*   The machine-readable permission name.
56	*/
57	public function getPermissionName(): string;
58
59	/**
60	* Get roles allowed to use the Display builder.
61	*
62	* @return array
63	*   List of roles.
64	*/
65	public function getRoles(): array;
66
67	/**
68	* Whether the library panels are merged into a single flat list.
69	*
70	* @return bool
71	*   TRUE if library panels (Components, Blocks, Presets...) are merged
72	*   into a single flat list without tabs, FALSE otherwise.
73	*/
74	public function isLibraryFlat(): bool;
75
76	/**
77	* How library tabs (Components, Blocks, Presets...) should be displayed.
78	*
79	* @return string
80	*   One of 'label', 'icon' or 'icon_label'.
81	*/
82	public function getLibraryTabsDisplay(): string;
83
84	/**
85	* How contextual panel tabs should be displayed.
86	*
87	* @return string
88	*   One of 'label', 'icon' or 'icon_label'.
89	*/
90	public function getContextualTabsDisplay(): string;
91
92	/**
93	* How View panels (main area tabs, sidebar buttons) should be displayed.
94	*
95	* @return string
96	*   One of 'label', 'icon' or 'icon_label'.
97	*/
98	public function getViewPanelsDisplay(): string;
99
100	}