fe_adminLib.inc

Hauptklasse, die benutzt wird, um die Frontend-Verwaltungsformulare anzuzeigen.
Kann von einem »USER_INT-Inhaltsobjekt durch userFunc = user_feAdmin->init aufgerufen werden. Siehe static_templates für Beispiele.
ANMERKUNG: Der Gebrauch des »USER_INT ermöglicht es dem Skript, unabhängig von Seiten-Cache zu arbeiten.

fe_admin_fe_users.tmpl

Beispiel-Designvorlage für das Anlegen neuer Frontendbenutzer (fe_users). Diese Designvorlage wird auch vom static_template plugin.feadmin.fe_users benutzt.

cmd

Anweisung

backURL

Zurück-URL

aC

Authentifizierungscode

FE

Datenarray der Frontendbearbeitung, Syntax: FE[Tabellenname][Feldname] = Wert

templateFile

resource

Die Designvorlagendatei, siehe Beispiele in media/scripts/fe_user_admin.tmpl.

table

Tabellenname

Die zu bearbeitende Tabelle.

ANMERKUNG: Die Liste von Feldern, die schlußendlich wirklich bearbeitet werden dürfen, werden unter dem Schlüssel ["feInterface"]["fe_admin_fieldList"] in der TCA für jede infrage kommende Tabelle gespeichert. Für ein Beispiel, siehe die Tabellendefinition für fe_users, die ein gutes Beispiel ist.

clearCacheOfPages

[Integerliste]

Dies ist eine Liste von Seiten-IDs, deren Cache bei jeder erfolgreich durchgeführten Operation, sei es nun CREATE, EDIT oder DELETE, gelöscht werden soll.

Aktionen

create

Boolean / actionObject

Das Gleiche wie ».edit, wenn nicht anders angegeben. Zusätzlich gibt es folgende Parameter:

.noSpecialLoginForm (Boolean) Wenn diese Eigenschaft gesetzt ist, sicht fe_adminLib NICHT nach dem Subpart-Marker TEMPLATE_CREATE_LOGIN, sondern immer nach TEMPLATE_CREATE

.defaultValues.[Feldname] (String) Wie .overrideValues, allerdings setzt diese Eigenschaft die Vorgabewerte wenn das Formular zum ersten Mal angezeigt wird.

infomail

Boolean

Infomails sind Textmails, die auf Designvorlagen aus der Vorlagendatei basieren. Sie könnten benutzt werden, um zum Beispiel einem Benutzer ein vergessenes Passwort zuzuschicken, aber was in die Infomail hineinkommt, hängt völlig von Ihrer Gestaltung der Designvorlage ab.

Normalerweise haben Sie nur eine Vorgabe-Infomail (infomail.default), zum Beispiel zum Verschicken des Passwortes. Sie können allerdings auch andere Schlüssel verwenden. Siehe unten.

setfixed

Boolean / Eigenschaften

Ermöglicht die Eingabe von setfixed-Angaben, die zum Beispiel von einem Link in einer Infomail oder einer Benachrichtigungsmail kommen könnten.

Syntax:
.[fix-Schlüssel].[Feldname] = Wert: Wird benutzt, um einen setfixed-Link zu erstellen, der für den SYS_SETFIXED_*-Marker in die Infomail eingefügt wird.
Der besondere fix-Schlüssel DELETE ist nur ein Boolean-Wert.

Konzept:
Das setfixed-Konzept lässt sich am besten anhand einer typischen Situation beschreiben - die in der Tat auch der häufigste Verwendungszweck für diese Funktionalität ist:
Stellen Sie sich vor, auf Ihrer Website können Benutzer Daten übermitteln. Aber bevor diese Daten sichtbar werden, möchten Sie diese moderieren - also einfach einmal anschauen, und dann entweder veröffentlichen oder löschen. In der »create-Konfiguration von fe_adminLib lassen Sie das hidden-Field mit dem Wert 1 überschreiben. Der Datensatz wird also nach dem Erstellen grundsätzlich erst einmal versteckt. Dann konfigurieren Sie einen setfixed-Schlüssel, der das hidden-Field auf 0 setzt. Diese Einstellung erzeugt eine Parameterliste, die an eine URL angehängt wird, welche wiederum in den entsprechenden Marker in der Email-Designvorlage eingesetzt wird. Der Link beinhaltet sämtliche notwendigen Authentifizierungen, um die Wertzuweisungen durchzuführen, daher reicht ein einziger Mausklick, um die Feldwerte zu ändern. Der Datensatz wird also auf diese Weise - durch einen einzigen Mausklick auf einen Link in einer Benachrichtigungsmail an den Administrator - veröffentlicht, oder bei einem ähnlichen Link mit cmd=delete gelöscht.

Es gibt einen speziellen "Feldnamen", den Sie benutzen können, nämlich _FIELDLIST. Hier können Sie eine Liste von Feldern angeben, auf deren Basis der Authentifikationscode erstellt werden soll.
Wenn hier nichts angegeben ist, wird der md5-Hash auf dem gesamten Datensatz basierend erstellt, was bedeutet, dass jede Änderung am Datensatz den setfixed-Link ungültig machen wird. Wenn Sie _FIELDLIST jedoch andererseits den Wert uid,pid zuweisen, bleibt der Link solange gültig, wie auch die uid- und pid-Werte intakt sind.

Beispiel:
Dies ist eine gewöhnliche Konfiguration der Email-Einstellungen mit einer einfachen setfixed-Einstellung:

email.from = kasper@typo3.com
email.fromName = Kasper Skårhøj
email.admin = kasper@typo3.com
setfixed.approve {
  hidden = 0
  _FIELDLIST = uid,pid
}
setfixed.DELETE = 1
setfixed.DELETE._FIELDLIST = uid

Wenn Sie jetzt diesen Marker in Ihre Email-Designvorlage einbauen:
###SYS_SETFIXED_approve###
wird dieser mit einem Parameter wie diesem hier ersetzt:
&cmd=setfixed&rU=9&fD[hidden]=0&aC=5c403d90

Alles, was Sie jetzt noch tun müssen, ist, diese Parameter der korrekten URL zuzuweisen (wo fe_adminLib aufgerufen wird), z.B:
###THIS_URL######FORM_URL######SYS_SETFIXED_approve###
und zum Löschen:
...###SYS_SETFIXED_DELETE###

email

.from (String, Email) gibt die Absenderadresse von verschickten Mails an.

.fromName (String) gibt den Namen des Absenders an. Wenn diese Eigenschaft gesetzt ist, wird sie in der Form NAME <EMAIL> verwendet.

.admin ist die Emailadresse des Administrators, der über Veränderungen informiert wird.

.field (String/Integer) gibt den Feldnamen des Datensatzes an, in dem die Emailadresse, an die die Mail verschickt werden soll, zu finden ist. Wenn der Inhalt des Feldes ein Integer-Wert sein sollte, wird davon ausgegangen, dass dieser Integer-Wert die UID des fe_users ist, dem der Datensatz gehört, und die Emailadresse dieses Benutzers wird dann herangezogen.

fe_userEditSelf

Boolean

Wenn diese Eigenschaft gesetzt ist, können fe_users ihren eigenen Datensatz bearbeiten, egal ob er ihnen gehört oder nicht.

evalFunc

Funktionsname

Funktion, mit der Sie den Daten-Array bearbeiten können, bevor er gespeichert wird. Der Daten-Array wird als $content an die Funktion als Parameter übergeben und MUSS von dieser Funktion auch wieder zurückgeliefert haben.
Die Eigenschaft parentObj ist eine hardcodierte Referenz auf das fe_adminLib-Objekt.

parseValues.[Feld]

[Liste von parseCodes]

ParseCodes:

• int - Liefert den Integer Wert der Eingabe zurück
• lower - Liefert eine kleingeschriebene Version der Eingabe zurück
• upper - Liefert eine großgeschriebene Version der Eingabe zurück
• nospace - Entfernt alle Leerzeichen
• alpha, num, alphanum, alphanum_x - Erlaubt nur alphabetische (a-z) oder numerische Zeichen (0-9). alphanum_x erlaubt auch _ und -.
• trim - Entfernt abschließende Leerzeichen.
• setEmptyIfAbsend - Stellt sicher, dass der Feldwert auf einen leeren Wert gesetzt wird, wenn kein Wert übermittelt wird. Dies stellt sicher, dass ein Feld aktualisiert wird und ist nützlich mit Checkboxen.
• random[x] - Liefert eine zufälligt Nummer zwischen 0 und x zurück
• files[Semikolonliste(!) mit Dateiendungen, Keine Angabe=Alle Endungen][Maximale Größe in Kb, keine Angabe=keine Beschränkung] - Definiert das Feld, das Dateien beinhaltet. Siehe unten für Details!
• multiple - Setzen Sie diese Eigenschaft, wenn die Eingabe von einer multiplen Auswahlbox kommen (Denken Sie daran, dem Feldnamen [] hinzuzufügen, sodass die Werte in einem Array übergeben werden)
• checkArray - Setzen Sie diese Eigenschaften, wenn mehrere Checkboxen einzelne Bits in einem einzelnen Feld setzen sollen. In diesem Fall müssen Sie dem Namen jeder Checkbox [x] voranstellen, wobei x der zu setzenden Bitnummer entspricht, beginnend bei 0. Die Vorgabewerte der Checkbox-Formularelemente müssen auf falsch stehen.
• uniqueHashInt[Semikolonliste(!) von anderen Feldern] - Dies erzeugt einen einzigartigen Hash (32-Bit Integer) der Inhalte der angegebenen Felder. Die Werte dieser Felder werden zunächst in Kleinschreibung konvertiert und nur alphanumerische Zeichen bleiben erhalten.
  

evalErrors.[field].[evalCode]

Diese Eigenschaft lässt Sie die Fehlermeldungen, die in die Marker ###EVAL_ERROR_FIELD_[Feldname]### eingefügt werden, im Falle eines Auswertungsfehlers angeben.
Siehe die Beschreibung der Auswertung unten.

wrap1

»stdWrap

Globaler Wrap 1. Dies wird in die Marker ###GW1B### und ###GW1E### aufgeteilt. Verändern Sie nicht die Eingabe mit den Einstellungen, umschließen Sie sie einfach nur mit etwas.

Beispiel:
wrap1.wrap = <b> |</B>

color1

String / stdWrap

Wert für den ###GC1###-Marker (Global color 1)

color3

String / stdWrap

Wert für den ###GC3###-Marker (Global color 3)

###TEMPLATE_[action]_SAVED###

Wird für HTML-Ausgabe verwendet.

###TEMPLATE_SETFIXED_FAILED###

Wird für einen nicht erfolgreichen setfixed-Link benutzt. Beachten Sie, dass, wenn Sie einen setfixed-Link zweimal anklicken, das zweite Mal fehlschlagen wird. Das liegt daran, dass der setfixed-Link am Original-Datensatz hängt und der Authentifikationscode ungültig wird, wenn sich dieser (der Datensatz) in irgendeiner Weise ändert.

###EMAIL_TEMPLATE_[action]_SAVED-ADMIN###

Wird für eine Email-Nachricht an den Administrator benutzt.

###EMAIL_TEMPLATE_SETFIXED_[fixkey]-ADMIN###

s.o., für Mail an den Administrator.

###TEMPLATE_AUTH###

Wird angezeigt, wenn die Authentifikation - entweder durch fe_user oder Email-Authentifikation - fehlgeschlagen ist. Sie müssen die Fehlermeldung dementsprechend entwerfen, dass das Problem korrekt dargestellt wird.

###EMAIL_TEMPLATE_NORECORD###

###SUB_RECORD###

###SYS_AUTHCODE###

###GW1B### / ###GW1E###

Globaler Wrap 1, Anfang und Ende (Überschriften)

###GC1###/ ###GC2### / ###GC3###

Globale Farben 1 bis 3

###FORM_URL_ENC###

Wie oben, aber Rawurl-codiert.

###BACK_URL_ENC###

Wie oben, aber Rawurl-codiert.

###AUTH_CODE###

Die eingehende aC-Variable.

###THIS_ID###

Wird auf die ID der aktuellen Seite gesetzt.

###HIDDENFIELDS###

Einige versteckte Felder, die in die Formulare eingebunden werden müssen. Diese beinhalten standardmäßig Werte wie cmd, aC und backURL.

uniqueGlobal

Dies erfordert, dass der Wert eines Feldes global einzigartig ist, was bedeutet, dass er in diesem Feld in keinem anderen Datensatz dieser Tabelle existieren darf.

twice

Diese Eigenschaft, erfordert, dass der Wert des Feldes mit dem Wert eines zweiten Feldes mit dem Namen [Feldnamen]_again aus den eingehenden Formulardaten übereinstimmt. Das ist z.B. nützlich, wenn ein Passwort angegeben werden soll. Wenn der Feldnamen Ihres Passwortfeldes also z.B. user_pass ist, dann fügen Sie einfach ein zweites Feld mit dem Namen user_pass_again hinzu, und setzen den twice Eval-Code.

required

Lediglich eine einfache Erfordernis-Überprüfung. 0 (Null) gilt als leerer Wert.

inBranch

inBranch erfordert, dass der Wert (in der Regel ein PID-Feld) sich in einer Liste von Seiten-IDs (PIDs), welche mit dem inBranch-Parameter angegeben wurde, findet. Die Parameter werden so übergeben: [rood_pid; Tiefe; Anfang]
Beispiel, welches eine Liste von PIDs mit einer Ebene Tiefe von (einschließlich) Seite 4 aus: inBranch [4;1]