class ContentLockController in Content locking (anti-concurrent editing) 8

Class ContentLockController.

@package Drupal\content_lock\Controller

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\content_lock\Controller\ContentLockController

File

src/Controller/ContentLockController.php, line 21

Namespace

Drupal\content_lock\Controller

class ContentLockController extends ControllerBase {

  /**
   * Content lock service.
   *
   * @var \Drupal\content_lock\ContentLock\ContentLock
   */
  protected $lockService;

  /**
   * EntityBreakLockForm constructor.
   *
   * @param \Drupal\content_lock\ContentLock\ContentLock $lock_service
   *   Content lock service.
   */
  public function __construct(ContentLock $lock_service) {
    $this->lockService = $lock_service;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('content_lock'));
  }

  /**
   * Custom callback for the create lock route.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   * @param \Drupal\Core\Entity\ContentEntityInterface $entity
   *
   * @return \Symfony\Component\HttpFoundation\JsonResponse
   *
   * @see \Drupal\content_lock\Routing\ContentLockRoutes::routes()
   */
  public function createLockCall(Request $request, ContentEntityInterface $entity, $langcode, $form_op) {
    $response = new AjaxResponse();

    // Not lockable entity or entity creation.
    if (!$this->lockService
      ->isLockable($entity, $form_op) || is_null($entity
      ->id())) {
      $lockable = FALSE;
      $lock = FALSE;
    }
    else {
      $lockable = TRUE;
      $destination = $request->query
        ->get('destination') ?: $entity
        ->toUrl('edit-form')
        ->toString();
      $lock = $lockable ? $this->lockService
        ->locking($entity
        ->id(), $langcode, $form_op, $this
        ->currentUser()
        ->id(), $entity
        ->getEntityTypeId(), FALSE, $destination) : FALSE;

      // Render status messages from locking service.
      $response
        ->addCommand(new PrependCommand('', [
        '#type' => 'status_messages',
      ]));
      if ($lock) {
        $language = $this
          ->languageManager()
          ->getLanguage($langcode);
        $url = $entity
          ->toUrl('canonical', [
          'language' => $language,
        ]);
        $unlock_button = $this->lockService
          ->unlockButton($entity
          ->getEntityTypeId(), $entity
          ->id(), $langcode, $form_op, $url
          ->toString());
        $response
          ->addCommand(new AppendCommand('.content-lock-actions.form-actions', $unlock_button));
      }
    }
    $response
      ->addCommand(new LockFormCommand($lockable, $lock));
    return $response;
  }

  /**
   * Custom access checker for the create lock requirements route.
   *
   * @see \Drupal\content_lock\Routing\ContentLockRoutes::routes()
   */
  public function access(ContentEntityInterface $entity, AccountInterface $account) {
    return $entity
      ->access('update', $account, TRUE);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ContentLockController::$lockService	protected	property	Content lock service.
ContentLockController::access	public	function	Custom access checker for the create lock requirements route.
ContentLockController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
ContentLockController::createLockCall	public	function	Custom callback for the create lock route.
ContentLockController::__construct	public	function	EntityBreakLockForm constructor.
ControllerBase::$configFactory	protected	property	The configuration factory.
ControllerBase::$currentUser	protected	property	The current user service.	1
ControllerBase::$entityFormBuilder	protected	property	The entity form builder.
ControllerBase::$entityManager	protected	property	The entity manager.
ControllerBase::$entityTypeManager	protected	property	The entity type manager.
ControllerBase::$formBuilder	protected	property	The form builder.	2
ControllerBase::$keyValue	protected	property	The key-value storage.	1
ControllerBase::$languageManager	protected	property	The language manager.	1
ControllerBase::$moduleHandler	protected	property	The module handler.	2
ControllerBase::$stateService	protected	property	The state service.
ControllerBase::cache	protected	function	Returns the requested cache bin.
ControllerBase::config	protected	function	Retrieves a configuration object.
ControllerBase::container	private	function	Returns the service container.
ControllerBase::currentUser	protected	function	Returns the current user.	1
ControllerBase::entityFormBuilder	protected	function	Retrieves the entity form builder.
ControllerBase::entityManager Deprecated	protected	function	Retrieves the entity manager service.
ControllerBase::entityTypeManager	protected	function	Retrieves the entity type manager.
ControllerBase::formBuilder	protected	function	Returns the form builder service.	2
ControllerBase::keyValue	protected	function	Returns a key/value storage collection.	1
ControllerBase::languageManager	protected	function	Returns the language manager service.	1
ControllerBase::moduleHandler	protected	function	Returns the module handler.	2
ControllerBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state	protected	function	Returns the state storage service.
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator service.
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.