TechDivision\Import\Product\Ee\Utils\RmaKeys

Complexity

Total Complexity

4

Size/Duplication

Total Lines	48
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

0%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	isValid()	0	4	1
A	get()	0	4	2
A	getAll()	0	4	1

<?php

/**
 * TechDivision\Import\Product\Ee\Utils\RmaKeys
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * PHP version 5
 *
 * @author    Tim Wagner <t.wagner@techdivision.com>
 * @copyright 2020 TechDivision GmbH <info@techdivision.com>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/techdivision/import-product-ee
 * @link      http://www.techdivision.com
 */

namespace TechDivision\Import\Product\Ee\Utils;

/**
 * Utitlity class that provides RMA keys.
 *
 * @author    Tim Wagner <t.wagner@techdivision.com>
 * @copyright 2020 TechDivision GmbH <info@techdivision.com>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/techdivision/import-product-ee
 * @link      http://www.techdivision.com
 */
class RmaKeys implements RmaKeysInterface
{

    /**
     * The available states for the 'is_returnable' colum.
     *
     * @var array
     */
    protected $returnable = array(
        RmaKeysInterface::NOT_RETURNABLE => 0,
        RmaKeysInterface::RETURNABLE     => 1,
        RmaKeysInterface::USE_CONFIG     => 2
    );

    /**
     * Query's whether or not the passed key is valid or not.
     *
     * @param string $key The key to query for
     *
     * @return bool TRUE if the passed key is valid, else FALSE
     */
    public function isValid(string $key) : bool
    {
        return isset($this->returnable[$key]);
    }

    /**
     * Return's the value for the passed key.
     *
     * @param string $key The key to return the value for
     *
     * @return int The value
     */
    public function get(string $key) : int
    {
        return isset($this->returnable[$key]) ? $this->returnable[$key] : $this->returnable[RmaKeysInterface::USE_CONFIG];
    }

    /**
     * Return all available keys.
     *
     * @return array The array with the available keys
     */
    public function getAll() : array
    {
        return $this->returnable;
    }
}