GanbaroDigital\MessagingPipeline\V1\Requirements\RequireConfigHasKey

Complexity

Total Complexity

4

Size/Duplication

Total Lines	68
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	apply()	0	4	1
A	to()	0	16	2

<?php

declare(strict_types=1);

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

use GanbaroDigital\Defensive\V1\Interfaces\ListRequirement;
use GanbaroDigital\Defensive\V1\Interfaces\Requirement;
use GanbaroDigital\Defensive\V1\Requirements\InvokeableRequirement;
use GanbaroDigital\Defensive\V1\Requirements\ListableRequirement;
use GanbaroDigital\MessagingPipeline\V1\Checks\DoesArrayHaveKey;
use GanbaroDigital\MessagingPipeline\V1\Exceptions\ConfigKeyNotFound;

/**
 * make sure that the supplied config array contains the array key
 * that we need
 */
class RequireConfigHasKey implements Requirement, ListRequirement
{
    // saves us having to declare ::__invoke() ourselves
    use InvokeableRequirement;

    // saves us having to declare ::toList() ourselves
    use ListableRequirement;

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

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

    /**
     * create a Requirement that is ready to use
     *
     * @param string|int $expectedKey
     *        the array key that we are looking for
     * @return Requirement
     */
    public static function apply($expectedKey) : Requirement
    {
        return new static($expectedKey);
    }

    /**
     * make sure that the supplied config array contains the entry that
     * we need
     *
     * @param  array|ArrayAccess $item
     *         the item to examine
     * @param  string $fieldOrVarName
     *         what do you call $item in your own code?
     * @return void
     *
     * @throws ConfigKeyNotFound
     *         if $item[$this->expectedKey] does not exist
     */
    public function to($item, $fieldOrVarName='$item')
    {
        // are we happy?
        if (DoesArrayHaveKey::check($item, $this->expectedKey)) {
            // yes we are
            return;
        }

        // if we get here, then no, we are not happy
        throw ConfigKeyNotFound::newFromInputParameter(
            $item,
            $fieldOrVarName, [
                'expectedKey' => $this->expectedKey
            ]
        );
    }
}