Dsao_Uri_Http Klassenreferenz

Repräsentiert einen HTTP-URI. Mehr ...

Klassendiagramm für Dsao_Uri_Http:

Aufstellung aller Elemente

Öffentliche Methoden
	__construct ($uri=null, array $parameters=array(), $readOnly=false)
	Konstruktor.
	__toString ()
	Gibt URI als String zurück.
	createUriString ($uri, $appendToken=true, $absolute=false)
	URI-Generator für Smarty.
	getAclResourceId ()
	Gibt ACL-Ressourcen-ID zurück.
	getFragment ()
	Gibt das Fragment des URI zurück.
	getParameters ($parameters=null, $default=null)
	Gibt einen, mehrere oder alle Parameter zurück.
	getUriString ($parameters=true, $appendToken=false, $absolute=false)
	Gibt den URI als String zurück.
	hasParameters (array $parametersNames=array(), $or=false)
	Prüft, ob Parameter vorhanden sind.
	setFragment ($fragment)
	Setzt das Fragment des URI.
	setParameters (array $parameters=array(), $overwrite=true)
	Setzt Array von Parametern.
	setUri ($uri=false)
	Setzt neue URI.
	toString ($parameters=true, $appendToken=false, $absolute=false)
	Gibt den URI als String zurück.
Öffentliche, statische Methoden
static	getToken ()
	Gibt Token zurück oder erzeugt es.
static	setBaseUri ($baseUri)
	Legt Basis-Verzeichnis fest.
static	setHost ($host)
	Legt den Host fest.
static	setScheme ($scheme= 'http')
	Legt Schema fest (http / https).
static	setToken ($token=null)
	Legt Token fest.
Geschützte Methoden
	_getParametersString ($parameters)
	Gibt die Parameter als String zurück.
	_parsePath ($module, $controller, $action)
	Parst den aufgerufenen Pfad.
	_parseQuery ($query)
	URI-Query (?param=value&.
	_parseUri ($uri)
	Trennt einen URI in einen Adress- und einen Parameterteil und wandelt die Parameter in ein Array um.
	_parseUserParameters ($parameters)
	Parsen der benutzerdefinierten Parameter (/param1/value1/param2.
Geschützte Attribute
	$_fragment = null
	string, Fragment der URI
	$_data = array()
	array, Parameter der URI
	$_propertiesMandatory = array('module', 'controller', 'action')
	array, für Gültigkeit nötige Parameter
	$_propertiesProtected = array('module', 'controller', 'action')
	array, geschütze Parameter
Statische geschützte Attribute
static	$_baseUri = null
	string, Basisverzeichnis (http://expample.org/baseUri/htdocs/index.php)
static	$_host = null
	string, Hostadresse
static	$_scheme = 'http'
	string, http / https
static	$_token = null
	string, aktuelles Token

---

Ausführliche Beschreibung

Repräsentiert einen HTTP-URI.

Relativ simple URI-Klasse für Seiten relativ zu einem allgemeinen Host. Ist also weniger geeignet für Links auf externe Seiten.

Autor:

DSAo-Md

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

Version:

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

Definiert in Zeile 12 der Datei Http.php.

---

Beschreibung der Konstruktoren und Destruktoren

Dsao_Uri_Http::__construct	(	$	uri = null,
		array $	parameters = array(),
		$	readOnly = false
	)

Konstruktor.

Parameter:

	$uri	string, URI
	$parameters	array, Parameter
	$readOnly	bool, ob Objekt als schreibgeschützt markiert werden soll

Rückgabe:

void

Definiert in Zeile 62 der Datei Http.php.

Benutzt setUri().

  {
    $this->setUri($uri);

    parent::__construct($parameters, $readOnly);
  }

---

Dokumentation der Elementfunktionen

Dsao_Uri_Http::__toString

(

)

Gibt URI als String zurück.

Rückgabe:

string, URI

Definiert in Zeile 74 der Datei Http.php.

Benutzt toString().

  {
    return $this->toString();
  }

Dsao_Uri_Http::_getParametersString

(

$

parameters

)

[protected]

Gibt die Parameter als String zurück.

Parameter:

$parameters

array|bool, true = alle Parameter; false = keine Parameter; array = Teile der Parameter, innerhalb des Arrays können wiederum die Namen von Parametern sowie true oder false übergeben werden (array (true, 'blubb') -> alles außer 'blubb')

Rückgabe:

string, Parameterliste

Definiert in Zeile 88 der Datei Http.php.

Wird benutzt von toString().

  {
    // string, Parameter, zu einem String zusammengefügt
    $parametersString = '';

    // Falls keine Parameter vorhanden oder keine übergeben werden sollen
    if (null === $this->_data || false === $parameters)
    {
      return $parametersString;
    }

    // Sortieren
    ksort($this->_data);

    // Parameterliste in Array umwandeln
    $parameters = (array) $parameters;

    // Zu übergebende Parameter
    $parametersNames = array();

    // Übergebene Parameter durchgehen
    foreach ($parameters as $parameter)
    {
      // Falls true (alle Parameter) oder false (keine Parameter)
      if (is_bool($parameter))
      {
        $parametersNames =
          (true === $parameter ? $this->_data : array());

        continue;
      }

      // Falls Parameter vorhanden
      if (isset($this->_data[$parameter]))
      {
        // Falls Parameter bereits in Liste vorhanden, löschen
        if (isset($parametersNames[$parameter]))
        {
          unset($parametersNames[$parameter]);
        }
        // Ansonsten hinzufügen
        else
        {
          $parametersNames[$parameter] = true;
        }
      }
    }

    // Nun die endgültigen Parameter durchgehen und String basteln
    foreach ($parametersNames as $parameter => $value)
    {
      // Modul, Controller, Aktion und Token und Error-Handler überspringen
      if (in_array($parameter,
        array('action', 'controller', 'module', 'token', 'error_handler')))
      {
        continue;
      }

      $parametersString .= '/'.$parameter.'/'. urlencode((string) $this->_data[$parameter]);
    }

    return $parametersString;
  }

Dsao_Uri_Http::_parsePath	(	$	module,
		$	controller,
		$	action
	)			[protected]

Parst den aufgerufenen Pfad.

Parameter:

	$module	string, Modul
	$controller	string, Controller
	$action	string, Aktion

Rückgabe:

void

Definiert in Zeile 160 der Datei Http.php.

Wird benutzt von _parseUri().

  {
    // array, Name der Teile des Adressteils des URI
    $adress = array(
      'module'      => $module,
      'controller'  => $controller,
      'action'      => $action
    );

    // Modul, Controller und Aktion durchgehen, sofern vorhanden.
    foreach ($adress as $part => $value)
    {
      // Falls kein Wert übergeben
      if (!$value)
      {
        continue;
      }

      $this->_data[$part] = $value;
    }
  }

Dsao_Uri_Http::_parseQuery

(

$

query

)

[protected]

URI-Query (?param=value&.

..) parsen.

Parameter:

$query

string, Query

Rückgabe:

void

Definiert in Zeile 188 der Datei Http.php.

Wird benutzt von _parseUri().

  {
    // Falls Query leer
    if (!$query)
    {
      return;
    }

    // Parameter durchgehen
    foreach (explode('&', $query) as $parameter)
    {
      $parts = explode('=', $parameter);

      $this->_data[$parts[0]] = (isset($parts[1]) ? $parts[1] : true);
    }
  }

Dsao_Uri_Http::_parseUri

(

$

uri

)

[protected]

Trennt einen URI in einen Adress- und einen Parameterteil und wandelt die Parameter in ein Array um.

Parameter:

$uri

string, URI

Rückgabe:

void

Definiert in Zeile 212 der Datei Http.php.

Benutzt _parsePath(), _parseQuery() und _parseUserParameters().

Wird benutzt von setUri().

  {
    // Aufteilen des URI
    $pattern =
      '~^((?<protocol>https?|ftp)://(?<host>[^/?#]*))?/'.
      '(?<baseUri>'.self::$_baseUri.'/)?((?<module>[^/?#]*)/)?'.
      '((?<controller>[^/?#]*)/)?(?<action>[^/?#]*)?'.
      '(?<userParameters>[^?#]*)?\??((?<query>[^#]*))?#?(?<fragment>.*)?$~';

    preg_match($pattern, $uri, $matches);

    // Falls Aufteilung nicht erfolgreich war
    if (empty($matches))
    {
      return;
    }

    // Falls externe Adresse übergeben wurde
    if ($matches['host'] && $matches['host'] != self::$_host)
    {
      throw new Dsao_Exception(array(
        'message' => 'dsao_uri_http_unknown_host',
        'variables' => array('host' => $matches['host']),
        ));
    }

    // Fragment setzen
    $this->_fragment = $matches['fragment'];

    // Verschiedene Teile des URI parsen, mit aufsteigender Priorität

    // Query parsen
    $this->_parseQuery($matches['query']);

    // User-Parameter parsen
    $this->_parseUserParameters($matches['userParameters']);

    // Pfad parsen
    $this->_parsePath
      ($matches['module'], $matches['controller'], $matches['action']);

  }

Dsao_Uri_Http::_parseUserParameters

(

$

parameters

)

[protected]

Parsen der benutzerdefinierten Parameter (/param1/value1/param2.

..).

Parameter:

$parameters

string, mit Slashes geteilte Parameter

Rückgabe:

void

Definiert in Zeile 261 der Datei Http.php.

Wird benutzt von _parseUri().

  {
    // Falls Parameterliste leer
    if (!$parameters)
    {
      return;
    }

    // array, Parameter
    $partsParameters = explode('/', $parameters);

    // int, Anzahl Parameter-Teile (= Anzahl Parameter * 2 +-1)
    $countPartsParameters = count($partsParameters);

    // Parameter durchgehen (in Zweierschritten)
    for ($i = 0; $i < $countPartsParameters; $i += 2)
    {
      // Falls Parameter leerer String, annehmen, dass aus Versehen ein Slash
      // doppelt ist, und nur um eins inkrementieren (-1 +2 = 1)
      if (!$partsParameters[$i])
      {
        $i--;
        continue;
      }

      // Falls letztes Element erreicht oder kein Wert für den Parameter
      // übergeben wurde, Wert setzen
      if ($i == ($countPartsParameters-1) || !$partsParameters[($i+1)])
      {
        $partsParameters[($i+1)] = true;
      }


      $this->_data[$partsParameters[$i]] =
        urldecode($partsParameters[($i+1)]);
    }
  }

Dsao_Uri_Http::createUriString	(	$	uri,
		$	appendToken = true,
		$	absolute = false
	)

URI-Generator für Smarty.

Da Smarty nicht mit statischen Methoden umgehen kann, braucht es diese Methode. Außerdem wird sie intern zur Generierung des URI verwendet.

Diese Methode erstellt einen neuen URI aus dem übergebenen String, hängt das Token an und gibt den URI zurück.

Parameter:

	$uri	string, URI
	$appendToken	bool, ob Token angehängt werden soll
	$absolute	bool, ob URI mit Schema und Host erzeugt werden soll

Rückgabe:

string, URI, ergänzt um Token

Definiert in Zeile 313 der Datei Http.php.

Wird benutzt von toString().

  {
    // string, URI
    $uriResult = '';

    // Falls absoluter URI angefordert wurde
    if ($absolute)
    {
      $uriResult .= self::$_scheme.'://'.self::$_host;
    }

    // Slash voranstellen
    $uri = '/'. ltrim($uri, '/');

    // Eigentlicher URI mit Parametern
    $uriResult .= (self::$_baseUri ? self::$_baseUri.$uri : $uri);

    // Falls Token angehängt werden soll
    if ($appendToken)
    {
      $uriResult .= '/token/'.self::getToken();
    }

    return $uriResult.($this->_fragment ? '#'.$this->_fragment : '');
  }

Dsao_Uri_Http::getAclResourceId

(

)

Gibt ACL-Ressourcen-ID zurück.

Rückgabe:

string, ACL-Ressourcen-ID

Definiert in Zeile 344 der Datei Http.php.

  {
    return $this->_data['module'].'_'.
      $this->_data['controller'].'_'.$this->_data['action'];
  }

Dsao_Uri_Http::getFragment

(

)

Gibt das Fragment des URI zurück.

Rückgabe:

string, Fragment

Definiert in Zeile 355 der Datei Http.php.

  {
    return $this->_fragment;
  }

Dsao_Uri_Http::getParameters	(	$	parameters = null,
		$	default = null
	)

Gibt einen, mehrere oder alle Parameter zurück.

Parameter:

	$parameters	array|string, Parameter
	$default	mixed, Standardwert

Rückgabe:

mixed, Parameter, Array von Parametern oder Standardwert

Definiert in Zeile 367 der Datei Http.php.

Benutzt Dsao_DataHandler_Abstract::getData().

  {
    return parent::getData($parameters, $default);
  }

static Dsao_Uri_Http::getToken

(

)

[static]

Gibt Token zurück oder erzeugt es.

Rückgabe:

string, Token

Definiert in Zeile 377 der Datei Http.php.

  {
    return self::$_token;
  }

Dsao_Uri_Http::getUriString	(	$	parameters = true,
		$	appendToken = false,
		$	absolute = false
	)

Gibt den URI als String zurück.

Veraltet:

stattdessen toString() benutzen

Parameter:

	$parameters	array|bool, mit oder ohne Parameter, oder ein Array der Parameter, die übergeben werden sollen
	$appendToken	bool, mit oder ohne Token
	$absolute	bool, ob absoluter URI erzeugt werden soll

Rückgabe:

string, URI

Definiert in Zeile 392 der Datei Http.php.

Benutzt toString().

  {
    return $this->toString($parameters, $appendToken, $absolute);
  }

Dsao_Uri_Http::hasParameters	(	array $	parametersNames = array(),
		$	or = false
	)

Prüft, ob Parameter vorhanden sind.

Parameter:

	$parametersNames	array, Zu prüfende Parameter (leerer Array -> prüfen, ob überhaupt Parameter vorhanden sind)
	$or	bool, ob nur einer oder alle Parameter für das Erfüllen der Bedingung vorhanden sein müssen

Rückgabe:

bool, ob URI die geforderten Parameter hat oder nicht

Definiert in Zeile 406 der Datei Http.php.

Benutzt Dsao_DataHandler_Abstract::hasData().

  {
    return parent::hasData($parametersNames, $or, array('token'));
  }

static Dsao_Uri_Http::setBaseUri

(

$

baseUri

)

[static]

Legt Basis-Verzeichnis fest.

Parameter:

$baseUri

string, Basis-Verzeichnis

Rückgabe:

void

Definiert in Zeile 417 der Datei Http.php.

Wird benutzt von Dsao_Controller_Action_Helper_Uri::init().

  {
    self::$_baseUri = $baseUri;
  }

Dsao_Uri_Http::setFragment

(

$

fragment

)

Setzt das Fragment des URI.

Parameter:

$fragment

string, Fragment

Rückgabe:

Dsao_Uri_Http, fließendes Interface

Definiert in Zeile 428 der Datei Http.php.

  {
    $this->_fragment = (string) $fragment;

    return $this;
  }

static Dsao_Uri_Http::setHost

(

$

host

)

[static]

Legt den Host fest.

Parameter:

$host

string, Host

Rückgabe:

void

Definiert in Zeile 441 der Datei Http.php.

Wird benutzt von Dsao_Controller_Action_Helper_Uri::init().

  {
    self::$_host = $host;
  }

Dsao_Uri_Http::setParameters	(	array $	parameters = array(),
		$	overwrite = true
	)

Setzt Array von Parametern.

Parameter:

	$parameters	array, Parameter
	$overwrite	bool, ob neue Werte vorhandene überschreiben sollen

Rückgabe:

Dsao_Uri_Http, fließendes Interface

Definiert in Zeile 453 der Datei Http.php.

Benutzt Dsao_DataHandler_Abstract::setData().

Wird benutzt von setUri().

  {
    return parent::setData($parameters, $overwrite);
  }

static Dsao_Uri_Http::setScheme

(

$

scheme = 'http'

)

[static]

Legt Schema fest (http / https).

Parameter:

$scheme

string, HTTP / HTTPS

Rückgabe:

void

Definiert in Zeile 464 der Datei Http.php.

Wird benutzt von Dsao_Controller_Action_Helper_Uri::init().

  {
    self::$_scheme = $scheme;
  }

static Dsao_Uri_Http::setToken

(

$

token = null

)

[static]

Legt Token fest.

Parameter:

$token

string, Token

Rückgabe:

void

Definiert in Zeile 475 der Datei Http.php.

Benutzt Dsao_Hash::factory().

Wird benutzt von Dsao_Controller_Action_Helper_SessionToken::init().

  {
    // Falls kein Token übergeben, neues erzeugen
    if (null === $token)
    {
      $token = Dsao_Hash::factory()->getHash(4);
    }

    self::$_token = $token;

    return $token;
  }

Dsao_Uri_Http::setUri

(

$

uri = false

)

Setzt neue URI.

Parameter:

$uri

bool|string, URI; false = zurücksetzen auf Standardwerte

Rückgabe:

Dsao_Uri_Http, fließendes Interface

Definiert in Zeile 494 der Datei Http.php.

Benutzt _parseUri() und setParameters().

Wird benutzt von __construct().

  {
    // Falls URI zurück gesetzt werden soll
    if (false === $uri)
    {
      $this->setParameters(array(
        'module'      => null,
        'controller'  => null,
        'action'      => null));
    }
    else
    {
      $this->_parseUri($uri);
    }

    return $this;
  }

Dsao_Uri_Http::toString	(	$	parameters = true,
		$	appendToken = false,
		$	absolute = false
	)

Gibt den URI als String zurück.

Parameter:

	$parameters	array|bool, mit oder ohne Parameter, oder ein Array der Parameter, die übergeben werden sollen
	$appendToken	bool, mit oder ohne Token
	$absolute	bool, ob absoluter URI erzeugt werden soll

Rückgabe:

string, URI

Definiert in Zeile 521 der Datei Http.php.

Benutzt _getParametersString(), createUriString() und Dsao_DataHandler_Abstract::isValid().

Wird benutzt von __toString() und getUriString().

  {
    // Gültigkeit prüfen
    $this->isValid(true);

    // string, Parameter als String zusammensetzen
    $parametersString = $this->_getParametersString($parameters);

    // URI zusammenfügen
    $uri = '/'.$this->_data['module'].'/'.
      $this->_data['controller'].'/'.$this->_data['action'].
      $parametersString;

    // URI  zurückgeben
    return $this->createUriString($uri, $appendToken, $absolute);
  }

---

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

• /var/www/devel.dsao.eu/library/Dsao/Uri/Http.php