PHP Class programElementDoc

Inheritance: extends Doc

Public Properties

Property	Type	Description
$_access	str	Access type for this element.
$_filename	str	Which source file is this element in
$_final	boolean	If this element is final.
$_lineNumber	integer	The line in the source file this element can be found at
$_package	str	The elements package.
$_parent	doc	Reference to the elements parent.
$_sourcePath	str	The source path containing the source file
$_static	boolean	If this element is static.

Public Methods

Method	Description
asPath ( ) : str	Return the element path.
containingClass ( ) : ClassDoc	Get the containing class of this program element. If the element is in the global scope and does not have a parent class, this will return null.
containingPackage ( ) : PackageDoc	Get the package that this program element is contained in.
isFinal ( ) : boolean	Return true if this program element is final.
isPrivate ( ) : boolean	Return true if this program element is private.
isProtected ( ) : boolean	Return true if this program element is protected.
isPublic ( ) : boolean	Return true if this program element is public.
isStatic ( ) : boolean	Return true if this program element is static.
location ( ) : str	Get the source location of this element
makePrivate ( )	Set element to have private access
makeProtected ( )	Set element to have protected access
makePublic ( )	Set element to have public access
modifiers ( $showPublic = TRUE ) : str	Get modifiers string.
packageName ( ) : str	Get the name of the package that this program element is contained in.
qualifiedName ( ) : str	Get the fully qualified name.
sourceFilename ( )
sourceLine ( )

Method Details

asPath() public method

Return the element path.

public asPath ( ) : str
return	str

containingClass() public method

Get the containing class of this program element. If the element is in the global scope and does not have a parent class, this will return null.

public containingClass ( ) : ClassDoc
return	ClassDoc

containingPackage() public method

Get the package that this program element is contained in.

public containingPackage ( ) : PackageDoc
return	PackageDoc

isFinal() public method

Return true if this program element is final.

public isFinal ( ) : boolean
return	boolean

isPrivate() public method

Return true if this program element is private.

public isPrivate ( ) : boolean
return	boolean

isProtected() public method

Return true if this program element is protected.

public isProtected ( ) : boolean
return	boolean

isPublic() public method

Return true if this program element is public.

public isPublic ( ) : boolean
return	boolean

isStatic() public method

Return true if this program element is static.

public isStatic ( ) : boolean
return	boolean

location() public method

Get the source location of this element

public location ( ) : str
return	str

makePrivate() public method

Set element to have private access

public makePrivate ( )

makeProtected() public method

Set element to have protected access

public makeProtected ( )

makePublic() public method

Set element to have public access

public makePublic ( )

modifiers() public method

 Example, for:
public abstract int foo() { ... }
modifiers() would return:
'public abstract'

public modifiers ( $showPublic = TRUE ) : str
return	str

packageName() public method

Get the name of the package that this program element is contained in.

public packageName ( ) : str
return	str

qualifiedName() public method

Example:
for the method bar() in class Foo in the package Baz, return:
Baz\Foo\bar()

public qualifiedName ( ) : str
return	str

sourceFilename() public method

public sourceFilename ( )

sourceLine() public method

public sourceLine ( )

Property Details

$_access public property

Access type for this element.

public str $_access
return	str

$_filename public property

Which source file is this element in

public str $_filename
return	str

$_final public property

If this element is final.

public bool $_final
return	boolean

$_lineNumber public property

The line in the source file this element can be found at

public int $_lineNumber
return	integer

$_package public property

The elements package.

public str $_package
return	str

$_parent public property

Reference to the elements parent.

public doc $_parent
return	doc

$_sourcePath public property

The source path containing the source file

public str $_sourcePath
return	str

$_static public property

If this element is static.

public bool $_static
return	boolean