Documentation

Completions
in package

Completions class.

Table of Contents

EMOJI_REGEX  = '/\\:{2}[^\\:]+\\:{2}/'
Emoji regex patter.
FORMAT_HTML  = 'HTML'
Format HTML.
FORMAT_TEXT  = 'Text'
Format Text.
OWNER_SEPARATOR  = '@@'
Owner separator.
PATH_EMOJI_JSON  = 'public_html/vendor/ckeditor/ckeditor/plugins/emoji/emoji.json'
Path to emoji.json.
RECORD_SEPARATOR  = '##'
Record separator.
ROW_REGEX  = '/(\\##|\\@@)(\\d+)_([^\\##|\\@@]+)(\\##|\\@@)/u'
Record and Users regex patter.
decode()  : string
Get processed text in display mode.
decodeCustomTag()  : string
Decode custom yetiforce tag.
decodeEmoji()  : string
Get processed text in display Emoji.
encode()  : string
Get text to edit mode.
encodeAll()  : string
Process before writing to the database.
encodeEmoji()  : string
Process before writing to the database.
encodeRow()  : string
Process before writing to the database.
decodeOwner()  : string
Display owner.
decodeOwnerText()  : string
Display owner text.
decodeRecord()  : string
Display record.
decodeRecordText()  : string
Display record text.
decodeRow()  : string
Get processed text in display mode.
deletedRecordTemplate()  : string
Display deleted record template.
getEmojis()  : array<string|int, mixed>
Get array of emojis.

Constants

EMOJI_REGEX

Emoji regex patter.

public string EMOJI_REGEX = '/\\:{2}[^\\:]+\\:{2}/'

FORMAT_HTML

Format HTML.

public string FORMAT_HTML = 'HTML'

FORMAT_TEXT

Format Text.

public string FORMAT_TEXT = 'Text'

OWNER_SEPARATOR

Owner separator.

public string OWNER_SEPARATOR = '@@'

PATH_EMOJI_JSON

Path to emoji.json.

public string PATH_EMOJI_JSON = 'public_html/vendor/ckeditor/ckeditor/plugins/emoji/emoji.json'

RECORD_SEPARATOR

Record separator.

public string RECORD_SEPARATOR = '##'

ROW_REGEX

Record and Users regex patter.

public string ROW_REGEX = '/(\\##|\\@@)(\\d+)_([^\\##|\\@@]+)(\\##|\\@@)/u'

Methods

decode()

Get processed text in display mode.

public static decode(string $text[, string $format = self::FORMAT_HTML ]) : string
Parameters
$text : string
$format : string = self::FORMAT_HTML
Return values
string

decodeEmoji()

Get processed text in display Emoji.

public static decodeEmoji(string $text) : string
Parameters
$text : string
Return values
string

encode()

Get text to edit mode.

public static encode(string $text) : string
Parameters
$text : string
Tags
throws
AppException
Return values
string

encodeAll()

Process before writing to the database.

public static encodeAll(string $text) : string
Parameters
$text : string
Return values
string

encodeEmoji()

Process before writing to the database.

public static encodeEmoji(string $text) : string
Parameters
$text : string
Tags
example

FROM: 😀 TO: :grinning_face:

throws
AppException
Return values
string

encodeRow()

Process before writing to the database.

public static encodeRow(string $text) : string
Parameters
$text : string
Tags
example

FROM: text TO: @@115@@

Return values
string

decodeOwner()

Display owner.

private static decodeOwner(int $userId, string $recordLabel) : string
Parameters
$userId : int
$recordLabel : string
Return values
string

decodeOwnerText()

Display owner text.

private static decodeOwnerText(int $userId, string $recordLabel) : string
Parameters
$userId : int
$recordLabel : string
Return values
string

decodeRecord()

Display record.

private static decodeRecord(int $recordId, string $recordLabel) : string
Parameters
$recordId : int
$recordLabel : string
Return values
string

decodeRecordText()

Display record text.

private static decodeRecordText(int $recordId, string $recordLabel) : string
Parameters
$recordId : int
$recordLabel : string
Return values
string

decodeRow()

Get processed text in display mode.

private static decodeRow(string $baseText, string $type, int $id, string $label[, string $format = self::FORMAT_HTML ]) : string
Parameters
$baseText : string
$type : string
$id : int
$label : string
$format : string = self::FORMAT_HTML
Return values
string

deletedRecordTemplate()

Display deleted record template.

private static deletedRecordTemplate(string $recordLabel) : string
Parameters
$recordLabel : string
Return values
string

getEmojis()

Get array of emojis.

private static getEmojis() : array<string|int, mixed>
Tags
throws
AppException
Return values
array<string|int, mixed>

        

Search results