downloads | documentation | faq | getting help | mailing lists | licenses | wiki | reporting bugs | php.net sites | links | conferences | my php.net

search for in the

Our source is open

The syntax highlighted source is automatically generated by PHP from the plaintext script. If you're interested in what's behind the several functions we used, you can always take a look at the source of the following files:

Of course, if you want to see the source of this page, we have it available. You can also browse the SVN repository for this website on svn.php.net.

Source of: /manual/en/function.hwapi-object.php

<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.hwapi.inc";
$setup = array (
  'home' =>
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' =>
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' =>
  array (
    0 => 'function.hwapi-object.php',
    1 => 'hw_api->object',
  ),
  'up' =>
  array (
    0 => 'ref.hwapi.php',
    1 => 'Hyperwave API Functions',
  ),
  'prev' =>
  array (
    0 => 'function.hwapi-object-value.php',
    1 => 'hw_api_object->value',
  ),
  'next' =>
  array (
    0 => 'function.hwapi-objectbyanchor.php',
    1 => 'hw_api->objectbyanchor',
  ),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);

manual_header();
?>
<div id="function.hwapi-object" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">hw_api-&gt;object</h1>
  <p class="verinfo">(PHP 4, PHP 5 &lt; 5.2.0, PECL hwapi SVN)</p><p class="refpurpose"><span class="refname">hw_api-&gt;object</span> &mdash; <span class="dc-title">Retrieve attribute information</span></p>

 </div>
 
 <a name="function.hwapi-object.description"></a><div class="refsect1 description">
  <h3 class="title">Description</h3>
  <div class="classsynopsis">
   <div class="ooclass"><b class="classname">hw_api</b></div>
   <div class="methodsynopsis dc-description">
    <span class="type">hw_api_object</span> <span class="methodname"><b>object</b></span>
     ( <span class="methodparam"><span class="type">array</span> <tt class="parameter">$parameter</tt></span>
    )</div>

  </div>
  <p class="para">
   This function retrieves the attribute information of an object of any
   version. It will not return the document content.
  </p>
 </div>


 <a name="function.hwapi-object.parameters"></a><div class="refsect1 parameters">
  <h3 class="title">Parameters</h3>
  <p class="para">
   </p><dl>

    <dt class="varlistentry">

     <span class="term"><i><tt class="parameter">parameter</tt></i>
</span>

     </dt><dd class="listitem">

      <p class="para">
       The parameter array contains the required elements &#039;objectIdentifier&#039;
       and the optional elements &#039;attributeSelector&#039; and &#039;version&#039;.
      </p>
     </dd>

   
   </dl>
<p>
  </p>
 </div>


 <a name="function.hwapi-object.returnvalues"></a><div class="refsect1 returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="para">
   The returned object is an instance of class
   <b class="classname">HW_API_Object</b> on success or
   <b class="classname">HW_API_Error</b> if an error occurred.
  </p>
 </div>


 <a name="function.hwapi-object.examples"></a><div class="refsect1 examples">
  <h3 class="title">Examples</h3>
  <p class="para">
   This simple example retrieves an object and checks for errors.
   </p><div class="example">
    <p><b>Example #1 Retrieve an object</b></p>
    <div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br /></span><span style="color: #007700">function&nbsp;</span><span style="color: #0000BB">handle_error</span><span style="color: #007700">(</span><span style="color: #0000BB">$error</span><span style="color: #007700">)<br />{<br />&nbsp;&nbsp;</span><span style="color: #0000BB">$reason&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">$error</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">reason</span><span style="color: #007700">(</span><span style="color: #0000BB">0</span><span style="color: #007700">);<br />&nbsp;&nbsp;echo&nbsp;</span><span style="color: #DD0000">"Type:&nbsp;&lt;b&gt;"</span><span style="color: #007700">;<br />&nbsp;&nbsp;switch&nbsp;(</span><span style="color: #0000BB">$reason</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">type</span><span style="color: #007700">())&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;case&nbsp;</span><span style="color: #0000BB">0</span><span style="color: #007700">:<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;echo&nbsp;</span><span style="color: #DD0000">"Error"</span><span style="color: #007700">;<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;break;<br />&nbsp;&nbsp;&nbsp;&nbsp;case&nbsp;</span><span style="color: #0000BB">1</span><span style="color: #007700">:<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;echo&nbsp;</span><span style="color: #DD0000">"Warning"</span><span style="color: #007700">;<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;break;<br />&nbsp;&nbsp;&nbsp;&nbsp;case&nbsp;</span><span style="color: #0000BB">2</span><span style="color: #007700">:<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;echo&nbsp;</span><span style="color: #DD0000">"Message"</span><span style="color: #007700">;<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;break;<br />&nbsp;&nbsp;}<br />&nbsp;&nbsp;echo&nbsp;</span><span style="color: #DD0000">"&lt;/b&gt;&lt;br&nbsp;/&gt;\n"</span><span style="color: #007700">;<br />&nbsp;&nbsp;echo&nbsp;</span><span style="color: #DD0000">"Description:&nbsp;"&nbsp;</span><span style="color: #007700">.&nbsp;</span><span style="color: #0000BB">$reason</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">description</span><span style="color: #007700">(</span><span style="color: #DD0000">"en"</span><span style="color: #007700">)&nbsp;.&nbsp;</span><span style="color: #DD0000">"&lt;br&nbsp;/&gt;\n"</span><span style="color: #007700">;<br />}<br /><br />function&nbsp;</span><span style="color: #0000BB">list_attr</span><span style="color: #007700">(</span><span style="color: #0000BB">$obj</span><span style="color: #007700">)<br />{<br />&nbsp;&nbsp;echo&nbsp;</span><span style="color: #DD0000">"&lt;table&gt;\n"</span><span style="color: #007700">;<br />&nbsp;&nbsp;</span><span style="color: #0000BB">$count&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">$obj</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">count</span><span style="color: #007700">();<br />&nbsp;&nbsp;for&nbsp;(</span><span style="color: #0000BB">$i</span><span style="color: #007700">=</span><span style="color: #0000BB">0</span><span style="color: #007700">;&nbsp;</span><span style="color: #0000BB">$i</span><span style="color: #007700">&lt;</span><span style="color: #0000BB">$count</span><span style="color: #007700">;&nbsp;</span><span style="color: #0000BB">$i</span><span style="color: #007700">++)&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$attr&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">$obj</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">attribute</span><span style="color: #007700">(</span><span style="color: #0000BB">$i</span><span style="color: #007700">);<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"&lt;tr&gt;&lt;td&nbsp;align=\"right\"&nbsp;bgcolor=\"#c0c0c0\"&gt;&lt;b&gt;%s&lt;/b&gt;&lt;/td&gt;&lt;td&nbsp;bgcolor=\"#F0F0F0\"&gt;%s&lt;/td&gt;&lt;/tr&gt;\n"</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$attr</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">key</span><span style="color: #007700">(),&nbsp;</span><span style="color: #0000BB">$attr</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">value</span><span style="color: #007700">());<br />&nbsp;&nbsp;}<br />&nbsp;&nbsp;echo&nbsp;</span><span style="color: #DD0000">"&lt;/table&gt;\n"</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #0000BB">$hwapi&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">hwapi_hgcsp</span><span style="color: #007700">(</span><span style="color: #0000BB">$g_config</span><span style="color: #007700">[</span><span style="color: #0000BB">HOSTNAME</span><span style="color: #007700">]);<br /></span><span style="color: #0000BB">$parms&nbsp;</span><span style="color: #007700">=&nbsp;array(</span><span style="color: #DD0000">"objectIdentifier"</span><span style="color: #007700">=&gt;</span><span style="color: #DD0000">"rootcollection"</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">"attributeSelector"</span><span style="color: #007700">=&gt;array(</span><span style="color: #DD0000">"Title"</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">"Name"</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">"DocumentType"</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">$root&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">$hwapi</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">object</span><span style="color: #007700">(</span><span style="color: #0000BB">$parms</span><span style="color: #007700">);<br />if&nbsp;(</span><span style="color: #0000BB">get_class</span><span style="color: #007700">(</span><span style="color: #0000BB">$root</span><span style="color: #007700">)&nbsp;==&nbsp;</span><span style="color: #DD0000">"HW_API_Error"</span><span style="color: #007700">)&nbsp;{<br />&nbsp;&nbsp;</span><span style="color: #0000BB">handle_error</span><span style="color: #007700">(</span><span style="color: #0000BB">$root</span><span style="color: #007700">);<br />&nbsp;&nbsp;exit;<br />}<br /></span><span style="color: #0000BB">list_attr</span><span style="color: #007700">(</span><span style="color: #0000BB">$root</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</code></div>
    </div>

   </div><p>
  </p>
 </div>


 <a name="function.hwapi-object.seealso"></a><div class="refsect1 seealso">
  <h3 class="title">See Also</h3>
  <p class="para">
   </p><ul class="simplelist">
    <li class="member"><a href="function.hwapi-content.php" class="xref">hw_api->content</a></li>
   </ul><p>
  </p>
 </div>


</div><?php manual_footer(); ?>
 
show source | credits | sitemap | contact | advertising | mirror sites