API für Validatoren in edoc automate

Sie können für jede Aktion eine Validierungsfunktion (Validator) konfigurieren. Mithilfe der API können Sie die Standardüberprüfungsfunktionen im Abschnitt Validation einer Aktionen mit neuen Validatoren erweitern. Sie fügen Ihre eigene Validierungsfunktion in Aktionen als eigenes App-Plug-In hinzu.

Namespace für Validatoren

Die standardmäßigen Validatoren und Plug-In-Validatoren verwenden denselben Namespace.

namespace edoc\appserver\app\validators;

Basisklasse für Validatoren

Validatoren müssen von der Klasse AbstractValidator erben. Plug-Ins, die nicht von AbstractValidator erben, können von edoc automate nicht geladen werden.

<?php

abstract class AbstractValidator
{
  
    abstract protected function exec($value): bool;
    abstract protected function init(): void;
    
    /* adds a configuration-parameter */ 
    protected function addParameter($name, $type, $defaultValue = '');
    
    /* returns the configured value for the given parameter name */
    protected function param($name);
    
    /* returns the configured or currently set message */
    public function message(): string
    
    /* overwrites the configured message */
    protected function setMessage($message): void
    
    /* returns the id from the currently validated component */
    protected function currentComponentId(): string
}

Hinzufügen von eigenen App-Validatoren

Wenn Sie bestimmte Prüfungen bei der Validierung von Komponenten nicht mit den standardmäßigen Validatoren durchführen können, müssen Sie ein neues Plug-In im App-Ordner ./<app>/plugins/validators/ z.B. per WebDAV erstellen.

Sie können per WebDAV im Browser ein neues Plug-In einfach per Formular erstellen.

So geht's

1. Erstellen Sie im Ordner ./<app>/plugins/validators/ einen neuen Ordner (z.B. Email). Der Name des Ordner muss den Namen der Aktion widerspiegeln.

2. Erstellen Sie in dem Ordner eine Datei mit demselben Namen mit der Endung .php (z.B. Email.php)

3. Öffnen Sie die Datei mit einem beliebigen Texteditor.

4. Fügen Sie folgenden Inhalt in die Datei ein:
   

   PHP

   <?php
   
   namespace edoc\appserver\app\validators;
   
   use edoc\appserver\app\AbstractValidator;
   
   class Email extends AbstractValidator
   {
     protected function init(): void
     {
     }
     protected function exec($value): bool
     {
       return filter_var($value, FILTER_VALIDATE_EMAIL);
     }
   }

5. Speichern Sie die Datei mit dem korrekten Encoding: UTF-8 ohne BOM.