GanbaroDigital\MissingBits\TypeInspectors\GetPrintableType

Complexity

Total Complexity

19

Size/Duplication

Total Lines	177
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getPrintableType()	0	4	1
C	of()	0	24	7
A	returnCallableType()	0	20	4
A	returnObjectType()	0	15	3
A	returnScalarType()	0	21	4

<?php

/**
 * Copyright (c) 2016-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   MissingBits/Types
 * @author    Stuart Herbert <stuherbert@ganbarodigital.com>
 * @copyright 2015-present Ganbaro Digital Ltd www.ganbarodigital.com
 * @license   http://www.opensource.org/licenses/bsd-license.php  BSD License
 * @link      http://ganbarodigital.github.io/php-the-missing-bits
 */

namespace GanbaroDigital\MissingBits\TypeInspectors;

use Closure;

/**
 * GetPrintableType will tell you the PHP data type of any given input data.
 */
class GetPrintableType
{
    /**
     * use this flag for minimum output
     * @var int
     */
    const FLAG_NONE = 0;

    /**
     * use this flag to see classnames in the return value
     * @var int
     */
    const FLAG_CLASSNAME = 1;

    /**
     * use this flag to see what kind of callable `$item` is
     * @var int
     */
    const FLAG_CALLABLE_DETAILS = 2;

    /**
     * use this flag to see the value of `$item`
     * @var int
     */
    const FLAG_SCALAR_VALUE = 4;

    /**
     * current maximum possible value for `$flags`
     * @var int
     */
    const FLAG_MAX_VALUE = 7;

    /**
     * default value for `$flags` if you don't provide one
     * @var int
     */
    const FLAG_DEFAULTS = 7;

    /**
     * what PHP type is $item?
     *
     * @param  mixed $item
     *         the data to examine
     * @param  int $flags
     *         options to change what we put in the return value
     * @return string
     *         the data type of $item
     */
    public function getPrintableType($item, $flags = self::FLAG_DEFAULTS)

Please use __construct() instead of a PHP4-style constructor that is named after the class.

    {
        return self::of($item, $flags);
    }

    /**
     * what PHP type is $item?
     *
     * @param  mixed $item
     *         the data to examine
     * @param  int $flags
     *         options to change what we put in the return value
     * @return string
     *         the data type of $item
     */
    public static function of($item, $flags = self::FLAG_DEFAULTS)
    {
        // make sure we have a usable set of flags
        if (!is_int($flags)) {
            $flags = self::FLAG_DEFAULTS;
        }
        if ($flags < 0 || $flags > self::FLAG_MAX_VALUE) {
            $flags = self::FLAG_DEFAULTS;
        }

        if (is_object($item)) {
            return self::returnObjectType($item, $flags);
        }

        if (is_callable($item)) {
            return self::returnCallableType($item, $flags);
        }

        if (is_scalar($item)) {
            return self::returnScalarType($item, $flags);
        }

        return gettype($item);
    }

    /**
     * extract the details about a PHP callable array
     *
     * @param  array|string $item
     *         the callable() to examine
     * @param  int $flags
     *         options to change what we put in the return value
     * @return string
     *         the data type of $item
     */
    private static function returnCallableType($item, $flags)
    {
        // user doesn't want the details
        if (!($flags & self::FLAG_CALLABLE_DETAILS)) {
            return "callable";
        }

        // $item may contain the name of a function
        if (!is_array($item)) {
            return "callable<" . $item . ">";
        }

        // $item may contain a <classname, method> pair
        if (is_string($item[0])) {
            return "callable<" . $item[0] . "::" . $item[1] . ">";
        }

        // $item contains an <object, method> pair
        return "callable<" . get_class($item[0]). "::" . $item[1] . ">";
    }

    /**
     * turn a PHP object into the underlying PHP data type
     *
     * @param  object $item
     *         the data to inspect
     * @param  int $flags
     *         options to change what we put in the return value
     * @return string
     *         the data type of $item
     */
    private static function returnObjectType($item, $flags)
    {
        // special case - PHP Closure objects
        if ($item instanceof Closure) {
            return 'callable';
        }

        // does the caller want to know what kind of object?
        if ($flags & self::FLAG_CLASSNAME) {
            return 'object<' . get_class($item) . '>';
        }

        // if we get here, then a plain 'object' will suffice
        return "object";
    }

    /**
     * extract the details about a PHP scalar value
     *
     * @param  bool|float|int|string $item
     *         the data to examine
     * @param  int $flags
     *         options to change what we put in the return value
     * @return string
     *         the data type of $item
     */
    private static function returnScalarType($item, $flags)
    {
        // what do we have?
        $prefix = gettype($item);

        // user doesn't want the details
        if (!($flags & self::FLAG_SCALAR_VALUE)) {
            return $prefix;
        }

        // special case - boolean values
        if (is_bool($item)) {
            if ($item) {
                return $prefix . "<true>";
            }
            return $prefix . "<false>";
        }

        // general case
        return $prefix . "<{$item}>";
    }
}