GanbaroDigital\MessagingPipeline\V1\Checks\DoesArrayHaveKey

Complexity

Total Complexity

4

Size/Duplication

Total Lines	71
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	check()	0	4	1
A	inspect()	0	5	1
A	checkList()	0	6	1

<?php

/**
 * Copyright (c) 2017-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   MessagingPipeline/Checks
 * @author    Stuart Herbert <stuherbert@ganbarodigital.com>
 * @copyright 2017-present Ganbaro Digital Ltd www.ganbarodigital.com
 * @license   http://www.opensource.org/licenses/bsd-license.php  BSD License
 * @link      http://ganbarodigital.github.io/php-mv-messaging-pipeline
 */

namespace GanbaroDigital\MessagingPipeline\V1\Checks;

use GanbaroDigital\MissingBits\Checks\Check;
use GanbaroDigital\MissingBits\Checks\ListCheck;
use GanbaroDigital\MissingBits\Checks\ListCheckHelper;

/**
 * does the supplied array contain the key we want?
 */
class DoesArrayHaveKey implements Check, ListCheck
{
    // saves us having to implement inspectList() ourselves
    use ListCheckHelper;

    /**
     * the array key that we are looking for
     *
     * @var string|int
     */
    private $expectedKey;

    /**
     * create a Check that is ready to use
     *
     * @param string|int $expectedKey
     *        the array key that we are looking for
     */
    public function __construct($expectedKey)
    {
        $this->expectedKey = $expectedKey;
    }

    /**
     * does the supplied array contain the key we want?
     *
     * @param  array $data
     *         the array to be checked
     * @param  string|int $key
     *         the array index we are looking for
     * @return bool
     *         TRUE if $data[$key] exists
     *         FALSE otherwise
     */
    public static function check(array $data, $key) : bool
    {
        return array_key_exists($key, $data);
    }

    /**
     * does the supplied array contain the key we want?
     *
     * @param  array $data
     *         the array to be checked
     * @return bool
     *         TRUE if $data[$key] exists
     *         FALSE otherwise
     */
    public function inspect($data)
    {
        // we are just a wrapper around our stateless check
        return static::check($data, $this->expectedKey);
    }

    /**
     * does the supplied array contain the key we want?
     *
     * @param  array|Traversable $list
     *         the item to be checked
     * @return bool
     *         TRUE if the array key we are looking for exists in every
     *         item in $list
     *         FALSE otherwise
     */
    public static function checkList($list, $expectedKey) : bool
    {
        // we are just a wrapper around our OO list inspector
        $inspector = new static($expectedKey);
        return $inspector->inspectList($list);
    }
}