Описание класса Text | Universal Bot

Text
in

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

Class Text

Table of Contents

resize() Обрезает текст до необходимого количества символов. string
isUrl() Определяет наличие ссылки в переданном тексте bool
isSayTrue() Определяет наличие в тексте согласие пользователя bool
isSayFalse() Определяет наличие в тексте не согласие пользователя bool
isSayText() Определяет наличие в тексте определенного условия bool
getText() Получение строки из массива строк. В случае если передана строка, то вернется исходное значение. string
getEnding() Добавление нужного окончание в зависимости от переданного числа. mixed
textSimilarity() Проверяет тексты на сходство. array

Methods

resize()

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

public static resize( $text : string|null [, $size : int = 950 ] [, $isEllipsis : bool = true ] ) : string
Parameters
$text : string|null

Исходный текст.

$size : int = 950

Максимальный размер текста.

$isEllipsis : bool = true

Если true, тогда в конце добавится троеточие. Иначе текст просто обрезается.

Tags
api
Return values
string

isUrl()

Определяет наличие ссылки в переданном тексте

public static isUrl( $link : string ) : bool
Parameters
$link : string

Проверяемая строка

Tags
api
Return values
bool

isSayTrue()

Определяет наличие в тексте согласие пользователя

public static isSayTrue( $text : string ) : bool
Parameters
$text : string

Пользовательский текст.

Tags
api
Return values
bool

isSayFalse()

Определяет наличие в тексте не согласие пользователя

public static isSayFalse( $text : string ) : bool
Parameters
$text : string

Пользовательский текст.

Tags
api
Return values
bool

isSayText()

Определяет наличие в тексте определенного условия

public static isSayText( $find : array|string , $text : string [, $isPattern : bool = false ] ) : bool
Parameters
$find : array|string

Текст который ищем.

$text : string

Исходный текст, в котором осуществляется поиск.

$isPattern : bool = false

Определяет использование регулярного выражения

Tags
api
Return values
bool

getText()

Получение строки из массива строк. В случае если передана строка, то вернется исходное значение.

public static getText( $str : string|array ) : string
Parameters
$str : string|array

Исходная строка или массив из строк.

Tags
api
Return values
string

getEnding()

Добавление нужного окончание в зависимости от переданного числа.

public static getEnding( $num : int , $titles : array [, $index : int|null = null ] ) : mixed
Parameters
$num : int
  • само число.
$titles : array
  • массив из возможных вариантов. массив должен быть типа ['1 значение','2 значение','3 значение']. Где: 1 значение - это окончание, которое получится если последняя цифра числа 1 2 значение - это окончание, которое получится если последняя цифра числа от 2 до 4 3 значение - это окончание, если последняя цифра числа от 5 до 9 включая 0 Пример: ['Яблоко','Яблока','Яблок'] Результат: 1 Яблоко, 21 Яблоко, 3 Яблока, 9 Яблок
$index : int|null = null

Свое значение из массива. Если элемента в массиве с данным индексом нет, тогда параметр игнорируется.

Tags
api
Return values
mixed

textSimilarity()

Проверяет тексты на сходство.

public static textSimilarity( $origText : string , $text : string|array [, $percent : int = 80 ] ) : array

В результате вернет статус схожести, а также текст и ключ в массиве.

Если текста схожи, тогда status = true, и заполняются поля: index - Если был передан массив, тогда вернется его индекс. text - Текст, который оказался максимально схожим. percent - Процент схожести.

Parameters
$origText : string
  • оригинальный текст. С данным текстом будет производиться сравнение.
$text : string|array
  • Текст для сравнения. можно передать массив из текстов для поиска.
$percent : int = 80
  • при какой процентной схожести считать, что текста одинаковые.
Tags
api
Return values
array —

[

  • 'status' => bool, Статус выполнения
  • 'index' => int|string, В каком тексте значение совпало, либо максимальное. При передаче строки вернет 0
  • 'text' => string, Текст, который совпал
  • 'percent' => int На сколько процентов текста похожи ]

Search results