Dsao_Hash_User Klassenreferenz

Hash-Klasse, die auf Einträgen der Tabelle 'user_hash' basiert. Mehr ...

Klassendiagramm für Dsao_Hash_User:

Aufstellung aller Elemente

Öffentliche Methoden
	__get ($parameter)
	Wrapper für Getter-Methode des URI.
	__set ($parameter, $value)
	Wrapper für Setter-Methode des URI.
	deleteDuplicates ()
	Löscht alle Duplikate.
	deleteRow ()
	Löscht Tabellenzeile.
	getUri ()
	Gibt URI zurück.
	hasDuplicates ()
	Prüft, ob bereits Einträge mit dem gleichen Aktions-Hash für diesen Benutzer existieren.
	isValid ($parametersNames=true, $recheck=false)
	Prüft die Gültigkeit der Daten aus dem URI.
	insert ()
	Fügt Hash in Tabelle ein.
Öffentliche, statische Methoden
static	factory ($hash=null, $uri= '', array $parameters=array(), $length=32)
	Konstruktor.
static	fromText ($text=null, $uri= '', array $parameters=array(), $length=32)
	Einen Hash aus Klartext bilden.
Geschützte Methoden
	__construct ($hash=null, $length=32, array $parameters=array(), $uri= '')
	Erzeugt neuen Hash.
	_findRow ($again=false)
	Versucht Tabellenzeile des aktuelles Hashes zu finden.
Geschützte Attribute
	$_row = null
	Zend_Db_Table_Row, Datensatz des Hashes aus Tabelle.
	$_uri = null
	Dsao_Uri_Http, aufgerufener URI.

---

Ausführliche Beschreibung

Hash-Klasse, die auf Einträgen der Tabelle 'user_hash' basiert.

Repräsentiert einen um einen Aktion-Hash und Benutzer-ID erweiterten Hash, der eine Zeile der Tabelle 'user_hash' darstellt.

Autor:

DSAo-Md

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

Version:

SVN: $Id: User.php 518 2009-09-02 18:34:53Z saviola777 $

Definiert in Zeile 12 der Datei User.php.

---

Beschreibung der Konstruktoren und Destruktoren

Dsao_Hash_User::__construct	(	$	hash = null,
		$	length = 32,
		array $	parameters = array(),
		$	uri = ''
	)			[protected]

Erzeugt neuen Hash.

Der Parameter $uri erwartet den URI entweder in Form eines

• Strings
• Arrays (siehe Dsao_Uri_Http:: setParameters())
• Dsao_Uri_Http-Objekts

Parameter:

	$hash	string, Hash
	$length	int, Länge des Hashes
	$parameters	array, Parameter
	$uri	Dsao_Uri_Http|string, URI

Rückgabe:

void

Definiert in Zeile 39 der Datei User.php.

  {
    // Falls Objekt übergeben wurde
    if (is_object($uri))
    {
      $this->_uri = $uri;
      $this->_uri->setParameters($parameters, true);
    }
    // Ansonsten wurde String übergeben
    else
    {
      $this->_uri = new Dsao_Uri_Http($uri, $parameters);
    }

    // Falls Hash noch null ist
    if (null === $hash)
    {
      $hash = $this->_uri->hash;
    }


    parent::__construct($hash, $length);
  }

---

Dokumentation der Elementfunktionen

Dsao_Hash_User::__get

(

$

parameter

)

Wrapper für Getter-Methode des URI.

Parameter:

$parameter

string, Parameter

Rückgabe:

mixed, Wert des Parameters

Definiert in Zeile 69 der Datei User.php.

  {
    return $this->_uri->__get($parameter);
  }

Dsao_Hash_User::__set	(	$	parameter,
		$	value
	)

Wrapper für Setter-Methode des URI.

Parameter:

	$parameter	string, Parametername
	$value	mixed, Wert

Rückgabe:

void

Definiert in Zeile 81 der Datei User.php.

Benutzt Dsao_Hash::isReadOnly().

  {
    // Falls Objekt schreibgeschützt ist
    $this->isReadOnly(true);


    return $this->_uri->__set($parameter, $value);
  }

Dsao_Hash_User::_findRow

(

$

again = false

)

[protected]

Versucht Tabellenzeile des aktuelles Hashes zu finden.

Parameter:

$again

bool, ob in jedem Fall noch einmal gesucht werden soll

Rückgabe:

void

Definiert in Zeile 96 der Datei User.php.

Benutzt Dsao_Hash::getHash() und Dsao_Registry::getTable().

Wird benutzt von isValid().

  {
    // Falls schon geprüft wurde und nicht nochmal geprüft werden soll
    if (null !== $this->_row && !$again)
    {
      return;
    }

    // Falls keine Hash-ID vorhanden ist
    if (!$this->_uri->idHash)
    {
      $this->_row = Dsao_Registry::getTable('user_hash')->select()
        ->where('idUser = ?', $this->_uri->idUser)
        ->where('hash = ?', $this->getHash())->fetchRow();

      // Falls Zeile gefunden wurde
      if ($this->_row)
      {
        $this->_uri->idHash = $this->_row->id;
      }
    }
    else
    {
      $this->_row = Dsao_Registry::getTable('user_hash')
        ->find($this->_uri->idHash)->current();
    }
  }

Dsao_Hash_User::deleteDuplicates

(

)

Löscht alle Duplikate.

Duplikate sind Einträge mit gleicher Benutzer-ID und gleichem Aktions-Hash.

Rückgabe:

Dsao_Hash_User, fließendes Interface

Definiert in Zeile 132 der Datei User.php.

Benutzt Dsao_Registry::get(), Dsao_Registry::getTable() und isValid().

  {
    // Falls Objekt nicht gültig
    if (!$this->isValid(null))
    {
      throw new Dsao_Exception('dsao_hash_user_object_invalid');
    }

    // Where-Klausel
    $sqlWhere = 'idUser = '. (int) $this->_row->idUser.' AND '.
      Dsao_Registry::get('db')->quoteInto
        ('hashAction = ?', $this->_row->hashAction).' AND '.
      'id != '. (int) $this->_row->id;

    // Löschen
    Dsao_Registry::getTable('user_hash')->delete($sqlWhere);

    return $this;
  }

Dsao_Hash_User::deleteRow

(

)

Löscht Tabellenzeile.

Rückgabe:

Dsao_Hash_User, fließendes Interface

Definiert in Zeile 157 der Datei User.php.

Benutzt isValid().

Wird benutzt von Dsao_Model_User_Register::activateUser().

  {
    // Falls Zeile vorhanden, löschen
    if ($this->isValid(null))
    {
      $this->_row->delete();
      $this->_row = null;
    }

    return $this;
  }

static Dsao_Hash_User::factory	(	$	hash = null,
		$	uri = '',
		array $	parameters = array(),
		$	length = 32
	)			[static]

Konstruktor.

Parameter:

	$hash	string, Hash
	$uri	Dsao_Uri_Http|string, URI
	$parameters	array, Parameter des URI
	$length	int, Länge des Hashes

Rückgabe:

void

Definiert in Zeile 178 der Datei User.php.

Wird benutzt von Dsao_Model_User_Login::_cookieRegenerate(), User_RegisterController::activateAction(), Dsao_Model_User_Login::cookieLogin(), Dsao_Model_User_Register::insertUser(), isValid() und User_LoginController::passwordAction().

  {
    // Objekt zurück geben
    return new self($hash, $length, $parameters, $uri);
  }

static Dsao_Hash_User::fromText	(	$	text = null,
		$	uri = '',
		array $	parameters = array(),
		$	length = 32
	)			[static]

Einen Hash aus Klartext bilden.

Parameter:

	$text	string, Klartext
	$uri	Dsao_Uri_Http|string, URI
	$parameters	array, Parameter
	$length	int, Länge des Hashes

Rückgabe:

Dsao_Hash_User, Hash-Objekt

Definiert in Zeile 193 der Datei User.php.

Wird benutzt von insert().

  {
    $hash = new self(null, $length, $parameters, $uri);

    $hash->_generateHash($text);

    return $hash;
  }

Dsao_Hash_User::getUri

(

)

Gibt URI zurück.

Rückgabe:

Dsao_Uri_Http, URI

Definiert in Zeile 207 der Datei User.php.

Wird benutzt von Dsao_Model_User_Register::_sendActivationMail() und Dsao_Model_User_Register::activateUser().

  {
    return $this->_uri;
  }

Dsao_Hash_User::hasDuplicates

(

)

Prüft, ob bereits Einträge mit dem gleichen Aktions-Hash für diesen Benutzer existieren.

Rückgabe:

bool, Ob Duplikate vorhanden sind

Definiert in Zeile 218 der Datei User.php.

Benutzt Dsao_Registry::getTable() und Dsao_Hash::isReadOnly().

  {
    // Falls Hash nicht gültig
    $this->isReadOnly(true);

    // SELECT-Statement
    return (bool) Dsao_Registry::getTable('user_hash')->select(true)
      ->reset(Zend_Db_Select::COLUMNS)
      ->columns(new Zend_Db_Expr('COUNT(*) AS duplicates'))
      ->where('idUser = ?', (int) $this->_row->idUser)
      ->where('hashAction = ?', $this->_row->hashAction)
      ->where('id != ?', $this->_row->id)
      ->fetchRow()->duplicates;
  }

Dsao_Hash_User::insert

(

)

Fügt Hash in Tabelle ein.

Rückgabe:

Dsao_Hash_Entry, fließendes Interface

Definiert in Zeile 297 der Datei User.php.

Benutzt fromText(), Dsao_Hash::getHash(), Dsao_Registry::getTable() und isValid().

  {
    // Falls Zeile vorhanden
    if ($this->isValid(null))
    {
      throw new Dsao_Exception('dsao_hash_user_hash_inserted');
    }

    // Falls keine Benutzer-ID vorhanden
    if (!$this->_uri->idUser)
    {
      throw new Dsao_Exception('dsao_hash_user_id_missing');
    }

    // Hash hinzufügen
    $this->_uri->hash = $this->getHash();

    // Hash der Aktion
    $hashAction = parent::fromText($this->_uri->
      getUriString(array(true, 'hash', 'idHash')), null, $this->_length);

    // Daten
    $data = array(
      'idUser'      => (int) $this->_uri->idUser,
      'hash'        => $this->getHash(),
      'hashAction'  => $hashAction->getHash(),
      );

    $this->_uri->idHash = Dsao_Registry::getTable('user_hash')->insert($data);

    return $this;
  }

Dsao_Hash_User::isValid	(	$	parametersNames = true,
		$	recheck = false
	)

Prüft die Gültigkeit der Daten aus dem URI.

Die Methode lädt einen Hash aus der Datenbank und vergleicht ihn mit den in der URI übergebenen Daten.

Parameter:

	$parametersNames	array|bool Welche Parameter bei der Prüfung des Aktions-Hashes herangezeogen werden sollen; wird null übergeben, so wird lediglich die Zeile geladen und zurückgegeben
	$recheck	bool, ob Tabellenzeile neu geladen werden soll

Rückgabe:

bool, Gültigkeit

Definiert in Zeile 245 der Datei User.php.

Benutzt _findRow() und factory().

Wird benutzt von Dsao_Model_User_Register::activateUser(), deleteDuplicates(), deleteRow() und insert().

  {
    // Falls entweder neu geprüft werden soll oder noch nicht geprüft wurde
    if ($recheck || null === $this->_row)
    {
      $this->_findRow();
    }

    // Falls keine Zeile gefunden, abbrechen
    if (!$this->_row || null === $parametersNames)
    {
      return $this->_row;
    }

    // Ggf. Parameterliste in Array umwandeln
    if (!is_array($parametersNames))
    {
      $parametersNames = array($parametersNames);
    }

    // Leerer Array -> false
    if (empty($parametersNames))
    {
      $parametersNames = array(false);
    }
    // Ansonsten prüfen, ob als erster Parameter true übergeben wurde
    else if ($parametersNames[0] === true)
    {
      $parametersNames = array_merge($parametersNames,
        array('hash', 'idHash'));
    }

    // Falls Benutzer-ID nicht übereinstimmt
    if ($this->_row->idUser != $this->_uri->idUser
        // oder Hash nicht übereinstimmt
        || !parent::factory($this->_row->hash)->compareTo($this)
        // oder Hash der Aktion nicht stimmt
        || !parent::factory($this->_row->hashAction)->compareTo
            (parent::fromText($this->_uri
              ->getUriString($parametersNames))))
    {
      return false;
    }

    return true;
  }

---

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

• /var/www/devel.dsao.eu/library/Dsao/Hash/User.php