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 
<?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 invoke a method that is out of scope.
 *
 * @property-read string $method The method that is out of scope.
 * @property-read object|null $instance The instance on which the method was invoked.
 */
class MethodOutOfScope extends \BadMethodCallException
{
    use AccessorTrait;

    private $method;

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

    private $instance;

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

    /**
     * @inheritdoc
     *
     * @param string $method
     * @param object $instance
     * @param string|null $message
     * @param int $code
     * @param \Exception|null $previous
     */
    public function __construct($method, $instance, $message = null, $code = 500, \Exception $previous = null)
    {
        $this->method = $method;
        $this->instance = $instance;

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

    /**
     * Formats exception message.
     *
     * @param string $method
     * @param object $instance
     *
     * @return string
     */
    protected function format_message($method, $instance)
    {
        return \ICanBoogie\format('The method %method is out of scope for class %class.', [

            'method' => $method,
            'class' => get_class($instance)

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