GroundSix\Locker\Locker

Complexity

Total Complexity

5

Size/Duplication

Total Lines	58
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	unlock()	0	3	1
A	__construct()	0	3	1
A	isLocked()	0	4	1
A	getURLStatus()	0	3	1
A	lock()	0	3	1

<?php
declare(strict_types=1);

namespace GroundSix\Locker;

class Locker
{
    /** @var LockerDriver $driver */
    private $driver;

    /**
     * Creates a new Locker instance
     *
     * @param LockerDriver $driver The instance of the LockerDriver to use to check the state of locked pages
     */
    public function __construct(LockerDriver $driver)
    {
        $this->driver = $driver;
    }

    /**
     * Is the specified URL locked?
     *
     * @param string $url The URL to check the lock status for
     * @return bool true if locked, otherwise false
     */
    public function isLocked(string $url): bool
    {
        $status = $this->driver->getURLStatus($url);
        return $status->isLocked();
    }

    /**
     * Gets the full status of a page
     *
     * @param string $url
     * @return Status
     */
    public function getURLStatus(string $url): Status
    {
        return $this->driver->getURLStatus($url);
    }

    /**
     * Locks the given URL for a specified amount of time
     *
     * @param string $url The URL to lock
     * @param string $lockedBy The identifier of the user locking the page
     * @param int $lockFor The amount of seconds to lock the page for
     */
    public function lock(string $url, string $lockedBy, int $lockFor): void
    {
        $this->driver->lockURL($url, $lockedBy, $lockFor);
    }

    /**
     * Unlocks the given URL
     *
     * @param string $url The URL to unlock
     */
    public function unlock(string $url): void
    {
        $this->driver->unlockURL($url);
    }
}