Incoming\Structure\Exception\ReadOnlyException

Complexity

Total Complexity

2

Size/Duplication

Total Lines	84
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	forAttribute()	0	22	2

<?php
/**
 * Incoming
 *
 * @author    Trevor Suarez (Rican7)
 * @copyright (c) Trevor Suarez
 * @link      https://github.com/Rican7/incoming
 * @license   MIT
 */

declare(strict_types=1);

namespace Incoming\Structure\Exception;

use BadMethodCallException;
use Throwable;

/**
 * An exception to be thrown when an attempt is made to modify a read-only
 * value, property, or state.
 */
class ReadOnlyException extends BadMethodCallException
{

    /**
     * Constants
     */

    /**
     * The default exception message.
     *
     * @var string
     */
    const DEFAULT_MESSAGE = 'Illegal modification attempt';

    /**
     * The exception code for an exception with an attribute context.
     *
     * @var int
     */
    const CODE_FOR_ATTRIBUTE = 1;

    /**
     * The message extension format for providing an attribute context's info.
     *
     * @var string
     */
    const MESSAGE_EXTENSION_FOR_ATTRIBUTE_FORMAT = ' for attribute `%s`';

    /**
     * The message extension format for providing an attribute's value info in
     * addition to the attribute's context.
     *
     * @var string
     */
    const MESSAGE_EXTENSION_FOR_ATTRIBUTE_WITH_VALUE_FORMAT = ' and value `%s`';


    /**
     * Properties
     */

    /**
     * The exception message.
     *
     * @var string
     */
    protected $message = self::DEFAULT_MESSAGE;


    /**
     * Methods
     */

    /**
     * Create an exception instance with an attribute's context.
     *
     * @param mixed $name The name of the attribute attempted to be modified.
     * @param mixed|null $value The value attempted to be set.
     * @param int $code The exception code.
     * @param Throwable|null $previous A previous exception used for chaining.
     * @return static The newly created exception.
     */
    public static function forAttribute(
        $name,
        $value = null,
        int $code = self::CODE_FOR_ATTRIBUTE,
        Throwable $previous = null
    ): self {
        $message = self::DEFAULT_MESSAGE;

        if (null !== $value) {
            $message .= sprintf(
                self::MESSAGE_EXTENSION_FOR_ATTRIBUTE_FORMAT . self::MESSAGE_EXTENSION_FOR_ATTRIBUTE_WITH_VALUE_FORMAT,
                $name,
                var_export($value, true)
            );
        } else {
            $message .= sprintf(
                self::MESSAGE_EXTENSION_FOR_ATTRIBUTE_FORMAT,
                $name
            );
        }

        return new static($message, $code, $previous);
    }
}