Povs\ListerBundle\Exception\ListFieldException

Complexity

Total Complexity

7

Size/Duplication

Total Lines	82
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	fieldNotExists()	0	3	1
A	invalidPath()	0	3	1
A	getFieldId()	0	3	1
A	invalidType()	0	5	1
A	invalidPropertiesOption()	0	3	1
A	invalidFieldConfiguration()	0	3	1

<?php

namespace Povs\ListerBundle\Exception;

use Throwable;

/**
 * @author Povilas Margaiatis <p.margaitis@gmail.com>
 */
class ListFieldException extends ListException
{
    /**
     * @var string
     */
    private $fieldId;

    /**
     * ListFieldException constructor.
     *
     * @param string         $id      fieldId
     * @param string         $message
     * @param int            $code
     * @param Throwable|null $previous
     */
    public function __construct(string $id, string $message = '', $code = 500, Throwable $previous = null)
    {
        parent::__construct($message, $code, $previous);
        $this->fieldId = $id;
    }

    /**
     * @param string $id
     * @param string $message
     *
     * @return ListException
     */
    public static function invalidFieldConfiguration(string $id, string $message): ListException
    {
        return new self($id, sprintf('Invalid field "%s" configuration. %s', $id, $message));
    }

    /**
     * @param string $id
     *
     * @return ListException
     */
    public static function fieldNotExists(string $id): ListException
    {
        return new self($id, sprintf('Field "%s" do not exists', $id));
    }

    /**
     * @param string $id
     *
     * @return ListException
     */
    public static function invalidPropertiesOption(string $id): ListException
    {
        return new self($id, sprintf('"%s" - properties can only be set for a single path', $id));
    }

    /**
     * @param string $path join path
     *
     * @return ListException
     */
    public static function invalidPath(string $path): ListException
    {
        return new self($path, sprintf('Could not find join for path "%s"', $path));
    }

    /**
     * @param string $id         field id
     * @param string $type       type fully qualified class name
     * @param string $definition type interface fully qualified name
     *
     * @return ListException
     */
    public static function invalidType(string $id, string $type, string $definition): ListException
    {
        $message = sprintf('Type "%s" does not exist or does not implement %s', $type, $definition);

        return new self($id, $message);
    }

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