Class Index | File Index

Classes


Class ngin.router.Controller


Extends ngin.event.Emitter.

Defined in: controller.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Classe base para todas os controladores que utilizem a API de roteamento do Engine.
Field Summary
Field Attributes Field Name and Description
 
Objeto que contém as funções que devem ser executadas pelo método #runAction.
 
Nome do módulo onde o controlador foi declarado.
Fields borrowed from class ngin.event.Emitter:
duplicationHandling, listenerCompareFunction
Method Summary
Method Attributes Method Name and Description
 
badRequest(opt_content)
Cria uma resposta com erro BAD_REQUEST.
 
created(opt_content)
Cria uma resposta com estado CREATED.
 
forbidden(opt_content)
Cria uma resposta com erro FORBIDDEN.
 
hasAction(name)
Verifica se há uma ação com o nome informado.
 
Cria uma resposta com estado NO_CONTENT.
 
notFound(opt_content)
Cria uma resposta com erro NOT_FOUND.
 
ok(opt_content)
Cria uma resposta com estado OK.
 
runAction(action, parameters)
Executa uma ação do controlador com os parâmetros informados.
<static>  
ngin.router.Controller.wrap(object)
Cria uma controlador que encapsula o objeto informado.
Methods borrowed from class ngin.event.Emitter:
addListenersFromEmitter, assignListeners, emit, filterListeners, hasListeners, listenerHandlers, listeners, off, offAll, on, registerEventType, replaceListeners, unregisterEventType
Class Detail
ngin.router.Controller()
Classe base para todas os controladores que utilizem a API de roteamento do Engine.
Field Detail
actions_
Objeto que contém as funções que devem ser executadas pelo método #runAction. Por padrão, será a própria instância desta classe, ou seja, as ações são os métodos definidos na controller. No entanto, poderá ser delegado essa responsabilidade para outro objeto, como observado na criação do

moduleFileName
Nome do módulo onde o controlador foi declarado. Utilizado apenas nas mensagens de erro para auxiliar o desenvolvedor a localizar o controlador responsável por uma falha em uma rota.
Method Detail
badRequest(opt_content)
Cria uma resposta com erro BAD_REQUEST. Opcionalmente, pode ser informado o conteúdo da resposta.
Parameters:
{Object?} opt_content
Conteúdo da resposta.

created(opt_content)
Cria uma resposta com estado CREATED. Opcionalmente, pode ser informado o conteúdo da resposta.
Parameters:
{Object?} opt_content
Conteúdo da resposta.

forbidden(opt_content)
Cria uma resposta com erro FORBIDDEN. Opcionalmente, pode ser informado o conteúdo da resposta.
Parameters:
{Object?} opt_content
Conteúdo da resposta.

{boolean} hasAction(name)
Verifica se há uma ação com o nome informado.
Parameters:
{string} name
Nome do método a ser validado sua presença.
Returns:
{boolean} Retorna true caso haja uma ação com o nome informado.

noContent()
Cria uma resposta com estado NO_CONTENT.

notFound(opt_content)
Cria uma resposta com erro NOT_FOUND. Opcionalmente, pode ser informado o conteúdo da resposta.
Parameters:
{Object?} opt_content
Conteúdo da resposta.

ok(opt_content)
Cria uma resposta com estado OK. Opcionalmente, pode ser informado o conteúdo da resposta.
Parameters:
{Object?} opt_content
Conteúdo da resposta.

{ngin.router.Result} runAction(action, parameters)
Executa uma ação do controlador com os parâmetros informados. Uma ação da controladora é um método da classe. A diferença entre executar este método e executar diretamente o método do controlador é que os eventos beforeAction e afterAction são emitidos.
Parameters:
{string} action
Nome da ação a ser executada. Uma ação deverá ser implementada como método do controlador.
{Array<*>} parameters
Parâmetros que devem ser passados para o método do controlador responsável pela ação.
Returns:
{ngin.router.Result} Resultado da ação ou o erro que ocorreu durante a sua execução.

<static> ngin.router.Controller.wrap(object)
Cria uma controlador que encapsula o objeto informado. Todas as ações do controlador serão delegadas para o objeto informado e deverão ser criadas como métodos dele.
Parameters:
{Object} object
Objeto que será encapsulado pelo controlador.

Documentation generated by JsDoc Toolkit 2.4.0 on Tue Aug 23 2016 16:18:12 GMT-0300 (GFT)