Components¶

Einbinden von Komponenten in Kontrollklassen¶

Wenn deine Komponente (Component) fertig ist, kannst du sie in deinen Kontrollklassen (Controllers) verwenden, indem du den Namen der Komponente (ohne „Component“) dem $components Array der entsprechenden Kontrollklasse hinzufügst. In der Kontrollklasse steht dir dann automatisch ein neues Attrbut mit dem Namen deiner Komponente zur Verfügung, über welches du eine Instanz deiner Komponente erreichst:

/* Einbindung einer neuen "Math"-Komponente ($this->Math),
sowie der Kern-Methode "Session" ($this->Session) */
var $components = array('Math', 'Session');

Komponenten, die im AppController eingebunden werden, werden mit denen in anderen (abgeleiteten) Kontrollklassen zusammengeführt. Es ist also nicht nötig, die selbe Komponente zweimal zu deklarieren.

Beim Einbinden von Komponenten in Kontrollklassen können außerdem Parameter an die initialize() Methode der Komponente übergeben werden. Diese Parameter können dann von der Komponente verwendet werden.

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

Dieser Code übergibt ein Array mit den Werten für „precision“ und „randomGenerator“ als zweiten Parameter an die initialize() Methode der MathComponent.

Die Möglichkeit Parameter an Kern-Komponenten zu übergeben besteht zur Zeit noch nicht.

MVC Klassen-Zugriff in Komponenten¶

Um aus deiner neuen Komponente (Component) heraus auf eine Instanz der Kontrollklasse (Controller) zuzugreifen, muss deine Komponente über eine initialize() oder startup() Methode verfügen. Diese speziellen Methoden erwarten eine Referenz auf deine Kontrollklasse als ersten Parameter. Die initialize() Methode wird vor der beforeFilter() Methode der Kontrollklasse aufgerufen, während die startup() Methode erst nach der beforeFilter() Methode aufgerufen wird.

Methode aufgerufen wird, kannst du die Klassenvariable $disableStartup auf true setzen.

Logik, die vor der beforeFilter() Methode der Kontrollklasse ausgeführt werden muss, wird in der initialize() Methode einer Komponente definiert.

<?php
    class CheckComponent extends Object {
        // Wird vor Controller::beforeFilter() ausgeführt
        function initialize(&$controller) {
            // Speichern der Referenz auf die Kontrollklasse
            $this->controller =& $controller;
        }

        // Wird nach Controller::beforeFilter() ausgeführt
        function startup(&$controller) {
        }

        function redirectSomewhere($value) {
            // Aufruf einer Kontrollklassen-Methode
            $this->controller->redirect($value);
        }
    }
?>

Eventuell möchtest du in deiner Komponente auch auf andere Komponenten zugreifen. In dem Fall nutzt du einfach die $components Klassenvariable in deiner Komponente. Diese funktioniert in Komponenten genau so, wie in Kontrollklassen. Sie enthält ein Array mit den Namen der zu ladenden Komponenten.

Ausschließlich die initialize() Methode von „Unterkomponenten“ wird automatisch aufgerufen.

<?php
    class MyComponent extends Object {

        // Diese Komponente nutzt andere Komponenten
        var $components = array('Session', 'Math');

        function doStuff() {
            $result = $this->Math->doComplexOperation(1, 2);
            $this->Session->write('stuff', $result);
        }

    }
?>

Ein Model in einer Komponente zu nutzen wird grundsätzlich eher nicht empfohlen. Solltest du dich nach Abwägung der Alternativen dennoch dazu entscheiden, musst du deine Model-Klasse manuell instanzieren. Hier ein Beispiel:

<?php
    class MathComponent extends Object {
        function doComplexOperation($amount1, $amount2) {
            return $amount1 + $amount2;
        }

        function doUberComplexOperation ($amount1, $amount2) {
            $userInstance = ClassRegistry::init('User');
            $totalUsers = $userInstance->find('count');
            return ($amount1 + $amount2) / $totalUsers;
        }
    }
?>

Using other Components in your Component¶

Sometimes one of your components may need to use another.

You can include other components in your component the exact same way you include them in controllers: Use the $components var.

<?php
class CustomComponent extends Object {
    var $name = 'Custom'; // the name of your component
    var $components = array('Existing'); // the other component your component uses

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

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

<?php
class ExistingComponent extends Object {
    var $name = 'Existing';

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

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