Dsao_Module_Broker Klassenreferenz

Modulverwaltung (Singleton). Mehr ...

Aufstellung aller Elemente

Öffentliche Methoden
	getModule ($name)
	Gibt Modul zurück.
	getModules ($namesOnly=false)
	Gibt alle Module zurück.
	getModulesActive ($namesOnly=false)
	Gibt aktive Module zurück.
	getModulesNotActive ($namesOnly=false)
	Gibt nicht aktive Module zurück.
Öffentliche, statische Methoden
static	getInstance ()
	Gibt Singleton-Instanz der Modulverwaltung zurück.
Öffentliche Attribute
const	XML_MODULE_INFO_DIR = 'modules/meta/info'
	string, Verzeichnis mit Modulinformationen
Geschützte Methoden
	__construct ()
	Lädt Module und Menüs aus Datenbank.
Geschützte Attribute
	$_modulesActive = array()
	array, Array mit aktivierten Modulen; Index ist Modulname
	$_modulesNotActive = array()
	array, Array mit nicht aktiven Modulen
Statische geschützte Attribute
static	$_instance = null
	Dsao_Module_Broker|null, Singleton-Instanz.

---

Ausführliche Beschreibung

Modulverwaltung (Singleton).

Der Modulmanager lädt Module und deren Navigation aus der Datenbank.

Autor:

DSAo-Md

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

Version:

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

Definiert in Zeile 11 der Datei Broker.php.

---

Beschreibung der Konstruktoren und Destruktoren

Dsao_Module_Broker::__construct

(

)

[protected]

Lädt Module und Menüs aus Datenbank.

Rückgabe:

void

Definiert in Zeile 38 der Datei Broker.php.

  {
    $modulesLoader = new Dsao_Xml_Loader(XML_DIR.self::XML_MODULE_INFO_DIR);

    // Module durchgehen
    foreach ($modulesLoader->getXmlObjects() as $object)
    {
      // Modul instanziieren
      $module = new Dsao_Module($object->name, (bool) $object->active);

      // Zu internen Arrays hinzufügen
      if ($module->isActive())
      {
        $this->_modulesActive[$module->getName()] = $module;
      }
      else
      {
        $this->_modulesNotActive[$module->getName()] = $module;
      }
    }
  }

---

Dokumentation der Elementfunktionen

static Dsao_Module_Broker::getInstance

(

)

[static]

Gibt Singleton-Instanz der Modulverwaltung zurück.

Rückgabe:

Dsao_Module_Broker, Singleton-Instanz

Definiert in Zeile 65 der Datei Broker.php.

Wird benutzt von Dsao_Module_Menu::__construct() und Dsao_Constructor_Acl::getObject().

  {
    // Falls Instanz noch nicht initialisiert
    if (null === self::$_instance)
    {
      $cacheLoader = new Dsao_Cache_Loader('File',
        array('automatic_serialization' => true,
              'master_files' => array(XML_DIR.self::XML_MODULE_INFO_DIR)));
      $cache = $cacheLoader->getCache();

      // Falls Modulmanager nicht im Cache vorhanden
      if (!(self::$_instance = $cache->load('moduleBroker')))
      {
        self::$_instance = new self();

        // Alle von den Modulen abhängigen Cache-Einträge entfernen
        $cache->clean(Zend_Cache::CLEANING_MODE_MATCHING_TAG, array('module'));

        $cache->save(self::$_instance, 'moduleBroker');
      }
    }

    return self::$_instance;
  }

Dsao_Module_Broker::getModule

(

$

name

)

Gibt Modul zurück.

Parameter:

$name

string, Modulname

Rückgabe:

Dsao_Module, Modul

Definiert in Zeile 96 der Datei Broker.php.

  {
    $name = (string) $name;

    // Falls Modul aktives Modul
    if (isset($this->_modulesActive[$name]))
    {
      return $this->_modulesActive[$name];
    }
    // Falls Modul nicht aktives Modul
    else if (isset($this->_modulesNotActive[$name]))
    {
      return $this->_modulesNotActive[$name];
    }
    // Ansonsten ist Modul nicht vorhanden, Exception werfen
    else
    {
      throw new Dsao_Exception(array(
        'message' => 'dsao_module_manager_invalid_module',
        'variables' => array('name' => $name)
      ));
    }
  }

Dsao_Module_Broker::getModules

(

$

namesOnly = false

)

Gibt alle Module zurück.

Rückgabe:

array, Module

Definiert in Zeile 125 der Datei Broker.php.

  {
    return $namesOnly
    ? array_keys(array_merge($this->_modulesActive, $this->_modulesNotActive))
    : array_merge($this->_modulesActive, $this->_modulesNotActive);
  }

Dsao_Module_Broker::getModulesActive

(

$

namesOnly = false

)

Gibt aktive Module zurück.

Rückgabe:

array, Module

Definiert in Zeile 137 der Datei Broker.php.

  {
    return $namesOnly ? array_keys($this->_modulesActive)
      : $this->_modulesActive;
  }

Dsao_Module_Broker::getModulesNotActive

(

$

namesOnly = false

)

Gibt nicht aktive Module zurück.

Rückgabe:

array, Module

Definiert in Zeile 148 der Datei Broker.php.

  {
    return $namesOnly ? array_keys($this->_modulesNotActive)
      : $this->_modulesNotActive;
  }

---

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

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