wiki-engine/WikiPlugin.php at master · flourishlib/wiki-engine · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
<?php
/**
 * The basic functionality shared between wiki plugins
 */
abstract class WikiPlugin
{
	/**
	 * The array of parameters passed to the plugin
	 *
	 * @var array
	 */
	protected $parameters;

	/**
	 * The parent tags of the current tag
	 *
	 * @var array
	 */
	protected $parents;

	/**
	 * The parser object
	 *
	 * @var WikiParser
	 */
	protected $parser;

	/**
	 * The tag that represents this plugin in the parse tree
	 *
	 * @var stdClass
	 */
	protected $tag;

	/**
	 * Initializes the plugin
	 *
	 * @param WikiParser $parser      The currently running wiki parser
	 * @param array      $parents     The parent tags of the $tag
	 * @param stdClass   $tag         The tag in the parse tree that represents this plugin - this can be freely modified
	 * @param array      $parameters  The parameters passed to the plugin via the wiki markup
	 * @return PluginCss
	 */
	public function __construct($parser, $parents, $tag, $parameters)
	{
		$this->parser     = $parser;
		$this->parents    = $parents;
		$this->tag        = $tag;
		$this->parameters = $parameters;
	}
}