BootstrapInterface

API reference › yii › base › BootstrapInterface

interface	`yii\base\BootstrapInterface`
Since	2.0
Source	`framework/base/BootstrapInterface.php`

Implemented by 5 types

BootstrapInterface is the interface that should be implemented by classes who want to participate in the application bootstrap process.

The main method bootstrap() will be invoked by an application at the beginning of its init() method.

Bootstrapping classes can be registered in two approaches.

The first approach is mainly used by extensions and is managed by the Composer installation process. You mainly need to list the bootstrapping class of your extension in the composer.json file like following,

{
    // ...
    "extra": {
        "bootstrap": "path\\to\\MyBootstrapClass"
    }
}

If the extension is installed, the bootstrap information will be saved in Application::$extensions.

The second approach is used by application code which needs to register some code to be run during the bootstrap process. This is done by configuring the Application::bootstrap() property:

return [
    // ...
    'bootstrap' => [
        "path\\to\\MyBootstrapClass1",
        [
            'class' => "path\\to\\MyBootstrapClass2",
            'prop1' => 'value1',
            'prop2' => 'value2',
        ],
    ],
];

As you can see, you can register a bootstrapping class in terms of either a class name or a configuration class.

For more details and usage information on BootstrapInterface, see the guide article on bootstrapping applications.

Methods

Method	Description	Defined by
`bootstrap()` abstract	Bootstrap method to be called during application bootstrap stage.	`BootstrapInterface`

Method details

bootstrap()

abstract public function bootstrap(yii\base\Application $app): mixed

Bootstrap method to be called during application bootstrap stage.

Parameters

Parameter	Type	Description
`$app`	`Application`	The application currently running

Returns

mixed