Dsao_Ajax_Response Klassenreferenz

Repraesentiert die Antwort auf eine Ajax-Anfrage. Mehr ...

Aufstellung aller Elemente

Öffentliche Methoden
	getCallbackHandler ()
	Rückgabe der Callback-Funktion.
	getContent ()
	Rückgabe des Inhalts.
	getContentType ()
	Rückgabe des Mime-Typs.
	setCallbackHandler ($callbackHandler)
	Setzen der Callback-Funktion.
	setData ($data, $contentType=self::JSON, $overwrite=true)
	Setzen der Antwort-Daten.
	setMessages ($messages)
	Setzen zu übergebener Nachrichten.
Öffentliche Attribute
const	JSON = 'application/json'
	string, Mime-Type fuer JSON.
const	PLAIN = 'text/plain'
	string, Mime-Type fuer reinen Text.
Geschützte Attribute
	$_callbackHandler = null
	string, JS-Funktion, die die Ajax-Antwort uebernimmt.
	$_contentType = null
	string, Mime-Typ der Antwort.
	$_data = array()
	array, an den Client zu uebergebene Daten.
	$_messages = array()
	array, An Smarty uebergebene Nachrichten (Fehler usw.
	$_plainContent = ''
	string, Antworttext.

---

Ausführliche Beschreibung

Repraesentiert die Antwort auf eine Ajax-Anfrage.

Autor:

DSAo-Md

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

Version:

SVN: $Id: Response.php 457 2008-11-02 16:37:42Z saviola $

Definiert in Zeile 9 der Datei Response.php.

---

Dokumentation der Elementfunktionen

Dsao_Ajax_Response::getCallbackHandler

(

)

Rückgabe der Callback-Funktion.

Gibt die Funktion zurück, die die Ajax-Antwort entgegen nehmen soll.

Rückgabe:

null|string, Callback-Handler

Definiert in Zeile 53 der Datei Response.php.

  {
    return $this->_callbackHandler;
  }

Dsao_Ajax_Response::getContent

(

)

Rückgabe des Inhalts.

Gibt den zu sendenden Inhalt zurueck.

Rückgabe:

string

Definiert in Zeile 65 der Datei Response.php.

  {
    // Falls reiner Text zurueckgegeben werden soll
    if (self::PLAIN == $this->_contentType)
    {
      return (string) $this->_data;
    }
    // Ansonsten kodieren
    else
    {
      return Zend_Json::encode(array
        (
          'callbackHandler' => $this->_callbackHandler,
          'data'            => $this->_data,
          'messages'        => $this->_messages,
        ));
    }
  }

Dsao_Ajax_Response::getContentType

(

)

Rückgabe des Mime-Typs.

Gibt den Mime-Typ des zu sendenden Inhalts zurueck, ueblicherweise wird der Inhalt ueber JSON kodiert.

Rückgabe:

string

Definiert in Zeile 92 der Datei Response.php.

  {
    return ($this->_contentType ? $this->_contentType : self::JSON);
  }

Dsao_Ajax_Response::setCallbackHandler

(

$

callbackHandler

)

Setzen der Callback-Funktion.

Setzt die Funktion, die die Ajax-Antwort uebernimmt.

Parameter:

$callbackHandler

string, Callback-Funktion

Rückgabe:

Dsao_Ajax_Response, fließendes Interface

Definiert in Zeile 105 der Datei Response.php.

  {
    $this->_callbackHandler = $callbackHandler;

    return $this;
  }

Dsao_Ajax_Response::setData	(	$	data,
		$	contentType = self::JSON,
		$	overwrite = true
	)

Setzen der Antwort-Daten.

Setzt die per Ajax zu uebergebenen Daten.

Parameter:

	$data	mixed, Daten
	$contentType	string, Mime-Typ der Daten
	$overwrite	bool, ob vorhandene Daten ueberschrieben werden sollen

Rückgabe:

Dsao_Ajax_Response, fliessendes Interface

Definiert in Zeile 122 der Datei Response.php.

  {
    // Falls bereits Daten uebergeben wurden, neue ignorieren, sofern alte
    // Daten nicht ueberschrieben werden sollen
    if (!$overwrite && !empty($this->_data))
    {
      return $this;
    }

    $this->_data = $data;
    $this->_contentType = $contentType;

    return $this;
  }

Dsao_Ajax_Response::setMessages

(

$

messages

)

Setzen zu übergebener Nachrichten.

Setzt ein Array von per Ajax zu uebergebenen Nachrichten.

Parameter:

$messages

array|ArrayObject, Nachrichten

Rückgabe:

Dsao_Ajax_Response, fliessendes Interface

Definiert in Zeile 145 der Datei Response.php.

  {
    // Falls ArrayObjekt uebergeben wurde
    if (is_object($messages))
    {
      $messages = $messages->getArrayCopy();
    }

    $this->_messages = $messages;

    return $this;
  }

---

Dokumentation der Datenelemente

Dsao_Ajax_Response::$_messages = array() [protected]

array, An Smarty uebergebene Nachrichten (Fehler usw.

).

Definiert in Zeile 39 der Datei Response.php.

---

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

• /var/www/devel.dsao.eu/library/Dsao/Ajax/Response.php