没有命名空间的类 yii yii\base yii\behaviors yii\caching yii\captcha yii\console yii\console\controllers yii\console\widgets yii\data yii\db yii\db\conditions yii\db\cubrid yii\db\cubrid\conditions yii\db\mssql yii\db\mssql\conditions yii\db\mysql yii\db\oci yii\db\oci\conditions yii\db\pgsql yii\db\sqlite yii\db\sqlite\conditions yii\di yii\filters yii\filters\auth yii\grid yii\helpers yii\i18n yii\log yii\mail yii\mutex yii\rbac yii\rest yii\test yii\validators yii\web yii\widgets

Class yii\helpers\BaseStringHelper

所有类 | 方法
继承yii\helpers\BaseStringHelper
子类yii\helpers\StringHelper
可用版本自2.0
源码 https://github.com/yiichina/yii2/blob/api/framework/helpers/BaseStringHelper.php

BaseStringHelper 为 yii\helpers\StringHelper 提供了具体的实现。

不要使用 BaseStringHelper。使用 yii\helpers\StringHelper。

公共方法

隐藏继承的方法

方法描述被定义在
base64UrlDecode() 解码 "Base 64 Encoding with URL and Filename Safe Alphabet" (RFC 4648)。 yii\helpers\BaseStringHelper
base64UrlEncode() 将字符串编码为 "Base 64 Encoding with URL and Filename Safe Alphabet" (RFC 4648)。 yii\helpers\BaseStringHelper
basename() 返回指定的跟踪组件的路径。 这个方法类似于 php 函数 basename()， 除此之外它还同时将 \ 和 / 作为目录分隔符，独立于操作系统。 该方法主要用于处理 php 命名空间 php。 在处理实际文件路径时，php 的 basename() 应该可以很好地工作。 Note: 此方法不知道实际的文件系统路径，或路径组件诸如 ". yii\helpers\BaseStringHelper
byteLength() 返回给定字符串中的字节数。 该方法使用 mb_strlen() 确保字符串被视为字节数组。 yii\helpers\BaseStringHelper
byteSubstr() 返回由起始和长度参数指定的字符串部分。 该方法使用 mb_strlen() 确保字符串被视为字节数组。 yii\helpers\BaseStringHelper
countWords() 统计字符串中的单词。 yii\helpers\BaseStringHelper
dirname() 返回父目录的路径。 这个方法类似于 dirname()， 除此之外它还同时将 \ 和 / 作为目录分隔符，独立于操作系统之外。 yii\helpers\BaseStringHelper
endsWith() 检查给定字符串是否以指定的子字符串结束。 二进制和多字节安全。 yii\helpers\BaseStringHelper
explode() 将字符串分割为数组，可选地删除值并跳过空值。 yii\helpers\BaseStringHelper
floatToString() 安全地将 float 转换为字符串，与当前语言环境无关。 yii\helpers\BaseStringHelper
matchWildcard() 检查传递的字符串是否与给定的 shell 通配符模式匹配。 此函数使用 PCRE 模拟 \yii\helpers\fnmatch()，这在某些环境中可能不可用。 yii\helpers\BaseStringHelper
mb_ucfirst() 这个方法提供了内置 PHP 函数 ucfirst() 的 unicode-safe 实现。 yii\helpers\BaseStringHelper
mb_ucwords() 这个方法提供了内置 PHP 函数 ucwords() 的 unicode-safe 实现。 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() 公共 静态 方法 （自版本 2.0.12 可用）

解码 "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() 公共 静态 方法 （自版本 2.0.12 可用）

将字符串编码为 "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() 公共 静态 方法

返回指定的跟踪组件的路径。 这个方法类似于 php 函数 basename()， 除此之外它还同时将 \ 和 / 作为目录分隔符，独立于操作系统。 该方法主要用于处理 php 命名空间 php。 在处理实际文件路径时，php 的 basename() 应该可以很好地工作。 Note: 此方法不知道实际的文件系统路径，或路径组件诸如 ".

."。

参见 http://www.php.net/manual/en/function.basename.php.

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

一个路径字符串。
$suffix string

即使这个名称组件以后缀结尾也会将其删除。
return string

给定追踪名称组件的路径。
byteLength() 公共 静态 方法

返回给定字符串中的字节数。 该方法使用 mb_strlen() 确保字符串被视为字节数组。

public static integer byteLength($string)
$string string

字符串的长度
return integer

给定字符串中的字节数。
byteSubstr() 公共 静态 方法

返回由起始和长度参数指定的字符串部分。 该方法使用 mb_strlen() 确保字符串被视为字节数组。

参见 http://www.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() 公共 静态 方法 （自版本 2.0.8 可用）

统计字符串中的单词。

public static integer countWords($string)
$string string
dirname() 公共 静态 方法

返回父目录的路径。 这个方法类似于 dirname()， 除此之外它还同时将 \ 和 / 作为目录分隔符，独立于操作系统之外。

参见 http://www.php.net/manual/en/function.basename.php.

public static string dirname($path)
$path string

一个路径字符串。
return string

父目录的路径。
endsWith() 公共 静态 方法

检查给定字符串是否以指定的子字符串结束。 二进制和多字节安全。

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

要检查的输入字符串
$with string

部分用于搜索 $string 的内部。
$caseSensitive boolean

大小写敏感的搜索。默认是 true。当启用区分大小写时，$with 必须与字符串的结尾完全匹配，才能获得一个真正的值。
return boolean

如果第一个输入以第二个输入结束，则返回 true，否则返回 false
explode() 公共 静态 方法 （自版本 2.0.4 可用）

将字符串分割为数组，可选地删除值并跳过空值。

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

要分割的字符串。
$delimiter string

分隔符。默认设置是 ','。
$trim mixed

是否清除每个元素。可以是：

  • boolean - 正常清除；
  • string - 指定字符串进行清除。将作为第二个参数传递给 trim() 函数。
  • callable - 将调用每个值而不是 trim。给定指定的参数 - 值。
$skipEmpty boolean

是否跳过分隔符之间的空字符串。默认是 false。
floatToString() 公共 静态 方法 （自版本 2.0.13 可用）

安全地将 float 转换为字符串，与当前语言环境无关。

小数分隔符将始终为 .。

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

浮点数或整数。
return string

数字的字符串表示形式。
matchWildcard() 公共 静态 方法 （自版本 2.0.14 可用）

检查传递的字符串是否与给定的 shell 通配符模式匹配。 此函数使用 PCRE 模拟 \yii\helpers\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() 公共 静态 方法 （自版本 2.0.16 可用）

这个方法提供了内置 PHP 函数 ucfirst() 的 unicode-safe 实现。

参见 http://php.net/manual/en/function.ucfirst.php.

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

提取的字符串
$encoding string

可选项，默认是 "UTF-8"
mb_ucwords() 公共 静态 方法

这个方法提供了内置 PHP 函数 ucwords() 的 unicode-safe 实现。

参见 http://php.net/manual/en/function.ucwords.php.

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

指定进行的字符串
$encoding string

可选项，默认是 "UTF-8"
normalizeNumber() 公共 静态 方法 （自版本 2.0.11 可用）

如果小数点，则返回数字值的字符串表示形式， 并将逗号替换为点。

public static string normalizeNumber($value)
$value integer|float|string
startsWith() 公共 静态 方法

检查给定字符串是否以指定的子字符串开始。 二进制和多字节安全。

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

输入字符串
$with string

部分用于在 $string 中搜索
$caseSensitive boolean

大小写敏感的搜索。默认是 true。当启用区分大小写时，$with 必须与字符串的开头完全匹配，才能获得一个真正的值。
return boolean

如果第一个输入以第二个输入开始，则返回 true，否则返回 false
truncate() 公共 静态 方法

将字符串截取为指定的字符数。

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() 受保护 静态 方法 （自版本 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 string truncateWords($string, $count, $suffix = '...', $asHtml = false)
$string string

要截取的字符串。
$count integer

从原始字符串中包含多少个单词到截取的字符串中。
$suffix string

附加到截取字符串的末尾。
$asHtml boolean

是否将被截取的字符串视为 HTML 并保留适当的 HTML 标记。 这个参数在 2.0.1 版之后就可用了。
return string

截取的字符串。