mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 10:28:54 +00:00
c030e2adf7
- All id attributes are now xml:id - Add docbook namespace to all root elements - Replace <ulink /> with <link xlink:href /> - Minor markup fixes here and there git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@238160 c90b9560-bf6c-de11-be94-00142212c4b1
135 lines
3.2 KiB
XML
135 lines
3.2 KiB
XML
<?xml version='1.0' encoding='iso-8859-1' ?>
|
|
<!-- $Revision: 1.13 $ -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.hwapi-object">
|
|
<refnamediv>
|
|
<refname>hw_api->object</refname>
|
|
<refpurpose>Retrieve attribute information</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<classsynopsis>
|
|
<ooclass><classname>hw_api</classname></ooclass>
|
|
<methodsynopsis>
|
|
<type>hw_api_object</type><methodname>object</methodname>
|
|
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
|
</methodsynopsis>
|
|
</classsynopsis>
|
|
<para>
|
|
This function retrieves the attribute information of an object of any
|
|
version. It will not return the document content.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>parameter</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The parameter array contains the required elements 'objectIdentifier'
|
|
and the optional elements 'attributeSelector' and 'version'.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
The returned object is an instance of class
|
|
<classname>HW_API_Object</classname> on success or
|
|
<classname>HW_API_Error</classname> if an error occurred.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
This simple example retrieves an object and checks for errors.
|
|
<example>
|
|
<title>Retrieve an object</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?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></tr>\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);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><xref linkend="function.hwapi-content" /></member>
|
|
</simplelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"../../../../manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|