Componentes¶

Carregando componentes sob demanda¶

Você pode não precisar de todos os componentes disponibilizados em cada ação dos controllers. Nestas situações você pode carregar um componente em tempo de execução usando o Component Collection. Dentro de um controller você pode fazer o seguinte:

$this->OneTimer = $this->Components->load('OneTimer');
$this->OneTimer->getTime();

Incluindo seus componentes nos seus controllers¶

Após nosso componente estiver pronto, podemos usá-lo nos controllers da nossa aplicação pondo o nome do componente (sem o sufixo “Component”) no array $components do controller. O controller irá receber um novo atributo com o mesmo nome do componente, o qual poderemos acessá-lo como sendo uma instância da classe componente que queremos.

/* Torna o novo componente acessível em $this->Math,
bem como o $this->Session */
public $components = array('Math', 'Session');

Componentes declarados no AppController serão mesclados com os de outros controllers. Então não há necessidade de redeclarar o mesmo componente duas vezes.

Ao incluir componentes em um controller você também pode declarar um conjunto de parâmetros que serão passados para o construtor do componente. Estes parâmetros podem ser usados pelo componente.

public $components = array(
    'Math' => array(
        'precision' => 2,
        'randomGenerator' => 'srand'
    ),
    'Session', 'Auth'
);

O exemplo acima irá passar no segundo parâmetro do construtor MathComponent::__construct() um array contendo o atributo “precision” e “randomGenerator”.

Por convenção, qualquer configuração que você tenha passado e que também seja um atributo público do seu componente, irá ter seu valor definido com base no array.

Usando outros componentes nos seus Componentes¶

Às vezes, um de seus componentes poderá precisar usar outro componente. Neste caso você pode incluir outros componentes no seu da mesma forma que inclui em controllers, usando o atributo $components:

// app/Controller/Component/CustomComponent.php
class CustomComponent extends Component {
    // O outro componente que seu componente utiliza
    public $components = array('Existing');

    function initialize(Controller $controller) {
        $this->Existing->foo();
    }

    function bar() {
        // ...
   }
}

// app/Controller/Component/ExistingComponent.php
class ExistingComponent extends Component {

    function initialize(Controller $controller) {
        $this->Parent->bar();
    }

    function foo() {
        // ...
   }
}

Callbacks¶

Component::initialize($controller)¶

O método initialize é chamado antes do método beforeFilter do controller.

Component::startup($controller)¶

O método startup é chamado após o método beforeFilter do controller mas antes que o controller execute a ação.

Component::beforeRender($controller)¶

O método beforeRender é chamado após o controller executar a lógica da ação requisitada mas antes que o controller renderize a view e o layout.

Component::shutdown($controller)¶

O método shutdown é chamado antes que o conteúdo seja enviado para o browser.

Component::beforeRedirect($controller, $url, $status=null, $exit=true)¶

O método beforeRedirect é invocado quando o método redirect de um controller é chamado mas antes de qualquer ação. Se este método retornar false o controller não irá continuar com o redirecionamento. As variáveis $url, $status e $exit possuem o mesmo significado do método do controller. Você pode também retornar uma string que será interpretada como uma URL para ser usada no redirecionamento ou retornar um array associativo com a chave ‘url’ e opcionalmente com a chave ‘status’ e a chave ‘exit’.