get-sort-key.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 743f97dd06d53872e4f498141f57950afda34659 Maintainer: sergey Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="collator.getsortkey" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>Collator::getSortKey</refname>
  <refname>collator_get_sort_key</refname>
  <refpurpose>Получает ключ сортировки строки</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <para>
   &style.oop;
  </para>
  <methodsynopsis role="Collator">
   <modifier>public</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>Collator::getSortKey</methodname>
   <methodparam><type>string</type><parameter>string</parameter></methodparam>
  </methodsynopsis>
  <para>
   &style.procedural;
  </para>
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>collator_get_sort_key</methodname>
   <methodparam><type>Collator</type><parameter>object</parameter></methodparam>
   <methodparam><type>string</type><parameter>string</parameter></methodparam>
  </methodsynopsis>
  <para>
   Функция возвращает ключ сопоставления для строки.
   Ключи сопоставления возможно сравнивать напрямую, а не строки, хотя они зависят от реализации
   и могут меняться в зависимости от версии библиотеки ICU. Ключи сортировки обычно полезны только
   в базах данных или в других случаях, когда вызовы функций чрезвычайно дороги.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>object</parameter></term>
     <listitem>
      <para>
       Объект <classname>Collator</classname>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       Строка, из которой создаётся ключ.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Функция возвращает ключ сопоставления для строки&return.falseforfailure;.
  </para>
  &return.falseproblem;
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример получения ключа сортировки строки функцией <function>collator_get_sort_key</function></title>
    <programlisting role="php">
<![CDATA[
<?php

$s1 = 'Hello';

$coll = collator_create('en_US');
$res  = collator_get_sort_key($coll, $s1);

echo bin2hex($res);

?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
     3832404046010901dc08
    </screen>
   </example>
  </para>

  <para>
   <example>
    <title>Пример работы метода <function>Collator::getSortKey</function> с функцией <function>usort</function></title>
    <programlisting role="php">
<![CDATA[
<?php

$data = [
    [ 'name' => '🇳🇱 Derick Rethans', 'linked_account' => 'https://phpc.social/users/derickr' ],
    [ 'name' => 'Elephpant', 'linked_account' => 'https://phpc.social/phpc' ],
    [ 'name' => '🇫🇷 Marcus Bointon', 'linked_account' => 'https://phpc.social/users/Synchro' ],
];

/* Создаём объект Collator */
$col = new Collator('en');

/* Определяем порядок сортировки: заглавные варианты символов идут перед строчными. */
$col->setAttribute(Collator::CASE_FIRST, Collator::UPPER_FIRST);

/* Сортируем данные пользовательской функцией, которая также удаляет эмодзи */
usort(
    $data,
    function($a, $b) use ($col) {
        /* Указываем идентификатор 'S', который удалит символы Юникод-класса Symbols, и удаляем пробельные символы
         * в начале и конце строки функцией trim */
        $aName = trim(preg_replace('/\p{S}+/u', '', $a['name']));
        $bName = trim(preg_replace('/\p{S}+/u', '', $b['name']));

        /* Создаём ключи сортировки */
        $aKey = $col->getSortKey($aName);
        $bKey = $col->getSortKey($bName);

        /* Сравниваем ключи, чтобы определить порядок элементов. */
        return $aKey <=> $bKey;
    }
);

var_dump($data);

?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
array(3) {
  [0] =>
  array(2) {
    'name' =>
    string(25) "🇳🇱 Derick Rethans"
    'linked_account' =>
    string(33) "https://phpc.social/users/derickr"
  }
  [1] =>
  array(2) {
    'name' =>
    string(9) "Elephpant"
    'linked_account' =>
    string(24) "https://phpc.social/phpc"
  }
  [2] =>
  array(2) {
    'name' =>
    string(25) "🇫🇷 Marcus Bointon"
    'linked_account' =>
    string(33) "https://phpc.social/users/Synchro"
  }
}
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>collator_sort</function></member>
    <member><function>collator_sort_with_sort_keys</function></member>
   </simplelist>
  </para>
 </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml
 sgml-omittag:t
 sgml-shorttag:t
 sgml-minimize-attributes:nil
 sgml-always-quote-attributes:t
 sgml-indent-step:1
 sgml-indent-data:t
 indent-tabs-mode:nil
 sgml-parent-document:nil
 sgml-default-dtd-file:"~/.phpdoc/manual.ced"
 sgml-exposed-tags:nil
 sgml-local-catalogs:nil
 sgml-local-ecat-files:nil
 End:
 vim600: syn=xml fen fdm=syntax fdl=2 si
 vim: et tw=78 syn=sgml
 vi: ts=1 sw=1
-->