Dsao_DataHandler_Abstract Klassenreferenz

Abstrakte Klasse, die ein ArrayObject mit Daten und eine entsprechende API zur Verwaltung der Daten bietet. Mehr ...

Klassendiagramm für Dsao_DataHandler_Abstract:

Aufstellung aller Elemente

Öffentliche Methoden
	__call ($method, $parameters)
	Fängt Aufrufe wie 'getId()' oder 'setName()' o.
	__construct (array $data=array(), $readOnly=false)
	Setzt Daten.
	__get ($property)
	Einzelne Eigenschaft zurück geben.
	__isset ($property)
	Prüft, ob Eigenschaft vorhanden ist.
	__set ($property, $value)
	Setzt eine einzelne Eigenschaft.
	__sleep ()
	Loeschen von Tabellenobjekten und Rueckgabe von Array.
	__unset ($property)
	Element der Daten des Objekts löschen.
	__wakeup ()
	Deserialisierungroutine.
	clearData ()
	Löscht Daten des Objekts, ohne die Tabellenzeilen zu beeinträchtigen.
	getData ($properties=null, $default=null)
	(Teile der) Daten zurück geben.
	hasData (array $properties=array(), $or=false, array $skip=array())
	Prüft, ob übergeben Daten exisitieren.
	isReadOnly ($throw=false)
	Ob Objekt schreibgeschützt ist.
	isValid ($throw=false)
	Gültigkeit des Objekts.
	setData (array $data=array(), $overwrite=true)
	Setzt Daten des Objekts.
	setFromArray (array $data=array())
	Ersetzt bisherige Daten durch übergbene.
	setReadOnly ($readOnly=true)
	Markiert das Objekt als (nicht länger) schreibgeschützt.
	setValid ($valid=true)
	Setzt die Gültigkeit (wenn z.B.
	toArray ()
	Gibt alle Daten des Objekts als Array zurück.
Geschützte Methoden
	_checkValidity ()
	Gültigkeit des Objekts prüfen.
	_cleanData ($data)
	Säubert einen Array von Daten.
	_resetValidity ()
	Setzt Gültigkeit zurück.
Geschützte Attribute
	$_data = array()
	array, Daten des Objekts.
	$_propertiesMandatory = array()
	array, Notwendige Eigenschaften für eine grundlegende Gültigkeitsprüfung
	$_propertiesProtected = array()
	array, Geschützte Eigenschaften, können nicht über setData() gesetzt werden
	$_readOnly = false
	bool, ob Objekt schreibgeschützt ist
	$_valid = null
	bool, Gültigkeit (der Daten) des Objekts

---

Ausführliche Beschreibung

Abstrakte Klasse, die ein ArrayObject mit Daten und eine entsprechende API zur Verwaltung der Daten bietet.

Lange Beschreibung.

Autor:

DSAo-Md

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

Version:

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

Definiert in Zeile 12 der Datei Abstract.php.

---

Beschreibung der Konstruktoren und Destruktoren

Dsao_DataHandler_Abstract::__construct	(	array $	data = array(),
		$	readOnly = false
	)

Setzt Daten.

Parameter:

	$data	array, Daten
	$readOnly	bool, schreibgeschützt?

Definiert in Zeile 101 der Datei Abstract.php.

Benutzt setData() und setReadOnly().

  {
    // Damit man einfach isset() benutzen kann
    $this->_propertiesProtected = array_flip($this->_propertiesProtected);

    $this->setData($data);

    $this->setReadOnly($readOnly);
  }

---

Dokumentation der Elementfunktionen

Dsao_DataHandler_Abstract::__call	(	$	method,
		$	parameters
	)

Fängt Aufrufe wie 'getId()' oder 'setName()' o.

ä. auf und leitet sie an die entsprechenden Methoden weiter.

Parameter:

	$method	string, Methodenname
	$parameters	array, Parameter

Rückgabe:

mixed, je nach Methode

Definiert in Zeile 48 der Datei Abstract.php.

Benutzt __set() und Dsao_Model_Abstract::underscore().

  {
    // 'getId' -> 'get_id'
    $methodUnderscored = Dsao_Model_Abstract::underscore($method);
    $parts = explode('_', $methodUnderscored, 2);

    // 'get_id' -> 'get'
    $operation  = (isset($parts[0]) ? $parts[0] : null);
    // 'get_id' -> 'id'
    $property   = (isset($parts[1]) ? $parts[1] : null);

    switch ($operation)
    {
      case 'get':
      case 'unset':
      case 'isset':
      {
        $methodName = '__'.$operation;

        return $this->$methodName($property);
      }
      break;

      case 'set':
      {
        // Falls kein Parameter übergeben wurde, null annehmen (->unset)
        if (!isset($parameters[0]))
        {
          $parameters[0] = null;
        }

        $this->__set($property, $parameters[0]);

        // Fließendes Interface bei set*()-Methoden
        return $this;
      }
      break;

      default:
      {
        throw new Dsao_Exception(array(
          'message' =>'dsao_datahandler_abstract_method_not_found',
          'variables' => array('method' => $method)));
      }
    }
  }

Dsao_DataHandler_Abstract::__get

(

$

property

)

Einzelne Eigenschaft zurück geben.

Parameter:

$property

string, Eigenschaft

Definiert in Zeile 116 der Datei Abstract.php.

Wird benutzt von Dsao_Db_Table_DataHandler_Abstract::_addWhere(), Dsao_Scroll::_delete(), Dsao_Scroll::delete(), Dsao_Scroll::getOtherUser(), Dsao_Scroll::isAuthor(), Dsao_Scroll::isDeleted(), Dsao_Scroll::isParticipated(), Dsao_Scroll::isRead(), Dsao_Scroll::isRecipient(), Dsao_Scroll::markRead(), Dsao_Scroll::refresh(), Dsao_Scroll::toArrayDecoded(), Dsao_Hero::update() und Dsao_User::update().

  {
    $property = (string) $property;

    return isset($this->_data[$property]) ?
      $this->_data[$property] : null;
  }

Dsao_DataHandler_Abstract::__isset

(

$

property

)

Prüft, ob Eigenschaft vorhanden ist.

Parameter:

$property

string, Eigenschaft

Rückgabe:

bool, ob Eigenschaft vorhanden ist

Definiert in Zeile 130 der Datei Abstract.php.

Wird benutzt von __unset(), _checkValidity(), _cleanData(), Dsao_Db_Table_DataHandler_Abstract::_getValidIdentifiers(), getData(), hasData(), Dsao_Scroll::isDeleted(), Dsao_Scroll::isRead(), setData() und Dsao_Scroll::toArrayDecoded().

  {
    return isset($this->_data[(string) $property]);
  }

Dsao_DataHandler_Abstract::__set	(	$	property,
		$	value
	)

Setzt eine einzelne Eigenschaft.

Parameter:

	$property	string, Eigenschaft
	$value	mixed, Wert

Rückgabe:

void

Definiert in Zeile 142 der Datei Abstract.php.

Benutzt __unset() und _resetValidity().

Wird benutzt von __call(), Dsao_Scroll::delete(), Dsao_Db_Table_DataHandler_Row_Abstract::exists() und Dsao_Scroll::markRead().

  {
    if (!$property)
    {
      return;
    }

    // Ggf. Exception werfen
    $this->_resetValidity(true);

    // Falls null übergeben wurde, löschen
    if (null === $value)
    {
      $this->__unset($property);
    }
    else
    {
      $this->_data[(string) $property] = $value;
    }
  }

Dsao_DataHandler_Abstract::__sleep

(

)

Loeschen von Tabellenobjekten und Rueckgabe von Array.

Wird aufgerufen, wenn Objekt serialisiert werden soll, loescht Tabellenobjekte und gibt Array mit zu sichernden Werten zurueck

Rückgabe:

array

Erneute Implementation in Dsao_Db_Table_DataHandler_Abstract.

Definiert in Zeile 171 der Datei Abstract.php.

  {
    // Wichtige Einstellungen sichern
    return array('_readOnly', '_data', '_valid');
  }

Dsao_DataHandler_Abstract::__unset

(

$

property

)

Element der Daten des Objekts löschen.

Parameter:

$property

string, Element

Rückgabe:

void

Definiert in Zeile 183 der Datei Abstract.php.

Benutzt __isset() und _resetValidity().

Wird benutzt von __set().

  {
    $this->_resetValidity();

    $property = (string) $property;

    // Falls Element vorhanden
    if ($this->__isset($property))
    {
      unset($this->_data[$property]);
    }
  }

Dsao_DataHandler_Abstract::__wakeup

(

)

Deserialisierungroutine.

Daten sind widerhergestellt, aber geschütze Eigenschaften müssen wieder in die richtige Form gebracht werden (vllt. sollte man sich hier was besseres ausdenken).

Rückgabe:

typeReturn, descReturn

Definiert in Zeile 205 der Datei Abstract.php.

  {
    $this->_propertiesProtected = array_flip($this->_propertiesProtected);
  }

Dsao_DataHandler_Abstract::_checkValidity

(

)

[protected]

Gültigkeit des Objekts prüfen.

Rückgabe:

bool, Gültigkeit

Erneute Implementation in Dsao_Db_Table_DataHandler_Abstract, Dsao_Hero, Dsao_Scroll und Dsao_User.

Definiert in Zeile 215 der Datei Abstract.php.

Benutzt __isset().

Wird benutzt von isValid() und setValid().

  {
    // Pflichtdaten durchgehen
    foreach ($this->_propertiesMandatory as $property)
    {
      // Falls Datum nicht vorhanden
      if (!$this->__isset($property))
      {
        $this->_valid = false;

        return false;
      }
    }

    $this->_valid = true;

    return true;
  }

Dsao_DataHandler_Abstract::_cleanData

(

$

data

)

[protected]

Säubert einen Array von Daten.

Geschütze Eigenschaften werden entfernt, wenn sie bereits vorhanden sind.

Parameter:

$data

array, Daten

Definiert in Zeile 241 der Datei Abstract.php.

Benutzt __isset().

Wird benutzt von setData() und setFromArray().

  {
    foreach ($data as $property => $value)
    {
      // Falls geschütze Eigenschaft übergeben wurde und diese bereits
      // vorhanden, löschen
      if (isset($this->_propertiesProtected[$property])
        && $this->__isset($property))
      {
        unset($data[$property]);
      }
    }

    return $data;
  }

Dsao_DataHandler_Abstract::_resetValidity

(

)

[protected]

Setzt Gültigkeit zurück.

Rückgabe:

void

Erneute Implementation in Dsao_Db_Table_DataHandler_Abstract.

Definiert in Zeile 262 der Datei Abstract.php.

Benutzt isReadOnly().

Wird benutzt von __set(), __unset(), clearData() und setData().

  {
    $this->isReadOnly(true);

    $this->_valid = null;
  }

Dsao_DataHandler_Abstract::clearData

(

)

Löscht Daten des Objekts, ohne die Tabellenzeilen zu beeinträchtigen.

Rückgabe:

Dsao_DataHandler_Abstract, fließendes Interface

Definiert in Zeile 274 der Datei Abstract.php.

Benutzt _resetValidity().

Wird benutzt von setFromArray().

  {
    // Gültigkeit zurücksetzen
    $this->_resetValidity();

    // Daten löschen
    $this->_data = array();

    return $this;
  }

Dsao_DataHandler_Abstract::getData	(	$	properties = null,
		$	default = null
	)

(Teile der) Daten zurück geben.

Der erste Parameter kann entweder ein String sein, wenn nur ein Wert zurückgegeben werden soll (ist nur im Zusammenhang mit dem zweiten Parameter sinnvoll, da ansonsten auch __get() verwendet werden kann) oder als Array im folgenden Format:

array('property' => 'default', 'property2')

Sollte die Eigenschaft 'property' nicht existieren, wird der Wert 'default' genommen. Im zweiten Fall wurde kein Standardwert übergeben, sollte der Wert nicht existieren, wird $default zurück gegeben.

Parameter:

	$properties	array|string, zurückzugebene Daten
	$default	mixed, Standardwert

Rückgabe:

array, Daten

Definiert in Zeile 303 der Datei Abstract.php.

Benutzt __isset().

Wird benutzt von Dsao_Uri_Http::getParameters().

  {
    // Falls alles zurueckgegeben werden soll
    if (!$properties)
    {
      return $this->_data;
    }

    // Falls nur eine Eigenschaft zurueckgegeben werden soll
    if (!is_array($properties))
    {
      // Falls Element nicht vorhanden
      if (!$this->__isset($properties))
      {
        return $default;
      }

      return $this->_data[$properties];
    }

    // Array mit Ergebnissen
    $results = array();

    // Array/Objekt durchgehen
    foreach ($properties as $property => $defaultValue)
    {
      // Falls Index numerisch
      if (is_numeric($property))
      {
        $property = $defaultValue;
        $defaultValue = $default;
      }

      // Falls Element nicht vorhanden
      if (!$this->__isset($property))
      {
        $results[$property] = $defaultValue;
        continue;
      }

      // Eigenschaft dem Ergebnisarray zuweisen
      $results[$property] = $this->_data[$property];
    }

    return $results;
  }

Dsao_DataHandler_Abstract::hasData	(	array $	properties = array(),
		$	or = false,
		array $	skip = array()
	)

Prüft, ob übergeben Daten exisitieren.

Wurden keien Daten übergeben, wird zurück gegeben, ob Parameter vorhanden sind. Der dritte Parameter gibt die bei letzterer Prüfung zu ignorierende Felder an (immer vorhandene Daten o.ä.).

Parameter:

	$properties	array, Zu prüfende Eigenschaften (leeres Array -> prüfen, ob überhaupt Parameter vorhanden sind)
	$or	bool, ob nur einer oder alle Eigenschaften für das Erfüllen der Bedingung vorhanden sein müssen
	$skip	array, zu überspringende Eigenschaften (nur bei Prüfung, ob überhaupt Parameter vorhanden sind)

Rückgabe:

bool, ob Parameter vorhanden sind

Definiert in Zeile 365 der Datei Abstract.php.

Benutzt __isset().

Wird benutzt von Dsao_Uri_Http::hasParameters().

  {
    // Falls nichts übergeben wurde, nur prüfen, ob überhaupt Parameter
    // vorhanden sind
    if (empty($properties))
    {
      $propertiesCount = count($this->_data);

      // Zu überspringende Eigenschaften aus Zählung herausnehmen
      foreach ($skip as $property)
      {
        // Token soll nicht mitgezählt werden
        if ($this->__isset($property))
        {
          $parametersCount--;
        }
      }

      return (bool) $propertiesCount;
    }

    // Eigenschaften durchgehen
    foreach ($properties as $property)
    {
      // Falls Eigenschaft vorhanden
      if ($this->__isset($property))
      {
        // Falls nur einer der Eigenschaften vorhanden sein soll, hier
        // abbrechen
        if ($or)
        {
          return true;
        }
      }
      // Eigenschaft nicht vorhanden, also abbrechen, wenn alle Parameter
      // für das Erfüllen der Bedingung vorhanden sein müssen
      else if (!$or)
      {
        return false;
      }
    }

    // Alle Eigenschaften vorhanden
    return true;
  }

Dsao_DataHandler_Abstract::isReadOnly

(

$

throw = false

)

Ob Objekt schreibgeschützt ist.

Parameter:

$throw

bool, ob Exception geworden werden soll, wenn Objekt schreibgeschützt ist.

Rückgabe:

bool, ob schreibgeschützt

Definiert in Zeile 418 der Datei Abstract.php.

Wird benutzt von _resetValidity(), Dsao_Db_Table_DataHandler_Abstract::delete(), Dsao_Db_Table_DataHandler_Row_Abstract::exists(), Dsao_Db_Table_DataHandler_Abstract::insert(), Dsao_Scroll::markRead(), Dsao_Db_Table_DataHandler_Abstract::refresh() und Dsao_Db_Table_DataHandler_Abstract::update().

  {
    // Falls Objekt schreibgeschützt und Exception geworfen werden soll
    if ($this->_readOnly && $throw)
    {
      throw new Dsao_Exception('dsao_datahandler_abstract_readonly');
    }

    return (bool) $this->_readOnly;
  }

Dsao_DataHandler_Abstract::isValid

(

$

throw = false

)

Gültigkeit des Objekts.

Parameter:

$throw

bool, ob ggf. eine Exception geworfen werden soll

Rückgabe:

bool, ob das Objekt gültig ist.

Definiert in Zeile 435 der Datei Abstract.php.

Benutzt _checkValidity().

Wird benutzt von Dsao_Db_Table_DataHandler_Abstract::insert(), Dsao_Model_Scroll_Scroll::insertScroll(), Dsao_Scroll::markRead() und Dsao_Uri_Http::toString().

  {
    // Falls Gültigkeit noch nicht geprüft wurde oder erneut geprüft werden
    // soll
    if (null === $this->_valid)
    {
      $this->_checkValidity();
    }

    // Falls Objekt ungültig und Exception geworfen werden soll
    if (!$this->_valid && $throw)
    {
      throw new Dsao_Exception('dsao_datahandler_abstract_invalid');
    }

    return $this->_valid;
  }

Dsao_DataHandler_Abstract::setData	(	array $	data = array(),
		$	overwrite = true
	)

Setzt Daten des Objekts.

Parameter:

	$data	array, zu setzende Daten
	$overwrite	bool, ob neue Werte vorhandene überschreiben sollen (nur wenn $append true ist)

Rückgabe:

Dsao_DataHandler_Abstract, fließendes Interface

Definiert in Zeile 461 der Datei Abstract.php.

Benutzt __isset(), _cleanData() und _resetValidity().

Wird benutzt von __construct(), Dsao_Db_Table_DataHandler_Abstract::_parseResult(), Dsao_Db_Table_DataHandler_Row_Abstract::refresh() und Dsao_Uri_Http::setParameters().

  {
    // Falls keine Daten übergeben wurden, abbrechen
    if (empty($data))
    {
      return $this;
    }

    // Gültigkeit zurück setzen
    $this->_resetValidity();

    // Daten säubern
    $data = $this->_cleanData($data);

    // Zu setzende Eigenschaften durchlaufen
    foreach ($data as $property => $value)
    {
      // Falls Eigenschaft vorhanden und Überschreiben deaktiviert
      if (!$overwrite && $this->__isset($property))
      {
        continue;
      }

      // Falls null übergeben wurde, überspringen
      if (null === $value)
      {
        continue;
      }
      // Ansonsten normal setzen (kein __set(), um Zeit zu sparen)
      else
      {
        $this->_data[$property] = $value;
      }
    }

    return $this;
  }

Dsao_DataHandler_Abstract::setFromArray

(

array $

data = array()

)

Ersetzt bisherige Daten durch übergbene.

Parameter:

$data

array, Daten

Rückgabe:

Dsao_DataHandler_Abstract, fließendes Interface

Definiert in Zeile 505 der Datei Abstract.php.

Benutzt _cleanData() und clearData().

Wird benutzt von Dsao_Scroll::insert().

  {
    // Daten löschen
    $this->clearData();

    // Und neu setzen
    $this->_data = $this->_cleanData($data);

    return $this;
  }

Dsao_DataHandler_Abstract::setReadOnly

(

$

readOnly = true

)

Markiert das Objekt als (nicht länger) schreibgeschützt.

Parameter:

$readOnly

bool

Rückgabe:

Dsao_DataHandler_Abstract, fließendes Interface

Definiert in Zeile 522 der Datei Abstract.php.

Wird benutzt von __construct() und Dsao_Model_User_Profile::editProfile().

  {
    $this->_readOnly = (bool) $readOnly;

    return $this;
  }

Dsao_DataHandler_Abstract::setValid

(

$

valid = true

)

Setzt die Gültigkeit (wenn z.B.

Gültigkeitsprüfungen außerhalb durchgeführt wurden).

Es ist darauf zu achten, dass _checkValidity() niemals die Gültigkeit auf true setzen darf.

Parameter:

$valid

bool, Gültigkeit

Rückgabe:

Dsao_DataHandler_Abstract, fließendes Interface

Definiert in Zeile 539 der Datei Abstract.php.

Benutzt _checkValidity().

Wird benutzt von Dsao_Model_Scroll_Scroll::_checkScrollData() und Dsao_Scroll::refresh().

  {
    // Gültigkeitsprüfung durchführen
    $validityChecked = $this->_checkValidity();

    if (!$validityChecked && $valid)
    {
      throw new Dsao_Exception('dsao_datahandler_abstract_set_valid');
    }

    $this->_valid = (bool) $valid;

    return $this;
  }

Dsao_DataHandler_Abstract::toArray

(

)

Gibt alle Daten des Objekts als Array zurück.

Rückgabe:

array, Daten des Objekts

Definiert in Zeile 559 der Datei Abstract.php.

  {
    return $this->_data;
  }

---

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

• /var/www/devel.dsao.eu/library/Dsao/DataHandler/Abstract.php