Files
doc-fr/reference/hwapi/functions/hwapi-object.xml
Damien Seguy 79c7478ede minor spelling mistakes and literalisatin
git-svn-id: https://svn.php.net/repository/phpdoc/fr/trunk@259743 c90b9560-bf6c-de11-be94-00142212c4b1
2008-05-14 11:21:55 +00:00

141 lines
3.5 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.15 $ -->
<!-- EN-Revision: 1.13 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.hwapi-object">
<refnamediv>
<refname>hw_api->object</refname>
<refpurpose>Lit les informations d'attribut</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>
Lit les informations d'attribut d'un objet de n'importe quelle
version. Elle ne retournera pas le contenu du document.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>parameter</parameter></term>
<listitem>
<para>
Le paramètre <parameter>parameter</parameter>
est un tableau qui contient l'élément obligatoire
<literal>"objectIdentifier"</literal> et les éléments optionnels
<literal>"attributeSelector"</literal> et <literal>"version"</literal>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
L'objet retourné est une instance de la classe
<classname>HW_API_Object</classname> en cas de succès ou
<classname>HW_API_Error</classname> en cas d'erreur.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
Cet exemple simple lit un objet et vérifie les erreurs.
<example>
<title>Lit un objet Hyperwave et le vérifie</title>
<programlisting role="php">
<![CDATA[
<?php
function handle_error($error)
{
$reason = $error->reason(0);
echo "Type: <b>";
switch ($reason->type()) {
case 0:
echo "Erreur";
break;
case 1:
echo "Alerte";
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
-->