Skip to main content
Skip table of contents

script\PHPCallback - edoc automate

Die PHPCallback-Aktion führt einen Callback der App aus. Der Callback muss als Datei und als Klasse im App-Ordner vorhanden sein.

Sie müssen einen Callback von der Klasse \edoc\appserver\ScriptAPI\Callback ableiten.

Beispiel

PHP
< ?php

use edoc\appserver\ScriptAPI\Callback;

// Simple example for a callback
// The class name must match the file name!
class Example extends Callback
{
  public function init()
  {
  }
  public function exec()
  {
    $name = $this->param('name');
    $this->api->returnValue('Hello ' . $name . '!');
  }
}

Script API

PHP
class Action {
  // Executes an action.
  // @param string $actionName Type of action, e.g. default\\Message.
  // @param array $params The parameter for the selected action.
  public function exec($actionName, $params);

  // Get datasource instance (d.3/db/...)
  // @param $name
  // @return DataSource|null
  public function getDatasource($name): ?DataSource;

  // Sets return value of the callback. If called several times, the previous value will be overwritten!
  // @param string|int|boolean $value The return value.
  public function returnValue($value);

  // Sets the return dataset of the callback. If called several times, the previous value will be overwritten!
  // @param array $value The return dataset.
  public function returnDataset($value);

  // Returns information about the current app.
  // @return array
  public function info();

  // Returns all app variables.
  // @return array
  public function getAppVariables();

  // Returns the app variable with the name $name.
  // @return mixed
  public function getAppVariable($name);
}

class Callback {
  // Returns all parameter passed.
  // @return array
  public function params();

  // Returns the passed parameter with the specified names.
  // @return mixed
  public function param($name);

  // Checks whether a parameter with the name $name was returned. Returns true or false.
  // @return boolean
  public function paramExists($name);

  abstract public function init();
  abstract public function exec();
}

Parameter

Typ

Name

Beschreibung

TEXT

file

Gibt den Pfad und den Namen des PHP-Skripts auf dem Server im plugins-Verzeichnis der App an.

KEYVALUELIST

params

Gibt die Liste mit dem Namen und Werten der Parameter an, die an den Callback übergeben werden.

Rückgabe

Typ

Beschreibung

SINGLEVALUE

Gibt den Wert des Callbacks zurück.

DATASET

Gibt den Datensatz des Callbacks zurück.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.