Dsao_Config_Loader Klassenreferenz

Konfigurationsverwaltung. Mehr ...

Aufstellung aller Elemente

Öffentliche Methoden
	__construct ($filenameConfig, $dirCache, $section=null)
	Initialisiert Klassenvariablen.
	__get ($property)
	Konfigurationen einlesen.
	getConfig ()
	Gibt die Konfiguration zurück.
Geschützte Methoden
	_cacheConfig ()
	Versucht, die Konfiguration serialisiert zwischen zu speichern.
	_loadCachedConfig ()
	Versucht, die serialisierte Konfiguration aus einer Datei zu laden.
Geschützte Attribute
	$_config = null
	Zend_Config_Ini, Konfigurationsobjekt.
	$_dirCache = null
	string, Vollständiger Pfad zur cached-Konfiguration, sofern vorhanden
	$_filenameCache = null
	string, Datei, die serialisierte Konfiguration enthält
	$_filenameConfig = null
	string, Vollständiger Pfad zur Konfigurationsdatei
	$_section = null
	string, Zu ladende Konfigurationssektion

---

Ausführliche Beschreibung

Konfigurationsverwaltung.

Autor:

DSAo-Md

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

Version:

SVN: $Id: Loader.php 510 2009-05-29 20:04:37Z bregnitzhof $

Definiert in Zeile 9 der Datei Loader.php.

---

Beschreibung der Konstruktoren und Destruktoren

Dsao_Config_Loader::__construct	(	$	filenameConfig,
		$	dirCache,
		$	section = null
	)

Initialisiert Klassenvariablen.

Parameter:

	$filenameConfig	string, Konfigurationsdatei
	$dirCache	string, Verzeichnisangabe
	$section	string, Zu ladende Sektion

Rückgabe:

void

Definiert in Zeile 44 der Datei Loader.php.

  {
    // Parameter übernehmen
    $this->_dirCache        = $dirCache;

    // Falls Caching-Verzeichnis nicht les- oder schreibbar
    if (!is_readable($this->_dirCache) || !is_writable($this->_dirCache))
    {
      throw new Dsao_Exception('dsao_config_cache_directory');
    }

    $this->_filenameCache   = $dirCache.'config';
    $this->_filenameConfig  = $filenameConfig;

    // Falls Konfigurationsdatei nicht lesbar
    if (!is_readable($this->_filenameConfig))
    {
      throw new Dsao_Exception('dsao_config_file_not_readable');
    }

    $this->_section         = $section;
  }

---

Dokumentation der Elementfunktionen

Dsao_Config_Loader::__get

(

$

property

)

Konfigurationen einlesen.

Parameter:

$property

string, Konfigurationseigenschaft

Rückgabe:

mixed, Konfigurationswert

Definiert in Zeile 73 der Datei Loader.php.

Benutzt getConfig().

  {
    return $this->getConfig()->$property;
  }

Dsao_Config_Loader::_cacheConfig

(

)

[protected]

Versucht, die Konfiguration serialisiert zwischen zu speichern.

Rückgabe:

bool, Ob zwischenspeichern erfolgreich war

Definiert in Zeile 83 der Datei Loader.php.

Wird benutzt von getConfig().

  {
    // Falls Konfiguration noch nicht initialisiert wurde, abbrechen
    if (null == $this->_config)
    {
      return false;
    }

    // Serialisiertes Objekt in Datei schreiben
    return (bool) @file_put_contents
      ($this->_filenameCache, serialize($this->_config));
  }

Dsao_Config_Loader::_loadCachedConfig

(

)

[protected]

Versucht, die serialisierte Konfiguration aus einer Datei zu laden.

Rückgabe:

null|Zend_Config_Ini, Deserialisierte Konfiguration, oder null

Definiert in Zeile 101 der Datei Loader.php.

Wird benutzt von getConfig().

  {
    // Falls Datei vorhanden, Inhalt laden und deserialisieren
    if (is_file($this->_filenameCache))
    {
      $config =  unserialize($content = file_get_contents($this->_filenameCache));

      // Falls md5 übereinstimmen
      if (md5($content) == $config->config->md5)
      {
        return $config;
      }
      // ansonsten Konfigurationsdatei löschen (damit es nicht zu Problemen
      // kommt, wenn das Caching deaktiviert wurde)
      else
      {
        unlink($this->_filenameCache);
      }
    }

    return null;
  }

Dsao_Config_Loader::getConfig

(

)

Gibt die Konfiguration zurück.

Rückgabe:

Zend_Config_Ini, Konfigurationsobjekt

Definiert in Zeile 129 der Datei Loader.php.

Benutzt _cacheConfig() und _loadCachedConfig().

Wird benutzt von __get().

  {
    // Falls Konfiguration noch nicht initalisiert wurde
    if (null === $this->_config)
    {
      // Falls Konfiguration nicht zwischengespeichert worden ist
      if (!$this->_config = $this->_loadCachedConfig())
      {
        // Standardkonfiguration laden
        $this->_config = new Dsao_Config_Ini
          ($this->_filenameConfig.'.dist', $this->_section, true);
        // Mit lokaler Konfiguration überschreiben
        $this->_config->merge(new Dsao_Config_Ini
          ($this->_filenameConfig, $this->_section));

        // Temporaeres Verzeichnis festlegen
        $this->_config->tempDir = TEMP_DIR;

        // MD5 der Konfigurationsdatei
        $this->_config->config->md5 = md5
          (file_get_contents($this->_filenameConfig));

        // Konfiguration vor Änderungen schützen
        $this->_config->setReadOnly();

        // Falls Konfiguration zwischengespeichert werden soll
        if ($this->_config->config->caching)
        {
          $this->_cacheConfig();
        }
      }
    }

    return $this->_config;
  }

---

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

• /var/www/devel.dsao.eu/library/Dsao/Config/Loader.php