Charcoal\App\Script\CronScriptTrait

Complexity

Total Complexity

8

Size/Duplication

Total Lines	75
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	setUseLock()	0	5	1
A	useLock()	0	4	1
A	startLock()	0	17	3
A	stopLock()	0	7	2
A	getLockFileName()	0	7	1

<?php

namespace Charcoal\App\Script;

use Exception;

/**
 * Cron-job utilities
 */
trait CronScriptTrait
{
    /**
     * @var boolean $useLock
     */
    private $useLock = false;

    /**
     * Lock file pointer
     * @var resource $lockFilePointer
     */
    private $lockFilePointer;

    /**
     * @param boolean $useLock The boolean flag if a lock should be used.
     * @return self
     */
    public function setUseLock($useLock)
    {
        $this->useLock = !!$useLock;
        return $this;
    }

    /**
     * @return boolean
     */
    public function useLock()
    {
        return $this->useLock;
    }

    /**
     * @throws Exception If the lock file can not be opened or the script is already locked.
     * @return boolean
     */
    public function startLock()
    {
        $lockFile = $this->getLockFileName();
        $this->lockFilePointer = fopen($lockFile, 'w');
        if (!$this->lockFilePointer) {
            throw new Exception(
                sprintf('Can not run action. Lock file not available: "%s"', $lockFile)
            );
        }
        if (flock($this->lockFilePointer, LOCK_EX)) {
            return true;
        } else {
            throw new Exception(
                sprintf('Can not run action. Action locked: "%s".', $lockFile)
            );
        }
    }

    /**
     * @return void
     */
    public function stopLock()
    {
        if ($this->lockFilePointer) {
            flock($this->lockFilePointer, LOCK_UN);
            fclose($this->lockFilePointer);
        }
    }

    /**
     * @return string
     */
    private function getLockFileName()
    {
        $lockName = str_replace('\\', '-', static::class);
        $lockName .= md5(__DIR__);

        return sys_get_temp_dir().DIRECTORY_SEPARATOR.$lockName;
    }
}