This class is an instantion of the Command class, that executes a command pertaining to fetching configuration information, in the default case from the database. This class should only be instantiated by dispatchMBAPI() found in include/mbapi/mbapi.php. Something similar to the following XML should be passed to dispatchMBAPI() when you want to call the GetConfigGroups command:
<mbapi> <command><!-- None --></command> <showXMLHeader><!-- None --></showXMLHeader> <params> <configGroupID><!-- int --></configGroupID> <configGroupName><!-- string --></configGroupName> <parentConfigGroupID><!-- int --></parentConfigGroupID> <getNumChildren><!-- int --></getNumChildren> <getLevelOneChildren><!-- int --></getLevelOneChildren> <sortDir><!-- None --></sortDir> <sortColumn><!-- None --></sortColumn> <recordOffset><!-- None --></recordOffset> <numRecords><!-- None --></numRecords> </params> </mbapi>
None
mbapi
command
showXMLHeader
params
configGroupID
The ID of the config group to be fetched.
configGroupName
The name of the config group whose parameters that will be fetched. This should be used sparingly as many config groups have the same name.
parentConfigGroupID
The ID of the parent config group to be fetched. This will return all config groups with this parent.
getNumChildren
Set to 1 to retrieve the number of children config groups that a config group is parent of. Should only be used in conjuction with one config group selected.
getLevelOneChildren
Set to 1 to retrieve the full info of children config groups that a config group is parent of. Should only be used in conjuction with one config group selected.
sortDir
sortColumn
recordOffset
numRecords