<?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-set-ordering.php',
    1 => 'enchant_broker_set_ordering',
    2 => 'Declares a preference of dictionaries to use for the language',
  ),
  'up' => 
  array (
    0 => 'ref.enchant.php',
    1 => 'Enchant Functions',
  ),
  'prev' => 
  array (
    0 => 'function.enchant-broker-set-dict-path.php',
    1 => 'enchant_broker_set_dict_path',
  ),
  'next' => 
  array (
    0 => 'function.enchant-dict-add.php',
    1 => 'enchant_dict_add',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/enchant/functions/enchant-broker-set-ordering.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.enchant-broker-set-ordering" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">enchant_broker_set_ordering</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_set_ordering</span> &mdash; <span class="dc-title">Declares a preference of dictionaries to use for the language</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.enchant-broker-set-ordering-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>enchant_broker_set_ordering</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="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$tag</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$ordering</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="simpara">
   Declares a preference of dictionaries to use for the language
   described/referred to by &#039;tag&#039;. The ordering is a comma delimited
   list of provider names. As a special exception, the &quot;*&quot; tag can
   be used as a language tag to declare a default ordering for any
   language that does not explicitly declare an ordering.
  </p>

 </div>

 <div class="refsect1 parameters" id="refsect1-function.enchant-broker-set-ordering-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>
    
   
    <dt><code class="parameter">tag</code></dt>
    <dd>
     <span class="simpara">
      Language tag. The special &quot;*&quot; tag can be used as a language tag
      to declare a default ordering for any language that does not
      explicitly declare an ordering.
     </span>
    </dd>
   
   
    <dt><code class="parameter">ordering</code></dt>
    <dd>
     <span class="simpara">
      Comma delimited list of provider names
     </span>
    </dd>
   
  </dl>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-function.enchant-broker-set-ordering-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-set-ordering-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>
  <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><?php manual_footer($setup); ?>