PHP 클래스 programElementDoc

상속: extends Doc
파일 보기 프로젝트 열기: peej/phpdoctor

공개 프로퍼티들

프로퍼티 타입 설명
$_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