Documentation

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 => </p> </li> <li> <p>select => <select></p> </li> <li> <p>checkbox => <input type="checkbox"></p> </li> <li> <p>radio => <input type="radio"></p> </li> <li> <p>textinput/unbekannt => <input type="text"></p> </li> <li> <p>Aufbau für alle Feld-Typen:</p> </li> <li> <ul> <li>'type' => Feld-Type</li> </ul> </li> <li> <ul> <li>'name' => Feld-Name</li> </ul> </li> <li> <ul> <li>'value' => Feld-Value</li> </ul> </li> <li> <ul> <li>'class' => CSS-Klasse für Feld</li> </ul> </li> <li> <ul> <li>'readonly' => readonly-Eigenschaft</li> </ul> </li> <li> <p>zusätzlich für Typ "textinput"</p> </li> <li> <ul> <li>'lenght' => maximale Textlänge</li> </ul> </li> <li> <p>zusätzlich für Typ "select"</p> </li> <li> <ul> <li>'options' => Optionen für Select-Box</li> </ul> </li> <li> <ul> <li>'firstempty' => erstes Element automatisch "Bitte wählen"</li> </ul> </li> <li> <ul> <li>'firstenabled' => erstes Element automatisch leer</li> </ul> </li> <li> <p>zusätzlich für Typ "checkbox" und "radio"</p> </li> <li> <ul> <li>'description' => Bschreibung von Checkbox/ Radiobutton</li> </ul> </li> <li> <ul> <li>'id' => Element-ID</li> </ul> </li> <li> <ul> <li>'selected' => Vorauswahl ja/nein</li> </ul> </li> </ul></section> <h3>Table of Contents</h3> <table class="phpdocumentor-table_of_contents"> <tr> <th class="phpdocumentor-heading"><a href="../classes/fpcm-events-abstracts-event.html#property_data">$data</a></th> <td class="phpdocumentor-cell">Event-Daten</td> <td class="phpdocumentor-cell">array</td> </tr> <tr> <th class="phpdocumentor-heading"><a href="../classes/fpcm-events-abstracts-event.html#property_modules">$modules</a></th> <td class="phpdocumentor-cell">Events mit aktuellem Event</td> <td class="phpdocumentor-cell">array</td> </tr> <tr> <th class="phpdocumentor-heading"><a href="../classes/fpcm-events-abstracts-event.html#property_activeModules">$activeModules</a></th> <td class="phpdocumentor-cell">Liste mit aktiven Modulen</td> <td class="phpdocumentor-cell">array</td> </tr> <tr> <th class="phpdocumentor-heading"><a href="../classes/fpcm-events-abstracts-event.html#property_cache">$cache</a></th> <td class="phpdocumentor-cell">Event-Cache</td> <td class="phpdocumentor-cell"><a href="../classes/fpcm-classes-cache.html"><abbr title="\fpcm\classes\cache">cache</abbr></a></td> </tr> <tr> <th class="phpdocumentor-heading"><a href="../classes/fpcm-events-abstracts-event.html#property_permissions">$permissions</a></th> <td class="phpdocumentor-cell">Berechtigungen</td> <td class="phpdocumentor-cell"><a href="../classes/fpcm-model-permissions-permissions.html"><abbr title="\fpcm\model\permissions\permissions">permissions</abbr></a></td> </tr> <tr> <th class="phpdocumentor-heading"><a href="../classes/fpcm-events-abstracts-event.html#method_getReturnType">getReturnType()</a></th> <td class="phpdocumentor-cell">Defines type of returned data</td> <td class="phpdocumentor-cell">string|bool|null</td> </tr> <tr> <th class="phpdocumentor-heading"><a href="../classes/fpcm-events-abstracts-event.html#method___construct">__construct()</a></th> <td class="phpdocumentor-cell">Konstruktor</td> <td class="phpdocumentor-cell">bool</td> </tr> <tr> <th class="phpdocumentor-heading"><a href="../classes/fpcm-events-abstracts-event.html#method_isExecutable">isExecutable()</a></th> <td class="phpdocumentor-cell">User acan execute event</td> <td class="phpdocumentor-cell">bool</td> </tr> <tr> <th class="phpdocumentor-heading"><a href="../classes/fpcm-events-abstracts-event.html#method_is_a">is_a()</a></th> <td class="phpdocumentor-cell">Checks if module event class has implemented \fpcm\module\event</td> <td class="phpdocumentor-cell">bool</td> </tr> <tr> <th class="phpdocumentor-heading"><a href="../classes/fpcm-events-abstracts-event.html#method_getEventClasses">getEventClasses()</a></th> <td class="phpdocumentor-cell">Liefert Array mit Event-Klassen in installierten Modulen zurück</td> <td class="phpdocumentor-cell">array</td> </tr> <tr> <th class="phpdocumentor-heading"><a href="../classes/fpcm-events-abstracts-event.html#method_getEventClassBase">getEventClassBase()</a></th> <td class="phpdocumentor-cell">Returns event base class data</td> <td class="phpdocumentor-cell">string</td> </tr> <tr> <th class="phpdocumentor-heading"><a href="../classes/fpcm-events-abstracts-event.html#method_run">run()</a></th> <td class="phpdocumentor-cell">Executes a certain event</td> <td class="phpdocumentor-cell">array</td> </tr> <tr> <th class="phpdocumentor-heading"><a href="../classes/fpcm-events-abstracts-event.html#method_getEventNamespace">getEventNamespace()</a></th> <td class="phpdocumentor-cell">Returns full event namespace</td> <td class="phpdocumentor-cell">string</td> </tr> </table> <section> <h3 class="phpdocumentor-properties__header">Properties</h3> <a id="property_data"></a> <article class=" phpdocumentor-property phpdocumentor-property--protected " > <h4 class="phpdocumentor-property__name">$data</h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="inc/events/abstracts/event.php"><a href="../files/inc-events-abstracts-event.html"><abbr title="inc/events/abstracts/event.php">event.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">54</span> </aside> <p class="phpdocumentor-summary">Event-Daten</p> <code class="phpdocumentor-signature phpdocumentor-code "> <span class="phpdocumentor-signature__visibility">protected</span> <span class="phpdocumentor-signature__type">array</span> <span class="phpdocumentor-signature__name">$data</span> </code> </article> <a id="property_modules"></a> <article class=" phpdocumentor-property phpdocumentor-property--protected " > <h4 class="phpdocumentor-property__name">$modules</h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="inc/events/abstracts/event.php"><a href="../files/inc-events-abstracts-event.html"><abbr title="inc/events/abstracts/event.php">event.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">60</span> </aside> <p class="phpdocumentor-summary">Events mit aktuellem Event</p> <code class="phpdocumentor-signature phpdocumentor-code "> <span class="phpdocumentor-signature__visibility">protected</span> <span class="phpdocumentor-signature__type">array</span> <span class="phpdocumentor-signature__name">$modules</span> </code> </article> <a id="property_activeModules"></a> <article class=" phpdocumentor-property phpdocumentor-property--protected " > <h4 class="phpdocumentor-property__name">$activeModules</h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="inc/events/abstracts/event.php"><a href="../files/inc-events-abstracts-event.html"><abbr title="inc/events/abstracts/event.php">event.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">66</span> </aside> <p class="phpdocumentor-summary">Liste mit aktiven Modulen</p> <code class="phpdocumentor-signature phpdocumentor-code "> <span class="phpdocumentor-signature__visibility">protected</span> <span class="phpdocumentor-signature__type">array</span> <span class="phpdocumentor-signature__name">$activeModules</span> = <span class="phpdocumentor-signature__default-value">[]</span> </code> </article> <a id="property_cache"></a> <article class=" phpdocumentor-property phpdocumentor-property--protected " > <h4 class="phpdocumentor-property__name">$cache</h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="inc/events/abstracts/event.php"><a href="../files/inc-events-abstracts-event.html"><abbr title="inc/events/abstracts/event.php">event.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">72</span> </aside> <p class="phpdocumentor-summary">Event-Cache</p> <code class="phpdocumentor-signature phpdocumentor-code "> <span class="phpdocumentor-signature__visibility">protected</span> <span class="phpdocumentor-signature__type"><a href="../classes/fpcm-classes-cache.html"><abbr title="\fpcm\classes\cache">cache</abbr></a></span> <span class="phpdocumentor-signature__name">$cache</span> </code> </article> <a id="property_permissions"></a> <article class=" phpdocumentor-property phpdocumentor-property--protected " > <h4 class="phpdocumentor-property__name">$permissions</h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="inc/events/abstracts/event.php"><a href="../files/inc-events-abstracts-event.html"><abbr title="inc/events/abstracts/event.php">event.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">78</span> </aside> <p class="phpdocumentor-summary">Berechtigungen</p> <code class="phpdocumentor-signature phpdocumentor-code "> <span class="phpdocumentor-signature__visibility">protected</span> <span class="phpdocumentor-signature__type"><a href="../classes/fpcm-model-permissions-permissions.html"><abbr title="\fpcm\model\permissions\permissions">permissions</abbr></a></span> <span class="phpdocumentor-signature__name">$permissions</span> </code> </article> </section> <section> <h3 class="phpdocumentor-methods__header">Methods</h3> <a id="method_getReturnType"></a> <article class=" phpdocumentor-method phpdocumentor-method--protected " > <h4 class="phpdocumentor-method__name">getReturnType()</h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="inc/events/abstracts/event.php"><a href="../files/inc-events-abstracts-event.html"><abbr title="inc/events/abstracts/event.php">event.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">169</span> </aside> <p class="phpdocumentor-summary">Defines type of returned data</p> <code class="phpdocumentor-signature phpdocumentor-code "> <span class="phpdocumentor-signature__visibility">protected</span> <span class="phpdocumentor-signature__name">getReturnType</span>( ) : <span class="phpdocumentor-signature__response_type">string|bool|null</span> </code> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">string|bool|null</span> </article> <a id="method___construct"></a> <article class=" phpdocumentor-method phpdocumentor-method--public " > <h4 class="phpdocumentor-method__name">__construct()</h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="inc/events/abstracts/event.php"><a href="../files/inc-events-abstracts-event.html"><abbr title="inc/events/abstracts/event.php">event.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">85</span> </aside> <p class="phpdocumentor-summary">Konstruktor</p> <code class="phpdocumentor-signature phpdocumentor-code "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">__construct</span>( <span class="phpdocumentor-signature__argument"> [ <span class="phpdocumentor-signature__argument__name">$dataParams</span> : <span class="phpdocumentor-signature__argument__return-type">mixed</span> = <span class="phpdocumentor-signature__argument__default-value">null</span> ] </span> ) : <span class="phpdocumentor-signature__response_type">bool</span> </code> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$dataParams</span> : <span class="phpdocumentor-signature__argument__return-type">mixed</span> = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt> <dd class="phpdocumentor-argument-list__definition"><section class="phpdocumentor-description"></section></dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">bool</span> </article> <a id="method_isExecutable"></a> <article class=" phpdocumentor-method phpdocumentor-method--public " > <h4 class="phpdocumentor-method__name">isExecutable()</h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="inc/events/abstracts/event.php"><a href="../files/inc-events-abstracts-event.html"><abbr title="inc/events/abstracts/event.php">event.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">160</span> </aside> <p class="phpdocumentor-summary">User acan execute event</p> <code class="phpdocumentor-signature phpdocumentor-code "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">isExecutable</span>( ) : <span class="phpdocumentor-signature__response_type">bool</span> </code> <h5 class="phpdocumentor-tag-list__heading">Tags</h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">since</span> </dt> <dd class="phpdocumentor-tag-list__definition"><section class="phpdocumentor-description"></section></dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">bool</span> </article> <a id="method_is_a"></a> <article class=" phpdocumentor-method phpdocumentor-method--protected " > <h4 class="phpdocumentor-method__name">is_a()</h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="inc/events/abstracts/event.php"><a href="../files/inc-events-abstracts-event.html"><abbr title="inc/events/abstracts/event.php">event.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">179</span> </aside> <p class="phpdocumentor-summary">Checks if module event class has implemented \fpcm\module\event</p> <code class="phpdocumentor-signature phpdocumentor-code "> <span class="phpdocumentor-signature__visibility">protected</span> <span class="phpdocumentor-signature__name">is_a</span>( <span class="phpdocumentor-signature__argument"> <span class="phpdocumentor-signature__argument__name">$object</span> : <span class="phpdocumentor-signature__argument__return-type">mixed</span> </span> ) : <span class="phpdocumentor-signature__response_type">bool</span> </code> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$object</span> : <span class="phpdocumentor-signature__argument__return-type">mixed</span> </dt> <dd class="phpdocumentor-argument-list__definition"><section class="phpdocumentor-description"></section></dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">bool</span> </article> <a id="method_getEventClasses"></a> <article class=" phpdocumentor-method phpdocumentor-method--protected " > <h4 class="phpdocumentor-method__name">getEventClasses()</h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="inc/events/abstracts/event.php"><a href="../files/inc-events-abstracts-event.html"><abbr title="inc/events/abstracts/event.php">event.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">195</span> </aside> <p class="phpdocumentor-summary">Liefert Array mit Event-Klassen in installierten Modulen zurück</p> <code class="phpdocumentor-signature phpdocumentor-code "> <span class="phpdocumentor-signature__visibility">protected</span> <span class="phpdocumentor-signature__name">getEventClasses</span>( ) : <span class="phpdocumentor-signature__response_type">array</span> </code> <h5 class="phpdocumentor-tag-list__heading">Tags</h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">since</span> </dt> <dd class="phpdocumentor-tag-list__definition"><section class="phpdocumentor-description"></section></dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">array</span> </article> <a id="method_getEventClassBase"></a> <article class=" phpdocumentor-method phpdocumentor-method--protected " > <h4 class="phpdocumentor-method__name">getEventClassBase()</h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="inc/events/abstracts/event.php"><a href="../files/inc-events-abstracts-event.html"><abbr title="inc/events/abstracts/event.php">event.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">222</span> </aside> <p class="phpdocumentor-summary">Returns event base class data</p> <code class="phpdocumentor-signature phpdocumentor-code "> <span class="phpdocumentor-signature__visibility">protected</span> <span class="phpdocumentor-signature__name">getEventClassBase</span>( ) : <span class="phpdocumentor-signature__response_type">string</span> </code> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">string</span> </article> <a id="method_run"></a> <article class=" phpdocumentor-method phpdocumentor-method--public " > <h4 class="phpdocumentor-method__name">run()</h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="inc/events/abstracts/event.php"><a href="../files/inc-events-abstracts-event.html"><abbr title="inc/events/abstracts/event.php">event.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">233</span> </aside> <p class="phpdocumentor-summary">Executes a certain event</p> <code class="phpdocumentor-signature phpdocumentor-code "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">run</span>( ) : <span class="phpdocumentor-signature__response_type">array</span> </code> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">array</span> </article> <a id="method_getEventNamespace"></a> <article class=" phpdocumentor-method phpdocumentor-method--public phpdocumentor-element--static phpdocumentor-element--final " > <h4 class="phpdocumentor-method__name">getEventNamespace()</h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="inc/events/abstracts/event.php"><a href="../files/inc-events-abstracts-event.html"><abbr title="inc/events/abstracts/event.php">event.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">285</span> </aside> <p class="phpdocumentor-summary">Returns full event namespace</p> <code class="phpdocumentor-signature phpdocumentor-code "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__final">final</span> <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">getEventNamespace</span>( <span class="phpdocumentor-signature__argument"> <span class="phpdocumentor-signature__argument__name">$event</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </span> ) : <span class="phpdocumentor-signature__response_type">string</span> </code> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$event</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"><section class="phpdocumentor-description"></section></dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">string</span> </article> </section> </article> <div data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden"> <h2>Search results</h2> <ul class="phpdocumentor-search-results__entries"> </ul> </div> </div> </div> </main> </body> </html>