Home > PHP > Function > Hyperwave API > hw_api->children()

hw_api->children()

hw_api->children - Returns children of an object

Syntax

array hw_api->children (array $parameter)

Arguments

  • parameter - The parameter array contains the required elements \'objectIdentifier\' and the optional elements \'attributeSelector\' and \'objectQuery\'.

Description

Retrieves the children of a collection or the attributes of a document. The children can be further filtered by specifying an object query.

Version

PHP 4, 5 < 5.2.0, PECL hwapi SVN

Return value

The return value is an array of objects of type HW_API_Objector HW_API_Error.