BlubberFormat Class Reference

Inheritance diagram for BlubberFormat:

Public Member Functions
	__construct ()
Public Member Functions inherited from StudipFormat
	__construct ()
Public Member Functions inherited from TextFormat
	__construct ($markup_rules=[])
	addMarkup ($name, $start, $end, $callback, $before=null)
	getMarkup ($name)
	removeMarkup ($name)
	format ($text)
	quote ($text)
	isInsideOf ($rule)

Static Public Member Functions
static static	addBlubberMarkup ($name, $start, $end, $callback, $before=null)
static	getBlubberMarkup ($name)
static	removeBlubberMarkup ($name)
Static Public Member Functions inherited from StudipFormat
static static	getStudipMarkups ()
static	addStudipMarkup ($name, $start, $end, $callback, $before=null)
static	getStudipMarkup ($name)
static	removeStudipMarkup ($name)

Data Fields
const	REGEXP_HASHTAG = '(?<=^|\s)#([\w\x{1F600}-\x{1F64F}\x{1F300}-\x{1F5FF}\x{1F680}-\x{1F6FF}\x{2600}-\x{26FF}\x{2700}-\x{27BF}]+)'

Static Protected Member Functions
static	markupHashtags ($markup, $matches)

Additional Inherited Members
Protected Member Functions inherited from TextFormat
	formatParts ($text, &$parts, $open_rule=NULL)

Constructor & Destructor Documentation

__construct()

__construct

(

)

Initializes a new BlubberFormat instance.

Member Function Documentation

addBlubberMarkup()

static static addBlubberMarkup (   $name,   $start,   $end,   $callback,   $before = null  )

static

Adds a new markup rule to the blubber markup set. This can also be used to replace an existing markup rule. The end regular expression is optional (i.e. may be NULL) to indicate that this rule has an empty content model. The callback is called whenever the rule matches and is passed the following arguments:

• $markup the markup parser object
• $matches match results of preg_match for $start
• $contents (parsed) contents of this markup rule

Sometimes you may want your rule to apply before another specific rule will apply. For this case the parameter $before defines a rulename of existing markup, before which your rule should apply.

Parameters

string	$name	name of this rule
string	$start	start regular expression
string	$end	end regular expression (optional)
callback	$callback	function generating output of this rule
string	$before	mark before which rule this rule should be appended

getBlubberMarkup()

static getBlubberMarkup (   $name )

static

Returns a single markup-rule if it exists.

Returns

array: array('start' => "...", 'end' => "...", 'callback' => "...")

markupHashtags()

static markupHashtags (   $markup,   $matches  )

staticprotected

Stud.IP markup for hashtags

Parameters

StudipFormat	$markup	Markup object
array	$matches	Found matches

Returns

string

removeBlubberMarkup()

static removeBlubberMarkup (   $name )

static

Removes a markup rule from the blubber markup set.

Parameters

string

$name

Name of the rule

Field Documentation

REGEXP_HASHTAG

const REGEXP_HASHTAG = '(?<=^|\s)#([\w\x{1F600}-\x{1F64F}\x{1F300}-\x{1F5FF}\x{1F680}-\x{1F6FF}\x{2600}-\x{26FF}\x{2700}-\x{27BF}]+)'

---

The documentation for this class was generated from the following file:

• lib/classes/BlubberFormat.php