[PHP源码阅读]trimrtrimltrim函数

Posted 2020-07-11

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了[PHP源码阅读]trimrtrimltrim函数相关的知识，希望对你有一定的参考价值。

trim系列函数是用于去除字符串中首尾的空格或其他字符。ltrim函数只去除掉字符串首部的字符，rtrim函数只去除字符串尾部的字符。

trim

string trim ( string $str [, string $character_mask = " \\t\\n\\r\\0\\x0B" ] )

参数说明

character_mask
默认是" \\t\\n\\r\\0\\x0B"等空白字符。

使用..可以指定一段范围的字符。此处要注意，".."左右两边是一对合法的范围值，如果传递的是非法的值会报错。

运行示例

先来看看用正常的使用：

$str = ‘hello..‘;
$new_str = trim($str, ‘.‘); // 结果是hello

一个比较诡异的结果。这里报错是因为php把..左右两边看作是范围值，而此处‘..‘左边是字符‘.‘，PHP内部将认为其是一个缺少右边界的范围值。

$str = ‘hello...‘;
$second_str = trim($str, ‘...‘); // 报错

第二个参数使用合法的边界值：

$str = ‘helloabcdefg‘;
$new_str = trim($str, ‘a..g‘); // 输出hello

trim执行步骤

trim、ltrim、rtrim三个函数都是调用了php_do_trim函数，区别在于第二个参数mode的不同。本文主要对trim函数进行分析，ltrim和rtrim函数跟trim的类似。然后php_do_trim会调用了php_trim来实现功能，因此trim函数的核心函数时php_trim函数。其执行步骤如下：

1、根据what的值设置保存过滤字符的mask数组

2、过滤在字符串首部的待过滤字符

3、过滤在字符串尾部的待过滤字符

php_trim函数执行的流程图如下：

技术分享

源码解读

php_trim函数先调用了php_charmask，这个函数试将过滤字符设置为mask[char] = 1的形式，这样就是一个哈希数组，然后可用于后面的判断。如果第二个参数是范围值时，调用了memset函数给mask数组赋值。

在用mode变量判断是哪种过滤时，此处有一个小优化，在PHP内部使用的是与运算，而不是多个的判断条件。该部分代码如下：

    if (mode & 1) {
        for (i = 0; i < len; i++) {
            if (mask[(unsigned char)c[i]]) {
                trimmed++;
            } else {
                break;
            }
        }
        len -= trimmed;
        c += trimmed;
    }
    if (mode & 2) {
        for (i = len - 1; i >= 0; i--) {
            if (mask[(unsigned char)c[i]]) {
                len--;
            } else {
                break;
            }
        }
    }