Chubbyphp\ApiHttp\Error\Error

Complexity

Total Complexity

6

Size/Duplication

Total Lines	103
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	13	1
A	getScope()	0	4	1
A	getKey()	0	4	1
A	getDetail()	0	4	1
A	getReference()	0	4	1
A	getArguments()	0	4	1

<?php

declare(strict_types=1);

namespace Chubbyphp\ApiHttp\Error;

final class Error
{
    /**
     * @var string|null
     */
    private $scope;

    const SCOPE_METHOD = 'method';
    const SCOPE_RESOURCE = 'resource';
    const SCOPE_QUERY = 'query';
    const SCOPE_HEADER = 'header';
    const SCOPE_BODY = 'body';
    const SCOPE_SERVER = 'server';

    /**
     * Identifier.
     *
     * @var string
     */
    private $key;

    /**
     * Technical error description.
     *
     * @var string|null
     */
    private $detail;

    /**
     * Reference to the error causing form field, parameter, value, header, etc.
     *
     * @var string|null
     */
    private $reference;

    /**
     * Parameters which can be used by client in order to display a expressive error message.
     *
     * @var array|null
     */
    private $arguments;

    /**
     * @param string|null $scope
     * @param string      $key
     * @param string|null $detail
     * @param string|null $reference
     * @param array       $arguments
     */
    public function __construct(
        string $scope,
        string $key,
        string $detail = null,
        string $reference = null,
        array $arguments = []
    ) {
        $this->scope = $scope;
        $this->key = $key;
        $this->detail = $detail;
        $this->reference = $reference;
        $this->arguments = $arguments;
    }

    /**
     * @return null|string
     */
    public function getScope()
    {
        return $this->scope;
    }

    /**
     * @return string
     */
    public function getKey(): string
    {
        return $this->key;
    }

    /**
     * @return string|null
     */
    public function getDetail()
    {
        return $this->detail;
    }

    /**
     * @return string|null
     */
    public function getReference()
    {
        return $this->reference;
    }

    /**
     * @return array|null
     */
    public function getArguments()
    {
        return $this->arguments;
    }
}