\net_nemein_wiki_parser

Wiki markup parser

Note, that the request data, for ease of use, already contains the L10n Databases of the Component and MidCOM itself located in this class. They are stored as 'l10n' and 'l10n_midcom'. Also available as 'config' is the current component configuration.

Summary

Methods

Properties

Constants

__construct()
__get()
__isset()
set_active_leaf()
add_stylesheet()
get_workflow()
get_html()
get_markdown()
render_link()
find_links_in_content()

$_component
$_i18n
$_l10n
$_l10n_midcom
$_config

No constants found

No protected methods found

No protected properties found

N/A

_run_macro_abbr()
_run_macro_photo()
_run_macro_wiki()
_run_macro_note()
_run_macro_tip()
_run_macro_warning()
_run__classed_div()
_run_macro_nodetoc()
_run_macro_tagged()
_code_sort_by_title()
replace_wikiwords()

$_services
$_page

N/A

Properties

$_component

$_component : string

The name of the component, e.g. net.nehmer.static. Should be used whenever the component's name is required instead of hardcoding it.

Type

string

$_i18n

$_i18n : \midcom_services_i18n

A handle to the i18n service.

Type

\midcom_services_i18n

$_l10n

$_l10n : \midcom_services_i18n_l10n

The components' L10n string database.

Type

\midcom_services_i18n_l10n

$_l10n_midcom

$_l10n_midcom : \midcom_services_i18n_l10n

The global MidCOM string database.

Type

\midcom_services_i18n_l10n

$_config

$_config : \midcom_helper_configuration

The current configuration.

Type

\midcom_helper_configuration

$_services

$_services : array

Array that holds the already instantiated services

Type

array

$_page

$_page : \net_nemein_wiki_wikipage

The page we're working on

Type

\net_nemein_wiki_wikipage

Methods

__construct()

__construct(\net_nemein_wiki_wikipage  $page)

Parameters

\net_nemein_wiki_wikipage

$page

__get()

__get(  $field)

Parameters

$field

__isset()

__isset(  $field)

Parameters

$field

set_active_leaf()

set_active_leaf(  $leaf_id)

Parameters

$leaf_id

add_stylesheet()

add_stylesheet(string  $url, string  $media = false)

Convenience shortcut for adding CSS files

Parameters

string	$url	The stylesheet URL
string	$media	The media type(s) for the stylesheet, if any

get_workflow()

get_workflow(string  $identifier, array  $options = array()) : \midcom\workflow\dialog

Parameters

string	$identifier
array	$options

Returns

\midcom\workflow\dialog

get_html()

get_html()

get_markdown()

get_markdown(  $input)

Parameters

$input

render_link()

render_link(  $wikilink,   $text = null)

Parameters

	$wikilink
	$text

find_links_in_content()

find_links_in_content()

_run_macro_abbr()

_run_macro_abbr(  $macro_content,   $fulltag,   $after)

Abbreviation support [abbr: Abbreviation - Explanation]

Parameters

	$macro_content
	$fulltag
	$after

_run_macro_photo()

_run_macro_photo(  $macro_content,   $fulltag,   $after)

Photo inclusion support [photo: GUID]

Parameters

	$macro_content
	$fulltag
	$after

_run_macro_wiki()

_run_macro_wiki(  $macro_content,   $fulltag,   $after)

WikiPedia term search [wiki: search terms]

Parameters

	$macro_content
	$fulltag
	$after

Tags

todo	Switch to InterWiki format instead

_run_macro_note()

_run_macro_note(  $macro_content,   $fulltag,   $after)

A notice macro (will display a classed DIV)

Parameters

	$macro_content
	$fulltag
	$after

_run_macro_tip()

_run_macro_tip(  $macro_content,   $fulltag,   $after)

A tip macro (will display a classed DIV)

Parameters

	$macro_content
	$fulltag
	$after

_run_macro_warning()

_run_macro_warning(  $macro_content,   $fulltag,   $after)

A warning macro (will display a classed DIV)

Parameters

	$macro_content
	$fulltag
	$after

_run__classed_div()

_run__classed_div(  $css_class,   $macro_content,   $fulltag,   $after)

Creates a div with given CSS class(es)

Used by the note, tip and warning macros

Parameters

	$css_class
	$macro_content
	$fulltag
	$after

_run_macro_nodetoc()

_run_macro_nodetoc(  $macro_content,   $fulltag,   $after)

table of contents for the current pages node

Parameters

	$macro_content
	$fulltag
	$after

_run_macro_tagged()

_run_macro_tagged(  $macro_content,   $fulltag,   $after)

Links to other wiki pages tagged with arbitrary tags

Parameters

	$macro_content
	$fulltag
	$after

_code_sort_by_title()

_code_sort_by_title(  $a,   $b)

Code to sort array by values (which is object) property 'title'

Used by $this->_run_macro_tagged()

Parameters

	$a
	$b

replace_wikiwords()

replace_wikiwords(  $match)

Replace wiki syntax in the document with HTML for display purposes

Parameters

$match