Source of: /manual/en/function.hwapi-checkout.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-checkout.php',

    1 => 'hw_api->checkout',

  ),

  'up' => 

  array (

    0 => 'ref.hwapi.php',

    1 => 'Hyperwave API Functions',

  ),

  'prev' => 

  array (

    0 => 'function.hwapi-checkin.php',

    1 => 'hw_api->checkin',

  ),

  'next' => 

  array (

    0 => 'function.hwapi-children.php',

    1 => 'hw_api->children',

  ),

);

$setup["toc"] = $TOC;

$setup["parents"] = $PARENTS;

manual_setup($setup);



manual_header();

?>

<div id="function.hwapi-checkout" class="refentry">

 <div class="refnamediv">

  <h1 class="refname">hw_api-&gt;checkout</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;checkout</span> &mdash; <span class="dc-title">Checks out an object</span></p>



 </div>

 

 <a name="function.hwapi-checkout.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">bool</span> <span class="methodname"><b>checkout</b></span>

     ( <span class="methodparam"><span class="type">array</span> <tt class="parameter">$parameter</tt></span>

    )</div>



  </div>

  <p class="para">

   This function checks out an object or a whole hierarchy of objects.

  </p>

 </div>





 <a name="function.hwapi-checkout.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 parameters array contains the required element

       &#039;objectIdentifier&#039; and the optional element &#039;version&#039;, &#039;mode&#039;

       and &#039;objectQuery&#039;. &#039;mode&#039; can be one of the following values:

       </p><dl>



        <dt class="varlistentry">



         <br /><span class="term"><b><tt class="constant">HW_API_CHECKIN_NORMAL</tt></b></span>



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



          <span class="simpara">

           Checks out an object. The object must be a document.

          </span>

         </dd>



        

        <dt class="varlistentry">



         <span class="term"><b><tt class="constant">HW_API_CHECKIN_RECURSIVE</tt></b></span>



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



          <span class="simpara">

           If the object to check out is a collection, all children will be

           checked out recursively if they are documents. Trying to check out

           a collection would result in an error.

          </span>

         </dd>



        

       </dl>

<p>

      </p>

     </dd>



    

   </dl>

<p>

  </p>

 </div>





 <a name="function.hwapi-checkout.returnvalues"></a><div class="refsect1 returnvalues">

  <h3 class="title">Return Values</h3>

  <p class="para">

   Returns <b><tt class="constant">TRUE</tt></b> on success or <b><tt class="constant">FALSE</tt></b> on failure.

  </p>

 </div>





 <a name="function.hwapi-checkout.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-checkin.php" class="xref">hw_api->checkin</a></li>

   </ul><p>

  </p>

 </div>





</div><?php manual_footer(); ?>
Our source is open

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