Configuração¶

Carregando Arquivos de Configurações Adicionais¶

Se sua aplicação tiver muitas opções de configuração, pode ser útil dividir a configuração em vários arquivos. Depois de criar cada um dos arquivos no seu config/ diretório, você pode carregá-los em bootstrap.php:

use Cake\Core\Configure;
use Cake\Core\Configure\Engine\PhpConfig;

Configure::config('default', new PhpConfig());
Configure::load('app', 'default', false);
Configure::load('other_config', 'default');

Você também pode usar arquivos de configuração adicionais para fornecer sobreposições específicas do ambiente. Cada arquivo carregado após app.php pode redefinir valores previamente declarados permitindo que você personalize a configuração para ambientes de desenvolvimento ou de homologação.

Configuração Geral¶

Abaixo está uma descrição das variáveis e como elas afetam seu aplicativo CakePHP.

debug

Altera a saída de depuração do CakePHP. false = Modo Produção. Não é exibido nenhuma mensagem de erro e/ou aviso. true = Modo de Desenvolvimento. É exibido todas as mensagens de erros e/ou avisos.

App.namespace

O namespace em que as classes do aplicativo estão.

Note

Ao alterar o namespace em sua configuração, você também precisará atualizar o arquivo ** composer.json ** para usar esse namespace também. Além disso, crie um novo carregador automático executando php composer.phar dumpautoload.

App.baseUrl

Não comentar esta definição se você não planeja usar o mod_rewrite do Apache com o CakePHP. Não se esqueça de remover seus arquivos .htaccess também.

App.base

O diretório base no qual o aplicativo reside. Se false isso será detectado automaticamente. Se não false, certifique-se de que sua seqüência de caracteres começa com um / e NÃO termina com um /. Por exemplo, /basedir deve ser uma App.base válida. Caso contrário, o AuthComponent não funcionará corretamente.

App.encoding

Defina a codificação que seu aplicativo usa. Essa codificação é usada para gerar o charset no layout e codificar entidades. Ele deve corresponder aos valores de codificação especificados para o seu banco de dados.

App.webroot

O diretório raiz da aplicação web.

App.wwwRoot

O diretório raiz dos arquivos da aplicação web.

App.fullBaseUrl

O nome de domínio totalmente qualificado (incluindo o protocolo) para a raiz do aplicativo. Isso é usado ao gerar URLs absolutos. Por padrão, esse valor é gerado usando a variável $_SERVER. Entretanto, Você deve defini-lo manualmente para otimizar o desempenho ou se você está preocupado com as pessoas manipulando o cabeçalho do Host. Em um contexto CLI (do Shell) a fullBaseUrl não pode ser lido a partir de $_SERVER, como não há servidor envolvido. Você precisará especificá-lo se precisar gerar URLs de um shell (por exemplo, ao enviar e-mails).

App.imageBaseUrl

O caminho da web para as imagens públicas na webroot da aplicação. Se você estiver usando um CDN, você deve definir este valor para a localização do CDN.

App.cssBaseUrl

O caminho da web para os arquivos de estilos em cascata(.css) públicos na webroot da aplicação. Se você estiver usando um CDN, você deve definir este valor para a localização do CDN.

App.jsBaseUrl

O caminho da web para os scripts (em JavaScript) públicos na webroot da aplicação. Se você estiver usando um CDN, você deve definir este valor para a localização do CDN.

App.paths

Configurar caminhos para recursos não baseados em classe. Suporta as subchaves plugins, templates, locales, que permitem a definição de caminhos para plugins, templates e arquivos de locale respectivamente.

Security.salt

Uma seqüência aleatória usada em hash. Uma seqüência aleatória usada em hash. Este valor também é usado como o sal HMAC ao fazer criptografia simétrica.

Asset.timestamp

Acrescenta um carimbo de data/hora que é a última hora modificada do arquivo específico no final dos URLs de arquivos de recurso (CSS, JavaScript, Image) ao usar assistentes adequados. Valores válidos:

• (bool) false - Não fazer nada (padrão)

• (bool) true - Acrescenta o carimbo de data/hora quando depuração é true

• (string) “force” - Sempre anexa o carimbo de data/hora.

Configuração do banco de dados¶

Consulte Database Configuration para obter informações sobre como configurar suas conexões de banco de dados.

Configuração do Cache¶

Consulte Caching Configuration para obter informações sobre como configurar o cache no CakePHP.

Configuração de manipulação de erro e exceção¶

Consulte Error and Exception Configuration para obter informações sobre como configurar manipuladores de erro e exceção.

Configuração de log¶

Consulte Logging Configuration para obter informações sobre como configurar o log no CakePHP.

Configuração de e-mail¶

Consulte Email Configuration para obter informações sobre como configurar predefinições de e-mail no CakePHP.

Configuração de sessão¶

Consulte Configuração da Sessão para obter informações sobre como configurar o tratamento de sessão no CakePHP.

Configuração de roteamento¶

Consulte Routes Configuration para obter mais informações sobre como configurar o roteamento e criar rotas para seu aplicativo.

Plugin, Modelos de Visualização e Caminhos Locais¶

Como os plug-ins, os modelos de visualização (Templates) e os caminhos locais (locales) não são classes, eles não podem ter um autoloader configurado. O CakePHP fornece três variáveis de configuração para configurar caminhos adicionais para esses recursos. No config/app.php você pode definir estas variáveis

return [
    // More configuration
    'App' => [
        'paths' => [
            'plugins' => [
                ROOT . DS . 'plugins' . DS,
                '/path/to/other/plugins/'
            ],
            'templates' => [
                APP . 'Template' . DS,
                APP . 'Template2' . DS
            ],
            'locales' => [
                APP . 'Locale' . DS
            ]
        ]
    ]
];

Caminhos devem terminar com um separador de diretório, ou eles não funcionarão corretamente.

Escrevendo dados de configuração¶

static Cake\Core\Configure::write($key, $value)¶

Use write() para armazenar dados na configuração do aplicativo:

Configure::write('Company.name', 'Pizza, Inc.');
Configure::write('Company.slogan','Pizza for your body and soul');

O exemplo acima também pode ser escrito em uma única chamada:

Configure::write('Company', [
    'name' => 'Pizza, Inc.',
    'slogan' => 'Pizza for your body and soul'
]);

Você pode usar Configure::write('debug', $bool) para alternar entre os modos de depuração e produção na mosca. Isso é especialmente útil para interações JSON onde informações de depuração podem causar problemas de análise.

Leitura de dados de configuração¶

static Cake\Core\Configure::read($key = null)¶

Usado para ler dados de configuração da aplicação. Por padrão o valor de depuração do CakePHP é importante. Se for fornecida uma chave, os dados são retornados. Usando nossos exemplos de write() acima, podemos ler os dados de volta:

Configure::read('Company.name');    // Yields: 'Pizza, Inc.'
Configure::read('Company.slogan');  // Yields: 'Pizza for your body
                                    // and soul'

Configure::read('Company');

//Rendimentos:
['name' => 'Pizza, Inc.', 'slogan' => 'Pizza for your body and soul'];

Se $key for deixada nula, todos os valores em Configure serão retornados.

static Cake\Core\Configure::readOrFail($key)¶

Lê dados de configuração como Cake\Core\Configure::read, mas espera encontrar um par chave/valor. Caso o par solicitado não exista, a RuntimeException será lançada:

Configure::readOrFail('Company.name');    // Rendimentos: 'Pizza, Inc.'
Configure::readOrFail('Company.geolocation');  // Vai lançar uma exceção

Configure::readOrFail('Company');

// Rendimentos:
['name' => 'Pizza, Inc.', 'slogan' => 'Pizza for your body and soul'];

Verificar se os dados de configuração estão definidos¶

static Cake\Core\Configure::check($key)¶

Usado para verificar se uma chave/caminho existe e tem valor não nulo:

$exists = Configure::check('Company.name');

Excluindo Dados de Configuração¶

static Cake\Core\Configure::delete($key)¶

Usado para excluir informações da configuração da aplicação:

Configure::delete('Company.name');

Leitura e exclusão de dados de configuração¶

static Cake\Core\Configure::consume($key)¶

Ler e excluir uma chave do Configure. Isso é útil quando você deseja combinar leitura e exclusão de valores em uma única operação.

Carregando arquivos de configurações¶

static Cake\Core\Configure::load($key, $config = 'default', $merge = true)¶

Depois de ter anexado um motor de configuração para o Configure, ficará disponível para poder carregar ficheiros de configuração:

// Load my_file.php using the 'default' engine object.
Configure::load('my_file', 'default');

Os arquivos de configuração que foram carregados mesclam seus dados com a configuração de tempo de execução existente no Configure. Isso permite que você sobrescreva e adicione novos valores à configuração de tempo de execução existente. Ao definir $merge para true, os valores nunca substituirão a configuração existente.

Criando ou modificando arquivos de configuração¶

static Cake\Core\Configure::dump($key, $config = 'default', $keys = [])¶

Despeja todos ou alguns dos dados que estão no Configure em um sistema de arquivos ou armazenamento suportado por um motor de configuração. O formato de serialização é decidido pelo mecanismo de configuração anexado como $config. Por exemplo, se o mecanismo “padrão” é Cake\Core\Configure\Engine\PhpConfig, o arquivo gerado será um arquivo de configuração PHP carregável pelo Cake\Core\Configure\Engine\PhpConfig

Dado que o motor “default” é uma instância do PhpConfig. Salve todos os dados em Configure no arquivo my_config.php:

Configure::dump('my_config', 'default');

Salvar somente a configuração de manipulação de erro:

Configure::dump('error', 'default', ['Error', 'Exception']);

Configure::dump() pode ser usado para modificar ou substituir arquivos de configuração que são legíveis com Configure::load()

Armazenando Configuração do Tempo de Execução¶

static Cake\Core\Configure::store($name, $cacheConfig = 'default', $data = null)¶

Você também pode armazenar valores de configuração de tempo de execução para uso em uma solicitação futura. Como o configure só lembra valores para a solicitação atual, você precisará armazenar qualquer informação de configuração modificada se você quiser usá-la em solicitações futuras:

// Armazena a configuração atual na chave 'user_1234' no cache 'default'.
Configure::store('user_1234', 'default');

Os dados de configuração armazenados são mantidos na configuração de cache nomeada. Consulte a documentação Caching para obter mais informações sobre o cache.

Restaurando a Configuração do Tempo de Execução¶

static Cake\Core\Configure::restore($name, $cacheConfig = 'default')¶

Depois de ter armazenado a configuração de tempo de execução, você provavelmente precisará restaurá-la para que você possa acessá-la novamente. Configure::restore() faz exatamente isso:

// Restaura a configuração do tempo de execução do cache.
Configure::restore('user_1234', 'default');

Ao restaurar informações de configuração, é importante restaurá-lo com a mesma chave e configuração de cache usada para armazená-lo. As informações restauradas são mescladas em cima da configuração de tempo de execução existente.

Arquivos de configuração do PHP¶

class Cake\Core\Configure\Engine\PhpConfig¶

Permite ler arquivos de configuração que são armazenados como arquivos simples do PHP. Você pode ler arquivos da configuração do aplicativo ou do plugin configs diretórios usando sintaxe plugin. Arquivos devem retornar uma matriz. Um exemplo de arquivo de configuração seria semelhante a:

return [
    'debug' => 0,
    'Security' => [
        'salt' => 'its-secret'
    ],
    'App' => [
        'namespace' => 'App'
    ]
];

Carregue seu arquivo de configuração personalizado inserindo o seguinte em config/bootstrap.php:

Configure::load('customConfig');

Arquivos de configuração Ini¶

class Cake\Core\Configure\Engine\IniConfig¶

Permite ler arquivos de configuração armazenados como arquivos .ini simples. Os arquivos ini devem ser compatíveis com a função parse_ini_file() do php e beneficiar das seguintes melhorias.

• Os valores separados por ponto são expandidos em arrays.

• Valores booleanos como “on” e “off” são convertidos em booleanos.

Um exemplo de arquivo ini seria semelhante a:

debug = 0

[Security]
salt = its-secret

[App]
namespace = App

O arquivo ini acima, resultaria nos mesmos dados de configuração final do exemplo PHP acima. As estruturas de matriz podem ser criadas através de valores separados por pontos ou por seções. As seções podem conter chaves separadas por pontos para um assentamento mais profundo.

Arquivos de configuração do Json¶

class Cake\Core\Configure\Engine\JsonConfig¶

Permite ler/descarregar arquivos de configuração armazenados como cadeias codificadas JSON em arquivos .json.

Um exemplo de arquivo JSON seria semelhante a:

{
    "debug": false,
    "App": {
        "namespace": "MyApp"
    },
    "Security": {
        "salt": "its-secret"
    }
}

Application::bootstrap()¶

Além do arquivo config/bootstrap.php que deve ser usado para configurar preocupações de baixo nível do seu aplicativo, você também pode usar o método Application::bootstrap() para carregar/inicializar plugins, E anexar ouvintes de eventos globais:

// Em src/Application.php
namespace App;

use Cake\Core\Plugin;
use Cake\Http\BaseApplication;

class Application extends BaseApplication
{
    public function bootstrap()
    {
        // Chamar o pai para `require_once` config/bootstrap.php
        parent::bootstrap();

        Plugin::load('MyPlugin', ['bootstrap' => true, 'routes' => true]);
    }
}

Carregar plugins/eventos em Application::bootstrap() torna Teste de Integração do Controlador mais fácil à medida que os eventos e rotas serão re-processados em cada método de teste.