<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.enchant.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'function.enchant-broker-free.php',
    1 => 'enchant_broker_free',
    2 => 'Free the broker resource and its dictionaries',
  ),
  'up' => 
  array (
    0 => 'ref.enchant.php',
    1 => 'Enchant Functions',
  ),
  'prev' => 
  array (
    0 => 'function.enchant-broker-dict-exists.php',
    1 => 'enchant_broker_dict_exists',
  ),
  'next' => 
  array (
    0 => 'function.enchant-broker-free-dict.php',
    1 => 'enchant_broker_free_dict',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/enchant/functions/enchant-broker-free.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.enchant-broker-free" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">enchant_broker_free</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.3.0, PHP 7, PHP 8, PECL enchant &gt;= 0.1.0 )</p><p class="refpurpose"><span class="refname">enchant_broker_free</span> &mdash; <span class="dc-title">Free the broker resource and its dictionaries</span></p>

 </div>

 <div id="function.enchant-broker-free-refsynopsisdiv">
   <div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function has been
<em>DEPRECATED</em> as of PHP 8.0.0. Relying on this function
is highly discouraged.</p></div>
 </div>

 <div class="refsect1 description" id="refsect1-function.enchant-broker-free-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="attribute"><a href="class.deprecated.php">#[\Deprecated]</a> </span><br>
   <span class="methodname"><strong>enchant_broker_free</strong></span>(<span class="methodparam"><span class="type"><a href="class.enchantbroker.php" class="type EnchantBroker">EnchantBroker</a></span> <code class="parameter">$broker</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="simpara">
   Free a broker with all its dictionaries.
   As of PHP 8.0.0, it is recommended to unset the object instead of calling this function.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.enchant-broker-free-parameters">
  <h3 class="title">Parameters</h3>
  <dl>
   
     <dt><code class="parameter">broker</code></dt>
     <dd>
      <p class="para">
       An Enchant broker returned by <span class="function"><a href="function.enchant-broker-init.php" class="function">enchant_broker_init()</a></span>.
      </p>
     </dd>
    
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.enchant-broker-free-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="simpara">
   Returns <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> on failure.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.enchant-broker-free-changelog">
  <h3 class="title">Changelog</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>Version</th>
      <th>Description</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td>8.0.0</td>
      <td>
       This function has been deprecated in favor of unsetting the object.
      </td>
     </tr>

     <tr>
 <td>8.0.0</td>
 <td>
  <code class="parameter">broker</code> expects an <span class="classname"><a href="class.enchantbroker.php" class="classname">EnchantBroker</a></span> instance now;
  previoulsy, a <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> was expected.
 </td>
</tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 seealso" id="refsect1-function.enchant-broker-free-seealso">
  <h3 class="title">See Also</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="function.enchant-broker-init.php" class="function" rel="rdfs-seeAlso">enchant_broker_init()</a> - Create a new broker object capable of requesting</span></li>
  </ul>
 </div>

</div><?php manual_footer($setup); ?>