GanbaroDigital\DataContainers\Checks\IsDotNotationPath

Complexity

Total Complexity

10

Size/Duplication

Total Lines	139
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	2
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__invoke()	0	4	1
A	check()	0	5	1
A	in()	0	4	1
A	inString()	0	4	1
A	checkString()	0	13	2
A	nothingMatchesTheInputType()	0	4	1
A	hasDotInAcceptablePlace()	0	18	3

<?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/Checks
 * @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\Checks;

use GanbaroDigital\DataContainers\Exceptions\E4xx_UnsupportedType;
use GanbaroDigital\Reflection\Requirements\RequireStringy;
use GanbaroDigital\Reflection\ValueBuilders\LookupMethodByType;
use GanbaroDigital\Reflection\ValueBuilders\SimpleType;

class IsDotNotationPath
{
    use LookupMethodByType;

    /**
     * do we have a dot.notation string at all?
     *
     * @param  mixed $item
     *         the item to examine
     * @return boolean
     *         TRUE if the string is in dot.notation
     *         FALSE otherwise
     */
    public function __invoke($item)
    {
        return self::check($item);
    }

    /**
     * do we have a dot.notation string at all?
     *
     * @param  mixed $item
     *         the item to examine
     * @return boolean
     *         TRUE if the string is in dot.notation
     *         FALSE otherwise
     */
    public static function check($item)
    {
        $method = self::lookupMethodFor($item, self::$dispatchTable);
        return self::$method($item);
    }

    /**
     * do we have a dot.notation string at all?
     *
     * @deprecated since 2.3.0
     * @codeCoverageIgnore
     *
     * @param  mixed $item
     *         the item to examine
     * @return boolean
     *         TRUE if the string is in dot.notation
     *         FALSE otherwise
     */
    public static function in($item)
    {
        return self::check($item);
    }

    /**
     * do we have a dot.notation string at all?
     *
     * @deprecated since 2.3.0
     * @codeCoverageIgnore
     *
     * @param  string $item
     *         the item to examine
     * @return boolean
     *         TRUE if the string is in dot.notation
     *         FALSE otherwise
     */
    public static function inString($item)
    {
        return self::checkString($item);
    }

    /**
     * do we have a dot.notation string at all?
     *
     * @param  string $item
     *         the item to examine
     * @return boolean
     *         TRUE if the string is in dot.notation
     *         FALSE otherwise
     */
    public static function checkString($item)
    {
        // robustness!!
        RequireStringy::check($item, E4xx_UnsupportedType::class);

        // make sure we have a dot somewhere we like
        if (!self::hasDotInAcceptablePlace((string)$item)) {
            return false;
        }

        // if we get here, we're happy
        return true;
    }

    /**
     * called when there's no entry in our dispatch table that matches
     * $item's data type
     *
     * @param  mixed $item
     *         the item that we cannot process
     * @return void
     */
    public static function nothingMatchesTheInputType($item)
    {
        throw new E4xx_UnsupportedType(SimpleType::from($item));
    }

    /**
     * do we have a dot, and is it somewhere we're happy with?
     *
     * @param  string $item
     * @return boolean
     *         FALSE if there is no '.' anywhere
     *         FALSE if the first '.' is at the end of the string
     *         TRUE otherwise
     */
    private static function hasDotInAcceptablePlace($item)
    {
        // where is the dot?
        $firstDot = strpos($item, '.');

        // do we even have one?
        if (false === $firstDot) {
            return true;
        }

        // can't be at the end of the string
        if ($firstDot === strlen($item) - 1) {
            return false;
        }

        // this is okay
        return true;
    }

    /**
     * our lookup table of which method to call for which supported data type
     * @var array
     */
    private static $dispatchTable = [
        'String' => 'checkString',
    ];
}