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

    1 => 'hw_api->remove',

  ),

  'up' => 

  array (

    0 => 'ref.hwapi.php',

    1 => 'Hyperwave API Functions',

  ),

  'prev' => 

  array (

    0 => 'function.hwapi-reason-type.php',

    1 => 'hw_api_reason->type',

  ),

  'next' => 

  array (

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

    1 => 'hw_api->replace',

  ),

);

$setup["toc"] = $TOC;

$setup["parents"] = $PARENTS;

manual_setup($setup);



manual_header();

?>

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

 <div class="refnamediv">

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



 </div>

 

 <a name="function.hwapi-remove.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>remove</b></span>

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

    )</div>



  </div>

  <p class="para">

   Removes an object from the specified parent. Collections

   will be removed recursively. 

  </p>

 </div>





 <a name="function.hwapi-remove.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">

       You can pass an optional object query to remove only those objects

       which match the query. An object will be deleted physically if it is

       the last instance. 

      </p>

      <p class="para">

       The parameter array contains the required elements &#039;objectidentifier&#039;

       and &#039;parentidentifier&#039;. If you want to remove a user or group

       &#039;parentidentifier&#039; can be skipped.

      </p>

      <p class="para">

       The optional parameter &#039;mode&#039; determines how the deletion is

       performed. In normal mode the object will not be removed physically

       until all instances are removed. In physical mode all instances of the

       object will be deleted immediately. In removelinks mode all references

       to and from the objects will be deleted as well. In nonrecursive the

       deletion is not performed recursive. Removing a collection which is

       not empty will cause an error.

      </p>

     </dd>



    

   </dl>

<p>

  </p>

 </div>





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

   </ul><p>

  </p>

 </div>





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

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