Components (Composants)¶

Configuration des Components¶

De nombreux components du cœur nécessitent une configuration. Quleques exemples de composants qui requièrent une configuration sont SecurityComponent (Sécurité) et Request Handling (Gestion des requêtes). La configuration pour ces components, et pour les components en général, se fait via loadComponent() dans la méthode initialize() de votre Controller ou via le tableau $components:

class PostsController extends AppController
{
    public function initialize(): void
    {
        parent::initialize();
        $this->loadComponent('RequestHandler', [
            'viewClassMap' => ['json' => 'AppJsonView'],
        ]);
        $this->loadComponent('Security', ['blackholeCallback' => 'blackhole']);
    }
}

Vous pouvez configurer les components à la volée en utilisant la méthode setConfig(). Souvent, ceci est fait dans la méthode beforeFilter() de votre controller. Ceci peut aussi être exprimé comme ceci:

public function beforeFilter(EventInterface $event)
{
    $this->RequestHandler->setConfig('viewClassMap', ['rss' => 'MyRssView']);
}

Comme les helpers, les components ont des méthodes getConfig() et setConfig() qui sont utilisées pour récupérer et définir toutes les configurations pour un component:

// Lire des données de config.
 $this->RequestHandler->getConfig('viewClassMap');

// Définir la config
$this->Csrf->setConfig('cookieName', 'token');

Comme avec les helpers, les components vont automatiquement fusionner leur propriété $_defaultConfig avec la configuration du constructeur pour créer la propriété $_config qui est accessible avec getConfig() et setConfig().

// src/Controller/PostsController.php
class PostsController extends AppController
{
    public function initialize(): void
    {
        parent::initialize('Auth', [
            'className' => 'MyAuth'
        ]);
    }
}

// src/Controller/Component/MyAuthComponent.php
use Cake\Controller\Component\AuthComponent;

class MyAuthComponent extends AuthComponent
{
    // Ajoutez votre code pour surcharge l'AuthComponent du cœur
}

// Dans l'action du controller
$this->loadComponent('OneTimer');
$time = $this->OneTimer->getTime();

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 Cake\Controller\Component\FlashComponent dans votre controller, vous pouvez y accéder comme ceci:

class PostsController extends AppController
{
    public function initialize(): void
    {
        parent::initialize();
        $this->loadComponent('Flash');
    }

    public function delete()
    {
        if ($this->Post->delete($this->request->getData('Post.id')) {
            $this->Flash->success('Publication effacée.');

            return $this->redirect(['action' => 'index']);
        }
    }

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 src/Controller/Component/MathComponent.php. La structure de base pour le component ressemblerait à quelque chose comme cela:

namespace App\Controller\Component;

use Cake\Controller\Component;

class MathComponent extends Component
{
    public function doComplexOperation($amount1, $amount2)
    {
        return $amount1 + $amount2;
    }
}

// Dans un controller
// Rend le nouveau component disponible avec $this->Math
// ainsi que le component standard $this->Csrf
public function initialize(): void
{
    parent::initialize();
    $this->loadComponent('Math');
    $this->loadComponent('Csrf');
}

// Dans votre controller.
public function initialize(): void
{
    parent::initialize();
    $this->loadComponent('Math', [
        'precision' => 2,
        'randomGenerator' => 'srand'
    ]);
    $this->loadComponent('Csrf');
}

// src/Controller/Component/CustomComponent.php
namespace App\Controller\Component;

use Cake\Controller\Component;

class CustomComponent extends Component
{
    // L'autre component que votre component utilise
    public $components = ['Existing'];

    // Exécute une autre configuration additionnelle pour votre component.
    public function initialize(array $config): void
    {
        $this->Existing->foo();
    }

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

// src/Controller/Component/ExistingComponent.php
namespace App\Controller\Component;

use Cake\Controller\Component;

class ExistingComponent extends Component
{

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

$controller = $this->getController();

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.

beforeFilter(EventInterface $event)¶

Est appelée avant la méthode du controller beforeFilter, mais après la méthode initialize() du controller.

startup(EventInterface $event)¶

Est appelée après la méthode du controller beforeFilter mais avant que le controller n’exécute l’action prévue.

beforeRender(EventInterface $event)¶

Est appelée après que le controller exécute la logique de l’action requêtée, mais avant le rendu de la vue et le layout du controller.

shutdown(EventInterface $event)¶

Est appelée avant que la sortie soit envoyée au navigateur.

beforeRedirect(EventInterface $event, $url, Response $response)¶

Est invoquée quand la méthode de redirection du controller est appelée, mais avant toute action qui suit. Si cette méthode retourne false, le controller ne continuera pas à rediriger la requête. Les paramètres $url et $response vous permettent d’inspecter et de modifier la localisation ou toutes autres entêtes dans la réponse.

Utiliser des Redirections dans les Events des Components¶

Pour rediriger à partir d’une méthode de rappel de composant, vous pouvez utiliser ce qui suit:

public function beforeFilter(EventInterface $event)
{
    $event->stopPropagation();

    return $this->getController()->redirect('/');
}

En arrêtant l’événement, vous faites savoir à CakePHP que vous ne voulez pas que les autres méthodes de callback de d’autres composants ne soient appelées ni que le controller ne gère l’action plus avant. À partir de la version 4.1.0, vous pouvez déclencher une RedirectException pour signaler une redirection:

use Cake\Http\Exception\RedirectException;
use Cake\Routing\Router;

public function beforeFilter(EventInterface $event)
{
    throw new RedirectException(Router::url('/'))
}

La levée d’une exception arrêtera tous les autres écouteurs d’événements et créera une nouvelle réponse qui ne conserve ou n’hérite d’aucun des en-têtes de la réponse actuelle. Lors de la levée d’une RedirectException, vous pouvez inclure des en-têtes supplémentaires:

throw new RedirectException(Router::url('/'), 302, [
    'Header-Key' => 'value',
]);