includes/compat/normal/UtfNormalUtil.php

   1 <?php
   2 /**
   3  * Some of these functions are adapted from places in MediaWiki.
   4  * Should probably merge them for consistency.
   5  *
   6  * Copyright © 2004 Brion Vibber <brion@pobox.com>
   7  * https://www.mediawiki.org/
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write to the Free Software Foundation, Inc.,
  21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  22  * http://www.gnu.org/copyleft/gpl.html
  23  *
  24  * @file
  25  * @ingroup UtfNormal
  26  */
  27
  28 use UtfNormal\Utils;
  29
  30 /**
  31  * Return UTF-8 sequence for a given Unicode code point.
  32  *
  33  * @param int $codepoint
  34  * @return string
  35  * @throws InvalidArgumentException if fed out of range data.
  36  * @public
  37  * @deprecated since 1.25, use UtfNormal\Utils directly
  38  */
  39 function codepointToUtf8( $codepoint ) {
  40         wfDeprecated( __FUNCTION__, '1.25' );
  41         return Utils::codepointToUtf8( $codepoint );
  42 }
  43
  44 /**
  45  * Take a series of space-separated hexadecimal numbers representing
  46  * Unicode code points and return a UTF-8 string composed of those
  47  * characters. Used by UTF-8 data generation and testing routines.
  48  *
  49  * @param string $sequence
  50  * @return string
  51  * @throws InvalidArgumentException if fed out of range data.
  52  * @private
  53  * @deprecated since 1.25, use UtfNormal\Utils directly
  54  */
  55 function hexSequenceToUtf8( $sequence ) {
  56         wfDeprecated( __FUNCTION__, '1.25' );
  57         return Utils::hexSequenceToUtf8( $sequence );
  58 }
  59
  60 /**
  61  * Take a UTF-8 string and return a space-separated series of hex
  62  * numbers representing Unicode code points. For debugging.
  63  *
  64  * @fixme this is private but extensions + maint scripts are using it
  65  * @param string $str UTF-8 string.
  66  * @return string
  67  * @private
  68  */
  69 function utf8ToHexSequence( $str ) {
  70         wfDeprecated( __FUNCTION__, '1.25' );
  71         $buf = '';
  72         foreach ( preg_split( '//u', $str, -1, PREG_SPLIT_NO_EMPTY ) as $cp ) {
  73                 $buf .= sprintf( '%04x ', UtfNormal\Utils::utf8ToCodepoint( $cp ) );
  74         }
  75
  76         return rtrim( $buf );
  77 }
  78
  79 /**
  80  * Determine the Unicode codepoint of a single-character UTF-8 sequence.
  81  * Does not check for invalid input data.
  82  *
  83  * @param string $char
  84  * @return int
  85  * @public
  86  * @deprecated since 1.25, use UtfNormal\Utils directly
  87  */
  88 function utf8ToCodepoint( $char ) {
  89         wfDeprecated( __FUNCTION__, '1.25' );
  90         return Utils::utf8ToCodepoint( $char );
  91 }
  92
  93 /**
  94  * Escape a string for inclusion in a PHP single-quoted string literal.
  95  *
  96  * @param string $string string to be escaped.
  97  * @return string escaped string.
  98  * @public
  99  * @deprecated since 1.25, use UtfNormal\Utils directly
 100  */
 101 function escapeSingleString( $string ) {
 102         wfDeprecated( __FUNCTION__, '1.25' );
 103         return Utils::escapeSingleString( $string );
 104 }