class BreakLockLink
Same name and namespace in other branches
- 9 core/lib/Drupal/Core/TempStore/Element/BreakLockLink.php \Drupal\Core\TempStore\Element\BreakLockLink
- 8.9.x core/lib/Drupal/Core/TempStore/Element/BreakLockLink.php \Drupal\Core\TempStore\Element\BreakLockLink
- 10 core/lib/Drupal/Core/TempStore/Element/BreakLockLink.php \Drupal\Core\TempStore\Element\BreakLockLink
Provides a link to break a tempstore lock.
Properties:
@property $label The label of the object that is locked. @property $lock \Drupal\Core\TempStore\Lock object. @property $url \Drupal\Core\Url object pointing to the break lock form.
Usage example:
$build['examples_lock'] = [
'#type' => 'break_lock_link',
'#label' => $this->t('example item'),
'#lock' => $tempstore->getMetadata('example_key'),
'#url' => \Drupal\Core\Url::fromRoute('examples.break_lock_form'),
];
Attributes
#[RenderElement('break_lock_link')]
Hierarchy
- class \Drupal\Component\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
- class \Drupal\Core\Render\Element\RenderElementBase extends \Drupal\Core\Render\Element\ElementInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\TempStore\Element\BreakLockLink extends \Drupal\Core\Plugin\ContainerFactoryPluginInterface implements \Drupal\Core\Render\Element\RenderElementBase
- class \Drupal\Core\Render\Element\RenderElementBase extends \Drupal\Core\Render\Element\ElementInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of BreakLockLink
1 #type use of BreakLockLink
- ViewEditForm::form in core/
modules/ views_ui/ src/ ViewEditForm.php - Gets the actual form array to be built.
File
-
core/
lib/ Drupal/ Core/ TempStore/ Element/ BreakLockLink.php, line 36
Namespace
Drupal\Core\TempStore\ElementView source
class BreakLockLink extends RenderElementBase implements ContainerFactoryPluginInterface {
/**
* The date formatter.
*
* @var \Drupal\Core\Datetime\DateFormatterInterface
*/
protected $dateFormatter;
/**
* The entity type manager.
*
* @var \Drupal\Core\Entity\EntityTypeManagerInterface
*/
protected $entityTypeManager;
/**
* The renderer.
*
* @var \Drupal\Core\Render\RendererInterface
*/
protected $renderer;
/**
* Constructs a new BreakLockLink.
*
* @param array $configuration
* A configuration array containing information about the plugin instance.
* @param string $plugin_id
* The plugin ID for the plugin instance.
* @param mixed $plugin_definition
* The plugin implementation definition.
* @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
* The date formatter.
* @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
* The entity type manager.
* @param \Drupal\Core\Render\RendererInterface $renderer
* The renderer.
* @param \Drupal\Core\Render\ElementInfoManagerInterface $elementInfoManager
* The element info manager.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, DateFormatterInterface $date_formatter, EntityTypeManagerInterface $entity_type_manager, RendererInterface $renderer, ElementInfoManagerInterface $elementInfoManager) {
parent::__construct($configuration, $plugin_id, $plugin_definition, $elementInfoManager);
$this->dateFormatter = $date_formatter;
$this->entityTypeManager = $entity_type_manager;
$this->renderer = $renderer;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container->get('date.formatter'), $container->get('entity_type.manager'), $container->get('renderer'), $container->get('plugin.manager.element_info'));
}
/**
* {@inheritdoc}
*/
public function getInfo() {
return [
'#pre_render' => [
[
$this,
'preRenderLock',
],
],
];
}
/**
* Pre-render callback: Renders a lock into #markup.
*
* @param array $element
* A structured array with the following keys:
* - #label: The label of the object that is locked.
* - #lock: The lock object.
* - #url: The URL object with the destination to the break lock form.
*
* @return array
* The passed-in element containing a rendered lock in '#markup'.
*/
public function preRenderLock($element) {
if (isset($element['#lock']) && isset($element['#label']) && isset($element['#url'])) {
/** @var \Drupal\Core\TempStore\Lock $lock */
$lock = $element['#lock'];
$age = $this->dateFormatter
->formatTimeDiffSince($lock->getUpdated());
$owner = $this->entityTypeManager
->getStorage('user')
->load($lock->getOwnerId());
$username = [
'#theme' => 'username',
'#account' => $owner,
];
$element['#markup'] = $this->t('This @label is being edited by user @user, and is therefore locked from editing by others. This lock is @age old. Click here to <a href=":url">break this lock</a>.', [
'@label' => $element['#label'],
'@user' => $this->renderer
->render($username),
'@age' => $age,
':url' => $element['#url']->toString(),
]);
}
return $element;
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
BreakLockLink::$dateFormatter | protected | property | The date formatter. | |||
BreakLockLink::$entityTypeManager | protected | property | The entity type manager. | |||
BreakLockLink::$renderer | protected | property | The renderer. | |||
BreakLockLink::create | public static | function | Creates an instance of the plugin. | Overrides RenderElementBase::create | ||
BreakLockLink::getInfo | public | function | Returns the element properties for this element. | Overrides ElementInterface::getInfo | ||
BreakLockLink::preRenderLock | public | function | Pre-render callback: Renders a lock into #markup. | |||
BreakLockLink::__construct | public | function | Constructs a new BreakLockLink. | Overrides RenderElementBase::__construct | ||
DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | |||
DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | |||
MessengerTrait::$messenger | protected | property | The messenger. | 25 | ||
MessengerTrait::messenger | public | function | Gets the messenger. | 25 | ||
MessengerTrait::setMessenger | public | function | Sets the messenger. | |||
PluginBase::$configuration | protected | property | Configuration information passed into the plugin. | 1 | ||
PluginBase::$pluginDefinition | protected | property | The plugin implementation definition. | 1 | ||
PluginBase::$pluginId | protected | property | The plugin ID. | |||
PluginBase::DERIVATIVE_SEPARATOR | constant | A string which is used to separate base plugin IDs from the derivative ID. | ||||
PluginBase::getBaseId | public | function | Gets the base_plugin_id of the plugin instance. | Overrides DerivativeInspectionInterface::getBaseId | ||
PluginBase::getDerivativeId | public | function | Gets the derivative_id of the plugin instance. | Overrides DerivativeInspectionInterface::getDerivativeId | ||
PluginBase::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | Overrides PluginInspectionInterface::getPluginDefinition | 2 | |
PluginBase::getPluginId | public | function | Gets the plugin ID of the plugin instance. | Overrides PluginInspectionInterface::getPluginId | ||
PluginBase::isConfigurable | Deprecated | public | function | Determines if the plugin is configurable. | ||
RenderElementBase::$renderParent | protected | property | The parent element. | |||
RenderElementBase::$renderParentName | protected | property | The parent key. | |||
RenderElementBase::$storage | protected | property | The storage. | |||
RenderElementBase::addChild | public | function | Adds a child render element. | Overrides ElementInterface::addChild | ||
RenderElementBase::changeType | public | function | Change the type of the element. | Overrides ElementInterface::changeType | ||
RenderElementBase::createChild | public | function | Creates a render object and attaches it to the current render object. | Overrides ElementInterface::createChild | ||
RenderElementBase::elementInfoManager | protected | function | Returns the element info manager. | |||
RenderElementBase::getChild | public | function | Gets a child. | Overrides ElementInterface::getChild | ||
RenderElementBase::getChildren | public | function | Returns child elements. | Overrides ElementInterface::getChildren | ||
RenderElementBase::initializeInternalStorage | public | function | Initialize storage. | Overrides ElementInterface::initializeInternalStorage | ||
RenderElementBase::preRenderAjaxForm | public static | function | Adds Ajax information about an element to communicate with JavaScript. | 2 | ||
RenderElementBase::preRenderGroup | public static | function | Adds members of this group as actual elements for rendering. | 2 | ||
RenderElementBase::processAjaxForm | public static | function | Form element processing handler for the #ajax form property. | 3 | ||
RenderElementBase::processGroup | public static | function | Arranges elements into groups. | 2 | ||
RenderElementBase::removeChild | public | function | Removes a child. | Overrides ElementInterface::removeChild | ||
RenderElementBase::setAttributes | public static | function | Sets a form element's class attribute. | Overrides ElementInterface::setAttributes | 2 | |
RenderElementBase::setType | protected | function | Set type on initialize. | 1 | ||
RenderElementBase::toRenderable | public | function | Returns a render array. | Overrides ElementInterface::toRenderable | ||
RenderElementBase::__get | public | function | Magic method: gets a property value. | |||
RenderElementBase::__isset | public | function | Magic method: checks if a property value is set. | |||
RenderElementBase::__set | public | function | Magic method: Sets a property value. | |||
RenderElementBase::__sleep | public | function | Overrides DependencySerializationTrait::__sleep | |||
RenderElementBase::__unset | public | function | Magic method: unsets a property value. | |||
RenderElementBase::__wakeup | public | function | Overrides DependencySerializationTrait::__wakeup | |||
StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | ||
StringTranslationTrait::formatPlural | protected | function | Formats a string containing a count of items. | |||
StringTranslationTrait::getNumberOfPlurals | protected | function | Returns the number of plurals supported by a given language. | |||
StringTranslationTrait::getStringTranslation | protected | function | Gets the string translation service. | |||
StringTranslationTrait::setStringTranslation | public | function | Sets the string translation service to use. | 2 | ||
StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. | 1 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.