PHP Class phpDoctor

Show file Open project: peej/phpdoctor Class Usage Examples

Public Properties

Property	Type	Description
$_constants	boolean	Parse out global constants.
$_currentFilename	str	The path and filename of the current file being parsed.
$_defaultPackage	str	Package to use for elements not in a package.
$_doclet	str	Specifies the name of the class that starts the doclet used in generating the documentation.
$_docletPath	str	Specifies the path to the doclet starting class file. If the doclet class is not in a file named <_doclet>/<_doclet>.php then this path should include the filename of the class file also.
$_files	str[]	Array of files to parse.
$_formatter	str	Specifies the name of the text formatter class.
$_formatterPath	str	Specifies the path to the formatters to use.
$_globals	boolean	Parse out global variables.
$_ignore	str[]	Array of files not to parse.
$_ignorePackageTags	boolean	Ignore any package tags in the source code.
$_options	str[]	Options from config file.
$_overview	str	Overview file. The "source" file that contains the overview documentation.
$_packageCommentDir	str	Package comment directory. if set, PHPDoctor will look in this directory for package comment files. Otherwise it looks in a directory named after the package ala Javadoc.
$_path	str	The path PHPDoctor is running from.
$_pearCompat	boolean	Whether or not to use PEAR compatibility mode for first sentence tags.
$_private	boolean	Parse all classes and members.
$_protected	boolean	Parse protected and public classes and members.
$_public	boolean	Parse only public classes and members.
$_quiet	boolean	Turn off all output other than warnings and errors.
$_sourceIndex
$_sourcePath	str	Directory containing files for parsing.
$_startTime	integer	The time in microseconds at the start of execution.
$_subdirs	boolean	Traverse sub-directories
$_tagletPath	str	Specifies the path to the taglets to use.
$_tree	boolean	Display class tree.
$_useClassPathAsPackage	boolean	Use the filesystem path of the class as the package it should be in.
$_verbose	boolean	Turn on verbose output.
$_version	str	The version of PHPDoctor.

Public Methods

Method	Description
_buildFileList ( $files, $dir )	Build a complete list of file to parse. Expand out wildcards and traverse directories if asked to.
_getNext ( &$tokens, $key, $whatToGet, $maxDist ) : str	Get next token of a certain type from token array
_getPrev ( &$tokens, $key, $whatToGet ) : str	Get previous token of a certain type from token array
_getProgramElementName ( &$tokens, $key ) : str	Get the next program element name from the token list
_getTime ( ) : integer	Get the current time in microseconds.
_hasPrivateName ( $name ) : boolean	Does the given element name conform to the format that is used for private elements?
_includeElements ( &$element ) : boolean	Is an element private and we are including private elements, or element is protected and we are including protected elements.
_mergeArrays ( $one, $two ) : mixed[]	Recursively merge two arrays into a single array. This differs from the PHP function array_merge_recursive as it replaces values with the same index from the first array with items from the second.
_mergeSuperClassData ( &$rootDoc, $parent = NULL )
createTag ( $name, $text, &$data, &$root ) : Tag	Create a tag. This method first tries to load a Taglet for the given tag name, upon failing it then tries to load a PHPDoctor specialised tag class (e.g. classes/paramtag.php), if it still has not found a tag class it uses the standard tag class.
defaultPackage ( ) : str	Return the default package.
docletPath ( ) : str	Return the path PHPDoctor is running from.
error ( $msg )	Write an error message to standard error.
execute ( &$rootDoc ) : boolean	Loads and runs the doclet.
fixPath ( $path ) : str	Add a trailing slash to a path if it does not have one.
getFormatter ( ) : TextFormatter	Creates the formatter and returns it.
getOption ( $option ) : str	Get a configuration option.
makeAbsolutePath ( $path, $prefix ) : str	Turn path into an absolute path using the given prefix?
message ( $msg )	Write a message to standard output.
options ( ) : str[]	Return a reference to the set options.
parse ( ) : RootDoc	Parse files into tokens and create rootDoc.
phpDoctor ( $config = 'default.ini' )	Constructor
processDocComment ( $comment, &$root ) : mixed[]	Process a doc comment into a doc tag array.
sourcePath ( ) : str	Return the source path.
verbose ( $msg )	Write a message to standard output.
version ( ) : str	Return the version of PHPDoctor.
warning ( $msg )	Write a warning message to standard error.

Method Details

_buildFileList() public method

Build a complete list of file to parse. Expand out wildcards and traverse directories if asked to.

public _buildFileList ( $files, $dir )

_getNext() public method

Get next token of a certain type from token array

public _getNext ( &$tokens, $key, $whatToGet, $maxDist ) : str
return	str	Value of found token

_getPrev() public method

Get previous token of a certain type from token array

public _getPrev ( &$tokens, $key, $whatToGet ) : str
return	str	Value of found token

_getProgramElementName() public method

Get the next program element name from the token list

public _getProgramElementName ( &$tokens, $key ) : str
return	str

_getTime() public method

Get the current time in microseconds.

public _getTime ( ) : integer
return	integer

_hasPrivateName() public method

Does the given element name conform to the format that is used for private elements?

public _hasPrivateName ( $name ) : boolean
return	boolean

_includeElements() public method

Is an element private and we are including private elements, or element is protected and we are including protected elements.

public _includeElements ( &$element ) : boolean
return	boolean

_mergeArrays() public method

Recursively merge two arrays into a single array. This differs from the PHP function array_merge_recursive as it replaces values with the same index from the first array with items from the second.

public _mergeArrays ( $one, $two ) : mixed[]
return	mixed[]	Merged array

_mergeSuperClassData() public method

public _mergeSuperClassData ( &$rootDoc, $parent = NULL )

createTag() public method

Create a tag. This method first tries to load a Taglet for the given tag name, upon failing it then tries to load a PHPDoctor specialised tag class (e.g. classes/paramtag.php), if it still has not found a tag class it uses the standard tag class.

public createTag ( $name, $text, &$data, &$root ) : Tag
return	Tag

defaultPackage() public method

Return the default package.

public defaultPackage ( ) : str
return	str

docletPath() public method

Return the path PHPDoctor is running from.

public docletPath ( ) : str
return	str

error() public method

Write an error message to standard error.

public error ( $msg )

execute() public method

Loads and runs the doclet.

public execute ( &$rootDoc ) : boolean
return	boolean

fixPath() public method

Add a trailing slash to a path if it does not have one.

public fixPath ( $path ) : str
return	str

getFormatter() public method

Creates the formatter and returns it.

public getFormatter ( ) : TextFormatter
return	TextFormatter

getOption() public method

Get a configuration option.

public getOption ( $option ) : str
return	str

makeAbsolutePath() public method

Turn path into an absolute path using the given prefix?

public makeAbsolutePath ( $path, $prefix ) : str
return	str

message() public method

Write a message to standard output.

public message ( $msg )

options() public method

Return a reference to the set options.

public options ( ) : str[]
return	str[]	An array of strings.

parse() public method

Parse files into tokens and create rootDoc.

public parse ( ) : RootDoc
return	RootDoc

phpDoctor() public method

Constructor

public phpDoctor ( $config = 'default.ini' )

processDocComment() public method

Process a doc comment into a doc tag array.

public processDocComment ( $comment, &$root ) : mixed[]
return	mixed[]	Array of doc comment data

sourcePath() public method

Return the source path.

public sourcePath ( ) : str
return	str

verbose() public method

Write a message to standard output.

public verbose ( $msg )

version() public method

Return the version of PHPDoctor.

public version ( ) : str
return	str

warning() public method

Write a warning message to standard error.

public warning ( $msg )

Property Details

$_constants public property

Parse out global constants.

public bool $_constants
return	boolean

$_currentFilename public property

The path and filename of the current file being parsed.

public str $_currentFilename
return	str

$_defaultPackage public property

Package to use for elements not in a package.

public str $_defaultPackage
return	str

$_doclet public property

Specifies the name of the class that starts the doclet used in generating the documentation.

public str $_doclet
return	str

$_docletPath public property

Specifies the path to the doclet starting class file. If the doclet class is not in a file named <_doclet>/<_doclet>.php then this path should include the filename of the class file also.

public str $_docletPath
return	str

$_files public property

Array of files to parse.

public str[] $_files
return	str[]

$_formatter public property

Specifies the name of the text formatter class.

public str $_formatter
return	str

$_formatterPath public property

Specifies the path to the formatters to use.

public str $_formatterPath
return	str

$_globals public property

Parse out global variables.

public bool $_globals
return	boolean

$_ignore public property

Array of files not to parse.

public str[] $_ignore
return	str[]

$_ignorePackageTags public property

Ignore any package tags in the source code.

public bool $_ignorePackageTags
return	boolean

$_options public property

Options from config file.

public str[] $_options
return	str[]

$_overview public property

Overview file. The "source" file that contains the overview documentation.

public str $_overview
return	str

$_packageCommentDir public property

Package comment directory. if set, PHPDoctor will look in this directory for package comment files. Otherwise it looks in a directory named after the package ala Javadoc.

public str $_packageCommentDir
return	str

$_path public property

The path PHPDoctor is running from.

public str $_path
return	str

$_pearCompat public property

Whether or not to use PEAR compatibility mode for first sentence tags.

public bool $_pearCompat
return	boolean

$_private public property

Parse all classes and members.

public bool $_private
return	boolean

$_protected public property

Parse protected and public classes and members.

public bool $_protected
return	boolean

$_public public property

Parse only public classes and members.

public bool $_public
return	boolean

$_quiet public property

Turn off all output other than warnings and errors.

public bool $_quiet
return	boolean

$_sourceIndex public property

public $_sourceIndex

$_sourcePath public property

Directory containing files for parsing.

public str $_sourcePath
return	str

$_startTime public property

The time in microseconds at the start of execution.

public int $_startTime
return	integer

$_subdirs public property

Traverse sub-directories

public bool $_subdirs
return	boolean

$_tagletPath public property

Specifies the path to the taglets to use.

public str $_tagletPath
return	str

$_tree public property

Display class tree.

public bool $_tree
return	boolean

$_useClassPathAsPackage public property

Use the filesystem path of the class as the package it should be in.

public bool $_useClassPathAsPackage
return	boolean

$_verbose public property

Turn on verbose output.

public bool $_verbose
return	boolean

$_version public property

The version of PHPDoctor.

public str $_version
return	str