PHP Class BBCode, vanilla

Mostra file Open project: vanilla/vanilla Class Usage Examples

Protected Properties

Property Type Description
$media A list of records from the Media table, indexed by MediaID.
$nbbc An instance of Nbbc\BBcode.

Public Methods

Method Description
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.

Method Details

doAttachment() public method

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.
return string Formatted value.

doImage() public method

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.
return boolean | string Formatted value.

doQuote() public method

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.
return boolean | string Formatted value.

doSize() public method

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.
return string Formatted value.

doURL() public method

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.
return boolean | string Formatted value.

doVideo() public method

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.
return string Formatted value.

doYoutube() public method

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.
return boolean | string Formatted value.

format() public method

Parse the provided BBCode into an HTML string.
public format ( string $bbcode ) : string
$bbcode string Raw BBCode.
return string HTML code, generated from the provided BBCode.

media() public method

Build and return a list of attachments for the current page.
public media ( ) : array
return array

nbbc() public method

Create, configure and return an instance of Nbbc\BBcode.
public nbbc ( ) : Nbbc\BBCode
return Nbbc\BBCode

removeAttachment() public method

Custom handler for the attachment tag.
public removeAttachment ( ) : string
return string

Property Details

$media protected_oe property

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

$nbbc protected_oe property

An instance of Nbbc\BBcode.
protected $nbbc