From 98efd86bc0c7c92cd7f9d0bc574e1d761887bfef Mon Sep 17 00:00:00 2001 From: Patrick <2913330+patrickpr@users.noreply.github.com> Date: Tue, 11 Feb 2020 00:15:53 +0100 Subject: [PATCH] functions doc --- docs/50-api-functions.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/50-api-functions.md b/docs/50-api-functions.md index f04dc2c..3fe85df 100644 --- a/docs/50-api-functions.md +++ b/docs/50-api-functions.md @@ -32,9 +32,9 @@ Functions are freely added in a plugin (you can use existing one to just add one Add the function parameters in the plugin->functions array : -- $functions[]['function'] : Name of the function to be called in this class -- $functions[]['params'] : Description of input parameters of function. -- $functions[]['description'] : Description. Can be multiline. +- $functions[name]['function'] : Name of the function to be called in this class +- $functions[name]['params'] : Description of input parameters of function. +- $functions[name]['description'] : Description. Can be multiline. Create in the plugin class a new function : @@ -42,9 +42,9 @@ Create in the plugin class a new function : where -- functionName = $functions[]['function'] +- functionName = $functions[name]['function'] - $params = params passed by rule. The function MUST check params and throw exception on error. -- return an evaluation +- return an evaluation as boolean Example with inNetwork function -------------------------------