ICanBoogie/Prototype 3.0.x
  • Namespace
  • Class

Namespaces

  • ICanBoogie
    • Prototype

Classes

  • Dummy

Exceptions

  • MethodNotDefined
  • MethodOutOfScope
  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 
<?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 ICanBoogie\Accessor\AccessorTrait;

/**
 * Exception thrown in attempt to access a method that is not defined.
 *
 * @property-read string $method The method that is not defined.
 * @property-read 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.
 */
class MethodNotDefined extends \BadMethodCallException
{
    use AccessorTrait;

    private $method;

    /**
     * @return string
     */
    protected function get_method()
    {
        return $this->method;
    }

    private $class;

    /**
     * @return string
     */
    protected function get_class()
    {
        return $this->class;
    }

    private $instance;

    /**
     * @return object|null
     */
    protected function get_instance()
    {
        return $this->instance;
    }

    /**
     * @inheritdoc
     *
     * @param string $method The method that is not defined.
     * @param string|object $class_or_instance The name of the class or one of its instances.
     * @param string|null $message If `null` a message is formatted with $method and $class.
     * @param int $code
     * @param \Exception $previous
     */
    public function __construct($method, $class_or_instance, $message = null, $code = 500, \Exception $previous = null)
    {
        $class = $class_or_instance;

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

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

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

    /**
     * Formats exception message.
     *
     * @param string $method
     * @param string $class
     *
     * @return string
     */
    protected function format_message($method, $class)
    {
        return \ICanBoogie\format('The method %method is not defined by the prototype of class %class.', [

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

        ]);
    }
}
ICanBoogie/Prototype 3.0.x API documentation generated by ApiGen