Arp\EventDispatcher\Event\ParametersAwareTrait

Complexity

Total Complexity

4

Size/Duplication

Total Lines	49
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	1	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getParameters()	0	3	1
A	setParameters()	0	3	1
A	setParam()	0	3	1
A	getParam()	0	3	1

<?php

declare(strict_types=1);

namespace Arp\EventDispatcher\Event;

/**
 * @author  Alex Patterson <alex.patterson.webdev@gmail.com>
 * @package Arp\EventDispatcher\Event
 */
trait ParametersAwareTrait
{
    /**
     * @var ParametersInterface<mixed>
     */
    protected ParametersInterface $params;

    /**
     * Set the parameters collection
     *
     * @param ParametersInterface<mixed> $params
     */
    public function setParameters(ParametersInterface $params): void
    {
        $this->params = $params;
    }

    /**
     * Return the parameters collection
     *
     * @return ParametersInterface<mixed>
     */
    public function getParameters(): ParametersInterface
    {
        return $this->params;
    }

    /**
     * Return a single parameter value by $name or if not found $default
     *
     * @param string $name
     * @param mixed  $default
     *
     * @return mixed
     */
    public function getParam(string $name, $default = null)
    {
        return $this->params->getParam($name, $default);
    }

    /**
     * Set a single parameter value by $name
     *
     * @param string $name
     * @param mixed  $value
     */
    public function setParam(string $name, $value): void
    {
        $this->params->setParam($name, $value);
    }
}