Namespaces

• ICanBoogie
  • Module
    • ModuleCollection
    • Operation

Classes

• Descriptor
• ForwardedOperationDispatcher
• Hooks
• ModelCollection
• ModuleCollection
• ModuleOperationDispatcher
• ModuleRouteDefinition
• ModuleTemplateResolver

Traits

• ApplicationBindings
• ControllerBindings
• ModuleRoute

Exceptions

• ModuleCollectionInstallFailed
• ModuleConstructorMissing
• ModuleIsDisabled
• ModuleNotDefined

 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 

<?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\Module;

use ICanBoogie\Accessor\AccessorTrait;
use ICanBoogie\HTTP\Status;

use function ICanBoogie\format;

/**
 * Exception thrown when a disabled module is requested.
 *
 * @property-read string $module_id The identifier of the disabled module.
 */
class ModuleIsDisabled extends \RuntimeException
{
    use AccessorTrait;

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

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

    /**
     * @param string $module_id
     * @param int $code
     * @param \Exception|null $previous
     */
    public function __construct($module_id, $code = Status::INTERNAL_SERVER_ERROR, \Exception $previous = null)
    {
        $this->module_id = $module_id;

        parent::__construct(format('Module is disabled: %module_id', [

            'module_id' => $module_id

        ]), $code, $previous);
    }
}