PHP Класс programElementDoc

Наследование: extends Doc
Показать файл Открыть проект

Открытые свойства

Свойство Тип Описание
$_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.

Открытые методы

Метод Описание
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 ( )

Описание методов

asPath() публичный Метод

Return the element path.
public asPath ( ) : str
Результат str

containingClass() публичный Метод

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
Результат ClassDoc

containingPackage() публичный Метод

Get the package that this program element is contained in.
public containingPackage ( ) : PackageDoc
Результат PackageDoc

isFinal() публичный Метод

Return true if this program element is final.
public isFinal ( ) : boolean
Результат boolean

isPrivate() публичный Метод

Return true if this program element is private.
public isPrivate ( ) : boolean
Результат boolean

isProtected() публичный Метод

Return true if this program element is protected.
public isProtected ( ) : boolean
Результат boolean

isPublic() публичный Метод

Return true if this program element is public.
public isPublic ( ) : boolean
Результат boolean

isStatic() публичный Метод

Return true if this program element is static.
public isStatic ( ) : boolean
Результат boolean

location() публичный Метод

Get the source location of this element
public location ( ) : str
Результат str

makePrivate() публичный Метод

Set element to have private access
public makePrivate ( )

makeProtected() публичный Метод

Set element to have protected access
public makeProtected ( )

makePublic() публичный Метод

Set element to have public access
public makePublic ( )

modifiers() публичный Метод 

 Example, for:
public abstract int foo() { ... }
modifiers() would return:
'public abstract'
public modifiers ( $showPublic = TRUE ) : str
Результат str

packageName() публичный Метод

Get the name of the package that this program element is contained in.
public packageName ( ) : str
Результат str

qualifiedName() публичный Метод 

Example:
for the method bar() in class Foo in the package Baz, return:
Baz\Foo\bar()
public qualifiedName ( ) : str
Результат str

sourceFilename() публичный Метод

public sourceFilename ( )

sourceLine() публичный Метод

public sourceLine ( )

Описание свойств

$_access публичное свойство

Access type for this element.
public str $_access
Результат str

$_filename публичное свойство

Which source file is this element in
public str $_filename
Результат str

$_final публичное свойство

If this element is final.
public bool $_final
Результат boolean

$_lineNumber публичное свойство

The line in the source file this element can be found at
public int $_lineNumber
Результат integer

$_package публичное свойство

The elements package.
public str $_package
Результат str

$_parent публичное свойство

Reference to the elements parent.
public doc $_parent
Результат doc

$_sourcePath публичное свойство

The source path containing the source file
public str $_sourcePath
Результат str

$_static публичное свойство

If this element is static.
public bool $_static
Результат boolean