Application

class AeonDigital\EnGarde\Config\Application

Implementação de Config\iApplication.

Parent

AeonDigital\BObject

Implements

AeonDigital\EnGarde\Interfaces\Config\iApplication

Used traits

AeonDigitalTraitsMainCheckArgumentException

Properties

Methods

public AeonDigital\EnGarde\Config\Application::getAppName()

Retorna o nome da aplicação.

Returns

‹ string ›

public AeonDigital\EnGarde\Config\Application::getAppRootPath()

Retorna o caminho completo até o diretório raiz da aplicação.

Todas as demais configurações que indicam diretórios ou arquivos usando caminhos

relativos iniciam a partir deste diretório.

Returns

‹ string ›

public AeonDigital\EnGarde\Config\Application::getPathToAppRoutes($fullPath=false)

Retorna o caminho relativo (a partir de appRootPath) até o arquivo de rotas da aplicação.

Parameters

• ‹ bool › $fullPath
  Se false retornará o caminho relativo. Quando true deverá retornar o caminho completo.

Returns

‹ string ›

public AeonDigital\EnGarde\Config\Application::getPathToControllers($fullPath=false)

Retorna o caminho relativo (a partir de appRootPath) até o diretório de controllers

da aplicação.

Parameters

• ‹ bool › $fullPath
  Se false retornará o caminho relativo. Quando true deverá retornar o caminho completo.

Returns

‹ string ›

public AeonDigital\EnGarde\Config\Application::getPathToViews($fullPath=false)

Retorna o caminho relativo (a partir de appRootPath) até o diretório das views

da aplicação.

Parameters

• ‹ bool › $fullPath
  Se false retornará o caminho relativo. Quando true deverá retornar o caminho completo.

Returns

‹ string ›

public AeonDigital\EnGarde\Config\Application::getPathToViewsResources($fullPath=false)

Retorna o caminho relativo (a partir de appRootPath) até o diretório que estarão

armazenados os recursos para as views (imagens, JS, CSS …).

Parameters

• ‹ bool › $fullPath
  Se false retornará o caminho relativo. Quando true deverá retornar o caminho completo.

Returns

‹ string ›

public AeonDigital\EnGarde\Config\Application::getPathToLocales($fullPath=false)

Retorna o caminho relativo (a partir de appRootPath) até o diretório que estarão

armazenados os documentos de configuração das legendas.

Parameters

• ‹ bool › $fullPath
  Se false retornará o caminho relativo. Quando true deverá retornar o caminho completo.

Returns

‹ string ›

public AeonDigital\EnGarde\Config\Application::getPathToCacheFiles($fullPath=false)

Retorna o caminho relativo (a partir de appRootPath) até o diretório de armazenamento

para os arquivos de cache.

Parameters

• ‹ bool › $fullPath
  Se false retornará o caminho relativo. Quando true deverá retornar o caminho completo.

Returns

‹ string ›

public AeonDigital\EnGarde\Config\Application::getPathToLocalData($fullPath=false)

Retorna o caminho relativo (a partir de appRootPath) até o diretório de armazenamento

para os arquivos de dados que constituem uma base de dados local.

O formato e conteúdo destes arquivos varia conforme a implementação realizada.

Parameters

• ‹ bool › $fullPath
  Se false retornará o caminho relativo. Quando true deverá retornar o caminho completo.

Returns

‹ string ›

public AeonDigital\EnGarde\Config\Application::getStartRoute()

Retorna a rota inicial da aplicação.

Returns

‹ string ›

public AeonDigital\EnGarde\Config\Application::getControllersNamespace()

Retorna a Namespace comum à todos os controllers da aplicação corrente.

Returns

‹ string ›

public AeonDigital\EnGarde\Config\Application::getLocales()

Retorna a coleção de locales suportada pela aplicação.

Returns

‹ array ›

public AeonDigital\EnGarde\Config\Application::getDefaultLocale()

Retorna o locale padrão para a aplicação corrente.

Returns

‹ string ›

public AeonDigital\EnGarde\Config\Application::getIsUseLabels()

Retorna true se a aplicação deve usar o sistema de legendas.

Returns

‹ bool ›

public AeonDigital\EnGarde\Config\Application::getDefaultRouteConfig()

Retorna um array associativo contendo os valores padrões para as rotas de toda a

aplicação. Estes valores podem ser sobrescritos pelas definições padrões dos controllers

e das próprias rotas.

Returns

‹ array ›

public AeonDigital\EnGarde\Config\Application::getCheckRouteOrder()

Retorna um array de strings contendo em cada posição um dos diferentes métodos de obter

a rota a ser executada segundo a requisição atual.

Ao iniciar a aplicação, a ordem dos métodos aqui definidos será usado para identificar qual

processo deve ser realizado a cada requisição.

Nesta implementação, são esperados os valores :

- "native" : Verificação baseada na lista de rotas definidas nos controllers.

- "catch-all": Regra especial "catchAll" que pode ser definida pelo desenvolvedor de cada aplicação.

- "redirect" : Regras de redirecionamentos.

Returns

‹ array ›

public AeonDigital\EnGarde\Config\Application::getPathToErrorView($fullPath=false)

Resgata o caminho relativo até a view que deve ser enviada ao UA em caso de erros

na aplicação.

Parameters

• ‹ bool › $fullPath
  Se false retornará o caminho relativo. Quando true deverá retornar o caminho completo.

Returns

‹ string ›

public AeonDigital\EnGarde\Config\Application::getPathToHttpMessageView($fullPath=false)

Resgata o caminho relativo até a view que deve ser enviada ao UA em caso de necessidade

de envio de uma simples mensagem Http.

Parameters

• ‹ bool › $fullPath
  Se false retornará o caminho relativo. Quando true deverá retornar o caminho completo.

Returns

‹ string ›

public AeonDigital\EnGarde\Config\Application::getHttpSubSystemNamespaces()

Resgata um array associativo contendo a correlação entre os métodos Http

e suas respectivas classes de resolução.

Tais classes serão usadas exclusivamente para resolver os métodos Http que

originalmente devem ser processados pelo framework.

Originalmente estes:

"HEAD", "OPTIONS", "TRACE", "DEV", "CONNECT"

```

// ex:

$arr = [

"HEAD" => "full\qualified\namespace\classnameHead",

"DEV" => "full\qualified\namespace\classnameDEV"

]

```

Returns

‹ array ›

public AeonDigital\EnGarde\Config\Application::__construct($appName, $appRootPath, $pathToAppRoutes, $pathToControllers, $pathToViews, $pathToViewsResources, $pathToLocales, $pathToCacheFiles, $pathToLocalData, $startRoute, $controllersNamespace, $locales, $defaultLocale, $isUseLabels, $defaultRouteConfig, $checkRouteOrder, $pathToErrorView, $pathToHttpMessageView, $httpSubSystemNamespaces)

Inicia uma nova instância de configurações para a aplicação.

Parameters

• ‹ string › $appName
  Nome da aplicação.

• ‹ string › $appRootPath
  Caminho completo até o diretório raiz da aplicação.

• ‹ string › $pathToAppRoutes
  Caminho relativo (a partir de "appRootPath") até o arquivo de rotas da aplicação.

• ‹ string › $pathToControllers
  Caminho relativo (a partir de "appRootPath") até o diretório de controllers da aplicação.

• ‹ string › $pathToViews
  Caminho relativo (a partir de "appRootPath") até o diretório das views da aplicação.

• ‹ string › $pathToViewsResources
  Caminho relativo (a partir de appRootPath) até o diretório de recursos para as views (imagens, JS, CSS …).

• ‹ string › $pathToLocales
  Caminho relativo (a partir de "appRootPath") até o diretório que estarão armazenados os documentos de configuração das legendas.

• ‹ string › $pathToCacheFiles
  Caminho relativo (a partir de "appRootPath") até o diretório de armazenamento para os arquivos de cache.

• ‹ string › $pathToLocalData
  Caminho relativo (a partir de appRootPath) até o diretório de armazenamento para os arquivos de dados locais.

• ‹ string › $startRoute
  Rota inicial da aplicação.

• ‹ string › $controllersNamespace
  Namespace para os controllers da aplicação.

• ‹ array › $locales
  Coleção de locales suportada pela aplicação.

• ‹ string › $defaultLocale
  Locale padrão para a aplicação corrente.

• ‹ bool › $isUseLabels
  Indica se deve ser usado o sistema de legendas.

• ‹ array › $defaultRouteConfig
  Array associativo contendo os valores padrões para as rotas da aplicação.

• ‹ array › $checkRouteOrder
  Array de métodos de identificação de processamento de rotas.

• ‹ string › $pathToErrorView
  Caminho relativo até a view que deve ser enviada ao UA em caso de erros na aplicação.

• ‹ string › $pathToHttpMessageView
  Caminho relativo até a view que deve ser enviada ao UA em caso de necessidade de envio de uma simples mensagem Http.

• ‹ array › $httpSubSystemNamespaces
  Coleção de métodos Http que devem ser resolvidos pelo framework e as respectivas classes que devem resolver cada qual.

Returns

‹ void ›

Throws

‹ InvalidArgumentException ›
Caso seja definido um valor inválido.

public static AeonDigital\EnGarde\Config\Application::fromArray($config)

Inicia uma nova instância Config\iApplication.

Parameters

• ‹ array › $config
  Array associativo contendo as configurações para esta instância.

Returns

‹ \AeonDigital\EnGarde\Interfaces\Config\iApplication ›