123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262 |
- <?php
- /*
- * This file is part of the Symfony package.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
- namespace Symfony\Polyfill\Intl\Icu;
- use Symfony\Polyfill\Intl\Icu\Exception\MethodArgumentValueNotImplementedException;
- use Symfony\Polyfill\Intl\Icu\Exception\MethodNotImplementedException;
- /**
- * Replacement for PHP's native {@link \Collator} class.
- *
- * The only methods currently supported in this class are:
- *
- * - {@link \__construct}
- * - {@link create}
- * - {@link asort}
- * - {@link getErrorCode}
- * - {@link getErrorMessage}
- * - {@link getLocale}
- *
- * @author Igor Wiedler <igor@wiedler.ch>
- * @author Bernhard Schussek <bschussek@gmail.com>
- *
- * @internal
- */
- abstract class Collator
- {
- /* Attribute constants */
- public const FRENCH_COLLATION = 0;
- public const ALTERNATE_HANDLING = 1;
- public const CASE_FIRST = 2;
- public const CASE_LEVEL = 3;
- public const NORMALIZATION_MODE = 4;
- public const STRENGTH = 5;
- public const HIRAGANA_QUATERNARY_MODE = 6;
- public const NUMERIC_COLLATION = 7;
- /* Attribute constants values */
- public const DEFAULT_VALUE = -1;
- public const PRIMARY = 0;
- public const SECONDARY = 1;
- public const TERTIARY = 2;
- public const DEFAULT_STRENGTH = 2;
- public const QUATERNARY = 3;
- public const IDENTICAL = 15;
- public const OFF = 16;
- public const ON = 17;
- public const SHIFTED = 20;
- public const NON_IGNORABLE = 21;
- public const LOWER_FIRST = 24;
- public const UPPER_FIRST = 25;
- /* Sorting options */
- public const SORT_REGULAR = 0;
- public const SORT_NUMERIC = 2;
- public const SORT_STRING = 1;
- /**
- * @param string|null $locale The locale code. The only currently supported locale is "en" (or null using the default locale, i.e. "en")
- *
- * @throws MethodArgumentValueNotImplementedException When $locale different than "en" or null is passed
- */
- public function __construct(?string $locale)
- {
- if ('en' !== $locale && null !== $locale) {
- throw new MethodArgumentValueNotImplementedException(__METHOD__, 'locale', $locale, 'Only the locale "en" is supported');
- }
- }
- /**
- * Static constructor.
- *
- * @param string|null $locale The locale code. The only currently supported locale is "en" (or null using the default locale, i.e. "en")
- *
- * @return static
- *
- * @throws MethodArgumentValueNotImplementedException When $locale different than "en" or null is passed
- */
- public static function create(?string $locale)
- {
- return new static($locale);
- }
- /**
- * Sort array maintaining index association.
- *
- * @param array &$array Input array
- * @param int $flags Flags for sorting, can be one of the following:
- * Collator::SORT_REGULAR - compare items normally (don't change types)
- * Collator::SORT_NUMERIC - compare items numerically
- * Collator::SORT_STRING - compare items as strings
- *
- * @return bool True on success or false on failure
- */
- public function asort(array &$array, int $flags = self::SORT_REGULAR)
- {
- $intlToPlainFlagMap = [
- self::SORT_REGULAR => \SORT_REGULAR,
- self::SORT_NUMERIC => \SORT_NUMERIC,
- self::SORT_STRING => \SORT_STRING,
- ];
- $plainSortFlag = $intlToPlainFlagMap[$flags] ?? self::SORT_REGULAR;
- return asort($array, $plainSortFlag);
- }
- /**
- * Not supported. Compare two Unicode strings.
- *
- * @return bool|int
- *
- * @see https://php.net/collator.compare
- *
- * @throws MethodNotImplementedException
- */
- public function compare(string $string1, string $string2)
- {
- throw new MethodNotImplementedException(__METHOD__);
- }
- /**
- * Not supported. Get a value of an integer collator attribute.
- *
- * @return bool|int The attribute value on success or false on error
- *
- * @see https://php.net/collator.getattribute
- *
- * @throws MethodNotImplementedException
- */
- public function getAttribute(int $attribute)
- {
- throw new MethodNotImplementedException(__METHOD__);
- }
- /**
- * Returns collator's last error code. Always returns the U_ZERO_ERROR class constant value.
- *
- * @return int The error code from last collator call
- */
- public function getErrorCode()
- {
- return Icu::U_ZERO_ERROR;
- }
- /**
- * Returns collator's last error message. Always returns the U_ZERO_ERROR_MESSAGE class constant value.
- *
- * @return string The error message from last collator call
- */
- public function getErrorMessage()
- {
- return 'U_ZERO_ERROR';
- }
- /**
- * Returns the collator's locale.
- *
- * @return string The locale used to create the collator. Currently always
- * returns "en".
- */
- public function getLocale(int $type = Locale::ACTUAL_LOCALE)
- {
- return 'en';
- }
- /**
- * Not supported. Get sorting key for a string.
- *
- * @return string The collation key for $string
- *
- * @see https://php.net/collator.getsortkey
- *
- * @throws MethodNotImplementedException
- */
- public function getSortKey(string $string)
- {
- throw new MethodNotImplementedException(__METHOD__);
- }
- /**
- * Not supported. Get current collator's strength.
- *
- * @return bool|int The current collator's strength or false on failure
- *
- * @see https://php.net/collator.getstrength
- *
- * @throws MethodNotImplementedException
- */
- public function getStrength()
- {
- throw new MethodNotImplementedException(__METHOD__);
- }
- /**
- * Not supported. Set a collator's attribute.
- *
- * @return bool True on success or false on failure
- *
- * @see https://php.net/collator.setattribute
- *
- * @throws MethodNotImplementedException
- */
- public function setAttribute(int $attribute, int $value)
- {
- throw new MethodNotImplementedException(__METHOD__);
- }
- /**
- * Not supported. Set the collator's strength.
- *
- * @return bool True on success or false on failure
- *
- * @see https://php.net/collator.setstrength
- *
- * @throws MethodNotImplementedException
- */
- public function setStrength(int $strength)
- {
- throw new MethodNotImplementedException(__METHOD__);
- }
- /**
- * Not supported. Sort array using specified collator and sort keys.
- *
- * @return bool True on success or false on failure
- *
- * @see https://php.net/collator.sortwithsortkeys
- *
- * @throws MethodNotImplementedException
- */
- public function sortWithSortKeys(array &$array)
- {
- throw new MethodNotImplementedException(__METHOD__);
- }
- /**
- * Not supported. Sort array using specified collator.
- *
- * @return bool True on success or false on failure
- *
- * @see https://php.net/collator.sort
- *
- * @throws MethodNotImplementedException
- */
- public function sort(array &$array, int $flags = self::SORT_REGULAR)
- {
- throw new MethodNotImplementedException(__METHOD__);
- }
- }
|