class Modal in Modal 5.0.x
Same name and namespace in other branches
- 8.3 src/Entity/Modal.php \Drupal\modal_page\Entity\Modal
- 8.2 src/Entity/Modal.php \Drupal\modal_page\Entity\Modal
- 4.0.x src/Entity/Modal.php \Drupal\modal_page\Entity\Modal
- 4.1.x src/Entity/Modal.php \Drupal\modal_page\Entity\Modal
Defines the Modal entity.
Plugin annotation
@ConfigEntityType(
id = "modal",
label = @Translation("Modal"),
handlers = {
"view_builder" = "Drupal\Core\Entity\EntityViewBuilder",
"list_builder" = "Drupal\modal_page\ModalListBuilder",
"form" = {
"add" = "Drupal\modal_page\Form\ModalForm",
"edit" = "Drupal\modal_page\Form\ModalForm",
"delete" = "Drupal\modal_page\Form\ModalDeleteForm"
},
"route_provider" = {
"html" = "Drupal\modal_page\ModalHtmlRouteProvider",
},
},
config_prefix = "modal",
admin_permission = "administer modal page",
entity_keys = {
"id" = "id",
"label" = "label",
"uuid" = "uuid",
"body" = "body",
"pages" = "pages",
"parameters" = "parameters",
"auto_open" = "auto_open",
"open_modal_on_element_click" = "open_modal_on_element_click",
"langcode" = "langcode",
"ok_label_button" = "ok_label_button",
"enable_dont_show_again_option" = "enable_dont_show_again_option",
"dont_show_again_label" = "dont_show_again_label",
"modal_size" = "modal_size",
"close_modal_esc_key" = "close_modal_esc_key",
"close_modal_clicking_outside" = "close_modal_clicking_outside",
"roles" = "roles",
"type" = "type",
"delay_display" = "delay_display",
"published" = "published",
},
config_export = {
"id",
"label",
"uuid",
"body",
"pages",
"parameters",
"auto_open",
"open_modal_on_element_click",
"langcode",
"ok_label_button",
"enable_dont_show_again_option",
"dont_show_again_label",
"modal_size",
"close_modal_esc_key",
"close_modal_clicking_outside",
"roles",
"type",
"delay_display",
"published",
},
links = {
"canonical" = "/admin/structure/modal/{modal}",
"add-form" = "/admin/structure/modal/add",
"edit-form" = "/admin/structure/modal/{modal}/edit",
"delete-form" = "/admin/structure/modal/{modal}/delete",
"collection" = "/admin/structure/modal"
}
)
Hierarchy
- class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
- class \Drupal\modal_page\Entity\Modal implements ModalInterface
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
Expanded class hierarchy of Modal
4 string references to 'Modal'
- ModalListBuilder::buildHeader in src/
ModalListBuilder.php - Builds the header row for the entity listing.
- modal_page.links.menu.yml in ./
modal_page.links.menu.yml - modal_page.links.menu.yml
- modal_page.routing.yml in ./
modal_page.routing.yml - modal_page.routing.yml
- modal_page_update_40003 in ./
modal_page.install - Create Modal Page Entity.
File
- src/
Entity/ Modal.php, line 78
Namespace
Drupal\modal_page\EntityView source
class Modal extends ConfigEntityBase implements ModalInterface {
/**
* The Modal ID.
*
* @var string
*/
protected $id;
/**
* The Modal label.
*
* @var string
*/
protected $label;
/**
* Body.
*
* @var string
*/
protected $body;
/**
* Pages.
*
* @var string
*/
protected $pages;
/**
* Parameters.
*
* @var string
*/
protected $parameters;
/**
* Auto Open.
*
* @var string
*/
protected $autoOpen;
/**
* Open Modal on Element Click.
*
* @var string
*/
protected $openModalOnElementClick;
/**
* Language code.
*
* @var string
*/
protected $langCode;
/**
* Ok Label Button.
*
* @var string
*/
protected $okLabelButton;
/**
* Ok Label Button.
*
* @var bool
*/
protected $enableDontShowAgainOption;
/**
* Dont Show Again Label.
*
* @var string
*/
protected $dontShowAgainLabel;
/**
* Modal Size.
*
* @var string
*/
protected $modalSize;
/**
* Close Modal pressing ESC key.
*
* @var string
*/
protected $closeModalEscKey;
/**
* Close Modal clicking outside the Modal.
*
* @var string
*/
protected $closeModalClickingOutside;
/**
* Roles.
*
* @var string
*/
protected $roles;
/**
* Type.
*
* @var string
*/
protected $type;
/**
* Delay Display.
*
* @var string
*/
protected $delayDisplay;
/**
* Published.
*
* @var string
*/
protected $published;
/**
* Get Id.
*/
public function getId() {
return $this
->get('id');
}
/**
* Set Id.
*/
public function setId($id) {
$this
->set('id', $id);
return $this;
}
/**
* Get Label.
*/
public function getLabel() {
return $this
->get('label');
}
/**
* Set Label.
*/
public function setLabel($label) {
$this
->set('label', $label);
return $this;
}
/**
* Get Body.
*/
public function getBody() {
return $this
->get('body');
}
/**
* Set Body.
*/
public function setBody($body) {
$this
->set('body', $body);
return $this;
}
/**
* Get Pages.
*/
public function getPages() {
return $this
->get('pages');
}
/**
* Set Pages.
*/
public function setPages($pages) {
$this
->set('pages', $pages);
return $this;
}
/**
* Get Parameters.
*/
public function getParameters() {
return $this
->get('parameters');
}
/**
* Set Parameters.
*/
public function setParameters($parameters) {
$this
->set('parameters', $parameters);
return $this;
}
/**
* Auto Open.
*/
public function getAutoOpen() {
return $this
->get('auto_open');
}
/**
* Auto Open.
*/
public function setAutoOpen($autoOpen) {
$this
->set('auto_open', $autoOpen);
return $this;
}
/**
* Get Open Modal on Element Click.
*/
public function getOpenModalOnElementClick() {
return $this
->get('open_modal_on_element_click');
}
/**
* Set Open Modal on Element Click.
*/
public function setOpenModalOnElementClick($openModalOnElementClick) {
$this
->set('open_modal_on_element_click', $openModalOnElementClick);
return $this;
}
/**
* Get LangCode.
*/
public function getLangCode() {
return $this
->get('langcode');
}
/**
* Set LangCode.
*/
public function setLangCode($langCode) {
$this
->set('langcode', $langCode);
return $this;
}
/**
* Get Ok Label Button.
*/
public function getOkLabelButton() {
return $this
->get('ok_label_button');
}
/**
* Set Ok Label Button.
*/
public function setOkLabelButton($okLabelButton) {
$this
->set('ok_label_button', $okLabelButton);
return $this;
}
/**
* Get Enable Don't Show Again.
*/
public function getEnableDontShowAgainOption() {
return $this
->get('enable_dont_show_again_option');
}
/**
* Set Enable Don't Show Again.
*/
public function setEnableDontShowAgainOption($enableDontShowAgainOption) {
$this
->set('enable_dont_show_again_option', $enableDontShowAgainOption);
return $this;
}
/**
* Get Dont Show Again Label.
*/
public function getDontShowAgainLabel() {
return $this
->get('dont_show_again_label');
}
/**
* Set Dont Show Again Label.
*/
public function setDontShowAgainLabel($dontShowAgainLabel) {
$this
->set('dont_show_again_label', $dontShowAgainLabel);
return $this;
}
/**
* Get Modal Size.
*/
public function getModalSize() {
return $this
->get('modal_size');
}
/**
* Set Modal Size.
*/
public function setModalSize($modalSize) {
$this
->set('modal_size', $modalSize);
return $this;
}
/**
* Get Close Modal ESC key.
*/
public function getCloseModalEscKey() {
return $this
->get('close_modal_esc_key');
}
/**
* Set Close Modal ESC key.
*/
public function setCloseModalEscKey($closeModalEscKey) {
$this
->set('close_modal_esc_key', $closeModalEscKey);
return $this;
}
/**
* Get Close Modal clicking outside the Modal.
*/
public function getCloseModalClickingOutside() {
return $this
->get('close_modal_clicking_outside');
}
/**
* Set Close Modal clicking outside the Modal.
*/
public function setCloseModalClickingOutside($closeModalEscKey) {
$this
->set('close_modal_clicking_outside', $closeModalEscKey);
return $this;
}
/**
* Get Roles.
*/
public function getRoles() {
return $this
->get('roles');
}
/**
* Set Roles.
*/
public function setRoles($roles) {
$this
->set('roles', $roles);
return $this;
}
/**
* Get Type.
*/
public function getType() {
return $this
->get('type');
}
/**
* Set Type.
*/
public function setType($type) {
$this
->set('type', $type);
return $this;
}
/**
* Get Delay Display.
*/
public function getDelayDisplay() {
return $this
->get('delay_display');
}
/**
* Set Delay Display.
*/
public function setDelayDisplay($delayDisplay) {
$this
->set('delay_display', $delayDisplay);
return $this;
}
/**
* Get Published.
*/
public function getPublished() {
return $this
->get('published');
}
/**
* Set Published.
*/
public function setPublished($published) {
$this
->set('published', $published);
return $this;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CacheableDependencyTrait:: |
protected | property | Cache contexts. | |
CacheableDependencyTrait:: |
protected | property | Cache max-age. | |
CacheableDependencyTrait:: |
protected | property | Cache tags. | |
CacheableDependencyTrait:: |
protected | function | Sets cacheability; useful for value object constructors. | |
ConfigEntityBase:: |
private | property | Whether the config is being deleted by the uninstall process. | |
ConfigEntityBase:: |
protected | property | The language code of the entity's default language. | |
ConfigEntityBase:: |
protected | property | The original ID of the configuration entity. | |
ConfigEntityBase:: |
protected | property | The enabled/disabled status of the configuration entity. | 4 |
ConfigEntityBase:: |
protected | property | Third party entity settings. | |
ConfigEntityBase:: |
protected | property | Trust supplied data and not use configuration schema on save. | |
ConfigEntityBase:: |
protected | property | The UUID for this entity. | |
ConfigEntityBase:: |
protected | property | ||
ConfigEntityBase:: |
protected | function | Overrides \Drupal\Core\Entity\DependencyTrait:addDependency(). | |
ConfigEntityBase:: |
public | function |
Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface:: |
14 |
ConfigEntityBase:: |
public | function |
Creates a duplicate of the entity. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Disables the configuration entity. Overrides ConfigEntityInterface:: |
1 |
ConfigEntityBase:: |
public | function |
Enables the configuration entity. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns the value of a property. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns the cache tags that should be used to invalidate caches. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Gets the configuration dependency name. Overrides EntityBase:: |
|
ConfigEntityBase:: |
protected static | function | Gets the configuration manager. | |
ConfigEntityBase:: |
public | function |
Gets the configuration target identifier for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the configuration dependencies. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the original ID. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
protected | function | Gets the typed config manager. | |
ConfigEntityBase:: |
public | function |
Gets whether on not the data is trusted. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
protected static | function |
Override to never invalidate the individual entities' cache tags; the
config system already invalidates them. Overrides EntityBase:: |
|
ConfigEntityBase:: |
protected | function |
Override to never invalidate the entity's cache tag; the config system
already invalidates it. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Checks whether this entity is installable. Overrides ConfigEntityInterface:: |
2 |
ConfigEntityBase:: |
public | function |
Overrides Entity::isNew(). Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface:: |
8 |
ConfigEntityBase:: |
public static | function |
Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase:: |
8 |
ConfigEntityBase:: |
public | function |
Acts on an entity before the presave hook is invoked. Overrides EntityBase:: |
13 |
ConfigEntityBase:: |
public | function |
Saves an entity permanently. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Sets the value of a property. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Sets the original ID. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Sets the status of the configuration entity. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function | ||
ConfigEntityBase:: |
public static | function | Helper callback for uasort() to sort configuration entities by weight and label. | 6 |
ConfigEntityBase:: |
public | function |
Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface:: |
4 |
ConfigEntityBase:: |
public | function |
Gets an array of all property values. Overrides EntityBase:: |
2 |
ConfigEntityBase:: |
public | function |
Gets the URL object for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Sets that the data should be trusted. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Unsets a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Constructs an Entity object. Overrides EntityBase:: |
10 |
ConfigEntityBase:: |
public | function |
Overrides EntityBase:: |
4 |
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | Aliased as: traitSleep | 2 |
DependencySerializationTrait:: |
public | function | 2 | |
DependencyTrait:: |
protected | property | The object's dependencies. | |
DependencyTrait:: |
protected | function | Adds multiple dependencies. | |
DependencyTrait:: |
protected | function | Adds a dependency. Aliased as: addDependencyTrait | |
EntityBase:: |
protected | property | Boolean indicating whether the entity should be forced to be new. | |
EntityBase:: |
protected | property | The entity type. | |
EntityBase:: |
protected | property | A typed data object wrapping this entity. | |
EntityBase:: |
public | function |
Checks data value access. Overrides AccessibleInterface:: |
1 |
EntityBase:: |
public | function |
Gets the bundle of the entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
public static | function |
Constructs a new entity object, without permanently saving it. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Deletes an entity permanently. Overrides EntityInterface:: |
2 |
EntityBase:: |
public | function |
Enforces an entity to be new. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | Gets the entity type bundle info service. | |
EntityBase:: |
protected | function | Gets the entity type manager. | |
EntityBase:: |
public | function |
The cache contexts associated with this object. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
The maximum age for which this object may be cached. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
The cache tags associated with this object. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
Gets the key that is used to store configuration dependencies. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the entity type definition. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the ID of the type of the entity. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | The list cache tags to invalidate for this entity. | |
EntityBase:: |
public | function |
Gets a typed data object for this entity object. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Indicates if a link template exists for a given key. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the identifier. Overrides EntityInterface:: |
11 |
EntityBase:: |
public | function |
Gets the label of the entity. Overrides EntityInterface:: |
6 |
EntityBase:: |
public | function |
Gets the language of the entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
protected | function | Gets the language manager. | |
EntityBase:: |
protected | function | Gets an array link templates. | 1 |
EntityBase:: |
public static | function |
Loads an entity. Overrides EntityInterface:: |
|
EntityBase:: |
public static | function |
Loads one or more entities. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Acts on a created entity before hooks are invoked. Overrides EntityInterface:: |
4 |
EntityBase:: |
public static | function |
Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface:: |
18 |
EntityBase:: |
public static | function |
Acts on loaded entities. Overrides EntityInterface:: |
2 |
EntityBase:: |
public | function |
Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface:: |
14 |
EntityBase:: |
public static | function |
Changes the values of an entity before it is created. Overrides EntityInterface:: |
7 |
EntityBase:: |
public | function |
Gets a list of entities referenced by this entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
public | function |
Generates the HTML for a link to this entity. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets a list of URI relationships supported by this entity. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | Gets an array of placeholders for this entity. | 2 |
EntityBase:: |
public | function |
Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface:: |
1 |
EntityBase:: |
protected | function | Gets the UUID generator. | |
Modal:: |
protected | property | Auto Open. | |
Modal:: |
protected | property | Body. | |
Modal:: |
protected | property | Close Modal clicking outside the Modal. | |
Modal:: |
protected | property | Close Modal pressing ESC key. | |
Modal:: |
protected | property | Delay Display. | |
Modal:: |
protected | property | Dont Show Again Label. | |
Modal:: |
protected | property | Ok Label Button. | |
Modal:: |
protected | property | The Modal ID. | |
Modal:: |
protected | property | The Modal label. | |
Modal:: |
protected | property | Language code. | |
Modal:: |
protected | property | Modal Size. | |
Modal:: |
protected | property | Ok Label Button. | |
Modal:: |
protected | property | Open Modal on Element Click. | |
Modal:: |
protected | property | Pages. | |
Modal:: |
protected | property | Parameters. | |
Modal:: |
protected | property | Published. | |
Modal:: |
protected | property | Roles. | |
Modal:: |
protected | property | Type. | |
Modal:: |
public | function |
Auto Open. Overrides ModalInterface:: |
|
Modal:: |
public | function |
Get Body. Overrides ModalInterface:: |
|
Modal:: |
public | function |
Get Close Modal clicking outside the Modal. Overrides ModalInterface:: |
|
Modal:: |
public | function |
Get Close Modal ESC key. Overrides ModalInterface:: |
|
Modal:: |
public | function |
Get Delay Display. Overrides ModalInterface:: |
|
Modal:: |
public | function |
Get Dont Show Again Label. Overrides ModalInterface:: |
|
Modal:: |
public | function |
Get Enable Don't Show Again. Overrides ModalInterface:: |
|
Modal:: |
public | function |
Get Id. Overrides ModalInterface:: |
|
Modal:: |
public | function |
Get Label. Overrides ModalInterface:: |
|
Modal:: |
public | function |
Get LangCode. Overrides ModalInterface:: |
|
Modal:: |
public | function |
Get Modal Size. Overrides ModalInterface:: |
|
Modal:: |
public | function |
Get Ok Label Button. Overrides ModalInterface:: |
|
Modal:: |
public | function |
Get Open Modal on Element Click. Overrides ModalInterface:: |
|
Modal:: |
public | function |
Get Pages. Overrides ModalInterface:: |
|
Modal:: |
public | function |
Get Parameters. Overrides ModalInterface:: |
|
Modal:: |
public | function |
Get Published. Overrides ModalInterface:: |
|
Modal:: |
public | function |
Get Roles. Overrides ModalInterface:: |
|
Modal:: |
public | function |
Get Type. Overrides ModalInterface:: |
|
Modal:: |
public | function |
Auto Open. Overrides ModalInterface:: |
|
Modal:: |
public | function |
Set Body. Overrides ModalInterface:: |
|
Modal:: |
public | function |
Set Close Modal clicking outside the Modal. Overrides ModalInterface:: |
|
Modal:: |
public | function |
Set Close Modal ESC key. Overrides ModalInterface:: |
|
Modal:: |
public | function |
Set Delay Display. Overrides ModalInterface:: |
|
Modal:: |
public | function |
Set Dont Show Again Label. Overrides ModalInterface:: |
|
Modal:: |
public | function |
Set Enable Don't Show Again. Overrides ModalInterface:: |
|
Modal:: |
public | function |
Set Id. Overrides ModalInterface:: |
|
Modal:: |
public | function |
Set Label. Overrides ModalInterface:: |
|
Modal:: |
public | function |
Set LangCode. Overrides ModalInterface:: |
|
Modal:: |
public | function |
Set Modal Size. Overrides ModalInterface:: |
|
Modal:: |
public | function |
Set Ok Label Button. Overrides ModalInterface:: |
|
Modal:: |
public | function |
Set Open Modal on Element Click. Overrides ModalInterface:: |
|
Modal:: |
public | function |
Set Pages. Overrides ModalInterface:: |
|
Modal:: |
public | function |
Set Parameters. Overrides ModalInterface:: |
|
Modal:: |
public | function |
Set Published. Overrides ModalInterface:: |
|
Modal:: |
public | function |
Set Roles. Overrides ModalInterface:: |
|
Modal:: |
public | function |
Set Type. Overrides ModalInterface:: |
|
PluginDependencyTrait:: |
protected | function | Calculates and adds dependencies of a specific plugin instance. | 1 |
PluginDependencyTrait:: |
protected | function | Calculates and returns dependencies of a specific plugin instance. | |
PluginDependencyTrait:: |
protected | function | Wraps the module handler. | 1 |
PluginDependencyTrait:: |
protected | function | Wraps the theme handler. | 1 |
RefinableCacheableDependencyTrait:: |
public | function | 1 | |
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
SynchronizableEntityTrait:: |
protected | property | Whether this entity is being created, updated or deleted through a synchronization process. | |
SynchronizableEntityTrait:: |
public | function | ||
SynchronizableEntityTrait:: |
public | function |