Stud.IP  5.4
StudipFormat Class Reference
Inheritance diagram for StudipFormat:
TextFormat BlubberFormat WikiFormat

Public Member Functions

 __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 getStudipMarkups ()
static addStudipMarkup ($name, $start, $end, $callback, $before=null)
static getStudipMarkup ($name)
static removeStudipMarkup ($name)

Additional Inherited Members

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

Constructor & Destructor Documentation

◆ __construct()

__construct ( )

Initializes a new StudipFormat instance.

Member Function Documentation

◆ addStudipMarkup()

static addStudipMarkup (   $name,
  $before = null 

Adds a new markup rule to the global Stud.IP 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.

string$namename of this rule
string$startstart regular expression
string$endend regular expression (optional)
callback$callbackfunction generating output of this rule
string$beforemark before which rule this rule should be appended

◆ getStudipMarkup()

static getStudipMarkup (   $name)

Returns a single markup-rule if it exists.

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

◆ getStudipMarkups()

static static getStudipMarkups ( )

Returns the list of global Stud.IP markup rules as an array. Each entry has the following attributes: 'start', 'end' and 'callback'. The rule name is used as the entry's array key.

array list of all markup rules

◆ removeStudipMarkup()

static removeStudipMarkup (   $name)

Removes a markup rule from the global Stud.IP markup set.

string$namename of the rule

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