GanbaroDigital\DataContainers\Requirements\RequireReadableContainer

Complexity

Total Complexity

4

Size/Duplication

Total Lines	50
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	check()	0	7	2
A	__invoke()	0	4	1
A	checkMixed()	0	4	1

<?php

/**
 * Copyright (c) 2015-present Ganbaro Digital Ltd
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in
 *     the documentation and/or other materials provided with the
 *     distribution.
 *
 *   * Neither the names of the copyright holders nor the names of his
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * @category  Libraries
 * @package   DataContainers/Requirements
 * @author    Stuart Herbert <stuherbert@ganbarodigital.com>
 * @copyright 2011-present Mediasift Ltd www.datasift.com
 * @copyright 2015-present Ganbaro Digital Ltd www.ganbarodigital.com
 * @license   http://www.opensource.org/licenses/bsd-license.php  BSD License
 * @link      http://code.ganbarodigital.com/php-data-containers
 */

namespace GanbaroDigital\DataContainers\Requirements;

use GanbaroDigital\DataContainers\Checks\IsReadableContainer;
use GanbaroDigital\DataContainers\Exceptions\E4xx_UnsupportedType;

class RequireReadableContainer
{
    /**
     * throws exceptions if $item is not a valid readable container
     *
     * @param  mixed $item
     *         the item to check
     * @param  string $eUnsupportedType
     *         the class to use when throwing an unsupported-type exception
     * @return void
     */
    public static function check($item, $eUnsupportedType = E4xx_UnsupportedType::class)
    {
        // make sure we have a valid container
        if (!IsReadableContainer::check($item)) {
            throw new $eUnsupportedType($item);
        }
    }

    /**
     * throws exceptions if $item is not a valid readable container
     *
     * @param  mixed $item
     *         the item to check
     * @param  string $eUnsupportedType
     *         the class to use when throwing an unsupported-type exception
     * @return void
     */
    public function __invoke($item, $eUnsupportedType = E4xx_UnsupportedType::class)
    {
        self::check($item, $eUnsupportedType);
    }

    /**
     * throws exceptions if $item is not a valid readable container
     *
     * @deprecated since 2.2.0
     * @codeCoverageIgnore
     *
     * @param  mixed $item
     *         the item to check
     * @param  string $eUnsupportedType
     *         the class to use when throwing an unsupported-type exception
     * @return void
     */
    public static function checkMixed($item, $eUnsupportedType = E4xx_UnsupportedType::class)
    {
        self::check($item, $eUnsupportedType);
    }
}