ICanBoogie\Prototype\MethodNotDefined

Complexity

Total Complexity

7

Size/Duplication

Total Lines	72
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	format_message()	0	6	1
A	__construct()	0	15	3
A	get_method()	0	3	1
A	get_instance()	0	3	1
A	get_class()	0	3	1

<?php

/*
 * This file is part of the ICanBoogie package.
 *
 * (c) Olivier Laviale <olivier.laviale@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ICanBoogie\Prototype;

use BadMethodCallException;
use ICanBoogie\Accessor\AccessorTrait;
use Throwable;

use function assert;
use function get_class;
use function ICanBoogie\format;
use function is_object;
use function is_string;

/**
 * Exception thrown in attempt to access a method that is not defined.
 *
 * @property-read string $method The method that is not defined.
 * @property-read class-string $class The class of the instance on which the method was invoked.
 * @property-read object|null $instance Instance on which the method was invoked, or `null` if
 * only the class is available.
 */

The doc comment class-string at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string.

class MethodNotDefined extends BadMethodCallException implements Exception
{
    /**
     * @uses get_method
     * @uses get_class
     * @uses get_instance
     */
    use AccessorTrait;

    /**
     * @var string
     */
    private $method;

    private function get_method(): string
    {
        return $this->method;
    }

    /**
     * @var class-string

The doc comment class-string at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string.

     */
    private $class;

    private function get_class(): string
    {
        return $this->class;
    }

    /**
     * @var object|null
     */
    private $instance;

    private function get_instance(): ?object
    {
        return $this->instance;
    }

    /**
     * @inheritdoc
     *
     * @param string $method The method that is not defined.
     * @param class-string|object $class_or_instance The name of the class or one of its instances.

The doc comment class-string|object at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string|object.

     * @param string|null $message If `null` a message is formatted with $method and $class.
     */
    public function __construct(string $method, $class_or_instance, string $message = null, Throwable $previous = null)
    {
        $class = $class_or_instance;

        if (is_object($class_or_instance)) {
            $this->instance = $class_or_instance;
            $class = get_class($class_or_instance);
        }

        assert(is_string($class));

        $this->method = $method;
        $this->class = $class;

        parent::__construct($message ?: $this->format_message($method, $class), 0, $previous);
    }

    /**
     * @param class-string $class

The doc comment class-string at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string.

     */
    private function format_message(string $method, string $class): string
    {
        return format('The method %method is not defined by the prototype of class %class.', [

            'method' => $method,
            'class' => $class

        ]);
    }
}