Класс 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() | Декодирует "Base 64 Кодирование с URL и безопасным для имен файлов алфавитом" (RFC 4648) | yii\helpers\BaseStringHelper |
| base64UrlEncode() | Кодирует строку в "Base 64 Кодирование с URL и безопасным для имен файлов алфавитом" (RFC 4648) | yii\helpers\BaseStringHelper |
| basename() | Возвращает последнюю часть имени пути. | yii\helpers\BaseStringHelper |
| byteLength() | Возвращает количество байтов в данной строке. | yii\helpers\BaseStringHelper |
| byteSubstr() | Возвращает часть строки, указанную параметрами начала и длины. | yii\helpers\BaseStringHelper |
| countWords() | Считает слова в строке | yii\helpers\BaseStringHelper |
| dirname() | Возвращает путь к родительской директории. | yii\helpers\BaseStringHelper |
| endsWith() | Проверяет, заканчивается ли данная строка указанной подстрокой. | yii\helpers\BaseStringHelper |
| explode() | Разделяет строку на массив, необязательно обрезает значения и пропускает пустые | 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)
Декодирует «Base 64 кодирование с URL и файловым именем безопасным алфавитом» (RFC 4648)
См. также https://tools.ietf.org/html/rfc4648#page-7.
| public static строка base64UrlDecode ( $input ) | ||
|---|---|---|
| $input | строка |
Закодированная строка. |
| return | строка |
Декодированная строка. |
base64UrlEncode() public static метод (доступен с версии 2.0.12)
Кодирует строку в «Base 64 кодирование с URL и файловым именем безопасным алфавитом» (RFC 4648)
Примечание: Заполнение Base 64
=может находиться в конце возвращаемой строки.=не прозрачно для URL-кодирования.
См. также https://tools.ietf.org/html/rfc4648#page-7.
| public static строка base64UrlEncode ( $input ) | ||
|---|---|---|
| $input | строка |
Строка для кодирования. |
| return | строка |
Закодированная строка. |
basename() public static метод
Возвращает компонент имени в конце пути.
Этот метод похож на php функцию basename() за исключением того, что он будет рассматривать как разделители каталогов и \ и / независимо от операционной системы. Этот метод был создан главным образом для работы с php именованными пространствами. При работе с реальными путями файлов php's basename() должно работать нормально. Примечание: этот метод не знает о фактической файловой системе или компонентах пути, таких как "..".
См. также http://www.php.net/manual/en/function.basename.php.
| public static строка basename ( $path, $suffix = '' ) | ||
|---|---|---|
| $path | строка |
Строка пути. |
| $suffix | строка |
Если компонент имени заканчивается на суффикс, то он также будет удален. |
| return | строка |
Компонент имени в конце заданного пути. |
byteLength() public static метод
Возвращает количество байтов в данной строке.
Этот метод гарантирует, что строка обрабатывается как массив байтов, используя mb_strlen().
| public static целое число byteLength ( $string ) | ||
|---|---|---|
| $string | строка |
Строка, длина которой измеряется. |
| return | целое число |
Количество байтов в данной строке. |
byteSubstr() public static метод
Возвращает часть строки, указанную параметрами начала и длины.
Этот метод гарантирует, что строка обрабатывается как массив байтов, используя mb_substr().
См. также http://www.php.net/manual/en/function.substr.php.
| public static строка byteSubstr ( $string, $start, $length = null ) | ||
|---|---|---|
| $string | строка |
Входная строка. Должна быть одной или более длины. |
| $start | целое число |
Начальная позиция |
| $length | целое число |
Длина желаемой части. Если не указано или |
| return | строка |
Извлеченная часть строки или FALSE при ошибке или пустая строка. |
countWords() public static метод (доступен с версии 2.0.8)
Подсчитывает слова в строке
| public static целое число countWords ( $string ) | ||
|---|---|---|
| $string | строка | |
dirname() public static метод
Возвращает путь родительского каталога.
Этот метод похож на dirname() за исключением того, что он будет рассматривать как разделители каталогов и \ и / независимо от операционной системы.
См. также http://www.php.net/manual/en/function.basename.php.
| public static строка dirname ( $path ) | ||
|---|---|---|
| $path | строка |
Строка пути. |
| return | строка |
Путь родительского каталога. |
endsWith() public static метод
Проверяет, заканчивается ли данная строка заданной подстрокой.
Бинарно и многобайтово безопасен.
| public static булево значение endsWith ( $string, $with, $caseSensitive = true ) | ||
|---|---|---|
| $string | строка |
Входная строка для проверки |
| $with | строка |
Часть для поиска внутри $string. |
| $caseSensitive | булево значение |
Поиск, чувствительный к регистру. По умолчанию true. При включенном чувствительном к регистру поиске $with должен точно совпадать с окончанием строки для получения значения true. |
| return | булево значение |
Возвращает true, если первый ввод заканчивается вторым вводом, в противном случае false |
explode() public static метод (доступен с версии 2.0.4)
Разбивает строку на массив, необязательно обрезает значения и пропускает пустые
| public static массив explode ( $string, $delimiter = ',', $trim = true, $skipEmpty = false ) | ||
|---|---|---|
| $string | строка |
Строка для разделения. |
| $delimiter | строка |
Разделитель. По умолчанию ','. |
| $trim | смешанный тип |
Нужно ли обрезать каждый элемент. Может быть:
|
| $skipEmpty | булево значение |
Нужно ли пропускать пустые строки между разделителями. По умолчанию false. |
normalizeNumber() public static метод (доступен с версии 2.0.11)
Возвращает строковое представление числового значения с заменёнными запятыми на точки, если десятичная точка текущего языка - запятая
| public static строка normalizeNumber ( $value ) | ||
|---|---|---|
| $value | целое число|число с плавающей точкой|строка | |
startsWith() public static метод
Проверяет, начинается ли данная строка со заданной подстроки.
Бинарно и многобайтово безопасен.
| public static булево значение startsWith ( $string, $with, $caseSensitive = true ) | ||
|---|---|---|
| $string | строка |
Входная строка |
| $with | строка |
Часть для поиска внутри $string |
| $caseSensitive | булево значение |
Поиск, чувствительный к регистру. По умолчанию true. При включенном чувствительном к регистру поиске $with должен точно совпадать с началом строки для получения значения true. |
| return | булево значение |
Возвращает 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() защищённый статический метод (доступен начиная с версии 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 |
Усечённая строка. |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-helpers-basestringhelper.html