Skip to content

Define a constant to easily add more characters to trim together with UTF8-spaces and line breaks #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Define a constant to easily add more characters to trim together with UTF8-spaces and line breaks #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b3a4659
define UTF8_SPACES + minor optimizations
utilmind Sep 13, 2024
1f873ef
Comment on UTF8_SPACES
utilmind Sep 13, 2024
b547b35
Update mb_trim.php
utilmind Sep 13, 2024
34de9af
Update MbTrimTest.php
utilmind Sep 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 30 additions & 33 deletions src/mb_trim.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
<?php
// UTF8_SPACES specifies standard space and line break characters for the UTF-8 encoded strings.
// Use this constant to add more characters to trim from the string together with spaces.
define('UTF8_SPACES', " \f\n\r\t\v\x00\u{00A0}\u{1680}\u{2000}\u{2001}\u{2002}\u{2003}\u{2004}\u{2005}\u{2006}\u{2007}\u{2008}\u{2009}\u{200A}\u{2028}\u{2029}\u{202F}\u{205F}\u{3000}\u{0085}\u{180E}");

/**
* Multi-byte safely strip white-spaces (or other characters) from the beginning and end of a string.
Expand All @@ -9,9 +12,9 @@
*
* @return string The trimmed string.
*/
function mb_trim(string $string, string $characters = " \f\n\r\t\v\x00\u{00A0}\u{1680}\u{2000}\u{2001}\u{2002}\u{2003}\u{2004}\u{2005}\u{2006}\u{2007}\u{2008}\u{2009}\u{200A}\u{2028}\u{2029}\u{202F}\u{205F}\u{3000}\u{0085}\u{180E}", ?string $encoding = null): string {
function mb_trim(string $string, string $characters = UTF8_SPACES, ?string $encoding = null): string {
// On supported versions, use a pre-calculated regex for performance.
if (PHP_VERSION_ID >= 80200 && ($encoding === null || $encoding === "UTF-8") && $characters === " \f\n\r\t\v\x00\u{00A0}\u{1680}\u{2000}\u{2001}\u{2002}\u{2003}\u{2004}\u{2005}\u{2006}\u{2007}\u{2008}\u{2009}\u{200A}\u{2028}\u{2029}\u{202F}\u{205F}\u{3000}\u{0085}\u{180E}") {
if (PHP_VERSION_ID >= 80200 && ($encoding === null || $encoding === 'UTF-8') && $characters === UTF8_SPACES) {
return preg_replace("/^[\s\0]+|[\s\0]+$/uD", '', $string);
}

Expand All @@ -21,26 +24,24 @@ function mb_trim(string $string, string $characters = " \f\n\r\t\v\x00\u{00A0}\u
throw new ValueError(sprintf('%s(): Argument #3 ($encoding) must be a valid encoding, "%s" given', __FUNCTION__, $encoding));
}

if ($characters === "") {
if ($characters === '') {
return $string;
}

if ($encoding !== null && $encoding !== 'UTF-8') {
$string = mb_convert_encoding($string, "UTF-8", $encoding);
$characters = mb_convert_encoding($characters, "UTF-8", $encoding);
$string = mb_convert_encoding($string, 'UTF-8', $encoding);
$characters = mb_convert_encoding($characters, 'UTF-8', $encoding);
}

$charMap = array_map(static fn(string $char): string => preg_quote($char, '/'), mb_str_split($characters));
$regexClass = implode('', $charMap);
$regex = "/^[" . $regexClass . "]+|[" . $regexClass . "]+$/uD";
$regex = '/^[' . $regexClass . ']+|[' . $regexClass . ']+$/uD';

$return = preg_replace($regex, '', $string);

if ($encoding !== null && $encoding !== 'UTF-8') {
$return = mb_convert_encoding($return, $encoding, "UTF-8");
}

return $return;
return $encoding !== null && $encoding !== 'UTF-8'
? mb_convert_encoding($return, $encoding, 'UTF-8')
: $return;
}

/**
Expand All @@ -52,9 +53,9 @@ function mb_trim(string $string, string $characters = " \f\n\r\t\v\x00\u{00A0}\u
*
* @return string The trimmed string.
*/
function mb_ltrim(string $string, string $characters = " \f\n\r\t\v\x00\u{00A0}\u{1680}\u{2000}\u{2001}\u{2002}\u{2003}\u{2004}\u{2005}\u{2006}\u{2007}\u{2008}\u{2009}\u{200A}\u{2028}\u{2029}\u{202F}\u{205F}\u{3000}\u{0085}\u{180E}", ?string $encoding = null): string {
function mb_ltrim(string $string, string $characters = UTF8_SPACES, ?string $encoding = null): string {
// On supported versions, use a pre-calculated regex for performance.
if (PHP_VERSION_ID >= 80200 && ($encoding === null || $encoding === "UTF-8") && $characters === " \f\n\r\t\v\x00\u{00A0}\u{1680}\u{2000}\u{2001}\u{2002}\u{2003}\u{2004}\u{2005}\u{2006}\u{2007}\u{2008}\u{2009}\u{200A}\u{2028}\u{2029}\u{202F}\u{205F}\u{3000}\u{0085}\u{180E}") {
if (PHP_VERSION_ID >= 80200 && ($encoding === null || $encoding === 'UTF-8') && $characters === UTF8_SPACES) {
return preg_replace("/^[\s\0]+/u", '', $string);
}

Expand All @@ -64,26 +65,24 @@ function mb_ltrim(string $string, string $characters = " \f\n\r\t\v\x00\u{00A0}\
throw new ValueError(sprintf('%s(): Argument #3 ($encoding) must be a valid encoding, "%s" given', __FUNCTION__, $encoding));
}

if ($characters === "") {
if ($characters === '') {
return $string;
}

if ($encoding !== null && $encoding !== 'UTF-8') {
$string = mb_convert_encoding($string, "UTF-8", $encoding);
$characters = mb_convert_encoding($characters, "UTF-8", $encoding);
$string = mb_convert_encoding($string, 'UTF-8', $encoding);
$characters = mb_convert_encoding($characters, 'UTF-8', $encoding);
}

$charMap = array_map(static fn(string $char): string => preg_quote($char, '/'), mb_str_split($characters));
$regexClass = implode('', $charMap);
$regex = "/^[" . $regexClass . "]+/u";
$regex = '/^[' . $regexClass . ']+/u';

$return = preg_replace($regex, '', $string);

if ($encoding !== null && $encoding !== 'UTF-8') {
$return = mb_convert_encoding($return, $encoding, "UTF-8");
}

return $return;
return $encoding !== null && $encoding !== 'UTF-8'
? mb_convert_encoding($return, $encoding, 'UTF-8')
: $return;
}

/**
Expand All @@ -95,9 +94,9 @@ function mb_ltrim(string $string, string $characters = " \f\n\r\t\v\x00\u{00A0}\
*
* @return string The trimmed string.
*/
function mb_rtrim(string $string, string $characters = " \f\n\r\t\v\x00\u{00A0}\u{1680}\u{2000}\u{2001}\u{2002}\u{2003}\u{2004}\u{2005}\u{2006}\u{2007}\u{2008}\u{2009}\u{200A}\u{2028}\u{2029}\u{202F}\u{205F}\u{3000}\u{0085}\u{180E}", ?string $encoding = null): string {
function mb_rtrim(string $string, string $characters = UTF8_SPACES, ?string $encoding = null): string {
// On supported versions, use a pre-calculated regex for performance.
if (PHP_VERSION_ID >= 80200 && ($encoding === null || $encoding === "UTF-8") && $characters === " \f\n\r\t\v\x00\u{00A0}\u{1680}\u{2000}\u{2001}\u{2002}\u{2003}\u{2004}\u{2005}\u{2006}\u{2007}\u{2008}\u{2009}\u{200A}\u{2028}\u{2029}\u{202F}\u{205F}\u{3000}\u{0085}\u{180E}") {
if (PHP_VERSION_ID >= 80200 && ($encoding === null || $encoding === 'UTF-8') && $characters === UTF8_SPACES) {
return preg_replace("/[\s\0]+$/uD", '', $string);
}

Expand All @@ -107,24 +106,22 @@ function mb_rtrim(string $string, string $characters = " \f\n\r\t\v\x00\u{00A0}\
throw new ValueError(sprintf('%s(): Argument #3 ($encoding) must be a valid encoding, "%s" given', __FUNCTION__, $encoding));
}

if ($characters === "") {
if ($characters === '') {
return $string;
}

if ($encoding !== null && $encoding !== 'UTF-8') {
$string = mb_convert_encoding($string, "UTF-8", $encoding);
$characters = mb_convert_encoding($characters, "UTF-8", $encoding);
$string = mb_convert_encoding($string, 'UTF-8', $encoding);
$characters = mb_convert_encoding($characters, 'UTF-8', $encoding);
}

$charMap = array_map(static fn(string $char): string => preg_quote($char, '/'), mb_str_split($characters));
$regexClass = implode('', $charMap);
$regex = "/[" . $regexClass . "]+$/uD";
$regex = '/[' . $regexClass . ']+$/uD';

$return = preg_replace($regex, '', $string);

if ($encoding !== null && $encoding !== 'UTF-8') {
$return = mb_convert_encoding($return, $encoding, "UTF-8");
}

return $return;
return $encoding !== null && $encoding !== 'UTF-8'
? mb_convert_encoding($return, $encoding, 'UTF-8')
: $return;
}
3 changes: 3 additions & 0 deletions tests/MbTrimTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,9 @@ public function testMbTrim(): void {
$this->assertSame("foo\n", mb_trim("foo\n", "o"));
$this->assertSame("foo\n", mb_rtrim("foo\n", "o"));

// AK 2024-09-13: please test this one too!
//$this->assertSame(' —888-888-00-00-', mb_trim(' —888-888-00-00-', UTF8_SPACES.'-–—'));

$this->expectException(\ValueError::class);
mb_trim( "\u{180F}", "", "NULL");
}
Expand Down