comparison core/modules/block_content/src/BlockContentInterface.php @ 0:4c8ae668cc8c

Initial import (non-working)
author Chris Cannam
date Wed, 29 Nov 2017 16:09:58 +0000
parents
children 1fec387a4317
comparison
equal deleted inserted replaced
-1:000000000000 0:4c8ae668cc8c
1 <?php
2
3 namespace Drupal\block_content;
4
5 use Drupal\Core\Entity\ContentEntityInterface;
6 use Drupal\Core\Entity\EntityChangedInterface;
7 use Drupal\Core\Entity\RevisionLogInterface;
8
9 /**
10 * Provides an interface defining a custom block entity.
11 */
12 interface BlockContentInterface extends ContentEntityInterface, EntityChangedInterface, RevisionLogInterface {
13
14 /**
15 * Returns the block revision log message.
16 *
17 * @return string
18 * The revision log message.
19 *
20 * @deprecated in Drupal 8.2.0, will be removed before Drupal 9.0.0. Use
21 * \Drupal\Core\Entity\RevisionLogInterface::getRevisionLogMessage() instead.
22 */
23 public function getRevisionLog();
24
25 /**
26 * Sets the block description.
27 *
28 * @param string $info
29 * The block description.
30 *
31 * @return \Drupal\block_content\BlockContentInterface
32 * The class instance that this method is called on.
33 */
34 public function setInfo($info);
35
36 /**
37 * Sets the block revision log message.
38 *
39 * @param string $revision_log
40 * The revision log message.
41 *
42 * @return \Drupal\block_content\BlockContentInterface
43 * The class instance that this method is called on.
44 *
45 * @deprecated in Drupal 8.2.0, will be removed before Drupal 9.0.0. Use
46 * \Drupal\Core\Entity\RevisionLogInterface::setRevisionLogMessage() instead.
47 */
48 public function setRevisionLog($revision_log);
49
50 /**
51 * Sets the theme value.
52 *
53 * When creating a new block content block from the block library, the user is
54 * redirected to the configure form for that block in the given theme. The
55 * theme is stored against the block when the block content add form is shown.
56 *
57 * @param string $theme
58 * The theme name.
59 *
60 * @return \Drupal\block_content\BlockContentInterface
61 * The class instance that this method is called on.
62 */
63 public function setTheme($theme);
64
65 /**
66 * Gets the theme value.
67 *
68 * When creating a new block content block from the block library, the user is
69 * redirected to the configure form for that block in the given theme. The
70 * theme is stored against the block when the block content add form is shown.
71 *
72 * @return string
73 * The theme name.
74 */
75 public function getTheme();
76
77 /**
78 * Gets the configured instances of this custom block.
79 *
80 * @return array
81 * Array of Drupal\block\Core\Plugin\Entity\Block entities.
82 */
83 public function getInstances();
84
85 }