Online help display

package midcom.admin.help

 Methods

__construct ()

_handler_component (mixed $handler_id, array $args, array $data)

Parameters

$handler_id

mixedThe ID of the handler.

$args

arrayThe argument list.

$data

array&$data The local request data.

_handler_help (mixed $handler_id, array $args, array $data)

Parameters

$handler_id

mixedThe ID of the handler.

$args

arrayThe argument list.

$data

array&$data The local request data.

_handler_welcome (mixed $handler_id, array $args, array $data)

Parameters

$handler_id

mixedThe ID of the handler.

$args

arrayThe argument list.

$data

array&$data The local request data.

_on_initialize ()

_show_component (mixed $handler_id, array $data)

Shows the component help ToC.

Parameters

$handler_id

mixedThe ID of the handler.

$data

array&$data The local request data.

_show_help (mixed $handler_id, array $data)

Shows the help page.

Parameters

$handler_id

mixedThe ID of the handler.

$data

array&$data The local request data.

_show_welcome (mixed $handler_id, array $data)

Shows the help system main screen

Parameters

$handler_id

mixedThe ID of the handler.

$data

array&$data The local request data.

check_component ($component)

Static

Parameters

$component

generate_file_path ($help_id, $component, $language)

Static

Parameters

$help_id

$component

$language

get_documentation_dir (string $component)

Static method for getting component's documentation directory path
Static

Parameters

$component

stringComponent name

Returns

stringComponent documentation directory path

get_help_contents ($help_id, $component)

Load a help file and markdownize it

Parameters

$help_id

$component

get_help_title ($help_id, $component)

Static

Parameters

$help_id

$component

help_exists (string $help_id, string $component)

Static method for checking if help file exists
Static

Parameters

$help_id

stringHelp name ID

$component

stringComponent name

Returns

boolTrue of false

list_files ($component, $with_index)

Parameters

$component

$with_index

read_component_handlers ($component)

Parameters

$component

read_schema_properties ()

read_url_methods ($component)

Parameters

$component

_add_virtual_files ($files, $component)

Parameters

$files

$component

_get_property_data ($mrp, $prop)

Parameters

$mrp

$prop

_list_components ()

_list_physical_files ($component)

Parameters

$component

_load_component_data ($name)

Parameters

$name

_load_file ($help_id, $component)

Load the file from the component's documentation directory.

Parameters

$help_id

$component

_prepare_breadcrumb ($handler_id)

Parameters

$handler_id

 Properties

 

mixed $mgdtypes

 

mixed $special_ids