Autoloading de Classes

O Yii baseia-se no mecanismo de autoloading de classe para localizar e incluir todos os arquivos de classe necessários. Ele fornece um autoloader de alto desempenho que é compatível com o PSR-4 standard. O autoloader é instalado quando o arquivo Yii.php é incluído.

Observação: Para simplificar a descrição, nesta seção, nós falaremos apenas sobre autoloading de classe. No entanto, tenha em mente que o conteúdo que estamos descrevendo aqui se aplica a autoloading de interfaces e traits também.

Usando o Autoloader do Yii

Para fazer uso da autoloader de classe do Yii, você deve seguir duas regras simples ao criar e nomear suas classes:

Cada classe deve estar debaixo de um namespace (exemplo. foo\bar\MyClass)
Cada classe deve ser salvo em um arquivo individual cujo caminho é determinado pelo seguinte algoritmo:

// $className é um nome de classe totalmente qualificado sem o primeiro barra invertida
$classFile = Yii::getAlias('@' . str_replace('\\', '/', $className) . '.php');

Por exemplo, se um nome de classe e seu namespace for foo\bar\MyClass, o alias correspondente ao caminho do arquivo da classe seria @foo/bar/MyClass.php. Para que este alias seja resolvido em um caminho de arquivo, de outra forma @foo ou @foo/bar deve ser um alias raiz.

Quando se utiliza o Template Básico de Projetos, você pode colocar suas classes sob o namespace de nível superior app de modo que eles podem ser carregados automaticamente pelo Yii sem a necessidade de definir um novo alias. Isto é porque @app é um alias predefinido, e um nome de classe como app\components\MyClass pode ser resolvido no arquivo de classe AppBasePath/components/MyClass.php, de acordo com o algoritmo já descrito.

No Template Avançado de Projetos, cada camada tem seu própria alias raiz. Por exemplo, a camada front-end tem um alias raiz @frontend, enquanto a camada back-end o alias raiz é @backend. Como resultado, você pode colocar as classes do front-end debaixo do namespace frontend enquanto as classes do back-end estão debaixo do namespace backend. Isto permitirá que estas classes sejam carregadas automaticamente pelo Yii autoloader.

Mapeamento de Classes

O autoloader de classe do Yii suporta o recurso de mapeamento de classe, que mapeia nomes de classe para os caminhos de arquivo das classes correspondentes. Quando o autoloader está carregando uma classe, ele irá primeiro verificar se a classe se encontra no mapa. Se assim for, o caminho do arquivo correspondente será incluído diretamente, sem mais verificações. Isso faz com que classe seja carregada super rápido. De fato, todas as classes principais do Yii são carregadas automaticamente dessa maneira. Você pode adcionar uma classe no mapa de classe, armazenado em Yii::$classMap, usando:

Yii::$classMap['foo\bar\MyClass'] = 'path/to/MyClass.php';

Os aliases podem ser usados para especificar caminhos de arquivo de classe. Você deve definir o mapa de classe no processo de inicialização (bootstrapping) de modo que o mapa está pronto antes de suas classes serem usadas.

Usando outros Autoloaders

Uma vez que o Yii utiliza o Composer como seu gerenciador de dependência de pacotes, é recomendado que você sempre instale o autoloader do Composer. Se você está utilizando bibliotecas de terceiros que tem seus próprios autoloaders, você também deve instala-los. Ao usar o Yii autoloader junto com outros autoloaders, você deve incluir o arquivo Yii.php depois de todos os outros autoloaders serem instalados. Isso fará com que o Yii autoloader seja o primeiro a responder a qualquer solicitação de autoloading de classe. Por exemplo, o código a seguir foi extraído do script de entrada do Template Básico de Projeto. A primeira linha instala o Composer autoloader, enquanto a segunda linha instala o Yii autoloader:

require(__DIR__ . '/../vendor/autoload.php');
require(__DIR__ . '/../vendor/yiisoft/yii2/Yii.php');

Você pode usar o autoloader do Composer sozinho sem o autoloader do Yii. No entanto, ao fazê-lo, o desempenho do carregamento automático das classes pode ser degradada, e você deve seguir as regras estabelecidas pelo Composer para que suas classes sejam auto carregáveis.

Informação: Se você não quiser utilizar o autoloader do Yii, você deve criar sua própria versão do arquivo Yii.php e incluí-lo no seu script de entrada.