ApiOpenStudio PHPDoc

Details of the processor.

Indexes: 'name' (string): Human readable name of the processor.

'machineName' (string): Machine name of the processor in snake case.

'description' (string): Description of the processor.

'menu' (string): Lists the immediate menu parents.

examples: 'menu' => 'menu1' - belongs to menu1

'conditional' (optional, boolean):

ApiOpenStudio usually parses the node tree using depth-first iteration. In some cases, this may be wasteful because a processor may require conditional branching, in which case, we do not want to parse all comparison values until we know what branch we will take, i.e. in if_then_else processor, we do not need to process both the 'then' and the 'else' branches.

If omitted or set to false: The parsing will continue as normal (depth-first).

If set to true: The processor will be calculated and then the result branch will be returned and added to the stack.

'input': List the input nodes for this processor This is an array with the following indexes:

'description' (string): description of what the processor does

'cardinality': (int min, mixed max) e.g. [0, 1] max can be integer or ''. '' = infinite

'literalAllowed' (boolean): Allow liter values.

'limitValues' (array|mixed): Limit the result values passed into the processor.

'limitProcessors' (array|string): Limit the input processors.

'limitTypes' (array): an array of input type this processor will accept. Possible values: file literal bool numeric integer text float bool

'conditional' (optional): In the case of branching processors (see 'preprocess' above), this indicates if the input is a conditional input or required for the logic comparison.

examples: input => [ 'sources' => [ 'description' => 'desc1', 'cardinality' => [1, '*'], type => ['literal'] ] ] This processor has only one input, called sources. Sources must contain at least one value. The inputs can only be a literal value.

 input => [
   'method' => [
     'description' => 'desc1',
     'cardinality' => [1, 1],
     'literalAllowed': true
     'limitType': ['text'],
     'limitValues' => ["get", "post"]
   ],
   'auth' => [
      'description' => 'desc2',
      'cardinality' => [1, 1],
      'limitProcessors' => ['var_get'],
   ],
   'vars' => [
      'description' => 'desc3',
      'cardinality' => [0, '*'],
       limitTypes => ['integer'],
   ],
   't' => [
      'description' => 'desc4',
      'cardinality' => [0, '*'],
      'limitProcessors' => ['field'],
   ],
 ]

 This Processor has 4 inputs:

     method, which has only one input, of type text, with only 2 possible values ('get' and 'post'),
         literals are allowed.
     auth, which has only one value, of type processor (var_get).
     vars, which can contain:
         0 or many values
         Must be an integer
         with no limit on value
     t, which can take or many input of Processor Field.

Request.