class BreakLockLink in Drupal 10

Same name and namespace in other branches

8 core/lib/Drupal/Core/TempStore/Element/BreakLockLink.php \Drupal\Core\TempStore\Element\BreakLockLink
9 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'),
];

Plugin annotation

@RenderElement("break_lock_link");

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
    class \Drupal\Core\TempStore\Element\BreakLockLink implements ContainerFactoryPluginInterface

Expanded class hierarchy of BreakLockLink

1 #type use of BreakLockLink

ViewEditForm::form in core/modules/views_ui/src/ViewEditForm.php

File

core/lib/Drupal/Core/TempStore/Element/BreakLockLink.php, line 32

Namespace

Drupal\Core\TempStore\Element

View source

class BreakLockLink extends RenderElement 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

Name	Modifiers	Type	Description	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. Overrides PluginBase::__construct
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	18
MessengerTrait::messenger	public	function	Gets the messenger.	18
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.
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
PluginBase::getDerivativeId	public	function
PluginBase::getPluginDefinition	public	function		2
PluginBase::getPluginId	public	function
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
RenderElement::preRenderAjaxForm	public static	function	Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup	public static	function	Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm	public static	function	Form element processing handler for the #ajax form property.	1
RenderElement::processGroup	public static	function	Arranges elements into groups.
RenderElement::setAttributes	public static	function	Sets a form element's class attribute. Overrides ElementInterface::setAttributes
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.	1
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.

You are here

class BreakLockLink in Drupal 10

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation