Overview

Namespaces

  • Net
    • Bazzline
      • Component
        • Requirement
  • None

Classes

  • Net\Bazzline\Component\Requirement\AbstractCondition
  • Net\Bazzline\Component\Requirement\AbstractItem
  • Net\Bazzline\Component\Requirement\AndCondition
  • Net\Bazzline\Component\Requirement\OrCondition
  • Net\Bazzline\Component\Requirement\Requirement

Interfaces

  • Net\Bazzline\Component\Requirement\ConditionInterface
  • Net\Bazzline\Component\Requirement\IsDisabledInterface
  • Net\Bazzline\Component\Requirement\IsMetInterface
  • Net\Bazzline\Component\Requirement\ItemInterface
  • Net\Bazzline\Component\Requirement\RequirementInterface

Functions

  • netBazzlineComponentRequirementDevelopmentAutoloader
  • 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: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 
<?php

namespace Net\Bazzline\Component\Requirement;

use InvalidArgumentException;
use Net\Bazzline\Component\Lock\RuntimeLock;
use RuntimeException;
use SplObjectStorage;

/**
 * Class Requirement
 *
 * @package Net\Bazzline\Component\Requirement
 * @author stev leibelt <artodeto@bazzline.net>
 * @since 2013-06-25
 */
class Requirement implements RequirementInterface
{
    /** @var \SplObjectStorage|ConditionInterface[]|IsMetInterface[] */
    protected $conditions;

    /** @var \Net\Bazzline\Component\Lock\RuntimeLock */
    protected $lock;

    /** @var bool */
    protected $isDisabled;

    /** @var bool */
    private $returnValueIfIsDisabled;

    /**
     * @author stev leibelt <artodeto@bazzline.net>
     * @since 2013-06-25
     */
    public function __construct()
    {
        $this->conditions   = new SplObjectStorage();
        $this->isDisabled   = false;
        $this->lock         = new RuntimeLock();
        $this->lock->setResource(get_class($this));
        $this->setReturnValueIfIsDisabledToTrue();
    }

    /**
     * Magic call method to keep this class as generic as possible.
     *
     * @param string $methodName - name of the method
     * @param mixed $arguments - value
     * @return $this
     * @throws \InvalidArgumentException
     * @author sleibelt
     * @since 2013-06-25
     */
    public function __call($methodName, $arguments)
    {
        if (count($arguments) != 1) {
            throw new InvalidArgumentException(
                'Only one argument value should be provided.'
            );
        }

        $value = current($arguments);

        foreach ($this->conditions as $condition) {
            $condition->$methodName($value);
        }

        return $this;
    }

    /**
     * Validates if given requirement is met
     *
     * @return boolean
     * @throws \RuntimeException
     */
    public function __invoke()
    {
        return $this->isMet();
    }

    /**
     * {$inheritdoc}
     */
    public function addCondition(ConditionInterface $condition)
    {
        if ($this->lock->isLocked()) {
            throw new RuntimeException(
                'Requirement is locked, no new condition could be added.'
            );
        }

        $this->conditions->attach($condition);

        return $this;
    }

    /**
     * Validates if given requirement is met
     *
     * @return boolean
     * @throws \RuntimeException
     */
    public function isMet()
    {
        if ($this->isDisabled()) {
            return $this->getReturnValueIfIsDisabled();
        } else {
            if ($this->conditions->count() == 0) {
                throw new RuntimeException(
                    'No condition set in this requirement.'
                );
            }

            foreach ($this->conditions as $condition) {
                if (!$condition->isMet()) {
                    return false;
                }
            }

            return true;
        }
    }

    /**
     * {$inheritdoc}
     */
    public function isLocked()
    {
        return $this->lock->isLocked();
    }

    /**
     * {$inheritdoc}
     */
    public function lock()
    {
        $this->lock->acquire();

        return $this;
    }

    /**
     * {$inheritdoc}
     */
    public function isDisabled()
    {
        return $this->isDisabled;
    }

    /**
     * @return $this
     * @author stev leibelt <artodeto@bazzline.net>
     * @since 2013-09-29
     */
    public function disable()
    {
        $this->isDisabled = true;

        return $this;
    }

    /**
     * @return null|ConditionInterface[]
     * @author stev leibelt <artodeto@bazzline.net>
     * @since 2013-09-29
     */
    public function getConditions()
    {
        $conditions = array();

        foreach ($this->conditions as $condition) {
            $conditions[] = $condition;
        }

        return $conditions;
    }

    /**
     * @return bool
     * @author stev leibelt <artodeto@bazzline.net>
     * @since 2013-09-29
     */
    protected function getReturnValueIfIsDisabled()
    {
        return $this->isDisabled;
    }

    /**
     * @author stev leibelt <artodeto@bazzline.net>
     * @since 2013-09-29
     */
    protected function setReturnValueIfIsDisabledToFalse()
    {
        $this->returnValueIfIsDisabled = false;
    }

    /**
     * @author stev leibelt <artodeto@bazzline.net>
     * @since 2013-09-29
     */
    protected function setReturnValueIfIsDisabledToTrue()
    {
        $this->returnValueIfIsDisabled = true;
    }
}
PHP Requirement Component by bazzline.net API documentation generated by ApiGen