Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/modules/block/src/BlockInterface.php

	Code Coverage
	Classes and Traits		Functions and Methods				Lines
Total	100.00% covered (success)	0 / 0	100.00% covered (success)	100.00%	0 / 0	CRAP	100.00% covered (success)	100.00%	0 / 0

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\block\BlockInterface.
6	*/
7
8	namespace Drupal\block;
9
10	use Drupal\Core\Config\Entity\ConfigEntityInterface;
11
12	/**
13	* Provides an interface defining a block entity.
14	*/
15	interface BlockInterface extends ConfigEntityInterface {
16
17	/**
18	* Indicates the block label (title) should be displayed to end users.
19	*/
20	const BLOCK_LABEL_VISIBLE = 'visible';
21
22	/**
23	* Denotes that a block is not enabled in any region and should not be shown.
24	*/
25	const BLOCK_REGION_NONE = -1;
26
27	/**
28	* Returns the plugin instance.
29	*
30	* @return \Drupal\Core\Block\BlockPluginInterface
31	* The plugin instance for this block.
32	*/
33	public function getPlugin();
34
35	/**
36	* Returns the plugin ID.
37	*
38	* @return string
39	* The plugin ID for this block.
40	*/
41	public function getPluginId();
42
43	/**
44	* Returns the region this block is placed in.
45	*
46	* @return string
47	* The region this block is placed in.
48	*/
49	public function getRegion();
50
51	/**
52	* Returns the theme ID.
53	*
54	* @return string
55	* The theme ID for this block instance.
56	*/
57	public function getTheme();
58
59	/**
60	* Returns an array of visibility condition configurations.
61	*
62	* @return array
63	* An array of visibility condition configuration keyed by the condition ID.
64	*/
65	public function getVisibility();
66
67	/**
68	* Gets conditions for this block.
69	*
70	* @return \Drupal\Core\Condition\ConditionInterface[]\|\Drupal\Core\Condition\ConditionPluginCollection
71	* An array or collection of configured condition plugins.
72	*/
73	public function getVisibilityConditions();
74
75	/**
76	* Gets a visibility condition plugin instance.
77	*
78	* @param string $instance_id
79	* The condition plugin instance ID.
80	*
81	* @return \Drupal\Core\Condition\ConditionInterface
82	* A condition plugin.
83	*/
84	public function getVisibilityCondition($instance_id);
85
86	/**
87	* Sets the visibility condition configuration.
88	*
89	* @param string $instance_id
90	* The condition instance ID.
91	* @param array $configuration
92	* The condition configuration.
93	*
94	* @return $this
95	*/
96	public function setVisibilityConfig($instance_id, array $configuration);
97
98	/**
99	* Returns the weight of this block (used for sorting).
100	*
101	* @return int
102	* The block weight.
103	*/
104	public function getWeight();
105
106	/**
107	* Sets the region this block is placed in.
108	*
109	* @param string $region
110	* The region to place this block in.
111	*
112	* @return $this
113	*/
114	public function setRegion($region);
115
116	/**
117	* Sets the block weight.
118	*
119	* @param int $weight
120	* The desired weight.
121	*
122	* @return $this
123	*/
124	public function setWeight($weight);
125
126	/**
127	* Creates a duplicate of the block entity.
128	*
129	* @param string $new_id
130	* (optional) The new ID on the duplicate block.
131	* @param string $new_theme
132	* (optional) The theme on the duplicate block.
133	*
134	* @return static
135	* A clone of $this with all identifiers unset, so saving it inserts a new
136	* entity into the storage system.
137	*/
138	public function createDuplicateBlock($new_id = NULL, $new_theme = NULL);
139
140	}