Composr API documentation
Back to top  

Provide multi-screen (multi-form) decision trees.

package core

 Methods

Create a decision tree handler.

__construct(array $decision_tree, \ID_TEXT $default_screen = 'start') 

Parameters

$decision_tree

array

Decision tree structure to work from

$default_screen

\ID_TEXT

Name of the default screen to start from

Start the decision tree process, returning Tempcode for the screen currently on.

run() : \Tempcode

Returns

\TempcodeScreen output

Build out a URL to a particular decision tree screen.

build_url(\ID_TEXT $target_position) : \Tempcode

Parameters

$target_position

\ID_TEXT

Tree position to go to

Returns

\TempcodeURL

Process a step within the decision tree needing value checks.

process_input(\ID_TEXT $tree_position) : \ID_TEXT

Parameters

$tree_position

\ID_TEXT

Tree position coming from

Returns

\ID_TEXTTree position going to

Render out decision tree screen.

render(\ID_TEXT $tree_position) : \Tempcode

Parameters

$tree_position

\ID_TEXT

Tree position at

Returns

\TempcodeScreen output

 Properties

 

$decision_tree

$decision_tree 

Default

 

$default_screen

$default_screen 

Default