Decorator Grundlagen

Übersicht über das Decorator Pattern

Am Beginn behandeln wir einige Hintergründe des » Decorator Design Patterns. Eine verbreitetere Technik ist die Definition eines gemeinsamen Interfaces welche sowohl das originale Objekt als auch alle von Ihm abhängigen implementieren; der Decorator akzeptiert dann das originale Objekt als abhängiges, und wird entweder darauf verweisen oder seine Methoden überschreiben. Schreiben wir etwas Code damit es leichter verständlich wird:

  1. interface Window
  2. {
  3.     public function isOpen();
  4.     public function open();
  5.     public function close();
  6. }
  7.  
  8. class StandardWindow implements Window
  9. {
  10.     protected $_open = false;
  11.  
  12.     public function isOpen()
  13.     {
  14.         return $this->_open;
  15.     }
  16.  
  17.     public function open()
  18.     {
  19.         if (!$this->_open) {
  20.             $this->_open = true;
  21.         }
  22.     }
  23.  
  24.     public function close()
  25.     {
  26.         if ($this->_open) {
  27.             $this->_open = false;
  28.         }
  29.     }
  30. }
  31.  
  32. class LockedWindow implements Window
  33. {
  34.     protected $_window;
  35.  
  36.     public function __construct(Window $window)
  37.     {
  38.         $this->_window = $window;
  39.         $this->_window->close();
  40.     }
  41.  
  42.     public function isOpen()
  43.     {
  44.         return false;
  45.     }
  46.  
  47.     public function open()
  48.     {
  49.         throw new Exception('Cannot open locked windows');
  50.     }
  51.  
  52.     public function close()
  53.     {
  54.         $this->_window->close();
  55.     }
  56. }

Wir haben ein Objekt vom Typ StandardWindow erstellt, es dem Contructor von LockedWindow übergeben, und die eigene Fenster Instanz hat jetzt ein anderes Verhalten. Das Schöne daran ist, das man keine Art von "Locking" Funktionalität in der standardmäßigen Fenster Klasse implementieren muss -- der Decorator passt für einen darauf auf. In der Zwischenzeit kann das gesperrte Fenster herum übergeben wie wenn ein nur ein anderes Fenster wäre.

Ein spezieller Platz an dem das Decorator Pattern nützlich ist, ist die Erstellung von textuellen Repräsentationen von Objekten. Als Beispiel könnte man ein "Person" Objekt haben welches, aus sich selbst heraus, keine textuelle Repräsentation hat. Durch Verwendung des Decorator Patterns arbeitet es als wäre es eine Peron, bietet aber auch die Möglichkeit diese Person textuell darzustellen.

In diesem speziellen Beispiel, werden wir ein sogenanntes » Duck Typing verwenden statt einem expliziten Interface. Das erlaubt unserer Implementation etwas flexibler zu sein, wärend es dem Decorator Pattern trotzdem noch erlaubt so exakt zu arbeiten als wäre es ein Personen Objekt.

  1. class Person
  2. {
  3.     public function setFirstName($name) {}
  4.     public function getFirstName() {}
  5.     public function setLastName($name) {}
  6.     public function getLastName() {}
  7.     public function setTitle($title) {}
  8.     public function getTitle() {}
  9. }
  10.  
  11. class TextPerson
  12. {
  13.     protected $_person;
  14.  
  15.     public function __construct(Person $person)
  16.     {
  17.         $this->_person = $person;
  18.     }
  19.  
  20.     public function __call($method, $args)
  21.     {
  22.         if (!method_exists($this->_person, $method)) {
  23.             throw new Exception('Ungültige Methode bei HtmlPerson aufgerufen: '
  24.                 .  $method);
  25.         }
  26.         return call_user_func_array(array($this->_person, $method), $args);
  27.     }
  28.  
  29.     public function __toString()
  30.     {
  31.         return $this->_person->getTitle() . ' '
  32.             . $this->_person->getFirstName() . ' '
  33.             . $this->_person->getLastName();
  34.     }
  35. }

In diesem Beispiel übergeben wir unsere Instanz von Person an den Constructor von TextPerson. Durch Verwendung von Methoden Überladung sind wir in der Lage weiterzumachen und alle Methoden von Person auf Ihr aufzurufen -- um den Vornamen, den Nachnamen, oder den Titel zu setzen -- aber man erhält jetzt auch eine String Repräsentation über die __toString() Methode.

Das letztere Beispiel kommt der Arbeitsweise der Decorators von Zend_Form schon nahe. Der eigentliche Unterschied besteht darin, das statt den Decorator in einem Element einzubetten, das Element ein oder mehrere Decorators angehängt haben kann welche es dann in sich selbst injiziert und weiterhin Eigenschaften um eine Repräsentation des Elements -- oder einem Subset von sich -- zu erstellen.

Den ersten Decorator erstellen

Zend_Form Decorators implementieren alle ein gemeinsames Interface Zend_Form_Decorator_Interface. Dieses Interface bietet die Fähigkeit decorator-spezifische Optionen zu setzen, das Element zu registrieren und zu empfangen, und darzustellen. Der Basis Decorator, Zend_Form_Decorator_Abstract, bietet die jede Funktionalität welche man irgendwann verwenden wird, mit Ausnahme der Logik für die Darstellung.

Nehmen wir eine Situation an in der wir einfach ein Element als Standard Formular Texteinfabe mit einer Überschrift darstellen wollen. Wir denken jetzt nicht an Fehlerbehandlung oder ob das Element mit anderen Tags umhüllt werden soll oder nicht -- nur die Grundlagen. Solch ein Decorator könnte wie folgt aussehen:

  1. class My_Decorator_SimpleInput extends Zend_Form_Decorator_Abstract
  2. {
  3.     protected $_format = '<label for="%s">%s</label>'
  4.                        . '<input id="%s" name="%s" type="text" value="%s"/>';
  5.  
  6.     public function render($content)
  7.     {
  8.         $element = $this->getElement();
  9.         $name    = htmlentities($element->getFullyQualifiedName());
  10.         $label   = htmlentities($element->getLabel());
  11.         $id      = htmlentities($element->getId());
  12.         $value   = htmlentities($element->getValue());
  13.  
  14.         $markup  = sprintf($this->_format, $name, $label, $id, $name, $value);
  15.         return $markup;
  16.     }
  17. }

Erstellen wir ein Element welches diesen Decorator verwendet:

  1. $decorator = new My_Decorator_SimpleInput();
  2. $element   = new Zend_Form_Element('foo', array(
  3.     'label'      => 'Foo',
  4.     'belongsTo'  => 'bar',
  5.     'value'      => 'test',
  6.     'decorators' => array($decorator),
  7. ));

Die Darstellung dieses Elements führt zum folgenden Markup:

  1. <label for="bar[foo]">Foo</label>
  2. <input id="bar-foo" name="bar[foo]" type="text" value="test"/>

Man könnte diese Klasse auch irgendwo in die eigene Bibliothek geben, das Element über den Pfad informieren, und auf den Decorator genauso einfach als "SimpleInput" verweisen:

  1. $element = new Zend_Form_Element('foo', array(
  2.     'label'      => 'Foo',
  3.     'belongsTo'  => 'bar',
  4.     'value'      => 'test',
  5.     'prefixPath' => array('decorator' => array(
  6.         'My_Decorator' => 'path/to/decorators/',
  7.     )),
  8.     'decorators' => array('SimpleInput'),
  9. ));

Das gibt den Vorteil das er auch in anderen Projekten wiederverwendet werden kann, und öffnet die Türen damit später alternative Implementationen dieses Decorators angeboten werden können.

Im nächsten Abschnitt schauen wir uns an wie Decorators kombiniert werden können um kombinierte Ausgaben zu erstellen.

blog comments powered by Disqus