class BreakLockLink
Same name 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
- 11.x core/lib/Drupal/Core/TempStore/Element/BreakLockLink.php \Drupal\Core\TempStore\Element\BreakLockLink
Provides a link to break a tempstore lock.
Properties:
- #label: The label of the object that is locked.
- #lock: \Drupal\Core\TempStore\Lock object.
- #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'),
];
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\Core\Render\Element\RenderElementBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Render\Element\ElementInterface
- class \Drupal\Core\TempStore\Element\BreakLockLink extends \Drupal\Core\Render\Element\RenderElementBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface
- class \Drupal\Core\Render\Element\RenderElementBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Render\Element\ElementInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of BreakLockLink
File
-
core/
lib/ Drupal/ Core/ TempStore/ Element/ BreakLockLink.php, line 31
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.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, DateFormatterInterface $date_formatter, EntityTypeManagerInterface $entity_type_manager, RendererInterface $renderer) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$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'));
}
/**
* {@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 | 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 ContainerFactoryPluginInterface::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. | ||
PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 6 | |
PluginInspectionInterface::getPluginId | public | function | Gets the plugin ID of the plugin instance. | 2 | |
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::setAttributes | public static | function | Sets a form element's class attribute. | Overrides ElementInterface::setAttributes | 2 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.