1
0
mirror of https://github.com/php/php-src.git synced 2026-04-14 19:41:05 +02:00
Files
archived-php-src/ext/intl/doc/normalizer_api.php
Peter Kokot 60a69daec6 Sync leading and final newlines in source code files
This patch adds missing newlines, trims multiple redundant final
newlines into a single one, and trims redundant leading newlines.

According to POSIX, a line is a sequence of zero or more non-' <newline>'
characters plus a terminating '<newline>' character. [1] Files should
normally have at least one final newline character.

C89 [2] and later standards [3] mention a final newline:
"A source file that is not empty shall end in a new-line character,
which shall not be immediately preceded by a backslash character."

Although it is not mandatory for all files to have a final newline
fixed, a more consistent and homogeneous approach brings less of commit
differences issues and a better development experience in certain text
editors and IDEs.

[1] http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_206
[2] https://port70.net/~nsz/c/c89/c89-draft.html#2.1.1.2
[3] https://port70.net/~nsz/c/c99/n1256.html#5.1.1.2
2018-10-14 12:54:08 +02:00

91 lines
3.0 KiB
PHP

<?php
#############################################################################
# Object-oriented API
#############################################################################
/**
* Normalizer class.
*
* Normalizer provides access to Unicode normalization of strings. This class consists
* only of static methods. The iterator interface to normalizer is rarely used, so is
* not provided here.
*
* Example:
* <code>
*
* </code>
*
* @see http://www.icu-project.org/apiref/icu4c/unorm_8h.html
* @see http://www.icu-project.org/apiref/icu4c/classNormalizer.html
*
*/
class Normalizer {
#############################################################################
# Common constants.
#############################################################################
/**
* Valid normalization form values.
*
* @see Normalizer::normalize()
* @see Normalizer::isNormalize()
* @see normalizer_normalize()
* @see normalizer_is_normalized()
*/
const NONE = 1;
/** Canonical decomposition. */
const NFD = 2;
const FORM_D = NFD;
/** Compatibility decomposition. */
const NFKD = 3;
const FORM_KD = NFKD;
/** Canonical decomposition followed by canonical composition. */
const NFC = 4;
const FORM_C = NFC;
/** Compatibility decomposition followed by canonical composition. */
const NFKC =5;
const FORM_KC = NFKC;
/**
* Normalizes the input provided and returns the normalized string
* @param string $input The input string to normalize
* @param [int] $form One of the normalization forms
* @return string The normalized string or null if an error occurred.
*/
public static function normalize($input, $form = Normalizer::FORM_C) {}
/**
* Checks if the provided string is already in the specified normalization form.
* @param string $input The input string to normalize
* @param [int] $form One of the normalization forms
* @return boolean True if normalized, false otherwise or if there is an error
*/
public static function isNormalized($input, $form = Normalizer::FORM_C) {}
}
#############################################################################
# Procedural API
#############################################################################
/**
* Normalizes the input provided and returns the normalized string
* @param string $input The input string to normalize
* @param [int] $form One of the normalization forms
* @return string The normalized string or null if an error occurred.
*/
function normalizer_normalize($input, $form = Normalizer::FORM_C) {}
/**
* Checks if the provided string is already in the specified normalization form.
* @param string $input The input string to normalize
* @param [int] $form One of the normalization forms
* @return boolean True if normalized, false otherwise or if there an error
*/
function normalizer_is_normalized($input, $form = Normalizer::FORM_C) {}
?>