Dsao_Module_Menu_Group Klassenreferenz

Repräsentiert eine Menügruppe. Mehr ...

Aufstellung aller Elemente

Öffentliche Methoden
	__construct ($label=null, array $uriArray=array())
	Setzt Eigenschaften.
	__toString ()
	PHP-Stringumwandlung.
	addUri ($uri)
	Fügt ein Kindelement hinzu.
	getLabel ()
	Gibt Message-ID zurück.
	removeUri ($uri)
	Entfernt URI.
	setFromArray (array $array=array())
	Setzt URI-Array.
	setLabel ($label)
	Setzt Beschriftung der Gruppe.
	toArray ()
	Gibt einen Array aller enthaltener Elemente zurück.
	toString ()
	Gibt Beschreibung des Menüpunkts zurück.
Geschützte Attribute
	$_label = null
	string, Message-ID der Gruppenbeschreibung (ohne 'menu_' am Anfang)
	$_uriArray = null
	array, Array mit zu der Gruppe gehörenden URIs

---

Ausführliche Beschreibung

Repräsentiert eine Menügruppe.

Jedes Modul kann eine beliebige Anzahl von Menügruppen definieren, die wiederum aus einer beliebigen Gruppe von URIs bestehen kann.

Autor:

DSAo-Md

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

Version:

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

Definiert in Zeile 12 der Datei Group.php.

---

Beschreibung der Konstruktoren und Destruktoren

Dsao_Module_Menu_Group::__construct	(	$	label = null,
		array $	uriArray = array()
	)

Setzt Eigenschaften.

Parameter:

	$label	string, Linkbeschreibung
	$depth	int, Menütiefe

Rückgabe:

void

Definiert in Zeile 31 der Datei Group.php.

Benutzt setFromArray().

  {
    // Falls eine Beschriftung übergeben wurde
    if (null != $label)
    {
      $this->_label = 'menu_'.(string) $label;
    }

    // URIs setzen
    $this->setFromArray($uriArray);
  }

---

Dokumentation der Elementfunktionen

Dsao_Module_Menu_Group::__toString

(

)

PHP-Stringumwandlung.

Rückgabe:

string, Beschreibung

Definiert in Zeile 48 der Datei Group.php.

Benutzt toString().

  {
    return $this->toString();
  }

Dsao_Module_Menu_Group::addUri

(

$

uri

)

Fügt ein Kindelement hinzu.

Parameter:

$uri

Dsao_Module_Menu_Item, Kindelement

Rückgabe:

Dsao_Module_Menu_Item, fließendes Interface

Definiert in Zeile 59 der Datei Group.php.

Wird benutzt von setFromArray().

  {
    // Falls bereits Objekt übergeben wurde
    if ($uri instanceof Dsao_Uri_Http)
    {
      $this->_uriArray[$uri->toString(false)] = $uri;
    }
    else
    {
      $uri = (string) $uri;

      $this->_uriArray[$uri] = new Dsao_Uri_Http($uri);
    }

    return $this;
  }

Dsao_Module_Menu_Group::getLabel

(

)

[final]

Gibt Message-ID zurück.

Rückgabe:

string, Message-ID

Definiert in Zeile 81 der Datei Group.php.

  {
    return $this->_label;
  }

Dsao_Module_Menu_Group::removeUri

(

$

uri

)

Entfernt URI.

Parameter:

$uri

string, URI

Rückgabe:

Dsao_Module_Menu_Group, fließendes Interface

Definiert in Zeile 92 der Datei Group.php.

  {
    $uri = (string) $uri;

    // Falls URI vorhanden
    if (isset($this->_uriArray[$uri]))
    {
      unset($this->_uriArray[$uri]);
    }

    return $this;
  }

Dsao_Module_Menu_Group::setFromArray

(

array $

array = array()

)

Setzt URI-Array.

Parameter:

$uriArray

array, URIs

Rückgabe:

Dsao_Module_Menu_Group, fließendes Interface

Definiert in Zeile 111 der Datei Group.php.

Benutzt addUri().

Wird benutzt von __construct().

  {
    $this->_uriArray = array();

    // URIs durchgehen und hinzufügen
    foreach ($array as $uri)
    {
      $this->addUri($uri);
    }

    return $this;
  }

Dsao_Module_Menu_Group::setLabel

(

$

label

)

Setzt Beschriftung der Gruppe.

Parameter:

$label

string, Beschriftung

Rückgabe:

Dsao_Module_Menu_Group, fließendes Interface

Definiert in Zeile 130 der Datei Group.php.

  {
    $this->_label = 'menu_'. (string) $label;

    return $this;
  }

Dsao_Module_Menu_Group::toArray

(

)

Gibt einen Array aller enthaltener Elemente zurück.

Rückgabe:

array, Menü

Definiert in Zeile 142 der Datei Group.php.

  {
    return $this->_uriArray;
  }

Dsao_Module_Menu_Group::toString

(

)

Gibt Beschreibung des Menüpunkts zurück.

Rückgabe:

string, Beschreibung

Definiert in Zeile 152 der Datei Group.php.

Wird benutzt von __toString().

  {
    return (string) $this->_label;
  }

---

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

• /var/www/devel.dsao.eu/library/Dsao/Module/Menu/Group.php