File core/traits/patterns/structural/Lockable.php

  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

<?php

/**
 * @author Brian Dayhoff <mopsyd@me.com>
 * @license http://opensource.org/licenses/MIT The MIT License (MIT)
 * @copyright (c) 2014, Brian Dayhoff all rights reserved.
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

namespace oroboros\core\traits\patterns\structural;

/**
 * Lockable Pattern Trait
 * Provides a basic pattern for making objects only
 * accessible to other objects based on specified criteria.
 * @version 0.1.1 alpha
 * @category traits
 * @category design patterns
 * @category behaviorial patterns
 */
trait Lockable {

    private $_accessible = [];
    private $_keys = [];
    private $_tokens = [];
    private $_namespaces = [];
    private $_functions = [];
    private $_methods = [];
    private $_locks = [
        'read' => false,
        'write' => false,
        'execute' => false,
        'all' => false,
        'conditions' => false,
    ];
    private $_conditions = [
        'read' => [],
        'write' => [],
        'execute' => [],
        'all' => [],
    ];
    private $_conditions_valid = [
        'owner',
        'interface',
        'namespace',
        'key',
        'token',
        'function',
        'methods',
        'extends',
    ];

    final protected function _lock($type = ['write', 'execute'], $args = [], $flags = []) {
        if (is_array($type)) {
            array_map(function($typeof) use($args, $flags) {
                $this->_lock($typeof, $args, $flags);
            }, $type);
            return;
        }
        if (!in_array($type, array_keys($this->_locks))) {
            throw new \oroboros\core\utilities\exception\Exception('Invalid parameters passed at ' . __LINE__ . ' of ' . __METHOD__, self::EXCEPTION_CODE_BAD_PARAMETERS);
        }
        if (in_array(true, array_map(function($condition) use ($args) {
                            return (in_array($condition, array_keys($args)));
                        }, $this->_conditions_valid))) {
            //conditional unlock
            array_map(function($condition) use ($args, $type) {
                if (array_key_exists($condition, $args)) {
                    $this->_conditions[$type][$condition] = $args[$condition];
                }
            }, $this->_conditions_valid);
        } else {
            //default behavior
            $this->_lockSet($type);
        }
    }

    final protected function _unlock($type = 'read', $args = [], $flags = []) {
        if (is_array($type)) {
            array_map(function($typeof) use($args, $flags) {
                $this->_unlock($typeof, $args, $flags);
            }, $type);
        }
        if (!in_array($type, array_keys($this->_locks))) {
            throw new \oroboros\core\utilities\exception\Exception('Invalid parameters passed at ' . __LINE__ . ' of ' . __METHOD__, self::EXCEPTION_CODE_BAD_PARAMETERS);
        }
        $this->_lockRelease($type);
    }

    final protected function _registerAccess($type, $args = [], $flags = []) {
        if (is_array($type)) {
            array_map(function($typeof) use($args, $flags) {
                $this->_registerAccess($typeof, $args, $flags);
            }, $type);
        }
    }

    final protected function _unregisterAccess($type, $args = [], $flags = []) {
        if (is_array($type)) {
            array_map(function($typeof) use($args, $flags) {
                $this->_unregisterAccess($typeof, $args, $flags);
            }, $type);
        }
    }

    final protected function _checkAccess($type, $args = [], $flags = []) {
        if (is_array($type)) {
            array_map(function($typeof) use($args, $flags) {
                $this->_checkAccess($typeof, $args, $flags);
            }, $type);
        }
        if (!array_key_exists($type, $this->_locks)) {
            throw new \oroboros\core\utilities\exception\InvalidArgumentException('Invalid lock type passed at ' . __LINE__ . ' of ' . __METHOD__, self::EXCEPTION_CODE_BAD_PARAMETERS);
        }
        if ($this->_locks[$type]) {
            throw new \oroboros\core\utilities\exception\Exception('Requested operation cannot complete because ' . get_class($this) . ' is locked.', self::EXCEPTION_CODE_SECURITY_LOCKED_DATA_OBJECT);
        }
    }

    private function _lockRelease($type) {
        $this->_locks[$type] = false;
    }

    private function _lockSet($type) {
        $this->_locks[$type] = true;
    }

}

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions