help_class Class Reference
Provides easier access to meta information about Nacoma's object types.
More...
Detailed Description
Provides easier access to meta information about Nacoma's object types.
Member Function Documentation
help_class::get_available_objects |
( |
$ |
detailed = false |
) |
|
- Parameters:
-
| $detailed | boolean = false |
- Returns:
- array e.g. [host] => host_class
help_class::get_html_help_for_object_type |
( |
$ |
object_type |
) |
|
- Parameters:
-
| $object_type | string e.g. 'host' |
- Exceptions:
-
| Exception | when given invalid object type |
- Returns:
- string
help_class::list_objects |
( |
$ |
base_uri = null |
) |
|
- Parameters:
-
| $base_uri | string = null This will be prepended to the href |
- Returns:
- string
Field Documentation
help_class::$blacklist [static] |
Initial value: array(
'common_gui',
'pnp_page_class',
'FILE_class',
'new_host_class',
'escalation_class',
'extinfo_class',
'hostextinfo_class',
'serviceextinfo_class',
)
Classes that for different reasons aren't part of this API.
- Todo:
- common_gui does weird things when included (and isn't a class), so it shouldn't even be in the class directory
The documentation for this class was generated from the following file: