Da ich derzeit an einem CMS-System arbeite habe ich mir natürlich diese Gedanken gemacht und mich daran gemacht ein Widget-System zu errichten, dass neben den anderen Helfern arbeitet. Dieses bietet die Möglichkeit in einer CMS-Seite einen String einzubinden, der das Laden auslöst.

{widget:Test}
{widget:Test|Google,Yahoo,Bing}

Über diese einfache Syntax wird das Widget übergeben. Natürlich auch mit der Möglichkeit Parameter einzusetzen um die Widgets Variabel aufzubauen. Zu dieser Synatx gibt es einen ActionHelper, der ihn aus einem String heraussucht und dann das Rendern des Helpers beginnt.

$this->content = $this->_helper->widget->convert($content);

<?php

/**
 * Der Actionhelper läd View Helper indem er entsprechende Stellen aus einem String sucht.
 *
 * @see         Zend_Controller_Action_Helper_Abstract
 * @uses        Zend_Controller_Action_Helper_Abstract
 * @category    Suka
 * @package     Suka_Controller
 * @subpackage  Action_Helper
 * @author      Denis Zunke <denis.zunke@zorta.de>;
 * @version     0.1
 * @copyright   2010 zorta.de
 * @link        http://www.zorta.de/SukaSys
 * @license     http://opensource.org/licenses/gpl-license.php GNU Public License v3
 */

class Suka_Controller_Action_Helper_Widget extends Zend_Controller_Action_Helper_Abstract {

    /**
     * Sucht ein Widget aus einem Text und ersetzt es durch die Ausgabe eines View Helpers
     *
     * @param   string      $content    Der Seiteninhalt
     * @return  string
     */
    public function convert($content)
    {
        // Heraussuchen der vorhandenen Widgets
        $matches = array();
        preg_match_all('|{widget:([^\|]*)(\|.*)?}|U',$content,$matches,PREG_SET_ORDER);

        // Lade die gefundenen Widgets und ersetze den entsprechenden Content
        foreach ($matches as $widget) {
            try {
            	// Sollte es Parameter geben, dann trenne diese auf
            	if (!empty($widget[2])) {
            	   $paramsString = str_replace('|','',$widget[2]);
            	   $params = explode(',',$paramsString);
            	   $widgetOutput = (string) Suka_Widget::load($widget[1],$params);
            	} else {
            	   $widgetOutput = (string) Suka_Widget::load($widget[1]);
            	}
                $content       = str_replace($widget[0],$widgetOutput,$content);
            } catch (CLib_Widget_Exception $e) {
                continue;
            }
        }

        return $content;
    }
}

Wie schön zu sehen ist wird über einen Regex die Syntax aus dem Text gesucht und entsprechend aufgeteilt, dass am Ende entweder das Widget mit oder ohne Parameter geladen werden kann. Das Widget selber basiert auf einer Abstrakten Klasse, die die Grundfunktionalitäten mitbringt und in der die Methode draw() überschrieben werden muss. Ich habe die Widgets in application/views/widgets untergebracht und den Autoloader entsprechend konfiguriert, so dass sie dem Namensschema App_Widget_MyWidget folgen. Probiert es einfach auf, für Rückfragen stehe ich gerne zur Verfügung. Natürlich gibt es im Folgenden noch die entsprechenden Klassen.

Eine Überlegung für die Zukunft ist es noch den Inhalt des Widgets in phtml Dateien auszulagern. So lange aber lagert er in der draw() Methode.

'resourceAutoloader' => array (
            'basePath'   => APPLICATION_PATH,
            'namespace'     => 'App_',
            'resourceTypes' => array (
                'widget'   => array(
                    'path'      => 'views/widgets',
                    'namespace' => 'Widget_'
                )
            )
        )

<?php

/**
 * Widgetklasse
 *
 * Enthällt funktionalitäten rund um Widgets.
 *
 * @category    Suka
 * @package     Suka
 * @author      Denis Zunke <denis.zunke@zorta.de>;
 * @version     0.1
 * @copyright   2010 zorta.de
 * @link        http://www.zorta.de/SukaSys
 * @license     http://opensource.org/licenses/gpl-license.php GNU Public License v3
 */

class Suka_Widget
{

    /**
     * Läd ein Widget aus den vorgegebenen Verzeichnissen
     *
     * @param   string  $widget     Name des Widgets
     * @return  CLib_Widget_Abstract | boolean
     */
    public static function load($widget, $params = null)
    {
        # Erstmal prüfen, ob es ein normales Widget ist
        $loader = Zend_Loader_Autoloader::getInstance();
        $autoloadWidget = 'App_Widget_' . $widget;
        if(@$loader->autoload($autoloadWidget))
        {
            return new $autoloadWidget($params);
        }
        else
        {
           # Wenn nicht, dann prüfe, ob es ein Widget aus einam Modul ist
            $pfad_imp = explode('_',$widget);
            $pfad_imp[0] = strtolower($pfad_imp[0]);
            if (isset($pfad_imp[1])) {
                $pfad = APPLICATION_PATH ."/modules/{$pfad_imp[0]}/views/widgets/{$pfad_imp[1]}.php";
                if (file_exists($pfad)) {
                    require_once $pfad;

                    $widget = ucfirst($pfad_imp[0]) .'_Views_Widgets_'. $pfad_imp[1];

                    return new $widget($params);
                }
            }
        }

       return null;
    }
}

<?php

/**
 * Basisklasse für Widgets
 *
 * Über diese KLasse werdne den Widgets funktionalitäten hinzugefügt,
 * die jedes Widget im Standard aufweisen muss.
 *
 * @category    Suka
 * @package     Suka_Widget
 * @author      Denis Zunke <denis.zunke@zorta.de>;
 * @version     0.1
 * @copyright   2010 zorta.de
 * @link        http://www.zorta.de/SukaSys
 * @license     http://opensource.org/licenses/gpl-license.php GNU Public License v3
 */

abstract class Suka_Widget_Abstract
{

    /**
     * Enthält die Optionen, die für das Widget mitgegeben wurden
     *
     * @var array
     */
    protected $_options = array();

    /**
     * Erstellt diese Klasse, alles was für das Widget abgearbeitet werden soll
     * bei der Erstellung muss eine Unterkunft in dieser Methode finden
     *
     * @param   array   $params     Ein Array mit Parametern für das Widget
     */
    public function __construct($params = null)
    {
        if (!empty($params) AND is_array($params)) {
            $this->setOptions($params);
        }
    }

    /**
     * Ausgeben des generierten Contents
     *
     * @return string
     */
    public function __toString()
    {
        return (string) $this->draw();
    }

    /**
     * Setzt die Optionen dieses Widgets
     *
     * @param   array   $options    Ein Array mit Optionen
     * @return  Suka_Widget_Abstract
     */
    public function setOptions($options)
    {
        $this->_options = $options;
        return $this;
    }

    /**
     * Gibt eine Option des Widgets zurück
     *
     * @param   string  $option     Welche Option ausgegeben werdne soll
     * @return  mixed
     */
    public function getOption($option)
    {
        if (isset($this->_options[$option])) {
            return $this->_options[$option];
        }

        return false;
    }

    /**
     * Erstellen des Contents. Muss in einem Widget vorkommen um
     * den Content darstellen zu können.
     *
     * @return  string
     */
    abstract protected function draw();

}

<?php

/**
 * Fehlermeldungen des Widgetsystems
 *
 * @category    Suka
 * @package     Suka_Widget
 * @author      Denis Zunke <denis.zunke@zorta.de>;
 * @version     0.1
 * @copyright   2010 zorta.de
 * @link        http://www.zorta.de/SukaSys
 * @license     http://opensource.org/licenses/gpl-license.php GNU Public License v3
 */

class Suka_Widget_Exception extends Zend_Exception {}

<?php

/**
 * Test
 *
 * @category    Views
 * @package     Views_Helpers
 * @author      Denis Zunke <denis.zunke@zorta.de>
 * @version     0.1
 * @copyright   2010 zorta.de
 * @link        http://www.zorta.de/SukaSys
 * @license     http://opensource.org/licenses/gpl-license.php GNU Public License v3
 */

class App_Widget_MyWidget extends Suka_Widget_Abstract {

    protected function draw()
    {
        return '<p>Ich bin ein Text aus einem Widget</p>' . ' ' . $this->getOption(0) . ' ' . $this->getOption(1) . ' ' . $this->getOption(2) . ' ';
    }
}

Ich gehe jetzt einmal von einer frischen Installation des Zend Studio aus. Wir legen uns zunächst ein einfaches Zend Framework Projekt an. Das ganze bekommt einen Namen und den gewünschten Workspace. Die ZF Version auswählen und dann gleich auf “Fertig” klicken.

Ein einfaches Zend Framework Projekt wird jetzt inkl. Sturktur und einigen Basisdateien angelegt. Dazu auch ein Verzeichnis Test. Dies öffnen wir und sehen die Datei “AllTests.php”. Mit einem Rechtsklick auf die Datei rufen wir das Context Menü dieser Datei auf und gehen auf “Debug As”. Wie wir sehen steht dort nichts vom PHPUnit Test. Also klicken wir auf “Debug Configurations”. Es öffnet sich ein Fenster. Mit einem Rechtsklick auf “PHPUnit” gibt es ein neues Contextmenü indem wir auf “New” klicken.

So wird gleich ein neuer PHPUnit Test mit dem Namen “AllTests.php” angezeigt. Klickt diesen an. Nun ist eigentlich nur wichtig, dass ihr die 2. Option ausgewählt habt, dass alle Tests gestartet werden. Nicht wie die erste Option es angibt “Run as single Test”. Das wollen wir nicht. Noch nicht.

Nun noch ein klick auf “Debug” und das Fenster schließt sich. Es kommt die Frage, ob ihr in eine ander ePerspektive wechseln wollt. Das müsst ihr für euch Entscheiden. Ich mache es eher seltener, da ich nicht alle die Fenster aus der Debug Ansicht brauche. Rechts im Zend Studio hat sich nun ein neuer Bereich geöffnet für die PHPUnit Tests. Dort seht ihr, ob es Errors gab usw. eigentlich recht simple zu verstehen.

Wenn ihr nun auch in der Dateileiste wieder auf “AllTests.php” geht, dann findet ihr nun im Contectmenü auch den Punkt “Debug As PHPUnit Test”.