Docs For Class virtual

Description

Located in /sources/occle.php (line 121)

Variable Summary

mixed $current_input

mixed $fs

mixed $input_parameters

mixed $output

mixed $parsed_input

mixed $parse_runtime

Method Summary

virtual_bash virtual_bash (string $inputted_command, [?array $prior_output = NULL], [?array $parameters = NULL])

~tempcode output_html ([boolean $blank_ok = false])

boolean output_xml ()

void parse_input ()

~array return_output ()

~array return_parse_tree ()

tempcode _array_to_html (array $array)

string _array_to_text (array $array, [integer $indentation = 0])

boolean _check_is_redirection ()

array _combine_streams (array $stream1, array $stream2)

string _do_indentation (integer $indentation)

void _extract_command ()

void _extract_extras ()

void _extract_options ()

void _extract_parameters ()

~string _find_script_file (string $script_name, [?string $dir = NULL])

void _handle_php_command ()

Variables

mixed $current_input (line 123)

mixed $fs (line 128)

mixed $input_parameters (line 127)

mixed $output (line 126)

mixed $parsed_input (line 124)

mixed $parse_runtime (line 125)

Methods

Constructor virtual_bash (line 137)

Constructor function. Starts command parsing on the supplied command.

virtual_bash virtual_bash (string $inputted_command, [?array $prior_output = NULL], [?array $parameters = NULL])

string $inputted_command: The inputted command, unparsed
?array $prior_output: An array of prior output to be prepended (NULL: none)
?array $parameters: An array of prior parameters (NULL: none)

output_html (line 252)

Return the HTML rendering of the parsed command's output.

return: The HTML (false: error)

~tempcode output_html ([boolean $blank_ok = false])

boolean $blank_ok: Whether it is okay to have blank output

output_xml (line 213)

Output an XML-RPC packet (hopefully) to the AJAX in the frontend.

return: Success?

boolean output_xml ()

parse_input (line 839)

Parses input setup in constructor, and creates a parse tree.

void parse_input ()

return_output (line 202)

Returns the output for the command just parsed.

return: The output (false: failure)

~array return_output ()

return_parse_tree (line 191)

Returns the parse tree for the command just parsed.

return: The parse tree (false: failure)

~array return_parse_tree ()

_array_to_html (line 1146)

Convert an array to tempcode for display.

return: Tempcode for array

tempcode _array_to_html (array $array)

array $array: Array to display

_array_to_text (line 1165)

Convert an array to text for display.

return: Text representation of array

string _array_to_text (array $array, [integer $indentation = 0])

array $array: Array to display
integer $indentation: Global indentation

_check_is_redirection (line 822)

Is the current block a valid redirection instruction?

return: Redirection instruction?

boolean _check_is_redirection ()

_combine_streams (line 1091)

Combine two streams regardless of their format.

return: Combined streams

array _combine_streams (array $stream1, array $stream2)

array $stream1: Stream 1
array $stream2: Stream 2

_do_indentation (line 1184)

Return a specified number of tabs.

return: Tabs

string _do_indentation (integer $indentation)

integer $indentation: Number of tabs to return

_extract_command (line 280)

Extract the command name from the input.

void _extract_command ()

_extract_extras (line 652)

Extract extra tokens from the input.

void _extract_extras ()

_extract_options (line 345)

Extract options (switches) from the input.

void _extract_options ()

_extract_parameters (line 508)

Extract parameters from the input.

void _extract_parameters ()

_find_script_file (line 1302)

Find a script file.

return: Path or failure (false: failure)

~string _find_script_file (string $script_name, [?string $dir = NULL])

string $script_name: Script name
?string $dir: Directory (NULL: OcCLE module data dir)

_handle_php_command (line 1195)

Handle a PHP command by executing it, dealing with variables from the class.

void _handle_php_command ()

Class virtual_bash