Dsao_Model_User_Register Klassenreferenz

Model-Klasse des Register-Controllers. Mehr ...

Klassendiagramm für Dsao_Model_User_Register:

Aufstellung aller Elemente

Öffentliche Methoden
	activateUser (Dsao_Hash_User $activationKey)
	Versucht, einen Benutzer mit der übergebenen ID zu aktivieren.
	getUsernameSuggestions ($username)
	Erzeugt zu einem uebergebenen Benutzernamen vier Alternative Vorschlaege.
	isUniqueEmailAddress ($emailAddress)
	Prüft Einmaligkeit der E-Mail-Adresse.
	isUniqueUsername ($username)
	Prüft Einmaligkeit des Benutzernames.
	insertUser (Dsao_User $user)
	Fuegt einen Benutzer in die Datenbank ein.
Geschützte Methoden
	_init ()
	Initialisierung des Modells.
	_sendActivationMail (Dsao_User $user, Dsao_Hash_User $activationKey)
	Versendet eine E-Mail mit dem Aktivierungsschluessel an einen Benutzer.

---

Ausführliche Beschreibung

Model-Klasse des Register-Controllers.

Die Klasse enthaelt alle fuer die Registrierung wichtigen Methoden fuer die Kommunikation mit der Datenbank.

Autor:

DSAo-Md

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

Version:

SVN: $Id: Register.php 512 2009-06-19 08:11:48Z saviola777 $

Definiert in Zeile 12 der Datei Register.php.

---

Dokumentation der Elementfunktionen

Dsao_Model_User_Register::_init

(

)

[protected]

Initialisierung des Modells.

Die Modelle können diese Methode überladen, um Standardtabelle usw. fest zu legen.

Rückgabe:

void

Erneute Implementation von Dsao_Model_Abstract.

Definiert in Zeile 14 der Datei Register.php.

Benutzt Dsao_Model_Abstract::_setDefaultTable().

  {
    $this->_setDefaultTable('user_data');
  }

Dsao_Model_User_Register::_sendActivationMail	(	Dsao_User $	user,
		Dsao_Hash_User $	activationKey
	)			[protected]

Versendet eine E-Mail mit dem Aktivierungsschluessel an einen Benutzer.

Parameter:

	$user	Dsao_User, Benutzer, dem Bestaetigungsmail zugeschickt werden soll
	$activationKey	Dsao_Hash_User, Aktivierungsschluessel

Rückgabe:

bool, ob Versenden erfolgreich war

Definiert in Zeile 27 der Datei Register.php.

Benutzt Dsao_Model_Abstract::getTranslate(), Dsao_Hash_User::getUri() und Dsao_View_Smarty::sprintf().

Wird benutzt von insertUser().

  {
    // E-Mail vorbereiten
    $content = Dsao_View_Smarty::sprintf
      ('user_register_insert_activation_email_content',
      array
        (
          'activationUri' => $activationKey->getUri()
            ->getUriString(true, false, true),
        ));

    $subject = $this->getTranslate()->
                  _('user_register_insert_activation_email_subject');

    $mail = new Dsao_Mail($user, $subject, $content);

    // E-Mail versenden
    return $mail->send();
  }

Dsao_Model_User_Register::activateUser

(

Dsao_Hash_User $

activationKey

)

Versucht, einen Benutzer mit der übergebenen ID zu aktivieren.

Parameter:

$activationKey

Dsao_Hash_User, Aktivierungsschlüssel

Rückgabe:

bool, ob Aktivierung erfolgreich war

Definiert in Zeile 53 der Datei Register.php.

Benutzt Dsao_Hash_User::deleteRow(), Dsao_Model_Abstract::getLog(), Dsao_Hash_User::getUri() und Dsao_Hash_User::isValid().

  {
    // Benuter erstellen
    $user = new Dsao_User(array('id' => $activationKey->getUri()->idUser));

    // Falls Benutzer ungültig, abbrechen
    if (!$user->refresh()->isSynchronous())
    {
      $this->getLog()->err('user_register_activate_error_invalid_id',
        __METHOD__);
    }

    // Falls Benutzer bereits aktiviert, abbrechen
    else if ($user->activated)
    {
      $this->getLog()->err('user_register_activate_error_activated',
        __METHOD__);
    }

    // Falls Aktivierungsschlüssel nicht gültig
    else if (!$activationKey->isValid('idUser'))
    {
      $this->getLog()->err('user_register_activate_error_invalid_key',
        __METHOD__);
    }

    // Keine Fehler
    else
    {
      $user->activated = true;

      $user->setValid(true)->update(array('activated'));

      // Aktivierungsschlüssel aus Datenbank löschen
      $activationKey->deleteRow();

      return true;
    }

    return false;
  }

Dsao_Model_User_Register::getUsernameSuggestions

(

$

username

)

Erzeugt zu einem uebergebenen Benutzernamen vier Alternative Vorschlaege.

Parameter:

$username

string, Benutzername, zu dem Alternativen gefunden werden sollen

Rückgabe:

ArrayObject, Namensvorschlaege

Definiert in Zeile 102 der Datei Register.php.

Benutzt Dsao_Model_Abstract::_getTable().

  {
    // array, Vorschlaege fuer alternativen Benutzernamen
    $usernameSuggestions = new ArrayObject();

    // Nach verfuegbaren Benutzernamen suchen, bei vier gefundenen
    // Treffern Schleife verlassen
    for ($i = 1; (count($usernameSuggestions) < 4); $i++)
    {
      // Vorschlaege
      $suggestions = array
        (
          $username.$i,
          $username.'_'.$i,
          $i.$username,
          $i.'_'.$username,
        );

      foreach ($suggestions as $suggestion)
      {
        // Falls Benutzer noch nicht existiert, Vorschläge ergänzen
        if (!$this->_getTable()->select()->where('username = ?', $suggestion)->fetchRow())
        {
          $usernameSuggestions->append($suggestion);
        }
      }
    }

    return $usernameSuggestions;
  }

Dsao_Model_User_Register::insertUser

(

Dsao_User $

user

)

Fuegt einen Benutzer in die Datenbank ein.

Parameter:

$user

Dsao_User, einzutragener Benutzer

Rückgabe:

bool, ob Einfuegen erfolgreich war

Definiert in Zeile 169 der Datei Register.php.

Benutzt Dsao_Model_Abstract::_getTable(), _sendActivationMail(), Dsao_Hash_User::factory() und Dsao_Model_Abstract::getLog().

  {
    // Daten fuer Tabellen vorbereiten
    $sqlUserData = array
    (
      'emailAddress'  => $user->emailAddress,
      'password'      => $user->password,
      'username'      => $user->username,
    );

    // ID zunaechst auf 0 setzten, da noch unbekannt
    $sqlUserProfile = array
    (
      'id'          => 0,
    );

    $sqlUserSettings = array
    (
      'id'          => 0,
    );

    // Transaktion starten
    $this->_getTable()->getAdapter()->beginTransaction();

    try
    {
      // Benutzerdaten einfuegen und gleichzeitig ID fuer Datensatz in den
      // anderen Tabellen zuweisen
      $sqlUserProfile['id'] = $sqlUserSettings['id'] =
        $this->_getTable()->insert($sqlUserData);

      // Benutzerobjekt aktualisieren, um Aktivierungsmail verschicken zu
      // können
      $user->setId($sqlUserProfile['id'], false, false);

      // Profildaten eintragen
      $this->_getTable('user_profile')->insert($sqlUserProfile);

      // Einstellungen eintragen
      $this->_getTable('user_settings')->insert($sqlUserSettings);

      // Aktivierungsschlüssel
      $activationKey = Dsao_Hash_User::factory(null,
        new Dsao_Uri_Http('/user/register/activate', array(
          'idUser'  => $user->getId(),
        )));

      // Einfügen
      $activationKey->insert();

      // Transaktion abschliessen
      $this->_getTable()->getAdapter()->commit();
    }

    // Falls Fehler aufgetreten sind, Transaktion zuruecksetzen
    catch (Zend_Db_Exception $e)
    {
      $this->_getTable()->getAdapter()->rollback();

      $this->getLog()->err('global_error_mysql_write', __METHOD__);

      return false;
    }

    // Aktivierungsmail verschicken
    $this->_sendActivationMail($user, $activationKey);
  }

Dsao_Model_User_Register::isUniqueEmailAddress

(

$

emailAddress

)

Prüft Einmaligkeit der E-Mail-Adresse.

Gibt zurueck, ob E-Mail-Adresse noch nicht in der DB vorhanden ist.

Parameter:

$emailAddress

string, E-Mail-Adresse

Rückgabe:

bool, ob E-Mail-Adresse einmalig ist

Definiert in Zeile 141 der Datei Register.php.

Benutzt Dsao_Model_Abstract::_getTable().

  {
    // Query erstellen und durchführen
    return !(bool) $this->_getTable()->select()->where
      ('emailAddress = ?', $emailAddress)->fetchRow();
  }

Dsao_Model_User_Register::isUniqueUsername

(

$

username

)

Prüft Einmaligkeit des Benutzernames.

Gibt zurueck, ob Benutzername noch nicht in der DB vorhanden ist.

Parameter:

$username

string, Benutzername

Rückgabe:

bool, ob Benutzername einmalig ist

Definiert in Zeile 156 der Datei Register.php.

Benutzt Dsao_Model_Abstract::_getTable().

  {
    // Query erstellen und durchführen
    return !(bool) $this->_getTable()->select()
      ->where('username = ?', $username)->fetchRow();
  }

---

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

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