Interface yii\base\StaticInstanceInterface

Implemented byyii\base\DynamicModel, yii\base\Model, yii\data\ActiveDataFilter, yii\data\DataFilter, yii\db\ActiveRecord, yii\db\ActiveRecordInterface, yii\db\BaseActiveRecord, yii\debug\models\Router, yii\debug\models\UserSwitch, yii\debug\models\router\ActionRoutes, yii\debug\models\router\CurrentRoute, yii\debug\models\router\RouterRules, yii\debug\models\search\Base, yii\debug\models\search\Db, yii\debug\models\search\Debug, yii\debug\models\search\Event, yii\debug\models\search\Log, yii\debug\models\search\Mail, yii\debug\models\search\Profile, yii\debug\models\search\User, yii\debug\models\timeline\Search, yii\elasticsearch\ActiveRecord, yii\gii\Generator, yii\gii\generators\controller\Generator, yii\gii\generators\crud\Generator, yii\gii\generators\extension\Generator, yii\gii\generators\form\Generator, yii\gii\generators\model\Generator, yii\gii\generators\module\Generator, yii\mongodb\ActiveRecord, yii\mongodb\file\ActiveRecord, yii\mongodb\gii\model\Generator, yii\redis\ActiveRecord, yii\sphinx\ActiveRecord, yii\sphinx\gii\model\Generator
Available since version2.0.13
Source Code https://github.com/yiisoft/yii2/blob/master/framework/base/StaticInstanceInterface.php

StaticInstanceInterface is the interface for providing static instances to classes, which can be used to obtain class meta information that can not be expressed in static methods.

For example: adjustments made by DI or behaviors reveal only at object level, but might be needed at class (static) level as well.

To implement the instance() method you may use yii\base\StaticInstanceTrait.

See also yii\base\StaticInstanceTrait.

Public Methods

Hide inherited methods

MethodDescriptionDefined By
instance() Returns static class instance, which can be used to obtain meta information. yii\base\StaticInstanceInterface

Method Details

instance() public abstract static method

Returns static class instance, which can be used to obtain meta information.

public abstract static static instance ( $refresh false )
$refresh boolean

Whether to re-create static instance even, if it is already cached.

return static

Class instance.