Dsao_Controller_Action Klassenreferenz

Grundcontroller der Applikation. Mehr ...

Klassendiagramm für Dsao_Controller_Action:

Aufstellung aller Elemente

Öffentliche Methoden
	__call ($action, $parameters)
	Nicht vorhandene Aktionen werden abgefangen.
	__construct (Zend_Controller_Request_Abstract $request, Zend_Controller_Response_Abstract $response, array $invokeArgs=array())
	Wrapper für den Konstruktor, um Klasseneigenschaften zu initialisieren.
	forward ($action, $controller=null, $module=null, array $parameters=array())
	Interne Weiterleitung.
	getConfig ()
	Gibt Konfiguration zurück.
	getHelper ($helperName)
	Gibt Helper mit übergebenem Namen zurück.
	getLog ()
	Gibt Logger zurück.
	getModuleNavigation ()
	Gibt die Navigation des aufgerufenen Moduls zurück.
	getTranslate ()
	Gibt Sprachverwaltung zurück.
	getUri ()
	Gibt URI zurück.
	getUser ()
	Gibt das Objekt des angemeldeten Benutzers zurück.
	getView ()
	Gibt Objekt der View-Komponente zurück.
	init ()
	Initialisierung des Controllers.
	isXmlHttpRequest ()
	Wrapper für Zend_Controller_Request_Http::isXmlHttpRequest().
	postDispatch ()
	Abschließende Routinen.
	preDispatch ()
	Vor dem Dispatchen auszuführende Routinen.
	preRedirect ()
	Vor dem Weiterleiten auszuführende Controllerlogik.
	setUser (Dsao_User $user)
	Setzt Benutzerobjekt.
Geschützte Methoden
	_addJsFile ($action=null, $controller=null, $module=null)
	Fügt JavaScript-Datei hinzu.
	_getModel ($modelClass=null)
	Gibt ein angefordertes Modell zurueck.
	_gotoSimple ($action, $controller=null, $module=null, array $parameters=array(), $exit=true)
	Wrapper für die einfache Umleitung auf eine andere Seite.
	_initHelpers ()
	Initialisiert Helper.
	_setDefaultModelClass ($modelClass)
	Setzt die Standardmodellklasse.

---

Ausführliche Beschreibung

Grundcontroller der Applikation.

Von diesem Grundcontroller werden alle weiteren Controller abgeleitet.

Autor:

DSAo-Md

http://www.gnu.org/licenses/gpl-3.0.html GNU Public License

Version:

SVN: $Id: Action.php 519 2009-09-13 15:51:26Z saviola777 $

Definiert in Zeile 11 der Datei Action.php.

---

Dokumentation der Elementfunktionen

Dsao_Controller_Action::__call	(	$	action,
		$	parameters
	)

Nicht vorhandene Aktionen werden abgefangen.

Diese Methode leitet den Benutzer bei dem Aufruf einer nicht vorhandenen Seite auf eine Fehlerseite um.

Parameter:

	$action	string, Aktion
	$parameters	array, Parameter

Rückgabe:

void

Definiert in Zeile 58 der Datei Action.php.

  {
    // Falls nicht vorhandene Aktion aufgerufen wurde, auf Fehlerseite
    // weiterleiten
    if (substr($action, -6, 6) == 'Action')
    {
      return $this->_forward('exception', 'error', 'default');
    }

    throw new Dsao_Exception(array(
      'message' => 'dsao_controller_action_method_not_found',
      'variables' => array('method' => $action),
      ), 500);
  }

Dsao_Controller_Action::_addJsFile	(	$	action = null,
		$	controller = null,
		$	module = null
	)			[protected]

Fügt JavaScript-Datei hinzu.

Erzeugt aus den uebergebenen Parametern den Pfad zu der JS-Datei der Aktion, des Kontrollers oder des Moduls, relativ zu /htdocs/js und uebergibt ihn an Dsao_View_Smarty::addJsFile().

Bei den Parametern gilt jeweils:

false = dieser Teil soll abgeschnitten werden (macht bei Modul keinen Sinn) null = für diesen Teil den Standardwert benutzen string = für diesen Teil diese Zeichenkette benutzen

Parameter:

	$action	bool|null|string, Aktion
	$controller	bool|null|string, Controller
	$module	bool|null|string, Modul

Rückgabe:

bool

Definiert in Zeile 108 der Datei Action.php.

Benutzt getView().

Wird benutzt von Game_DeskController::showAction().

  {
    // string, Pfad zur JavaScript-Datei
    $path = null;

    $parameters = array(
      'Module'      => $module,
      'Controller'  => $controller,
      'Action'      => $action
      );

    foreach ($parameters as $name => $value)
    {
      // Falls false übergeben wurde, abbrechen
      if (false === $value)
      {
        break;
      }

      // Slash anhängen
      $path .= '/';

      // Methodenname für Standardparameter
      $method = 'get'.$name.'Name';

      $path .= (null === $value ? $this->getRequest()->$method() : $value);
    }

    // Falls kein Pfad gebildet wurde
    if (!$path)
    {
      return false;
    }

    // /module/controller/action uebergeben, Endung wird automatisch
    // hinzugefügt
    return $this->getView()->addJsFile($path);
  }

Dsao_Controller_Action::_getModel

(

$

modelClass = null

)

[protected]

Gibt ein angefordertes Modell zurueck.

Wrapper für Dsao_Registry::getModel().

Parameter:

$modelClass

string, Modell-Klasse ohne führendes 'Dsao_Model_'

Rückgabe:

Dsao_Model_Abstract|false, Objekt oder false

Definiert in Zeile 155 der Datei Action.php.

Benutzt Dsao_Registry::getModel().

Wird benutzt von User_RegisterController::activateAction(), News_AdminController::createAction(), Scroll_ScrollController::deleteAction(), News_AdminController::deleteAction(), Game_DeskController::deleteAction(), User_ProfileController::editAction(), Game_DeskController::editAction(), User_RegisterController::emailAction(), getModuleNavigation(), Hero_Dsa3Controller::heronameAction(), User_RegisterController::insertAction(), Hero_Dsa3Controller::insertAction(), Game_DeskController::insertAction(), User_LoginController::loginAction(), User_LoginController::logoutAction(), User_LoginController::passwordAction(), Game_DeskController::preDispatch(), Scroll_ScrollController::sendAction(), Scroll_ThreadController::showAction(), Scroll_OverviewController::showAction(), Game_DeskController::showAction(), News_IndexController::showAction(), About_SitemapController::showAction(), News_AdminController::updateAction() und User_RegisterController::usernameAction().

  {
    return Dsao_Registry::getModel
      ((null === $modelClass ? $this->_modelClassDefault : $modelClass));
  }

Dsao_Controller_Action::_gotoSimple	(	$	action,
		$	controller = null,
		$	module = null,
		array $	parameters = array(),
		$	exit = true
	)			[protected]

Wrapper für die einfache Umleitung auf eine andere Seite.

Parameter:

	$action	string, Aktion
	$controller	string, Controller
	$module	string, Modul
	$parameters	array Parameter des URI
	$exit	bool, ob direkt umgeleitet werden soll

Rückgabe:

void

Definiert in Zeile 171 der Datei Action.php.

Benutzt getHelper().

Wird benutzt von User_RegisterController::confirmAction(), User_RegisterController::emailAction(), User_RegisterController::insertAction(), Game_DeskController::insertAction(), User_LoginController::loginAction(), User_LoginController::logoutAction(), User_RegisterController::passwordAction(), User_RegisterController::preDispatch() und User_RegisterController::usernameAction().

  {
    $this->getHelper('Redirector')->setExit($exit)
      ->gotoSimple($action, $controller, $module, $parameters);
  }

Dsao_Controller_Action::_initHelpers

(

)

[protected]

Initialisiert Helper.

Rückgabe:

void

Definiert in Zeile 182 der Datei Action.php.

Wird benutzt von __construct().

  {
    // Falls dies nicht der erste instanziierte Controller ist
    if (0 !== Zend_Controller_Action_HelperBroker::getStack()->count())
    {
      return;
    }

    // Action-Helper initialisieren
    Zend_Controller_Action_HelperBroker::addPrefix
      ('Dsao_Controller_Action_Helper');

    // Zur Reihenfolge: alle Methoden werden in umgekehrter Reihenfolge
    // ausgeführt

    // Renderer (nach unten, damit postDispatch() als letztes ausgeführt wird)
    Zend_Controller_Action_HelperBroker::getStaticHelper('Renderer');

    // Garbage-Collector (nach unten, da unwichtig und ohne Abhängigkeiten)
    Zend_Controller_Action_HelperBroker::getStaticHelper('GarbageCollector');

    // Menü-Erstellung (braucht Benutzerobjekt)
    Zend_Controller_Action_HelperBroker::getStaticHelper('Menu');

    // History (braucht Benutzerobjekt)
    $this->_helpersArray['History'] =
      Zend_Controller_Action_HelperBroker::getStaticHelper('History');

    // Translator (braucht Benutzerobjekt)
    $this->_helpersArray['Translate'] =
      Zend_Controller_Action_HelperBroker::getStaticHelper('Translator');

    // Berechtigungsverwaltung (braucht Benutzerobjekt)
    Zend_Controller_Action_HelperBroker::getStaticHelper('AccessControl');

    // Authentifizierung (keine Abhängigkeiten, möglichst weit oben, da
    // spätere Änderungen auf das Benutzerobjekt keine Wirkung mehr haben)
    Zend_Controller_Action_HelperBroker::getStaticHelper('Auth');

    // Session Tokens (braucht URI-Objekt)
    $this->_helpersArray['SessionToken'] =
      Zend_Controller_Action_HelperBroker::getStaticHelper('SessionToken');

    // URI (kann nach oben, da es keine Abhängigkeiten hat und nur init())
    $this->_helpersArray['Uri'] =
      Zend_Controller_Action_HelperBroker::getStaticHelper('Uri');
  }

Dsao_Controller_Action::_setDefaultModelClass

(

$

modelClass

)

[protected]

Setzt die Standardmodellklasse.

Parameter:

$modelClass

string, Modellklasse, ohne führendes 'Dsao_Model_'

Rückgabe:

Dsao_Controller_Abstract, fließendes Interface

Definiert in Zeile 236 der Datei Action.php.

Wird benutzt von User_RegisterController::preDispatch(), User_ProfileController::preDispatch(), User_LoginController::preDispatch(), Scroll_ThreadController::preDispatch(), Scroll_ScrollController::preDispatch(), Scroll_OverviewController::preDispatch(), News_AdminController::preDispatch(), Hero_Dsa3Controller::preDispatch(), Game_DeskController::preDispatch(), News_IndexController::preDispatch() und About_SitemapController::preDispatch().

  {
    $this->_modelClassDefault = $modelClass;

    return $this;
  }

Dsao_Controller_Action::forward	(	$	action,
		$	controller = null,
		$	module = null,
		array $	parameters = array()
	)

Interne Weiterleitung.

Parameter:

	$action	string, Aktion
	$controller	string, Controller
	$module	string, Modul
	$parameters	array, Parameter

Definiert in Zeile 251 der Datei Action.php.

  {
    $this->_forward($action, $controller, $module, $parameters);
  }

Dsao_Controller_Action::getConfig

(

)

[final]

Gibt Konfiguration zurück.

Rückgabe:

Dsao_Config, Konfiguration

Definiert in Zeile 261 der Datei Action.php.

  {
    return $this->_config;
  }

Dsao_Controller_Action::getHelper

(

$

helperName

)

[final]

Gibt Helper mit übergebenem Namen zurück.

Parameter:

$helperName

string, Helper-Name

Rückgabe:

Zend_Controller_Action_Helper_Abstract, Helper

Definiert in Zeile 272 der Datei Action.php.

Wird benutzt von _gotoSimple(), Scroll_ScrollController::deleteAction(), Game_DeskController::deleteAction(), User_ProfileController::editAction(), Game_DeskController::editAction(), getTranslate(), getUri(), Game_DeskController::insertAction(), User_LoginController::logoutAction(), User_LoginController::passwordAction(), ErrorController::postDispatch(), News_IndexController::preDispatch(), IndexController::preDispatch(), About_SitemapController::preDispatch(), About_MastheadController::preDispatch(), Scroll_ScrollController::sendAction(), Scroll_ThreadController::showAction() und Game_DeskController::showAction().

  {
    $helperName = (string) $helperName;

    // Falls Helper noch nicht in Array vorhanden
    if (!isset($this->_helpersArray[$helperName]))
    {
      // Falls Helper-Broker noch nicht initialisiert
      if (null === $this->_helper)
      {
        // Bei der Instanziierung des Helper-Brokers werden alle Helper
        // neu initialisiert, allerdings ist während dessen das $_helper-
        // Objekt des Controllers leer. Also müssen wir über diesen Umweg
        // an die Helper herankommen.
        // Es werden nur schon vorhandene zurückgegeben, da ansonsten keine
        // Bindung an den Controller gegeben wäre
        $this->_helpersArray[$helperName] =
          Zend_Controller_Action_HelperBroker::getExistingHelper($helperName);
      }
      else
      {
        $this->_helpersArray[$helperName] = $this->_helper
          ->getHelper($helperName);
      }
    }

    return $this->_helpersArray[$helperName];
  }

Dsao_Controller_Action::getLog

(

)

[final]

Gibt Logger zurück.

Rückgabe:

Dsao_Log, Logger

Definiert in Zeile 306 der Datei Action.php.

Wird benutzt von User_RegisterController::activateAction(), News_AdminController::createAction(), Scroll_ScrollController::deleteAction(), News_AdminController::deleteAction(), Game_DeskController::deleteAction(), User_ProfileController::editAction(), Game_DeskController::editAction(), User_RegisterController::emailAction(), ErrorController::exceptionAction(), Hero_Dsa3Controller::heronameAction(), User_RegisterController::insertAction(), Hero_Dsa3Controller::insertAction(), User_LoginController::loginAction(), User_RegisterController::passwordAction(), User_LoginController::passwordAction(), ErrorController::postDispatch(), Scroll_ScrollController::sendAction(), Scroll_ThreadController::showAction(), Scroll_OverviewController::showAction(), News_AdminController::updateAction() und User_RegisterController::usernameAction().

  {
    return $this->_log;
  }

Dsao_Controller_Action::getModuleNavigation

(

)

Gibt die Navigation des aufgerufenen Moduls zurück.

Rückgabe:

array, Navigation

Definiert in Zeile 316 der Datei Action.php.

Benutzt _getModel().

  {
    return $this->_getModel()->getModuleNavigation();
  }

Dsao_Controller_Action::getTranslate

(

)

[final]

Gibt Sprachverwaltung zurück.

Rückgabe:

Zend_Translate, Sprachverwaltung

Definiert in Zeile 326 der Datei Action.php.

Benutzt getHelper().

Wird benutzt von User_ProfileController::editAction() und Game_DeskController::showAction().

  {
    return $this->getHelper('Translate')->getTranslate();
  }

Dsao_Controller_Action::getUri

(

)

[final]

Gibt URI zurück.

Rückgabe:

Dsao_Uri_Http, URI

Definiert in Zeile 336 der Datei Action.php.

Benutzt getHelper().

Wird benutzt von User_RegisterController::activateAction(), User_RegisterController::confirmAction(), Scroll_ScrollController::deleteAction(), News_AdminController::deleteAction(), Game_DeskController::deleteAction(), Game_DeskController::editAction(), User_LoginController::loginAction(), User_LoginController::passwordAction(), User_ProfileController::showAction(), Scroll_ThreadController::showAction(), About_SitemapController::showAction() und News_AdminController::updateAction().

  {
    return $this->getHelper('Uri')->getUri();
  }

Dsao_Controller_Action::getUser

(

)

[final]

Gibt das Objekt des angemeldeten Benutzers zurück.

Rückgabe:

Dsao_User, Angemeldeter Benutzer

Definiert in Zeile 346 der Datei Action.php.

Wird benutzt von Scroll_ScrollController::deleteAction(), Game_DeskController::deleteAction(), User_ProfileController::editAction(), Game_DeskController::editAction(), Hero_Dsa3Controller::heronameAction(), Game_DeskController::insertAction(), Scroll_ScrollController::sendAction(), User_ProfileController::showAction(), Scroll_ThreadController::showAction() und Scroll_OverviewController::showAction().

  {
    return $this->_user;
  }

Dsao_Controller_Action::getView

(

)

[final]

Gibt Objekt der View-Komponente zurück.

Rückgabe:

Dsao_View_Smarty, Smarty-Objekt

Definiert in Zeile 356 der Datei Action.php.

Wird benutzt von _addJsFile(), User_RegisterController::activateAction(), User_RegisterController::confirmAction(), News_AdminController::createAction(), Scroll_ScrollController::deleteAction(), News_AdminController::deleteAction(), Game_DeskController::deleteAction(), User_ProfileController::editAction(), Game_DeskController::editAction(), User_RegisterController::emailAction(), Hero_Dsa3Controller::heronameAction(), User_RegisterController::insertAction(), Hero_Dsa3Controller::insertAction(), User_LoginController::loginAction(), User_ProfileController::postDispatch(), Scroll_ScrollController::sendAction(), Scroll_ThreadController::showAction(), Scroll_OverviewController::showAction(), Game_DeskController::showAction(), News_IndexController::showAction(), About_SitemapController::showAction(), News_AdminController::updateAction() und User_RegisterController::usernameAction().

  {
    return $this->_smarty;
  }

Dsao_Controller_Action::init

(

)

[final]

Initialisierung des Controllers.

Die Methode initialisiert u.a. Smarty und die Sprachverwaltung.

Rückgabe:

void

Definiert in Zeile 368 der Datei Action.php.

Benutzt isXmlHttpRequest().

  {
    // Smarty instanziieren (braucht Translator)
    $this->_smarty = new Dsao_View_Smarty($this->isXmlHttpRequest());

    // Falls Ajax-Anfrage
    if ($this->isXmlHttpRequest())
    {
      // Falls bei der Anfrage eine Callback-Funktion uebergeben wurde
      if ($this->_request->getParam('callbackHandler'))
      {
        $this->_smarty->getAjaxResponse()->setCallbackHandler
          ($this->_request->getParam('callbackHandler'));
      }
    }
  }

Dsao_Controller_Action::isXmlHttpRequest

(

)

Wrapper für Zend_Controller_Request_Http::isXmlHttpRequest().

Rückgabe:

bool, ob Ajax-Anfrage vorliegt

Definiert in Zeile 390 der Datei Action.php.

Wird benutzt von Game_DeskController::deleteAction(), Game_DeskController::editAction(), init(), Game_DeskController::insertAction() und Game_DeskController::showAction().

  {
    // Falls Eigenschaft noch nicht initialisiert
    if (null === $this->_isXmlHttpRequest)
    {
      $this->_isXmlHttpRequest = $this->_request->isXmlHttpRequest();
    }

    return (bool) $this->_isXmlHttpRequest;
  }

Dsao_Controller_Action::postDispatch

(

)

Abschließende Routinen.

Rückgabe:

void

Erneute Implementation in ErrorController, Hero_Dsa3Controller, User_ProfileController und User_RegisterController.

Definiert in Zeile 406 der Datei Action.php.

  {}

Dsao_Controller_Action::preRedirect

(

)

Vor dem Weiterleiten auszuführende Controllerlogik.

Kann vom Controller ueberladen werden, um vor dem Ausfuehren einer Weiterleitung ausgefuehrt zu werden.

Rückgabe:

void

Definiert in Zeile 423 der Datei Action.php.

  {}

Dsao_Controller_Action::setUser

(

Dsao_User $

user

)

Setzt Benutzerobjekt.

Parameter:

$user

Dsao_User, Angemeldeter Benutzer

Rückgabe:

void

Definiert in Zeile 432 der Datei Action.php.

  {
    $this->_user = $user;
  }

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• /var/www/devel.dsao.eu/library/Dsao/Controller/Action.php