Drone\Util\ParamTrait

Complexity

Total Complexity

7

Size/Duplication

Total Lines	86
Duplicated Lines	0 %

Test Coverage

Coverage

77.78%

Importance

Changes	3
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getParams()	0	3	1
A	getParam()	0	5	1
A	isParam()	0	9	2
A	param()	0	3	1
A	setParam()	0	3	1
A	setParams()	0	3	1

<?php
/**
 * DronePHP (http://www.dronephp.com)
 *
 * @link      http://github.com/Pleets/DronePHP
 * @copyright Copyright (c) 2016-2018 Pleets. (http://www.pleets.org)
 * @license   http://www.dronephp.com/license
 * @author    Darío Rivera <fermius.us@gmail.com>
 */

namespace Drone\Util;

/**
 * ParamTrait trait
 *
 * Standard parameters management
 */
trait ParamTrait
{
    /**
     * Current parameters
     *
     * @var array
     */
    protected $params = [];

    /**
     * Returns all parameters
     *
     * @return array
     */
    public function getParams()
    {
        return $this->params;
    }

    /**
     * Gets a particular parameter
     *
     * @param string $param
     *
     * @return string
     */
    public function getParam($param)
    {
        $parameters = $this->getParams();

        return $parameters[$param];
    }

    /**
     * Set a parameter
     *
     * @param string $name
     * @param mixed $value
     *
     * @return null
     */
    public function setParam($name, $value)
    {
        $this->params[$name] = $value;
    }

    /**
     * Sets all parameters
     *
     * @param array $params
     *
     * @return null
     */
    public function setParams(array $params)
    {
        $this->params = $params;
    }

    /**
     * Checks if a parameter exists
     *
     * @param string $param
     *
     * @return boolean
     */
    public function isParam($param)
    {
        $parameters = $this->getParams();

        if (array_key_exists($param, $parameters)) {
            return true;
        }

        return false;
    }

    /**
     * Returns a param (alias for getParam())
     *
     * @param string $paramName
     *
     * @return mixed
     */
    public function param($paramName)
    {
        return $this->getParam($paramName);
    }
}