Documentation

addUserFields extends event
in package

Module-Event: addUserFields

Event wird ausgeführt, wenn im Artikel-Editor die Link-Liste für den "Link einfügen"-Dialog geladen wird Parameter: Array mit bereits vorhandenen benutzerdefinierten Feldern in der Form Beschreibung als key => Feldparamater als value Rückgabe: Array mit vorhandenen benutzerdefinierten Feldern in der Form Beschreibung als key => Feldparamater als value

  • Feld-Typen:

  • textarea => <textarea>

  • select =>

  • radio =>

  • textinput/unbekannt =>

  • Aufbau für alle Feld-Typen:

    • 'type' => Feld-Type
    • 'name' => Feld-Name
    • 'value' => Feld-Value
    • 'class' => CSS-Klasse für Feld
    • 'readonly' => readonly-Eigenschaft
  • zusätzlich für Typ "textinput"

    • 'lenght' => maximale Textlänge
  • zusätzlich für Typ "select"

    • 'options' => Optionen für Select-Box
    • 'firstempty' => erstes Element automatisch "Bitte wählen"
    • 'firstenabled' => erstes Element automatisch leer
  • zusätzlich für Typ "checkbox" und "radio"

    • 'description' => Bschreibung von Checkbox/ Radiobutton
    • 'id' => Element-ID
    • 'selected' => Vorauswahl ja/nein
Tags
author

Stefan Seehafer aka imagine fanpress@nobody-knows.org

copyright

(c) 2011-2022, Stefan Seehafer

license

http://www.gnu.org/licenses/gpl.txt GPLv3

Table of Contents

EVENT_BASE_INSTANCE  = '\\fpcm\\module\\event'
Base instaces a module event has to implement
$cache  : cache
Event-Cache
$data  : mixed|eventResult
Event-Daten
$permissions  : permissions
Berechtigungen
__construct()  : bool
Konstruktor
getEventNamespace()  : string
Returns full event namespace
isExecutable()  : bool
User acan execute event
run()  : eventResult
Executes event
afterProcess()  : bool
After event running
afterRun()  : bool
After event running
beforeProcess()  : void
Prepare event before processing
beforeRun()  : bool
Prepare event before running
getEventClassBase()  : string
Returns event base class data
getEventClasses()  : array<string|int, mixed>
Liefert Array mit Event-Klassen in installierten Modulen zurück
getEventParams()  : mixed
Returns event params
is_a()  : bool
Checks if module event class has implemented \fpcm\module\event
onNoClasses()  : eventResult
Return event result object if no events will be triggered
processClass()  : bool
Process class data

Constants

EVENT_BASE_INSTANCE

Base instaces a module event has to implement

public mixed EVENT_BASE_INSTANCE = '\\fpcm\\module\\event'

Properties

Methods

__construct()

Konstruktor

public __construct([mixed $dataParams = null ]) : bool
Parameters
$dataParams : mixed = null
Return values
bool

getEventNamespace()

Returns full event namespace

public final static getEventNamespace(string $event) : string
Parameters
$event : string
Return values
string

isExecutable()

User acan execute event

public isExecutable() : bool
Tags
since
4.4
Return values
bool

afterProcess()

After event running

protected afterProcess() : bool
Tags
since
5.3.0-dev
Return values
bool

afterRun()

After event running

protected afterRun() : bool
Tags
since
5.3.0-dev
Return values
bool

beforeProcess()

Prepare event before processing

protected beforeProcess(event $event) : void
Parameters
$event : event
Tags
since
5.3.0-dev
Return values
void

beforeRun()

Prepare event before running

protected beforeRun() : bool
Tags
since
5.3.0-dev
Return values
bool

getEventClassBase()

Returns event base class data

protected getEventClassBase() : string
Return values
string

getEventClasses()

Liefert Array mit Event-Klassen in installierten Modulen zurück

protected getEventClasses() : array<string|int, mixed>
Tags
since
3.3
Return values
array<string|int, mixed>

getEventParams()

Returns event params

protected getEventParams() : mixed
Return values
mixed

is_a()

Checks if module event class has implemented \fpcm\module\event

protected is_a(mixed $object) : bool
Parameters
$object : mixed
Return values
bool

onNoClasses()

Return event result object if no events will be triggered

protected onNoClasses() : eventResult
Tags
since
5.3.0-dev
Return values
eventResult

processClass()

Process class data

protected processClass(string $class) : bool
Parameters
$class : string
Tags
since
5.3.0-dev
Return values
bool

Search results