Dsao_Module Klassenreferenz

Ein Modul. Mehr ...

Aufstellung aller Elemente

Öffentliche Methoden
	__construct ($name, $active=true)
	Konstruktor.
	getMenu ()
	Gibt Menü zurück.
	getName ()
	Gibt Namen zurück.
	isActive ()
	Gibt zurück, ob das Modul aktiv ist.
	setActive ($active=true)
	Setzt Status des Moduls.
	setName ($name)
	Setzt den Namen des Moduls.
Geschützte Attribute
	$_active = null
	bool, aktiv?
	$_name = null
	string, Name

---

Ausführliche Beschreibung

Ein Modul.

Autor:

DSAo-Md

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

Version:

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

Definiert in Zeile 9 der Datei Module.php.

---

Beschreibung der Konstruktoren und Destruktoren

Dsao_Module::__construct	(	$	name,
		$	active = true
	)

Konstruktor.

Parameter:

	$id	int, Modul-ID
	$name	string, Name
	$active	bool, aktiv?

Rückgabe:

void

Definiert in Zeile 29 der Datei Module.php.

Benutzt setActive() und setName().

  {
    $this->setActive($active);

    $this->setName($name);
  }

---

Dokumentation der Elementfunktionen

Dsao_Module::getMenu

(

)

Gibt Menü zurück.

Rückgabe:

Dsao_Module_Menu_Item, Menü

Ausnahmebehandlung:

Dsao_Exception

Definiert in Zeile 42 der Datei Module.php.

  {
    // Falls Menü noch nicht gesetzt wurde
    if (null === $this->_menu)
    {
      throw new Dsao_Exception('dsao_module_menu_not_set');
    }

    return $this->_menu;
  }

Dsao_Module::getName

(

)

[final]

Gibt Namen zurück.

Rückgabe:

string, Name

Definiert in Zeile 58 der Datei Module.php.

  {
    return $this->_name;
  }

Dsao_Module::isActive

(

)

[final]

Gibt zurück, ob das Modul aktiv ist.

Rückgabe:

bool, aktiv?

Definiert in Zeile 68 der Datei Module.php.

  {
    return $this->_active;
  }

Dsao_Module::setActive

(

$

active = true

)

[final]

Setzt Status des Moduls.

Parameter:

$active

bool, ob Modul aktiv ist

Rückgabe:

Dsao_Module, fließendes Interface

Definiert in Zeile 79 der Datei Module.php.

Wird benutzt von __construct().

  {
    $this->_active = (bool) $active;

    return $this;
  }

Dsao_Module::setName

(

$

name

)

[final]

Setzt den Namen des Moduls.

Parameter:

$name

string, Modulname

Rückgabe:

Dsao_Module, fließendes Interface

Definiert in Zeile 92 der Datei Module.php.

Wird benutzt von __construct().

  {
    $this->_name = $name;

    return $this;
  }

---

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

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