|
Previous Page |
Solar_Docs_Phpdoc |
Next Page |
Methods
Public
__construct()- Constructor.
__destruct()- Default destructor; does nothing other than provide a safe fallback for calls to parent::__destruct().
apiVersion()- Reports the API version for this class.
dump()- Convenience method for getting a dump the whole object, or one of its properties, or an external variable.
locale()- Looks up class-specific locale strings based on a key.
parse()- Returns docblock comment parsed into summary, narrative, and technical information portions.
parseAuthor()- Parses one or more @author lines into $this->_info.
parseCategory()- Parses one @category line into $this->_info.
parseCopyright()- Parses one @copyright line into $this->_info.
parseDeprec()- Parses one @deprec line into $this->_info; alias for @deprecated.
parseDeprecated()- Parses one @deprecated line into $this->_info.
parseExample()- Parses one @example line into $this->_info.
parseException()- Parses one or more @exception lines into $this->_info; alias for @throws.
parseIgnore()- Parses one @ignore line into $this->_info.
parseLicense()- Parses one @license line into $this->_info.
parseLink()- Parses one or more @link lines into $this->_info.
parsePackage()- Parses one @package line into $this->_info.
parseParam()- Parses one or more @param lines into $this->_info.
parseReturn()- Parses one @return line into $this->_info.
parseSee()- Parses one or more @see lines into $this->_info.
parseSince()- Parses one @since line into $this->_info.
parseStaticvar()- Parses one or more @staticvar lines into $this->_info.
parseSubpackage()- Parses one @subpackage line into $this->_info.
parseThrows()- Parses one or more @throws lines into $this->_info.
parseTodo()- Parses one ore more @todo lines into $this->_info.
parseVar()- Parses one @var line into $this->_info.
parseVersion()- Parses one @version line into $this->_info.
Protected
_1part()- Parses a one-part block line.
_2part()- Parses a two-part block line.
_3part()- Parses a three-part block line.
_exception()- Convenience method for returning exceptions with localized text.
_loadInfo()- Gets the technical information from a docblock comment.
Private
None.
Local
- Overview
- Constants
- Properties
- Methods
- _1part()
- _2part()
- _3part()
- __construct()
- __destruct()
- _exception()
- _loadInfo()
- apiVersion()
- dump()
- locale()
- parse()
- parseAuthor()
- parseCategory()
- parseCopyright()
- parseDeprec()
- parseDeprecated()
- parseExample()
- parseException()
- parseIgnore()
- parseLicense()
- parseLink()
- parsePackage()
- parseParam()
- parseReturn()
- parseSee()
- parseSince()
- parseStaticvar()
- parseSubpackage()
- parseThrows()
- parseTodo()
- parseVar()
- parseVersion()