Components (Composants)¶

Configuration des Components¶

De nombreux components du cœur nécessitent une configuration. Quelques exemples : Authentification et Cookie. Toute configuration pour ces components, et pour les components en général, se fait dans le tableau des $components de la méthode beforeFilter() de vos controllers:

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

La portion de code précédente est un exemple de configuration d’un component avec le tableau $components. Tous les components du coeur permettent aux paramètres d’être configurés dans la méthode de votre controller beforeFilter(). C’est utile quand vous avez besoin d’assigner les résultats d’une fonction à la propriété d’un component. Ceci peut aussi être exprimé comme ceci:

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

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

C’est possible, cependant, que le component nécessite certaines options de configuration avant que le controller beforeFilter() soit lancé. Pour cela, certains components permettent aux options de configuration d’être définies dans le tableau $components:

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

Consultez la documentation appropriée pour connaître les options de configuration que chaque component fournit.

Un paramètre commun à utiliser est l’option className, qui vous autorise les alias des components. Cette fonctionnalité est utile quand vous voulez remplacer $this->Auth ou une autre référence de Component commun avec une implémentation sur mesure:

// 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 {
    // Ajouter votre code pour surcharger le AuthComponent du coeur
}

Ce qu’il y a au-dessous donnerait un alias MyAuthComponent à $this->Auth dans vos controllers.

Utiliser les Components¶

Une fois que vous avez inclus quelques components dans votre controller, les utiliser est très simple. Chaque component que vous utilisez est enregistré comme propriété dans votre controller. Si vous avez chargé la SessionComponent et le CookieComponent dans votre controller, vous pouvez y accéder comme ceci:

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 des Components¶

Les components vous offrent aussi quelques callbacks durant leur cycle de vie qui vous permettent d’augmenter le cycle de la requête. Allez voir l’api API de Component pour plus d’informations sur les callbacks possibles des components.

Créer un Component¶

Supposons que notre application en ligne ait besoin de réaliser une opération mathématique complexe dans plusieurs sections différentes de l’application. Nous pourrions créer un component pour héberger cette logique partagée afin de l’utiliser dans plusieurs controllers différents.

La première étape consiste à créer un nouveau fichier et une classe pour le component. Créez le fichier dans app/Controller/Component/MathComponent.php. La structure de base pour le component ressemblerait à quelque chose comme cela:

App::uses('Component', 'Controller');

class MathComponent extends Component {
    public function faireDesOperationsComplexes($montant1, $montant2) {
        return $montant1 + $montant2;
    }
}

/* Rend le nouveau component disponible par $this->Math
ainsi que le component standard $this->Session */
public $components = array('Math', 'Session');

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

// app/Controller/Component/CustomComponent.php
App::uses('Component', 'Controller');

class CustomComponent extends Component {
    // l'autre component que votre component utilise
    public $components = array('Existing');

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

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

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

class ExistingComponent extends Component {

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

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

API de Component¶

class Component¶

La classe de base de Component vous offre quelques méthodes pour le chargement facile des autres Components à travers ComponentCollection comme nous l’avons traité avec la gestion habituelle des paramètres. Elle fournit aussi des prototypes pour tous les callbacks des components.

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

Les Constructeurs pour la classe de base du component. Tous les paramètres se trouvent dans $settings et ont des propriétés publiques. Ils vont avoir leur valeur changée pour correspondre aux valeurs de $settings.