WikiFormat Class Reference

Inheritance diagram for WikiFormat:

Public Member Functions
	__construct ($range_id=null, $page_id=null)
	getRangeId ()
	getPageId ()
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	addWikiMarkup ($name, $start, $end, $callback, $before=null)
static	getWikiMarkup ($name)
static	removeWikiMarkup ($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)

Static Protected Member Functions
static	markupWikiComments ($markup, $matches)
static	markupWikiLinks ($markup, $matches)

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

Constructor & Destructor Documentation

__construct()

__construct	(		$range_id = null,
			$page_id = null
	)

Initializes a new WikiFormat instance.

Parameters

string | null

$range_id

ID of the course or institute.

Member Function Documentation

addWikiMarkup()

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

static

Adds a new markup rule to the wiki 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

getPageId()

getPageId

(

)

Returns the page_id of the wiki-page for which the markup is desired.

Returns

string|null

getRangeId()

getRangeId

(

)

Returns the range_id of the wiki-page for which the markup is desired.

Returns

string|null

getWikiMarkup()

static getWikiMarkup (   $name )

static

Returns a single markup-rule if it exists.

Returns

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

markupWikiComments()

static markupWikiComments (   $markup,   $matches  )

staticprotected

Stud.IP markup for wiki-comments

Parameters

StudipFormat	$markup	Markup object
array	$matches	Found matches

Returns

string

markupWikiLinks()

static markupWikiLinks (   $markup,   $matches  )

staticprotected

Stud.IP markup for wiki links

Parameters

StudipFormat	$markup	Markup object
array	$matches	Found matches

Returns

string

removeWikiMarkup()

static removeWikiMarkup (   $name )

static

Removes a markup rule from the wiki markup set.

Parameters

string

$name

Name of the rule

---

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

• lib/classes/WikiFormat.php