Dsao_Translate_Adapter_Array Klassenreferenz

Erweitert den Array-Adapter der Zend_Translate-Komponente um einige nützliche Methoden. Mehr ...

Aufstellung aller Elemente

Öffentliche Methoden
	_ ($idMessage, $locale=null)
	Wrapper für Zend_Translate_Adapter::_(), der ggf.
	addLayoutTranslationData ($layout)
	Lädt Sprachdateien für das Layout.
	getList ()
	Gibt eine Liste der verfügbaren Sprachen zurück.
	isAvailable ($locale)
	Prüft, ob übergeben Sprache verfügbar ist.
	setLocale ($locale)
	Setzt Sprache.
Geschützte Methoden
	_lazyLoadTranslationData ($idMessage, $locale)
	Lädt Sprachdateien nach.
	_loadTranslationData ($data, $locale, array $options=array())
	Lädt Sprachdatei und bindet als Array zurückzugebende Daten ein.
Geschützte Attribute
	$_localeList = null
	array, Liste der vorhandenen Sprachen

---

Ausführliche Beschreibung

Erweitert den Array-Adapter der Zend_Translate-Komponente um einige nützliche Methoden.

Autor:

DSAo-Md

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

Version:

SVN: $Id: Array.php 505 2009-05-03 20:57:48Z saviola777 $

Definiert in Zeile 10 der Datei Array.php.

---

Dokumentation der Elementfunktionen

Dsao_Translate_Adapter_Array::_	(	$	idMessage,
		$	locale = null
	)

Wrapper für Zend_Translate_Adapter::_(), der ggf.

Sprachdateien nachlädt.

Parameter:

	$idMessage	int, Message-ID
	$locale	string, Sprache

Rückgabe:

string, Übersetzung oder unübersetzte ID

Definiert in Zeile 137 der Datei Array.php.

Benutzt _lazyLoadTranslationData().

  {
    // Ggf. Standardsprache benutzen
    if (null == $locale)
    {
      $locale = $this->_options['locale'];
    }

    // Falls ID nicht übersetzt, versuchen, diese nachzuladen
    if (!isset($this->_translate[$locale][$idMessage]))
    {
      // Versuchen, Übersetzung nach zu laden
      $this->_lazyLoadTranslationData($idMessage, $locale);
    }

    return parent::_($idMessage, $locale);
  }

Dsao_Translate_Adapter_Array::_lazyLoadTranslationData	(	$	idMessage,
		$	locale
	)			[protected]

Lädt Sprachdateien nach.

Parameter:

	$idMessage	string, Message-ID
	$locale	string, Sprache

Rückgabe:

bool, ob Übersetzung gefunden wurde

Definiert in Zeile 24 der Datei Array.php.

Benutzt _loadTranslationData() und isAvailable().

Wird benutzt von _().

  {
    // Falls Sprache nicht verfügbar
    if (!$this->isAvailable($locale))
    {
      // Auf eingestellte Sprache wechseln (die auf jeden Fall existiert, s.u.)
      $locale = $this->getLocale();
    }

    // Message-ID auseinander pfluecken

    // array, die ersten beiden Teile des Message-ID, die ggf. Aufschluss über
    // Modul und Controller geben sollen, deren Sprachdateien nachgeladen
    // werden müssen
    $arrayMessage = explode('_', $idMessage, 3);

    // Modul prüfen

    // Falls erster Teil übersetzt werden kann, ist die Sprachdatei des Moduls
    // bereits geladen und es bedarf keiner weiteren Untersuchungen
    if (!isset($this->_translate[$locale][$arrayMessage[0]]))
    {
      // string, Dateiname der Sprachdatei des Moduls
      $fileModule = BASE_DIR.'lang/'.$locale.'/'.$arrayMessage[0].'.php';

      // Versuchen, Datei einzubinden und bei Misserfolg abbrechen, da es
      // dann natürlich keinen Sinn macht, noch zu versuchen, die
      // Sprachdatei des Controllers zu laden
      if (!$this->_loadTranslationData($fileModule, $locale))
      {
        return false;
      }
      // Falls das gereicht hat, um die ID zu übersetzen, abbrechen
      else if (isset($this->_translate[$locale][$idMessage]))
      {
        return true;
      }
    }

    // Controller einbinden

    // Hier ergibt sich jetzt ein Problem, da wir nicht wirklich prüfen können,
    // ob die Sprachdatei des Controllers (sofern es überhaupt ein gültiger
    // Controller ist) schon eingebunden wurde.
    // Also einfach auf gut Glück versuchen, die beiden Dateien einzubinden

    // string, Dateinamen der Sprachdateien des Controllers (PHP/Template)
    $fileControllerPhp = BASE_DIR.'lang/'.$locale.'/php/'.$arrayMessage[0].
      '/'.$arrayMessage[1].'.php';
    $fileControllerTemplate = BASE_DIR.'lang/'.$locale.'/template/'.
    $arrayMessage[0].'/'.$arrayMessage[1].'.php';


    // Dateien einbinden
    $this->_loadTranslationData($fileControllerPhp, $locale);
    $this->_loadTranslationData($fileControllerTemplate, $locale);


    // Kann die ID nun übersetzt werden?
    return isset($this->_translate[$locale][$idMessage]);
  }

Dsao_Translate_Adapter_Array::_loadTranslationData	(	$	data,
		$	locale,
		array $	options = array()
	)			[protected]

Lädt Sprachdatei und bindet als Array zurückzugebende Daten ein.

Unterschied zur überladenen Methode ist, dass die neuen Inhalte direkt eingebunden werden und keine Exception geworfen wird, wenn eine Datei nicht geöffnet werden kann.

Parameter:

	$data	array|string, Dateiname / Array mit Zeichenketten
	$locale	string|Zend_Locale, Sprache
	$options	array, Optionen

Rückgabe:

array, hinzugefügte Übersetzungen

Definiert in Zeile 98 der Datei Array.php.

Wird benutzt von _lazyLoadTranslationData() und addLayoutTranslationData().

  {
    // Falls kein Array übergeben wurde, soll eine Datei geladen werden
    if (!is_array($data))
    {
        // Falls Datei vorhanden
        if (file_exists($data))
        {
            // Ausgabe verhindern und Datei einbinden, sofern sie nicht schon
            // eingebunden wurde
            ob_start();
            // Das ganze ist hier etwas unsauber und erklärungsbedürftig:
            // Wenn eine Datei übergeben wurde, müssen wir verhindern, dass
            // diese direkt an die u.g. Methode der Elternklasse übergeben
            // wird, da sonst ggf. eine Exception geworfen würde und Dateien
            // auch doppelt eingebunden werden können. Hier wird nun die Datei
            // erst eingebunden und dann der Array an addTranslation()
            // übergeben, damit die Übersetzungen ordnungsgemäß hinzugefügt
            // werden können
            return $this->addTranslation((array) include_once($data), $locale);
            ob_end_clean();
        }
        // Ansonsten leeren Array zurück geben
        else
        {
          return array();
        }
    }

    return parent::_loadTranslationData($data, $locale, $options);
  }

Dsao_Translate_Adapter_Array::addLayoutTranslationData

(

$

layout

)

Lädt Sprachdateien für das Layout.

Parameter:

$layout

string, Layout, dessen Sprachdatei geladen werden soll

Rückgabe:

bool, ob Sprachdatei hinzugefügt wurde

Definiert in Zeile 161 der Datei Array.php.

Benutzt _loadTranslationData().

  {
    // Absoluter Pfad zur Sprachdatei des Layouts
    $fileLayoutTranslation = BASE_DIR.'lang/'.
      $this->_options['locale'].'/layout/'.$layout.'.php';

    // Sprachdatei laden
    return $this->_loadTranslationData
      ($fileLayoutTranslation, $this->_options['locale']);
  }

Dsao_Translate_Adapter_Array::getList

(

)

Gibt eine Liste der verfügbaren Sprachen zurück.

Da das Adapter in der Lage ist, noch nicht vorhandene Übersetzungen nachzuladen, gehen wir hierbei nicht von den bereits vorhandenen Übersetzungen aus, sondern von den Ordnern in /lang/ aus.

Rückgabe:

array, Sprachen

Definiert in Zeile 181 der Datei Array.php.

Wird benutzt von isAvailable().

  {
    // Falls Liste noch nicht initialisiert wurde
    if (null === $this->_localeList)
    {
      // Liste erstellen
      $this->_localeList = array();

      // Verzeichnis mit Sprachen
      $directory = new DirectoryIterator(BASE_DIR.'lang/');

      // Dateien und Verzeichnisse durchgehen
      foreach ($directory as $file)
      {
        // Falls Element Verzeichnis, dessen Name eine Sprache darstellt,
        // zur Liste hinzufügen
        if (!$file->isDot()
            && $file->isDir()
            && Zend_Locale::isLocale($file->getFilename()))
        {
          $this->_localeList[] = $file->getFilename();
        }
      }
    }

    return $this->_localeList;
  }

Dsao_Translate_Adapter_Array::isAvailable

(

$

locale

)

Prüft, ob übergeben Sprache verfügbar ist.

Parameter:

$locale

string, Sprache

Rückgabe:

bool, Verfügbarkeit der Sprache

Definiert in Zeile 215 der Datei Array.php.

Benutzt getList().

Wird benutzt von _lazyLoadTranslationData() und setLocale().

  {
    // Sofern bereits Übersetzungen der geforderten Sprache vorhanden sind,
    // true zurückgeben, ansonsten prüfen, ob Sprache geladen werden könnte
    return (parent::isAvailable($locale) ? true :
      in_array($locale, $this->getList()));
  }

Dsao_Translate_Adapter_Array::setLocale

(

$

locale

)

Setzt Sprache.

Unterbindet Exception bei nicht verfügbarer Sprache und setzt vorhandene Sprache.

Parameter:

$locale

string, Sprache

Rückgabe:

Dsao_Translate_Adapter_Array, fließendes Interface

Definiert in Zeile 232 der Datei Array.php.

Benutzt isAvailable().

  {
    // Falls Sprache nicht verfügbar ist, auf Standard setzen
    if (!$this->isAvailable($locale))
    {
      $locale = array_keys(Zend_Locale::getDefault());
      $locale = $locale[0];
    }

    parent::setLocale($locale);
  }

---

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

• /var/www/devel.dsao.eu/library/Dsao/Translate/Adapter/Array.php