Overview

Namespaces

  • Net
    • Bazzline
      • Component
        • Lock

Classes

  • Net\Bazzline\Component\Lock\FileHandlerLock
  • Net\Bazzline\Component\Lock\FileNameLock
  • Net\Bazzline\Component\Lock\RuntimeLock

Interfaces

  • Net\Bazzline\Component\Lock\LockAwareInterface
  • Net\Bazzline\Component\Lock\LockDependentInterface
  • Net\Bazzline\Component\Lock\LockInterface
  • Overview
  • Namespace
  • Class
  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 
<?php
/**
 * @author stev leibelt <artodeto@bazzline.net>
 * @since 2013-06-30 
 */

namespace Net\Bazzline\Component\Lock;

use InvalidArgumentException;
use RuntimeException;

/**
 * Class FileNameLock
 *
 * @package Net\Bazzline\Component\Lock
 * @author stev leibelt <artodeto@bazzline.net>
 * @since 2013-06-30
 */
class FileNameLock implements LockInterface
{
    /** @var string */
    private $name = '';

    /**
     * @param string $resource
     */
    public function __construct($resource = '')
    {
        if (strlen($resource) > 0) {
            $this->setResource($resource);
        }
    }

    /**
     * @throws \RuntimeException
     */
    public function acquire()
    {
        if ($this->isLocked()) {
            throw new RuntimeException(
                'Can not acquire lock, lock already exists.'
            );
        }

        file_put_contents($this->getResource(), 'process id: ' . getmypid());
    }

    /**
     * @throws \RuntimeException
     */
    public function release()
    {
        if (!$this->isLocked()) {
            throw new RuntimeException(
                'Can not release lock, no lock exists.'
            );
        }

        unlink($this->getResource());
    }

    /**
     * @return bool
     */
    public function isLocked()
    {
        return file_exists($this->getResource());
    }

    /**
     * @return mixed|string
     */
    public function getResource()
    {
        if (!$this->isValidName()) {
            return $this->getDefaultName();
        } else {
            return $this->name;
        }
    }

    /**
     * @param mixed|string $resource
     * @throws InvalidArgumentException
     */
    public function setResource($resource)
    {
        if (is_string($resource)) {
            $this->name = (string) ($this->stringEndsWithDotLock($resource)
                ? $resource
                : $resource . '.lock');
        } else {
            throw new InvalidArgumentException(
                'resource must be of type string'
            );
        }
    }

    /**
     * @return bool
     */
    private function stringEndsWithDotLock($string)
    {
        $endsWith           = '.lock';
        $lengthOfEndsWith   = strlen($endsWith);
        $stringEnding       = substr($string, -$lengthOfEndsWith);

        return ($stringEnding == $endsWith);
    }

    /**
     * @return boolean
     */
    private function isValidName()
    {
        return (is_string($this->name) && strlen($this->name) > 0);
    }

    /**
     * @return string
     */
    private function getDefaultName()
    {
        return (string) str_replace('\\', '_', get_class($this)) . '.lock';
    }
}
PHP Process Lock Component by bazzline.net API documentation generated by ApiGen