hw_api->object

Description

This function retrieves the attribute information of an object of any version. It will not return the document content. The parameter array contains the required elements 'objectIdentifier' and the optional elements 'attributeSelector' and 'version'.

The returned object is an instance of class HW_API_Object on success or HW_API_Error if an error occured.

This simple example retrieves an object and checks for errors.

Example 1. Retrieve an object <?php function handle_error($error) { $reason = $error->reason(0); echo "Type: <B>"; switch($reason->type()) { case 0: echo "Error"; break; case 1: echo "Warning"; break; case 2: echo "Message"; break; } echo "</B><BR>\n"; echo "Description: ".$reason->description("en")."<BR>\n"; } function list_attr($obj) { echo "<TABLE>\n"; $count = $obj->count(); for($i=0; $i<$count; $i++) { $attr = $obj->attribute($i); printf(" <TR><TD ALIGN=right bgcolor=#c0c0c0><B>%s</B></TD><TD bgcolor=#F0F0F0>%s</TD>\n", $attr->key(), $attr->value()); } echo "</TABLE>\n"; } $hwapi = hwapi_hgcsp($g_config[HOSTNAME]); $parms = array("objectIdentifier"=>"rootcollection, "attributeSelector"=>array("Title", "Name", "DocumentType")); $root = $hwapi->object($parms); if(get_class($root) == "HW_API_Error") { handle_error($root); exit; } list_attr($root); ?>

See also hwapi_content().