DlrgLogin.php

<?php
interface DlrgLogin
{
    /**
     * Diese Funktion gibt den HTML-Code eines Login- oder Logout-Formulars zurück, je nach Login-Status
     * @see isAuthenticated
     * @return string
     */
    public function getLoginForm();

    /**
     * Gibt true zurück, wenn ein gültiger DLRG-Account eingelogt ist
     * @param string[] $gruppen Wenn dieser Parameter gesetzt ist, wird zusätzlich überprüft, ob der
     * entsprechende Account Mitglied EINER dieser ISC-Internbereichsgruppen ist.
     * Es muss ein Array an Internbereich-IDs aus dem ISC angegeben werden
     * @return bool
     */
    public function isAuthenticated($gruppen = []);

    /**
     * Gibt true zurück, wenn ein (von irgendeiner Gliederung) bestätigter DLRG-Account eingelogt ist
     * @param string[] $gruppen Wenn dieser Parameter gesetzt ist, wird zusätzlich überprüft, ob der
     * entsprechende Account Mitglied EINER dieser ISC-Internbereichsgruppen ist.
     * Es muss ein Array an Internbereich-IDs aus dem ISC angegeben werden
     * @see isAuthenticated
     * @return bool
     */
    public function isApproved($gruppen = []);

    /**
     * Gibt den Benutzernamen eines eingelogten DLRG-Accounts zurück
     * Wenn @see isAuthenticated false ist, wird ein leerer string zurückgegeben
     * @return string
     */
    public function getUsername();

    /**
     * Gibt den Vornamen des eingelogten DLRG-Accounts zurück
     * @return string
     */
    public function getVorname();

    /**
     * Gibt den Nachnamen des eingelogten DLRG-Accounts zurück
     * @return string
     */
    public function getName();

    /**
     * Gibt den vollständigen Namen des eingelogten DLRG-Accounts zurück (getVorname().' '.getName())
     * @see getVorname
     * @see getName
     * @return string
     */
    public function getRealname();

    /**
     * Gibt die Email-Adresse des eingelogten DLRG-Accounts zurück
     * @return string
     */
    public function getEMail();
}