Componentes¶

Configurando componentes¶

Mucho de los componentes principales requieren configuración. Algunos ejemplos de componentes que requieren configuración son Authentication y Cookie. La configuración para estos componentes, y para los componentes en general, es realizada usualmente en el array $components o en el método beforeFilter() de tú controlador:

class PostsController extends AppController {
    public $components = array(
        'Auth' => array(
            'authorize' => array('controller'),
            'loginAction' => array(
                'controller' => 'users',
                'action' => 'login'
            )
        ),
        'Cookie' => array('name' => 'CookieMonster')
    );

El fragmento de código anterior sería un ejemplo de configuración de un componente con el array $components. Todos los componentes principales permiten que su configuración sea seteada de ésta forma. A su vez, es posible configurar el componente a través del método beforeFilter() de tú controlador. Esto es útil cuando necesitas asignar los resultados de una función a la propiedad de un componente. El código anterior también podría ser expresado como:

public function beforeFilter() {
    $this->Auth->authorize = array('controller');
    $this->Auth->loginAction = array(
        'controller' => 'users',
        'action' => 'login'
    );

    $this->Cookie->name = 'CookieMonster';
}

Sin embargo, es posible que un componente requiera que cierta configuración antes que el método beforeFilter() del controlador sea ejecutado. Con éste fin, algunos componentes permiten que las opciones de configuración sean seteadas en el array $components:

public $components = array(
    'DebugKit.Toolbar' => array('panels' => array('history', 'session'))
);

Consulte la documentación relevante para determinar que opción de configuración provee cada componente.

Una opcion común es el uso de className, la cual le permite ponerle un alias a un componente. Esta caracteristica es útil cuando se quiere reemplazar $this->Auth o la referencia de otro componente común con una implementación propia:

// app/Controller/PostsController.php
class PostsController extends AppController {
    public $components = array(
        'Auth' => array(
            'className' => 'MyAuth'
        )
    );
}

// app/Controller/Component/MyAuthComponent.php
App::uses('AuthComponent', 'Controller/Component');
class MyAuthComponent extends AuthComponent {
    // Add your code to override the core AuthComponent
}

El código anterior aplicaría un alias MyAuthComponent a $this->Auth en tús controladores.

Usando Componentes¶

Una vez que has incluido algunos componentes en tús controladores, usarlos es bastante sensillo. Cada componente que use es expuesto como una propiedad en tú controlador. Si ha cargado SessionComponent y CookieComponent en su controlador, accederia a ellos de esta forma:

class PostsController extends AppController {
    public $components = array('Session', 'Cookie');

    public function delete() {
        if ($this->Post->delete($this->request->data('Post.id'))) {
            $this->Session->setFlash('Post deleted.');
            return $this->redirect(array('action' => 'index'));
        }
    }

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

Callbacks de componentes¶

Los componentes también ofrecen varios callbacks que permiten aumentar el ciclo del request. Vea API Componentes para más información sobre los callbacks que ofrecen los componentes.

Creando componentes¶

Suponga que nuestra aplicación online necesita llevar a cabo una operación matemática compleja en diferentes partes de la aplicación. En este caso, crearíamos un componente que albergue esta lógica compartida para usar en diferentes controladores.

El primer paso es crear un nuevo archivo y clase de componente. Cree el archivo en app/Controller/Component/MathComponent.php. La estructura básica para un componente es:

App::uses('Component', 'Controller');
class MathComponent extends Component {
    public function doComplexOperation($amount1, $amount2) {
        return $amount1 + $amount2;
    }
}

/* Hacer disponible el nuevo componente $this->Math,
y el standard $this->Session */
public $components = array('Math', 'Session');

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

// app/Controller/Component/CustomComponent.php
App::uses('Component', 'Controller');
class CustomComponent extends Component {
    // los otros componentes que tu componente usa
    public $components = array('Existing');

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

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

// app/Controller/Component/ExistingComponent.php
App::uses('Component', 'Controller');
class ExistingComponent extends Component {

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

API Componentes¶

class Component¶

La clase base Component ofrece varios métodos para cargar otros componentes a través de ComponentCollection así como para tratar con configuraciones comunes. También provee prototipos para todos los callbacks de los componentes.

Component::__construct(ComponentCollection $collection, $settings = array())¶

Constructor para la clase base component. Todos los $settings que también tengan propiedades públicas serán actualizados para coincidir con $settings.