|
|
# Cron Package - Entwickler Doku
|
|
|
# Cron Package - Dokumentation für Entwickler
|
|
|
|
|
|
_Cron = Task, Aufgabe, Cron_
|
|
|
|
... | ... | @@ -13,6 +13,7 @@ Definieren Sie Im Hauptordner eines Pakets eine cron.xml. In dieser cron.xml kö |
|
|
<cron exec="CLASS::method">
|
|
|
<title>Titel des Cron</title>
|
|
|
<description>Beschreibung des Cron</description>
|
|
|
|
|
|
<!-- optional -->
|
|
|
<params>
|
|
|
<param name="project" type="string"/>
|
... | ... | @@ -20,6 +21,18 @@ Definieren Sie Im Hauptordner eines Pakets eine cron.xml. In dieser cron.xml kö |
|
|
<locale group="vendor/package" var="cron.param.lang"/>
|
|
|
</param>
|
|
|
</params>
|
|
|
|
|
|
<!-- optional -->
|
|
|
<autocreate>
|
|
|
<scope>projects</scope>
|
|
|
<interval>0 * * * *</interval>
|
|
|
<active>1</active>
|
|
|
|
|
|
<params>
|
|
|
<param name="project">[projectName]</param>
|
|
|
<param name="lang">[projectLang]</param>
|
|
|
</params>
|
|
|
</autocreate>
|
|
|
</cron>
|
|
|
</crons>
|
|
|
```
|
... | ... | @@ -77,4 +90,57 @@ In `params ` können festgelegte Parameter für den Cron definiert werden. Param |
|
|
* **data-qui** __(optional)__ - Lädt ein QUIQQER JavaScript-Control über das Eingabe-Input für den Parameter-Wert. So sind komplexere Eingaben für Parameter-Werte möglich (z.B. spezielle Auswahllisten, Mehr-Sprachen-Inputs etcg.gg).
|
|
|
|
|
|
### (Optional) Parameter-Beschreibung
|
|
|
Das `<param>`-Attribute kann optional ein `<locale>`-Attribute beinhalten (s. Beispiel oben). Damit kann in einer Sprachvaribable eine Kurzbeschreibung eines Parameters mitgegeben werden, welche bei Festlegung des Parameters in der Cron-Administration angezeigt wird. |
|
|
\ No newline at end of file |
|
|
Das `<param>`-Attribute kann optional ein `<locale>`-Attribute beinhalten (s. Beispiel oben). Damit kann in einer Sprachvaribable eine Kurzbeschreibung eines Parameters mitgegeben werden, welche bei Festlegung des Parameters in der Cron-Administration angezeigt wird.
|
|
|
|
|
|
## `<autocreate>`
|
|
|
|
|
|
Über das `<autocreate>`-Tag kann festgelegt werden, dass ein Cron automatisch vom System angelegt wird, wenn das entsprechende Paket installiert wird.
|
|
|
|
|
|
### `<interval>` *(Pflichtfeld)*
|
|
|
|
|
|
Gibt an, in welchem Intervall ein Cron ausgeführt wird.
|
|
|
|
|
|
Unterstützt wird hier die offizielle crontab Syntax (siehe z.B. https://www.stetic.com/developer/cronjob-linux-tutorial-und-crontab-syntax).
|
|
|
|
|
|
**Beispiel:** `<interval>0 * * * *</interval>` -> Jede Stunde bei Minute 0
|
|
|
|
|
|
### `<active>` *(optional)*
|
|
|
|
|
|
Gibt an, ob der Cron nach dem Anlegen aktiviert oder deaktiviert sein soll.
|
|
|
|
|
|
**Standard:** aktiv
|
|
|
|
|
|
**Beispiel:** `<active>0</active>` -> Cron wird angelegt, aber deaktiviert
|
|
|
|
|
|
### `<params>` *(optional)*
|
|
|
|
|
|
Legt die konkreten Parameter-Werte fest, mit denen der Cron automatisch angelegt wird.
|
|
|
|
|
|
Angegeben werden können hier alle Parameter, die in der `<cron>`-Ebene im Abschnitt `<params>` festgelegt wurden.
|
|
|
|
|
|
**Beispiel:**
|
|
|
|
|
|
```xml
|
|
|
<params>
|
|
|
<param name="key">value</param>
|
|
|
</params>
|
|
|
```
|
|
|
|
|
|
Der Cron wird mit dem Parameter `key` und dem Wert `value` angelegt.
|
|
|
|
|
|
### `<scope>` *(optional)*
|
|
|
|
|
|
Crons können für bestimmte Geltungsbereiche angelegt werden. Je nach Geltungsbereich stehen verschiedene Platzhalter in den Parametern (`<params>`; s.o.) zur Verfügung. Zusätzlich werden je nach Geltungsbereich u.U. auch mehrere Crons gleichzeitig angelegt.
|
|
|
|
|
|
Aktuell unterstützte Werte:
|
|
|
|
|
|
* `projects` -> Der Cron wird für alle Projekte (+ ggf. alle Projekt-Sprachen) im System angelegt und zusätzlich, wenn ein neues Projekt erstellt wird.
|
|
|
* Verfügbare Parameter-Platzhalter:
|
|
|
* `[projectName]` - Der (interne) Name des jeweiligen Projekts
|
|
|
* `[projectLang]` - Das Sprachkürzel des Projekts (z.B.: `de`)
|
|
|
|
|
|
### Mehrere `<autocreate>`-Einträge
|
|
|
|
|
|
Es können auch mehrere `<autocreate>`-Blöcke pro Cron angegeben werden. Jeder Block wird eingenständig geparst.
|
|
|
|
|
|
So können z.B. mehrere Crons mit unterschiedlichen Parametern automatisiert angelegt werden. |
|
|
\ No newline at end of file |