PHP Класс BBCode, vanilla

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$media A list of records from the Media table, indexed by MediaID.
$nbbc An instance of Nbbc\BBcode.

Открытые методы

Метод Описание
doAttachment ( Nbbc\BBCode $bbcode, integer $action, string $name, string $default, array $params, string $content ) : string Perform formatting against a string for the attach tag.
doImage ( Nbbc\BBCode $bbcode, integer $action, string $name, string $default, array $params, string $content ) : boolean | string Perform formatting against a string for the img tag.
doQuote ( Nbbc\BBCode $bbcode, integer $action, string $name, string $default, array $params, string $content ) : boolean | string Perform formatting against a string for the quote tag.
doSize ( Nbbc\BBCode $bbcode, integer $action, string $name, string $default, array $params, string $content ) : string Perform formatting against a string for the size tag.
doURL ( Nbbc\BBCode $bbcode, integer $action, string $name, string $default, array $params, string $content ) : boolean | string Perform formatting against a string for the url tag.
doVideo ( Nbbc\BBCode $bbcode, integer $action, string $name, string $default, array $params, string $content ) : string Perform formatting against a string for the video tag.
doYoutube ( Nbbc\BBCode $bbcode, integer $action, string $name, string $default, array $params, string $content ) : boolean | string Perform formatting against a string for the youtube tag
format ( string $bbcode ) : string Parse the provided BBCode into an HTML string.
media ( ) : array Build and return a list of attachments for the current page.
nbbc ( ) : Nbbc\BBCode Create, configure and return an instance of Nbbc\BBcode.
removeAttachment ( ) : string Custom handler for the attachment tag.

Описание методов

doAttachment() публичный Метод

Perform formatting against a string for the attach tag.
public doAttachment ( Nbbc\BBCode $bbcode, integer $action, string $name, string $default, array $params, string $content ) : string
$bbcode Nbbc\BBCode Instance of Nbbc doing the parsing.
$action integer Value of one of NBBC's defined constants. Typically, this will be BBCODE_CHECK.
$name string Name of the tag.
$default string Value of the _default parameter, from the $params array.
$params array A standard set parameters related to the tag.
$content string Value between the open and close tags, if any.
Результат string Formatted value.

doImage() публичный Метод

Perform formatting against a string for the img tag.
public doImage ( Nbbc\BBCode $bbcode, integer $action, string $name, string $default, array $params, string $content ) : boolean | string
$bbcode Nbbc\BBCode Instance of Nbbc doing the parsing.
$action integer Value of one of NBBC's defined constants. Typically, this will be BBCODE_CHECK.
$name string Name of the tag.
$default string Value of the _default parameter, from the $params array.
$params array A standard set parameters related to the tag.
$content string Value between the open and close tags, if any.
Результат boolean | string Formatted value.

doQuote() публичный Метод

Perform formatting against a string for the quote tag.
public doQuote ( Nbbc\BBCode $bbcode, integer $action, string $name, string $default, array $params, string $content ) : boolean | string
$bbcode Nbbc\BBCode Instance of Nbbc doing the parsing.
$action integer Value of one of NBBC's defined constants. Typically, this will be BBCODE_CHECK.
$name string Name of the tag.
$default string Value of the _default parameter, from the $params array.
$params array A standard set parameters related to the tag.
$content string Value between the open and close tags, if any.
Результат boolean | string Formatted value.

doSize() публичный Метод

Perform formatting against a string for the size tag.
public doSize ( Nbbc\BBCode $bbcode, integer $action, string $name, string $default, array $params, string $content ) : string
$bbcode Nbbc\BBCode Instance of Nbbc doing the parsing.
$action integer Value of one of NBBC's defined constants. Typically, this will be BBCODE_CHECK.
$name string Name of the tag.
$default string Value of the _default parameter, from the $params array.
$params array A standard set parameters related to the tag.
$content string Value between the open and close tags, if any.
Результат string Formatted value.

doURL() публичный Метод

Perform formatting against a string for the url tag.
public doURL ( Nbbc\BBCode $bbcode, integer $action, string $name, string $default, array $params, string $content ) : boolean | string
$bbcode Nbbc\BBCode Instance of Nbbc doing the parsing.
$action integer Value of one of NBBC's defined constants. Typically, this will be BBCODE_CHECK.
$name string Name of the tag.
$default string Value of the _default parameter, from the $params array.
$params array A standard set parameters related to the tag.
$content string Value between the open and close tags, if any.
Результат boolean | string Formatted value.

doVideo() публичный Метод

Perform formatting against a string for the video tag.
public doVideo ( Nbbc\BBCode $bbcode, integer $action, string $name, string $default, array $params, string $content ) : string
$bbcode Nbbc\BBCode Instance of Nbbc doing the parsing.
$action integer Value of one of NBBC's defined constants. Typically, this will be BBCODE_CHECK.
$name string Name of the tag.
$default string Value of the _default parameter, from the $params array.
$params array A standard set parameters related to the tag.
$content string Value between the open and close tags, if any.
Результат string Formatted value.

doYoutube() публичный Метод

Perform formatting against a string for the youtube tag
public doYoutube ( Nbbc\BBCode $bbcode, integer $action, string $name, string $default, array $params, string $content ) : boolean | string
$bbcode Nbbc\BBCode Instance of Nbbc doing the parsing.
$action integer Value of one of NBBC's defined constants. Typically, this will be BBCODE_CHECK.
$name string Name of the tag.
$default string Value of the _default parameter, from the $params array.
$params array A standard set parameters related to the tag.
$content string Value between the open and close tags, if any.
Результат boolean | string Formatted value.

format() публичный Метод

Parse the provided BBCode into an HTML string.
public format ( string $bbcode ) : string
$bbcode string Raw BBCode.
Результат string HTML code, generated from the provided BBCode.

media() публичный Метод

Build and return a list of attachments for the current page.
public media ( ) : array
Результат array

nbbc() публичный Метод

Create, configure and return an instance of Nbbc\BBcode.
public nbbc ( ) : Nbbc\BBCode
Результат Nbbc\BBCode

removeAttachment() публичный Метод

Custom handler for the attachment tag.
public removeAttachment ( ) : string
Результат string

Описание свойств

$media защищенное свойство

A list of records from the Media table, indexed by MediaID.
protected $media

$nbbc защищенное свойство

An instance of Nbbc\BBcode.
protected $nbbc