Navigation

Module.php

Timestamp:

01/10/06 11:23:13 (3 years ago)

Author:

argh

Message:

Added some docs; Added the setPretty method so that a module always has a reference to the main patXMLPretty object; Added the getName method.

Files:

r23	r39
27	27	{
28	28	/**
	29	* Stores a reference to the patXMLPretty object
	30	* this module has been created by.
	31	*
	32	* @access private
	33	* @var patXMLPretty
	34	* @see setPretty()
	35	*/
	36	var $pretty = null;
	37
	38	/**
29	39	* Stores all available options and their values/default values.
30	40	*
	41	* @abstract
31	42	* @access private
32	43	* @var array
…	…
36	47	*/
37	48	var $options = array();
	49
	50	/**
	51	* Stores the name of the module
	52	*
	53	* @abstract
	54	* @access private
	55	* @var string
	56	* @see getName()
	57	*/
	58	var $name = null;
	59
	60	/**
	61	* Sets the patXMLPretty object this module has
	62	* been created by.
	63	*
	64	* @access public
	65	* @param patXMLPretty
	66	* @see $pretty
	67	*/
	68	function setPretty( &$pretty )
	69	{
	70	$this->pretty =& $pretty;
	71	}
38	72
39	73	/**
…	…
66	100	}
67	101
	102	/**
	103	* Retrieves the current value of the specified option.
	104	*
	105	* @access public
	106	* @param string
	107	* @return mixed\|patError
	108	* @see setOption()
	109	* @see $options
	110	*/
68	111	function getOption( $optionName )
69	112	{
…	…
81	124	return $this->options[$optionName];
82	125	}
	126
	127	/**
	128	* Retrieves the name of the current module.
	129	*
	130	* @access public
	131	* @return string
	132	* @see $name
	133	*/
	134	function getName()
	135	{
	136	return $this->name;
	137	}
83	138	}
84	139