Class yii\helpers\BaseStringHelper

继承yii\helpers\BaseStringHelper
子类yii\helpers\StringHelper
可用自版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/helpers/BaseStringHelper.php

BaseStringHelper 为 yii\helpers\StringHelper 提供了具体的实现方法.

不要使用 BaseStringHelper. 改用 yii\helpers\StringHelper.

公共方法

隐藏继承的方法

方法描述定义在
base64UrlDecode() 解码"使用 URL 和文件名安全字母表进行 Base 64 编码(Base 64 Encoding with URL and Filename Safe Alphabet)"(RFC 4648). yii\helpers\BaseStringHelper
base64UrlEncode() 将字符串编码为"使用 URL 和文件名安全字母表进行 Base 64 编码(Base 64 Encoding with URL and Filename Safe Alphabet)"(RFC 4648). yii\helpers\BaseStringHelper
basename() 返回路径的尾部名称组件. yii\helpers\BaseStringHelper
byteLength() 返回给定字符串中的字节数. yii\helpers\BaseStringHelper
byteSubstr() 返回由起始(start)和长度(length)参数指定的字符串部分. yii\helpers\BaseStringHelper
countWords() 计算字符串中的单词数. yii\helpers\BaseStringHelper
dirname() 返回父目录的路径. yii\helpers\BaseStringHelper
endsWith() 检查给定字符串是否以指定的子字符串结束. yii\helpers\BaseStringHelper
explode() 将字符串分解为数组, 可选择修剪值并跳过空值. yii\helpers\BaseStringHelper
floatToString() 安全的将浮点数float转换为字符串, 与当前语言环境无关. yii\helpers\BaseStringHelper
matchWildcard() 检查给定的字符串是否与给定的shell通配符模式匹配. yii\helpers\BaseStringHelper
mb_ucfirst() 该方法提供了 PHP 内置函数ucfirst()的 unicode 安全实现. yii\helpers\BaseStringHelper
mb_ucwords() 该方法提供了 PHP 内置函数ucwords()的 unicode 安全实现. yii\helpers\BaseStringHelper
normalizeNumber() 如果当前语言环境的小数点为逗号,, 则返回数字值的字符串表示形式, 并将逗号,替换为点.. yii\helpers\BaseStringHelper
startsWith() 检查给定字符串是否以指定的子字符串开头. yii\helpers\BaseStringHelper
truncate() 将字符串截断为指定的字符数. yii\helpers\BaseStringHelper
truncateWords() 将字符串截断为指定的字数. yii\helpers\BaseStringHelper

受保护的方法

隐藏继承的方法

方法描述定义在
truncateHtml() 在保留 HTML 的同时截断字符串. yii\helpers\BaseStringHelper

方法详情

base64UrlDecode() public static 方法 (可用自版本: 2.0.12)

解码"使用 URL 和文件名安全字母表进行 Base 64 编码(Base 64 Encoding with URL and Filename Safe Alphabet)"(RFC 4648).

参见 https://tools.ietf.org/html/rfc4648#page-7.

public static string base64UrlDecode ( $input )
$input string

编码字符串.

return string

解码后的字符串.

base64UrlEncode() public static 方法 (可用自版本: 2.0.12)

将字符串编码为"使用 URL 和文件名安全字母表进行 Base 64 编码(Base 64 Encoding with URL and Filename Safe Alphabet)"(RFC 4648).

Note: Base 64 padding = 可能位于返回的字符串的末尾. =对 URL 编码不透明.

参见 https://tools.ietf.org/html/rfc4648#page-7.

public static string base64UrlEncode ( $input )
$input string

要编码的字符串.

return string

编码后的字符串.

basename() public static 方法

返回路径的尾部名称组件.

该方法类类似于 PHP 函数basename(), 除了它将把\/作为目录分隔符, 而与操作系统无关.

该方法主要适用于处理 PHP 命名空间. 当处理真实文件路径时, PHP 的basename()应该更适合你.

Note: 此方法不知道实际的文件系统, 或路径组件如"..".

参见 https://secure.php.net/manual/en/function.basename.php.

public static string basename ( $path, $suffix '' )
$path string

路径字符串.

$suffix string

如果名称组件以后缀($suffix)结尾, 则也会被切断.

return string

给定路径的尾部名称组件.

byteLength() public static 方法

返回给定字符串中的字节数.

该方法通过使用mb_strlen()确保字符串被视为字节数组.

public static integer byteLength ( $string )
$string string

要检查长度的字符串.

return integer

给定字符串中的字节数.

byteSubstr() public static 方法

返回由起始(start)和长度(length)参数指定的字符串部分.

该方法通过使用mbmb_substr()确保字符串被视为字节数组.

参见 https://secure.php.net/manual/en/function.substr.php.

public static string byteSubstr ( $string, $start, $length null )
$string string

输入字符串. 必须是一个字符或更长.

$start integer

起始位置.

$length integer

所需部分的长度. 如果未指定或为null, 则对长度没有限制, 即输出将一直到字符串的结尾.

return string

提取的字符串部分, 或者失败时为FALSE或空字符串.

countWords() public static 方法 (可用自版本: 2.0.8)

计算字符串中的单词数.

public static integer countWords ( $string )
$string string
dirname() public static 方法

返回父目录的路径.

该方法类似于 PHP 函数dirname(), 除了它将把\/作为目录分隔符, 而与操作系统无关.

参见 https://secure.php.net/manual/en/function.basename.php.

public static string dirname ( $path )
$path string

路径字符串.

return string

父目录的路径.

endsWith() public static 方法

检查给定字符串是否以指定的子字符串结束.

Binary and multibyte safe.

public static boolean endsWith ( $string, $with, $caseSensitive true )
$string string

要检查的输入字符串.

$with string

$string中搜索的部分.

$caseSensitive boolean

搜索是否应区分大小写. 默认为true. 当启用区分大小写时, $with必须与字符串的结尾位置完全匹配才能获得真值true.

return boolean

如果第一个输入以第二个输入结束, 则返回true, 否则返回false.

explode() public static 方法 (可用自版本: 2.0.4)

将字符串分解为数组, 可选择修剪值并跳过空值.

public static array explode ( $string, $delimiter ',', $trim true, $skipEmpty false )
$string string

要分解成数组的字符串.

$delimiter string

分隔符. 默认为','.

$trim mixed

是否修剪每个元素. 可以是:

  • boolean: 正常修剪;
  • string: 要修剪的自定义字符. 将作为第二个参数传递给trim()函数;
  • callable: will be called for each value instead of trim. Takes the only argument - value.
$skipEmpty boolean

是否跳过分隔符之间的空字符串. 默认为false.

floatToString() public static 方法 (可用自版本: 2.0.13)

安全的将浮点数float转换为字符串, 与当前语言环境无关.

小数点分隔符将始终为..

public static string floatToString ( $number )
$number float|integer

一个浮点数或整数.

return string

数字的字符串表示形式.

matchWildcard() public static 方法 (可用自版本: 2.0.14)

检查给定的字符串是否与给定的shell通配符模式匹配.

该函数使用 PCRE 模拟 fnmatch(), 在某些环境下可能不可用.

public static boolean matchWildcard ( $pattern, $string, $options = [] )
$pattern string

shell通配符模式

$string string

被测试的字符串.

$options array

匹配选项. 有效的选项包括:

  • caseSensitive: bool, 模式是否应该区分大小写. 默认为true.
  • escape: bool, 是否启用反斜杠转义. 默认为true.
  • filePath: bool, 字符串中的斜杠是否仅与给定模式中的斜杠匹配. 默认为false.
return boolean

字符串是否匹配模式

mb_ucfirst() public static 方法 (可用自版本: 2.0.16)

该方法提供了 PHP 内置函数ucfirst()的 unicode 安全实现.

参见 https://secure.php.net/manual/en/function.ucfirst.php.

public static string mb_ucfirst ( $string, $encoding 'UTF-8' )
$string string

要转换的字符串.

$encoding string

编码格式, 默认为UTF-8.

mb_ucwords() public static 方法 (可用自版本: 2.0.16)

该方法提供了 PHP 内置函数ucwords()的 unicode 安全实现.

参见 https://secure.php.net/manual/en/function.ucwords.php.

public static string mb_ucwords ( $string, $encoding 'UTF-8' )
$string string

要转换的字符串.

$encoding string

编码格式, 默认为UTF-8.

normalizeNumber() public static 方法 (可用自版本: 2.0.11)

如果当前语言环境的小数点为逗号,, 则返回数字值的字符串表示形式, 并将逗号,替换为点..

public static string normalizeNumber ( $value )
$value integer|float|string
startsWith() public static 方法

检查给定字符串是否以指定的子字符串开头.

Binary and multibyte safe.

public static boolean startsWith ( $string, $with, $caseSensitive true )
$string string

输入字符串.

$with string

$string中搜索的部分.

$caseSensitive boolean

搜索是否应区分大小写. 默认为true. 当启用区分大小写时, $with必须与字符串的起始位置完全匹配才能获得真值true.

return boolean

如果第一个输入以第二个输入开头, 则返回true, 否则返回false.

truncate() public static 方法

将字符串截断为指定的字符数.

public static string truncate ( $string, $length, $suffix '...', $encoding null, $asHtml false )
$string string

要截断的字符串.

$length integer

从原始字符串中包含多少个字符到截断的字符串.

$suffix string

要追加到截断字符串末尾的字符串.

$encoding string

要使用的字符集, 默认为应用程序当前使用的字符集.

$asHtml boolean

是否将被截断的字符串视为 HTML 并保留正确的 HTML 标签. 此参数自版本 2.0.1 起可用.

return string

截断的字符串.

truncateHtml() protected static 方法 (可用自版本: 2.0.1)

在保留 HTML 的同时截断字符串.

protected static string truncateHtml ( $string, $count, $suffix, $encoding false )
$string string

要截断的字符串.

$count integer
$suffix string

要追加到截断字符串末尾的字符串.

$encoding string|boolean
truncateWords() public static 方法

将字符串截断为指定的字数.

public static string truncateWords ( $string, $count, $suffix '...', $asHtml false )
$string string

要截断的字符串.

$count integer

从原始字符串中包含多少个单词到截断的字符串.

$suffix string

要追加到截断字符串末尾的字符串.

$asHtml boolean

是否将被截断的字符串视为 HTML 并保留正确的 HTML 标签. 此参数自版本 2.0.1 起可用.

return string

截断的字符串.