class Popup in Entity Legal 8.2
Same name and namespace in other branches
- 4.0.x src/Plugin/EntityLegal/Popup.php \Drupal\entity_legal\Plugin\EntityLegal\Popup
- 3.0.x src/Plugin/EntityLegal/Popup.php \Drupal\entity_legal\Plugin\EntityLegal\Popup
Method class for alerting existing users via a jQuery UI popup window.
Plugin annotation
@EntityLegal(
id = "popup",
label = @Translation("Popup on all pages until accepted"),
type = "existing_users",
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\entity_legal\EntityLegalPluginBase implements EntityLegalPluginInterface
- class \Drupal\entity_legal\Plugin\EntityLegal\Popup
- class \Drupal\entity_legal\EntityLegalPluginBase implements EntityLegalPluginInterface
Expanded class hierarchy of Popup
File
- src/
Plugin/ EntityLegal/ Popup.php, line 16
Namespace
Drupal\entity_legal\Plugin\EntityLegalView source
class Popup extends EntityLegalPluginBase {
/**
* {@inheritdoc}
*/
public function execute(array &$context = []) {
if (!empty($this->documents)) {
/** @var \Drupal\Core\Render\RendererInterface $renderer */
$renderer = \Drupal::service('renderer');
$view_builder = \Drupal::entityTypeManager()
->getViewBuilder(ENTITY_LEGAL_DOCUMENT_VERSION_ENTITY_NAME);
/** @var \Drupal\entity_legal\EntityLegalDocumentInterface $document */
foreach ($this->documents as $document) {
$context['attachments']['#cache']['tags'][] = "entity_legal_document:{$document->id()}";
$document_markup = $view_builder
->view($document
->getPublishedVersion());
$context['attachments']['#attached']['library'][] = 'entity_legal/popup';
$context['attachments']['#attached']['drupalSettings']['entityLegalPopup'] = [
[
'popupTitle' => $document
->getPublishedVersion()
->label(),
'popupContent' => $renderer
->renderPlain($document_markup),
],
];
}
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
EntityLegalPluginBase:: |
protected | property | The legal documents that implement this plugin. | |
EntityLegalPluginBase:: |
public | function | Get all Entity Legal Documents for this plugin. | |
EntityLegalPluginBase:: |
public | function |
Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase:: |
1 |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
Popup:: |
public | function |
Execute callback for Entity Legal method plugin. Overrides EntityLegalPluginInterface:: |