Spec-Zone.ru › CakePHP 2.10

Класс TextHelper

Библиотека обработки текста.

Обработка текста: выделение, извлечение фрагмента, обрезка, удаление ссылок, преобразование адресов электронной почты в ссылки mailto:...

AppHelper
Extended by TextHelper
Пакет: Cake\View\Helper
Ссылка: https://book.cakephp.org/2.0/ru/core-libraries/helpers/text.html
См.: String
Авторские права: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/View/Helper/TextHelper.php

Резюме свойств

  • $_engine protected
    stdClass
    Экземпляр утилиты CakeText
  • $_placeholders protected
    array

    Массив md5sum и их содержимого. Используется при вставке ссылок в текст.

  • $helpers public
    array
    helpers

Резюме магических свойств

  • $Html public
    HtmlHelper

Резюме методов

  • __call() public
    Вызов методов класса утилиты CakeText
  • __construct() public
    Конструктор
  • _insertPlaceHolder() protected

    Сохраняет заполнитель для строки, для последующего использования. Это обходит двойное экранирование содержимого в URL.

  • _linkEmails() protected
    Создание ссылок на адреса электронной почты
  • _linkUrls() protected
    Замена плейсхолдеров ссылками.
  • autoLink() public
    Преобразование всех ссылок и адресов электронной почты в HTML-ссылки.
  • autoLinkEmails() public
    Добавляет ссылки на электронные письма (<a href="mailto:....) к заданному тексту.
  • autoLinkUrls() public

    Добавляет ссылки (<a href=....) к заданному тексту, найдя текст, начинающийся со строк типа http:// и ftp://.

  • autoParagraph() public

    Форматирует абзацы вокруг заданного текста для всех переносов строки
    добавленных для возврата одной строки

    <

    p> добавлено для возврата двух строк

  • excerpt() public

    Извлекает фрагмент текста, окружающий фразу с заданным количеством символов с каждой стороны, определенным радиусом.

  • highlight() public

    Выделяет заданную фразу в тексте. Можно указать любое выражение в highlighter, которое может включать выражение \1 для включения найденной фразы $phrase.

  • stripLinks() public
    Удаляет из заданного текста все ссылки (<a href=....)
  • tail() public
    Обрезает текст, начиная с конца.
  • toList() public
    Создает список, разделенный запятыми, где последние два элемента объединяются с 'и', образуя естественный язык.
  • truncate() public
    Обрезает текст.

Подробное описание методов

__call()source public 

__call( string $method , array $params )

Вызов методов класса утилиты CakeText

Параметры

строка $method
Метод для вызова.
массив $params
Параметры, передаваемые методу.

Возвращает

mixed
Результат вызываемого метода или false при неудаче

__construct()source public 

__construct( View $View , array $settings array() )

Конструктор

Настройки:

  • engine Имя класса для замены функциональности CakeText. Класс должен быть размещен в каталоге Utility.

Параметры

View $View
объект представления, к которому прикреплен помощник.
массив $settings необязательно array()
Массив настроек

Исключения

CakeException
при невозможности найти класс движка.

_insertPlaceHolder()source protected 

_insertPlaceHolder( array $matches )

Сохраняет заполнитель для строки, для последующего использования. Это обходит двойное экранирование содержимого в URL.

Параметры

массив $matches
Массив совпадений с регулярным выражением.

Возвращает

строка
Заменённые значения.

_linkEmails()source protected 

_linkEmails( string $text , array $options )

Создание ссылок на адреса электронной почты

Параметры

строка $text
Текст для обработки
массив $options
Массив опций для использования в HTML.

Возвращает

строка

См.

TextHelper::autoLinkEmails()

_linkUrls()source protected 

_linkUrls( string $text , array $htmlOptions )

Замена плейсхолдеров ссылками.

Параметры

строка $text
Текст для обработки.
массив $htmlOptions
Опции для сгенерированных ссылок.

Возвращает

строка
Текст со вставленными ссылками.

autoLink()source public 

autoLink( string $text , array $options array() )

Преобразование всех ссылок и адресов электронной почты в HTML-ссылки.

Опции

  • escape Управление HTML-экранированием входных данных. По умолчанию значение true.

Параметры

строка $text
Текст
массив $options необязательно array()
Массив HTML-опций и вышеуказанных опций.

Возвращает

строка
Текст со ссылками

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/text.html#TextHelper::autoLink

autoLinkEmails()source public 

autoLinkEmails( string $text , array $options array() )

Добавляет ссылки на электронные письма (<a href="mailto:....) к заданному тексту.

Опции

  • escape Управление HTML-экранированием входных данных. По умолчанию значение true.

Параметры

строка $text
Текст
массив $options необязательно array()
Массив HTML-опций и вышеуказанных опций.

Возвращает

строка
Текст со ссылками

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/text.html#TextHelper::autoLinkEmails

autoLinkUrls()source public 

autoLinkUrls( string $text , array $options array() )

Добавляет ссылки (<a href=....) к заданному тексту, найдя текст, начинающийся со строк типа http:// и ftp://.

Опции

  • escape Управление HTML-экранированием входных данных. По умолчанию значение true.

Параметры

строка $text
Текст
массив $options необязательно array()
Массив HTML-опций и вышеуказанных опций.

Возвращает

строка
Текст со ссылками

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/text.html#TextHelper::autoLinkUrls

autoParagraph()source public 

autoParagraph( string $text )

Форматирует абзацы вокруг заданного текста для всех переносов строки
добавлен для возврата в одну строку

<

p> добавлен для возврата в две строки

Параметры

строка $text
Текст

Возвращает

строка

Текст с правильными

<

p> и
тегами


Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/text.html#TextHelper::autoParagraph

excerpt()source public 

excerpt( string $text , string $phrase , integer $radius 100 , string $ending '...' )

Извлекает выдержку из текста, окружающего фразу с количеством символов с каждой стороны, определяемым радиусом.

Параметры

строка $text
Строка для поиска фразы в ней
строка $phrase
Фраза, которая будет искаться
целое число $radius необязательно 100
Количество символов, которые будут возвращены с каждой стороны найденной фразы
строка $ending необязательно '...'
Окончание, которое будет добавлено

Возвращает

строка
Измененная строка

См. также

CakeText::excerpt()

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/text.html#TextHelper::excerpt

highlight()source public 

highlight( string $text , string $phrase , array $options array() )

Выделяет заданную фразу в тексте. Вы можете указать любое выражение в выделении, которое может включать выражение \1 для включения найденной фразы $phrase.

Параметры

строка $text
Текст для поиска фразы в нем
строка $phrase
Фраза, которая будет искаться
массив $options необязательно array()
Массив атрибутов и опций html.

Возвращает

строка
Выделенный текст

См. также

CakeText::highlight()

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/text.html#TextHelper::highlight

stripLinks()source public 

stripLinks( string $text )

Удаляет из заданного текста все ссылки (<a href=....)

Параметры

строка $text
Текст

Возвращает

строка
Текст без ссылок

См. также

CakeText::stripLinks()

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/text.html#TextHelper::stripLinks

tail()source public 

tail( string $text , integer $length 100 , array $options array() )

Обрезает текст, начиная с конца.

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

Опции:

  • ellipsis Будет использоваться как начало и предварять обрезанную строку
  • exact Если false, $text не будет обрезан в середине слова

Параметры

строка $text
Строка для обрезки.
целое число $length необязательно 100
Длина возвращаемой строки, включая многоточие.
массив $options необязательно array()
Массив атрибутов и опций html.

Возвращает

строка
Обрезанная строка.

См. также

CakeText::tail()

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/text.html#TextHelper::tail

toList()source public 

toList( array $list , string $and null , string $separator ', ' )

Создает список, разделенный запятыми, где последние два элемента объединяются с 'и', образуя естественный язык.

Параметры

массив $list
Список, который будет соединен.
строка $and необязательно null
Слово, используемое для объединения последних двух элементов вместе. По умолчанию 'и'.
строка $separator необязательно ', '
Разделитель, используемый для объединения всех других элементов. По умолчанию ', '.

Возвращает

строка
Склеенная строка.

См. также

CakeText::toList()

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/text.html#TextHelper::toList

truncate()source public 

truncate( string $text , integer $length 100 , array $options array() )

Обрезает текст.

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

Опции:

  • ellipsis Будет использоваться как окончание и добавляться к обрезанной строке (ending устарело)
  • exact Если false, $text не будет обрезан в середине слова
  • html Если true, теги HTML будут обработаны правильно

Параметры

строка $text
Строка для обрезки.
целое число $length необязательно 100
Длина возвращаемой строки, включая многоточие.
массив $options необязательно array()
Массив атрибутов и опций html.

Возвращает

строка
Обрезанная строка.

См. также

CakeText::truncate()

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/text.html#TextHelper::truncate

Подробное описание свойств

$_enginesource

protected stdClass

Экземпляр утилиты CakeText

$_placeholderssource

protected массив

Массив md5sum и их содержимого. Используется при вставке ссылок в текст.

array()

$helperssource

public массив

helpers

array('Html')

Подробное описание магических свойств

$Htmlsource

public HtmlHelper

© 2005–2017 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/2.10/class-TextHelper.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API