PHP Class BBCode, vanilla

Afficher le fichier Open project: vanilla/vanilla Class Usage Examples

Protected Properties

Свойство	Type	Description
$media		A list of records from the Media table, indexed by MediaID.
$nbbc		An instance of Nbbc\BBcode.

Méthodes publiques

Méthode	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 méthode

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.
Résultat	string	Formatted value.

doImage() public méthode

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.
Résultat	boolean \| string	Formatted value.

doQuote() public méthode

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.
Résultat	boolean \| string	Formatted value.

doSize() public méthode

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.
Résultat	string	Formatted value.

doURL() public méthode

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.
Résultat	boolean \| string	Formatted value.

doVideo() public méthode

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.
Résultat	string	Formatted value.

doYoutube() public méthode

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.
Résultat	boolean \| string	Formatted value.

format() public méthode

Parse the provided BBCode into an HTML string.

public format ( string $bbcode ) : string
$bbcode	string	Raw BBCode.
Résultat	string	HTML code, generated from the provided BBCode.

media() public méthode

Build and return a list of attachments for the current page.

public media ( ) : array
Résultat	array

nbbc() public méthode

Create, configure and return an instance of Nbbc\BBcode.

public nbbc ( ) : Nbbc\BBCode
Résultat	Nbbc\BBCode

removeAttachment() public méthode

Custom handler for the attachment tag.

public removeAttachment ( ) : string
Résultat	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