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

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

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

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

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

$this->load->helper('text');

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

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

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 (строка) – Входная строка
Возвращает:	Строка с ASCII-значениями, преобразованными в сущности
Тип возвращаемого значения:	строка

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

Пример:

$string = ascii_to_entities($string);

convert_accented_characters($str)

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

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

Пример:

%%%CODE_BLOCK_9%%>

Примечание

Эта функция использует файл конфигурации-компаньон application/config/foreign_chars.php, чтобы определить массив для транслитерации.

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

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

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

Пример:

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

highlight_code($str)

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

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

$string = highlight_code($string);

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

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

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

Выделит фразу в строке текста. Первый параметр содержит исходную строку, второй — фразу, которую вы хотите выделить. Третий и четвертый параметры содержат открывающий/закрывающий 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 (строка) – Входная строка $charlim (целое число) – Предел символов
Возвращает:	Строка с переходом на новую строку
Тип возвращаемого значения:	строка

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

Пример:

$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.

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

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

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

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

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

Пример:

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

Выводит:

this_string_is_e…ak_my_design.jpg