NullLockBackend.php

Same filename in other branches
  1. 8.9.x core/lib/Drupal/Core/Lock/NullLockBackend.php
  2. 10 core/lib/Drupal/Core/Lock/NullLockBackend.php
  3. 11.x core/lib/Drupal/Core/Lock/NullLockBackend.php

Namespace

Drupal\Core\Lock

File

core/lib/Drupal/Core/Lock/NullLockBackend.php

View source
<?php

namespace Drupal\Core\Lock;


/**
 * Defines a Null lock backend.
 *
 * This implementation won't actually lock anything and will always succeed on
 * lock attempts.
 *
 * @ingroup lock
 */
class NullLockBackend implements LockBackendInterface {
    
    /**
     * Current page lock token identifier.
     *
     * @var string
     */
    protected $lockId;
    
    /**
     * {@inheritdoc}
     */
    public function acquire($name, $timeout = 30.0) {
        return TRUE;
    }
    
    /**
     * {@inheritdoc}
     */
    public function lockMayBeAvailable($name) {
        return TRUE;
    }
    
    /**
     * {@inheritdoc}
     */
    public function wait($name, $delay = 30) {
    }
    
    /**
     * {@inheritdoc}
     */
    public function release($name) {
    }
    
    /**
     * {@inheritdoc}
     */
    public function releaseAll($lock_id = NULL) {
    }
    
    /**
     * {@inheritdoc}
     */
    public function getLockId() {
        if (!isset($this->lockId)) {
            $this->lockId = uniqid(mt_rand(), TRUE);
        }
        return $this->lockId;
    }

}

Classes

Title Deprecated Summary
NullLockBackend Defines a Null lock backend.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.