Dsao_Controller_Action_Helper_History Klassenreferenz

Aktion-Helfer, der die Benutzer-History verwaltet. Mehr ...

Aufstellung aller Elemente

Öffentliche Methoden
	getPreviousUri ()
	Gibt URI der letzten aufgerufenen Seite zurück.
	init ()
	Initialisiert ggf.
	postDispatch ()
	Fügt die aktuelle Seite zur History hinzu.
	setAddToHistory ($add=true, $retainParameters=true)
	(De)aktiviert das Hinzufügen der aktuellen Seite zur History.
Geschützte Attribute
	$_addToHistory = 0
	int, ob aktuelle Seite in der Liste zuletzt besuchter Seiten auftauchen soll
	$_namespaceHistory = null
	Zend_Session_Namespace, Session-Namensbereich der History.

---

Ausführliche Beschreibung

Aktion-Helfer, der die Benutzer-History verwaltet.

Autor:

DSAo-Md

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

Version:

SVN: $Id: History.php 512 2009-06-19 08:11:48Z saviola777 $

Definiert in Zeile 9 der Datei History.php.

---

Dokumentation der Elementfunktionen

Dsao_Controller_Action_Helper_History::getPreviousUri

(

)

Gibt URI der letzten aufgerufenen Seite zurück.

Rückgabe:

Dsao_Uri, URI der zuletzt aufgerufenen Seite

Definiert in Zeile 30 der Datei History.php.

  {
    // Falls History nicht vorhanden
    if (null === $this->_namespaceHistory)
    {
      return null;
    }

    return new Dsao_Uri_Http(end(array_keys($this->_namespaceHistory->entries)));
  }

Dsao_Controller_Action_Helper_History::init

(

)

Initialisiert ggf.

den Session-Namensbereich für die History.

Rückgabe:

void

Definiert in Zeile 46 der Datei History.php.

  {
    // Falls Benutzer gültig und History noch nicht initialisiert
    if ($this->getActionController()->getUser()->isValid()
      && null === $this->_namespaceHistory)
    {
      $this->_namespaceHistory = new Zend_Session_Namespace('history');

      // Falls Array mit History-Einträgen noch nicht vorhanden
      if (!isset($this->_namespaceHistory->entries))
      {
        $this->_namespaceHistory->entries = array();
      }
    }
  }

Dsao_Controller_Action_Helper_History::postDispatch

(

)

Fügt die aktuelle Seite zur History hinzu.

Rückgabe:

bool

Definiert in Zeile 67 der Datei History.php.

  {
    // Falls Ajax-Anfrage, Weiterleitung aktiviert, Benutzer nicht
    // angemeldet oder noch Aktionen ausgeführt werden sollen, abbrechen
    if ($this->getActionController()->isXmlHttpRequest()
        || $this->getResponse()->isRedirect()
        || !$this->getActionController()->getUser()->isValid()
        || !$this->getRequest()->isDispatched())
    {
      return;
    }

    // string, Message-ID für die Beschriftung des Links
    $label = null;

    // string, URI der zur aktuellen Seite
    $uri = null;

    // array, Array aus aufgerufenem Modul, Controller und Aktion
    $moduleControllerAction = array
      (
        $this->getRequest()->getModuleName(),
        $this->getRequest()->getControllerName(),
        $this->getRequest()->getActionName(),
      );

    $label = implode('_', $moduleControllerAction);

    // Falls Parameter des Aufrufs beibehalten werden sollen
    if (2 == $this->_addToHistory)
    {
      // Token entfernen
      unset($this->getActionController()->getUri()->token);

      // String
      $uri = $this->getActionController()->getUri()->getUriString();
    }
    // Ansonsten Link aus aktuellem Modul, Controller und Aktion aufbauen
    else
    {
      $uri = $this->getActionController()->getUri()->getUriString(false);
    }

    // Falls ein Eintrag mit der gleichen Beschreibung existiert, diesen
    // löschen
    if (null !== $label && isset($this->_namespaceHistory->entries[$label]))
    {
      unset($this->_namespaceHistory->entries[$label]);
    }

    // Falls History vorhanden
    if (!empty($this->_namespaceHistory->entries))
    {
      $history = array_reverse($this->_namespaceHistory->entries);

      // History-Einträge an Smarty übergeben
      $this->getActionController()->getView()
        ->assign_by_ref('historyEntries', $history);
    }

    // Falls Seite nicht zur History hinzugefügt werden soll, abbrechen
    if (!$this->_addToHistory)
    {
      return false;
    }

    // Eintrag hinzufügen
    $this->_namespaceHistory->entries[$label] = $uri;

    // Falls maximale Anzahl Einträge erreicht ist, ersten Eintrag entfernen
    if (count($this->_namespaceHistory->entries) >
      $this->getActionController()->getConfig()->history->maxEntries)
    {
      array_shift($this->_namespaceHistory->entries);
    }

    return true;
  }

Dsao_Controller_Action_Helper_History::setAddToHistory	(	$	add = true,
		$	retainParameters = true
	)

(De)aktiviert das Hinzufügen der aktuellen Seite zur History.

Parameter:

	$add	bool, Ob Seite zu History hinzugefügt werden soll
	$retainParameters	bool, Ob Parameter des Aufrufs beibehalten werden sollen

Rückgabe:

Dsao_Controller_Abstract, fließendes Interface

Definiert in Zeile 154 der Datei History.php.

  {
    // Falls Seite hinzugefügt, und Parameter behalten werden sollen
    if ($add && $retainParameters)
    {
      $this->_addToHistory = 2;
    }
    else
    {
      $this->_addToHistory = (int) (bool) $add;
    }

    return $this;
  }

---

Dokumentation der Datenelemente

Dsao_Controller_Action_Helper_History::$_addToHistory = 0 [protected]

int, ob aktuelle Seite in der Liste zuletzt besuchter Seiten auftauchen soll

0 = nein; 1 = ja; 2 = ja, und Parameter beibehalten.

Definiert in Zeile 18 der Datei History.php.

---

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

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