Помощник по тексту

Файл Помощник по тексту содержит функции, которые помогают работать с текстом.

Загрузка этого помощника
Доступные функции

Загрузка этого помощника

Этот помощник загружается с помощью следующего кода:

helper('text');

Доступные функции

Доступны следующие функции:

random_string([$type = 'alnum'[, $len = 8]])

Параметры:	$type (строка) – Тип генерации случайных данных $len (целое число) – Длина генерируемой строки
Возвращает:	Случайная строка
Тип возвращаемого значения:	строка

Генерирует случайную строку на основе указанного типа и длины. Полезно для создания паролей или генерации случайных хэшей.

Первый параметр определяет тип строки, второй параметр определяет длину. Доступны следующие варианты:

alpha: Строка только с прописными и строчными буквами.
alnum: Буквенно-цифровая строка с прописными и строчными символами.
basic: Случайное число, основанное на mt_rand() (длина игнорируется).
numeric: Числовая строка.
nozero: Числовая строка без нулей.
md5: Зашифрованное случайное число, основанное на md5() (фиксированная длина 32).
sha1: Зашифрованное случайное число, основанное на sha1() (фиксированная длина 40).
crypto: Случайная строка, основанная на random_bytes().

Пример использования:

echo random_string('alnum', 16);

increment_string($str[, $separator = '_'[, $first = 1]])

Параметры:	$str (строка) – Входная строка $separator (строка) – Разделитель для добавления дублирующего числа $first (целое число) – Начальное число
Возвращает:	Увеличенная строка
Тип возвращаемого значения:	строка

Увеличивает строку, добавляя к ней число или увеличивая его. Полезно для создания «копий» файла или дублирования содержимого базы данных, имеющей уникальные заголовки или слоты.

Пример использования:

echo increment_string('file', '_'); // "file_1"
echo increment_string('file', '-', 2); // "file-2"
echo increment_string('file_4'); // "file_5"

alternator($args)

Параметры:	$args (смешанный тип) – Переменное количество аргументов
Возвращает:	Переключаемые строка(и)
Тип возвращаемого значения:	смешанный тип

Позволяет переключаться между двумя или более элементами при циклическом проходе по циклу. Пример:

for ($i = 0; $i < 10; $i++) {
    echo alternator('string one', 'string two');
}

Вы можете добавить любое количество параметров, и с каждой итерацией цикла будет возвращаться следующий элемент.

for ($i = 0; $i < 10; $i++) {
    echo alternator('one', 'two', 'three', 'four', 'five');
}

Примечание

Для использования нескольких отдельных вызовов этой функции просто вызовите функцию без аргументов для повторной инициализации.

reduce_double_slashes($str)

Параметры:	$str (строка) – Входная строка
Возвращает:	Строка с нормализованными слешами
Тип возвращаемого значения:	строка

Преобразует двойные слеши в строке в один слеш, за исключением тех, которые находятся в префиксах протокола URL (например, http://).

Пример:

$string = "http://example.com//index.php";
echo reduce_double_slashes($string); // results in "http://example.com/index.php"

strip_slashes($data)

Параметры:	$data (смешанный тип) – Входная строка или массив строк
Возвращает:	Строка(и) со удалёнными слешами
Тип возвращаемого значения:	смешанный тип

Удаляет все слеши из массива строк.

Пример:

$str = [
    'question' => "Is your name O\'reilly?",
    'answer'   => "No, my name is O\'connor."
];

$str = strip_slashes($str);

Вышеприведенное вернёт следующий массив:

[
    'question' => "Is your name O'reilly?",
    'answer'   => "No, my name is O'connor."
];

Примечание

По историческим причинам, эта функция также может принимать и обрабатывать строковые входные данные. Однако это делает её просто псевдонимом для stripslashes().

reduce_multiples($str[, $character = ''[, $trim = false]])

Параметры:	$str (строка) – Текст для поиска $character (строка) – Символ для сокращения $trim (булево) – Нужно ли также обрезать указанный символ
Возвращает:	Сокращенная строка
Тип возвращаемого значения:	строка

Уменьшает несколько последовательных вхождений определённого символа. Пример:

$string = "Fred, Bill,, Joe, Jimmy";
$string = reduce_multiples($string, ","); // results in "Fred, Bill, Joe, Jimmy"

Если третий параметр установлен в значение true, он удалит вхождения символа в начале и в конце строки. Пример:

$string = ",Fred, Bill,, Joe, Jimmy,";
$string = reduce_multiples($string, ", ", true); // results in "Fred, Bill, Joe, Jimmy"

quotes_to_entities($str)

Параметры:	$str (строка) – Входная строка
Возвращает:	Строка с кавычками, преобразованными в сущности HTML
Тип возвращаемого значения:	строка

Преобразует одинарные и двойные кавычки в строке в соответствующие сущности HTML. Пример:

$string = "Joe's \"dinner\"";
$string = quotes_to_entities($string); //results in "Joe&#39;s &quot;dinner&quot;"

strip_quotes($str)

Параметры:	$str (строка) – Входная строка
Возвращает:	Строка с удалёнными кавычками
Тип возвращаемого значения:	строка

Удаляет одинарные и двойные кавычки из строки. Пример:

$string = "Joe's \"dinner\"";
$string = strip_quotes($string); //results in "Joes dinner"

word_limiter($str[, $limit = 100[, $end_char = '…']])

Параметры:	$str (строка) – Входная строка $limit (целое число) – Ограничение $end_char (строка) – Символ окончания (обычно многоточие)
Возвращает:	Строка, ограниченная по количеству слов
Тип возвращаемого значения:	строка

Усекает строку до указанного числа слов. Пример:

$string = "Here is a nice text string consisting of eleven words.";
$string = word_limiter($string, 4);
// Returns:  Here is a nice

Третий параметр — это необязательный суффикс, добавляемый к строке. По умолчанию добавляется многоточие.

character_limiter($str[, $n = 500[, $end_char = '…']])

Параметры:	$str (строка) – Входная строка $n (целое число) – Количество символов $end_char (строка) – Символ окончания (обычно многоточие)
Возвращает:	Строка, ограниченная по количеству символов
Тип возвращаемого значения:	строка

Усекает строку до указанного числа символов. Она поддерживает целостность слов, поэтому количество символов может быть немного больше или меньше, чем вы указали.

Пример:

$string = "Here is a nice text string consisting of eleven words.";
$string = character_limiter($string, 20);
// Returns:  Here is a nice text string

Третий параметр — необязательный суффикс, добавляемый к строке. Если он не указан, этот помощник использует многоточие.

Примечание

Если вам нужно усечь до точного количества символов, см. функцию ellipsize() ниже.

ascii_to_entities($str)

Параметры:	$str (string) – Входная строка
Возвращаемое значение:	Строка с ASCII-значениями, преобразованными в сущности
Тип возвращаемого значения:	string

Преобразует ASCII-значения в символьные сущности, включая символы расширенного ASCII и MS Word, которые могут вызывать проблемы при использовании на веб-странице, чтобы они отображались согласованно независимо от настроек браузера или надежно хранились в базе данных. Существует определенная зависимость от поддерживаемых на сервере наборов символов, поэтому она может быть не на 100% надежной во всех случаях, но в большинстве случаев она должна правильно идентифицировать символы за пределами обычного диапазона (например, символы с диакритическими знаками).

Пример:

$string = ascii_to_entities($string);

entities_to_ascii($str[, $all = true])

Параметры:	$str (string) – Входная строка $all (bool) – Преобразовывать ли также небезопасные сущности
Возвращаемое значение:	Строка с HTML-сущностями, преобразованными в ASCII-символы
Тип возвращаемого значения:	string

Эта функция делает обратное тому, что делает ascii_to_entities(). Она преобразует символьные сущности обратно в ASCII.

convert_accented_characters($str)

Параметры:	$str (string) – Входная строка
Возвращаемое значение:	Строка с преобразованными символами с диакритическими знаками
Тип возвращаемого значения:	string

Транслитерирует символы расширенного ASCII в эквиваленты ASCII. Полезно, когда символы не английского языка должны быть использованы там, где используются только стандартные ASCII-символы, например, в URL.

Пример:

$string = convert_accented_characters($string);

Примечание

Эта функция использует файл конфигурации-компаньон app/Config/ForeignCharacters.php для определения массива преобразования.

word_censor($str, $censored[, $replacement = ''])

Параметры:	$str (string) – Входная строка $censored (array) – Список запрещённых слов $replacement (string) – На что заменить запрещённые слова
Возвращаемое значение:	Зацензуренная строка
Тип возвращаемого значения:	string

Позволяет цензурировать слова в текстовой строке. Первый параметр будет содержать исходную строку. Второй будет содержать массив слов, которые вы запрещаете. Третий (необязательный) параметр может содержать значение замены для слов. Если он не указан, слова заменяются на решетки: ####.

Пример:

$disallowed = ['darn', 'shucks', 'golly', 'phooey'];
$string     = word_censor($string, $disallowed, 'Beep!');

highlight_code($str)

Параметры:	$str (string) – Входная строка
Возвращаемое значение:	Строка с выделенным кодом с помощью HTML
Тип возвращаемого значения:	string

Выделяет цветом строку кода (PHP, HTML и т. д.). Пример:

$string = highlight_code($string);

Функция использует функцию PHP highlight_string(), поэтому цвета, используемые, соответствуют тем, которые указаны в вашем файле php.ini.

highlight_phrase($str, $phrase[, $tag_open = '<mark>'[, $tag_close = '</mark>']])

Параметры:	$str (string) – Входная строка $phrase (string) – Выделенное выражение $tag_open (string) – Открывающий тег, используемый для выделения $tag_close (string) – Закрывающий тег для выделения
Возвращаемое значение:	Строка с выделенным выражением с помощью HTML
Тип возвращаемого значения:	string

Выделит выражение в строке текста. Первый параметр будет содержать исходную строку, второй — выражение, которое вы хотите выделить. Третий и четвёртый параметры будут содержать открывающие/закрывающие HTML-теги, в которые вы хотите заключить выражение.

Пример:

$string = "Here is a nice text string about nothing in particular.";
echo highlight_phrase($string, "nice text", '<span style="color:#990000;">', '</span>');

Вышеприведённый код выводит:

Here is a <span style="color:#990000;">nice text</span> string about nothing in particular.

Примечание

Эта функция по умолчанию использовала тег <strong>. Более старые браузеры могут не поддерживать новый HTML5-тег mark, поэтому рекомендуется добавить следующий CSS-код в ваш стилевой файл, если вам нужно поддерживать такие браузеры:

mark {
    background: #ff0;
    color: #000;
};

word_wrap($str[, $charlim = 76])

Параметры:	$str (string) – Входная строка $charlim (int) – Ограничение символов
Возвращаемое значение:	Строка с переносённым текстом
Тип возвращаемого значения:	string

Обрезает текст по заданному количеству символов, сохраняя целые слова.

Пример:

$string = "Here is a simple string of text that will help us demonstrate this function.";
echo word_wrap($string, 25);

// Would produce:
// Here is a simple string
// of text that will help us
// demonstrate this
// function.

Excessively long words will be split, but URLs will not be.

ellipsize($str, $max_length[, $position = 1[, $ellipsis = '…']])

Параметры:	$str (string) – Входная строка $max_length (int) – Ограничение длины строки $position (mixed) – Позиция для разделения (int или float) $ellipsis (string) – Символ, который использовать в качестве многоточия
Возвращаемое значение:	Строка с многоточием
Тип возвращаемого значения:	string

Эта функция удалит теги из строки, разделит её по заданной максимальной длине и вставит многоточие.

Первый параметр — строка, которую нужно обрезать, второй — количество символов в окончательной строке. Третий параметр — позиция в строке, с которой должно начинаться многоточие (от 0 до 1, слева направо). Например, значение 1 поместит многоточие вправо от строки, .5 — посередине, 0 — слева.

Необязательный четвёртый параметр — вид многоточия. По умолчанию вставляется ….

Пример:

$str = 'this_string_is_entirely_too_long_and_might_break_my_design.jpg';
echo ellipsize($str, 32, .5);

Результат:

this_string_is_e&hellip;ak_my_design.jpg

excerpt($text, $phrase = false, $radius = 100, $ellipsis = '...')

Параметры:	$text (string) – Текст для выделения отрывка $phrase (string) – Выражение или слово для выделения текста вокруг $radius (int) – Количество символов до и после $phrase $ellipsis (string) – Символ, который использовать в качестве многоточия
Возвращаемое значение:	Отрывок.
Тип возвращаемого значения:	string

Эта функция выделит $radius символов до и после центрального $phrase с многоточием до и после.

Первый параметр — текст, из которого нужно выделить отрывок, второй — центральное слово или выражение, по которому считается количество символов до и после. Третий параметр — количество символов для подсчёта до и после центрального выражения. Если выражение не передано, отрывок будет включать первые $radius символов с многоточием в конце.

Пример:

$text = 'Ut vel faucibus odio. Quisque quis congue libero. Etiam gravida
eros lorem, eget porttitor augue dignissim tincidunt. In eget risus eget
mauris faucibus molestie vitae ultricies odio. Vestibulum id ultricies diam.
Curabitur non mauris lectus. Phasellus eu sodales sem. Integer dictum purus
ac enim hendrerit gravida. Donec ac magna vel nunc tincidunt molestie sed
vitae nisl. Cras sed auctor mauris, non dictum tortor. Nulla vel scelerisque
arcu. Cras ac ipsum sit amet augue laoreet laoreet. Aenean a risus lacus.
Sed ut tortor diam.';

echo excerpt($text, 'Donec');

Результат:

... non mauris lectus. Phasellus eu sodales sem. Integer dictum purus ac
enim hendrerit gravida. Donec ac magna vel nunc tincidunt molestie sed
vitae nisl. Cras sed auctor mauris, non dictum tortor. ...

© 2014–2020 British Columbia Institute of Technology
Licensed under the MIT License.
https://codeigniter.com/user_guide/helpers/text_helper.html