Module und Views #

Teil 3, Kapitel 9. Jede Seite von Exponential, die keine Inhaltsseite ist, ist eine View eines Moduls: /user/login, /setup/extensions, /owner/change/123. Eine Erweiterung fügt Seiten hinzu, indem sie Module hinzufügt. Dieses Kapitel erklärt die Definitionsdatei, das View-Skript und das, was eine View zurückgibt. Die Klasse, die das alles ausführt, ist eZModule (lib/ezutils/classes/ezmodule.php).

Den Modulordner registrieren #

In extension/mysite_hello/settings/module.ini.append.php:

<?php /* #?ini charset="utf-8"?

[ModuleSettings]
ExtensionRepositories[]=mysite_hello

*/ ?>

Jeder Ordner unter extension/mysite_hello/modules/ ist dann ein Modul. Die Adresse /hello/world/Ada führt die View world des Moduls hello mit dem Parameter Ada aus.

module.php #

Eine echte Definition aus se7enxweb/ezownerchange (modules/owner/module.php):

<?php
$Module = array( 'name' => 'Owner', 'variable_params' => false );

$ViewList = array();
$ViewList['change'] = array(
    'script' => 'change.php',
    'functions' => array( 'change' ),
    'params' => array( 'ObjectID' ),
    'unordered_params' => array( 'group' => 'StartNode', 'node' => 'NodeID', 'scope' => 'Scope' ),
    'ui_context' => 'edit',
    'default_navigation_part' => 'ezcontentnavigationpart',
    'post_actions' => array( 'BrowseActionName' ),
    'single_post_actions' => array( 'BrowseCancelButton' => 'Cancel',
                                    'CancelButton' => 'Cancel',
                                    'BrowseOwnerButton' => 'BrowseOwner',
                                    'PreviewButton' => 'Preview',
                                    'ConfirmButton' => 'Confirm' ),
    'post_action_parameters' => array( 'Cancel' => array( 'CancelURI' => 'BrowseCancelURI' ) )
);

$FunctionList = array();
$FunctionList['change'] = array();
$FunctionList['subtree'] = array();

Ein View-Skript #

modules/hello/world.php:

<?php
/** @var eZModule $Module */
$Module = $Params['Module'];
$name = isset( $Params['Name'] ) && $Params['Name'] !== '' ? $Params['Name'] : 'world';

$tpl = eZTemplate::factory();
$tpl->setVariable( 'name', $name );

$Result = array();
$Result['content'] = $tpl->fetch( 'design:hello/world.tpl' );
$Result['path'] = array( array( 'text' => 'Hello', 'url' => false ) );

Das Skript erhält $Params (mit dem Modul als $Params['Module']) und setzt $Result. Das Template maskiert, was aus der Adresse kam: {$name|wash}. Was $Result enthalten darf, steht im übernächsten Kapitel, View-Ergebnisse und das Pagelayout.

Eine View als Klasse #

Seit 6.0.15 kann eine View eine Klasse sein; das einfache Skript oben funktioniert weiterhin. Die Klasse erweitert \Exponential\Runnable\ModuleView (kernel/private/classes/runnable/moduleview.php) und gibt das Ergebnis zurück:

<?php
// extension/mysite_hello/classes/runnable/views/hello/world.php
namespace Exponential\View\Extension\MysiteHello\Hello;

class World extends \Exponential\Runnable\ModuleView
{
    public function run( array $scope )
    {
        $name = isset( $scope['Params']['Name'] ) && $scope['Params']['Name'] !== '' ? $scope['Params']['Name'] : 'world';
        $tpl = \eZTemplate::factory();
        $tpl->setVariable( 'name', $name );
        return array( 'content' => $tpl->fetch( 'design:hello/world.tpl' ),
                      'path' => array( array( 'text' => 'Hello', 'url' => false ) ) );
    }
}

und die in module.php genannte View-Datei schrumpft auf eine Zeile:

<?php
return \Exponential\View\Extension\MysiteHello\Hello\World::main( __FILE__, get_defined_vars() );

Klassen lassen sich ohne Request testen und teilen sich Code mit Befehlen und Cronjob-Teilen; siehe Befehle, Cronjob-Teile und Modul-Views als Klassen.

Formulare und Aktionen #

Eine View, die ein Formular verarbeitet, liest die Aktion, die das Modul aus dem POST abgeleitet hat:

<?php
$Module = $Params['Module'];
$http = eZHTTPTool::instance();

if ( $Module->isCurrentAction( 'Cancel' ) )
{
    return $Module->redirectTo( '/content/dashboard' );
}
if ( $Module->isCurrentAction( 'Confirm' ) )
{
    $comment = $http->postVariable( 'Comment', '' );
    // ... do the work, then redirect so a reload does not post again
    return $Module->redirectToView( 'world', array( 'Ada' ) );
}

Mit single_post_actions macht ein POST, der ConfirmButton enthält, isCurrentAction( 'Confirm' ) wahr. Formulare, die etwas ändern, müssen das Formular-Token mitführen (die Erweiterung ezformtoken fügt es in Formulare ein und prüft es); siehe ezformtoken und CSRF-Schutz.

Fehler #

<?php
$object = eZContentObject::fetch( (int)$Params['ObjectID'] );
if ( !$object instanceof eZContentObject )
{
    return $Module->handleError( eZError::KERNEL_NOT_FOUND, 'kernel' );
}
if ( !$object->canRead() )
{
    return $Module->handleError( eZError::KERNEL_ACCESS_DENIED, 'kernel' );
}

eZError (kernel/classes/ezerror.php) enthält die Codes: KERNEL_ACCESS_DENIED (1), KERNEL_NOT_FOUND (2), KERNEL_NOT_AVAILABLE (3), KERNEL_MOVED (4), KERNEL_LANGUAGE_NOT_FOUND (5), KERNEL_FORM_TOKEN_REFUSED (6), KERNEL_MODULE_NOT_FOUND (20), KERNEL_MODULE_VIEW_NOT_FOUND (21) und weitere. Der Kernel zeigt die passende Fehlerseite an.

Prüfen #

1. php -l für jede Datei.
2. Aktivieren, Caches leeren (Eine Erweiterung aktivieren).
3. /hello/world/Ada öffnen.
4. Wenn gemeldet wird, dass das Modul nicht existiert: ./console exp:ini where module.ini/ModuleSettings/ExtensionRepositories.

Ein Kernel-Modul ersetzen #

Eine Erweiterung kann ein ganzes Kernel-Modul durch ein eigenes ersetzen; siehe Eine Erweiterung kann ein Kernel-Modul ersetzen. Eine View zu einem vorhandenen Modul fügen Sie mit dem RAD-Werkzeug View für ein vorhandenes Modul hinzu.

RAD #

Assistent für Modul-Extensions (/setup/moduleextension) schreibt ein Modul mit Views, Templates, Richtlinien und Einstellungen; Modul-Assistent (/setup/modulewizard) schreibt ein Modul auf Grundlage vorhandener Datenbanktabellen. Siehe Mit RAD: ein Modul mit Views.

Verwandte Seiten #

• Zurück: Autoloads und Klassenbenennung
• Weiter: View-Parameter, ungeordnete Parameter und POST
• Von Hand: ein Modul mit einer View
• eZModule und Modulergebnisse
• Freie Dokumentation: Diese Seite darf unter der GNU FDL 1.3 frei kopiert, übersetzt und verbessert werden.