phpDocumentor

[ ] [ ] [ ]

Packages:
phpDocumentor
Converters
Cpdf
HTML_TreeMenu
Smarty
tests
XML_Beautifier

Tutorials/Manuals:
В пакете:

phpDocumentor Guide to Creating Fantastic Documentation
- phpDocumentor Quickstart
  - Source code for sample1.php
  - Source code for sample2.php
  - Source code for sample3.php
- phpDocumentor Tutorial
  - Documentable PHP Elements
  - phpDocumentor Tutorials
- phpDocumentor Manual
  - phpDocumentor tags
    - @abstract
    - @access
    - @author
    - @category
    - @copyright
    - @deprecated
    - @example
    - @final
    - @filesource
    - @global
    - @ignore
    - @internal
    - @license
    - @link
    - @method
    - @name
    - @package
    - @param
    - @property
    - @return
    - @see
    - @since
    - @static
    - @staticvar
    - @subpackage
    - @todo
    - @tutorial
    - @uses
    - @var
    - @version
  - phpDocumentor Inline tags
    - inline {@example}
    - inline {@id}
    - inline {@internal}}
    - inline {@inheritdoc}
    - inline {@link}
    - inline {@source}
    - inline {@toc}
    - inline {@tutorial}

Files:

subpackage DescHTML

DescHTML.inc

subpackage DocBlockTags

DocBlockTags.inc

subpackage Errors

Errors.inc

subpackage InlineTags

InlineTags.inc

subpackage Links

LinkClasses.inc

subpackage ParserData

ParserData.inc

subpackage ParserDocBlock

ParserDocBlock.inc

subpackage ParserElements

ParserElements.inc

subpackage Parsers

Beautifier.php
HighlightParser.inc
Parser.inc
phpDocumentorTParser.inc
Tokenizer.php
TutorialHighlightParser.inc
XMLpackagePageParser.inc

subpackage setup

find_phpdoc.php

subpackage Tutorial

PackagePageElements.inc

subpackage WordParsers

phpDocumentorTWordParser.inc
WordParser.inc

Classes:

Parsers
Parser
parserDescParser
phpDocumentorTParser
phpDocumentor_HighlightParser
phpDocumentor_HighlightWordParser
phpDocumentor_peardoc2_XML_Beautifier
phpDocumentor_TutorialHighlightParser
phpDocumentor_XML_Beautifier_Tokenizer
ppageParser
XMLPackagePageParser

Classes
EventStack
Io
phpDocumentor_IntermediateParser
phpDocumentor_setup
ProceduralPages
Publisher
tests_HighlightParserTests
tests_IntermediateParserTests
tests_ParserClassTests
tests_ParserPageTests
tests_phpDocumentorSetupTests
tests_phpDocumentorTParserTests

DescHTML
parserB
parserBr
parserCode
parserDescVar
parserI
parserKbd
parserList
parserPre
parserSamp

DocBlockTags
parserAccessTag
parserExampleTag
parserFileSourceTag
parserLicenseTag
parserLinkTag
parserMethodTag
parserNameTag
parserParamTag
parserPropertyReadTag
parserPropertyTag
parserPropertyWriteTag
parserReturnTag
parserSeeTag
parserStaticvarTag
parserTag
parserTutorialTag
parserUsedByTag
parserUsesTag
parserVarTag

Errors
ErrorTracker
RecordError
RecordWarning

InlineTags
parserExampleInlineTag
parserIdInlineTag
parserInheritdocInlineTag
parserInlineTag
parserLinkInlineTag
parserSourceInlineTag
parserTocInlineTag
parserTutorialInlineTag

Links
abstractLink
classLink
constLink
defineLink
functionLink
globalLink
methodLink
pageLink
tutorialLink
varLink

Tutorial
parserCData
parserEntity
parserXMLDocBookTag

ParserData
parserBase
parserData
parserPage
parserStringWithInlineTags

WordParsers
ObjectWordParser
phpDocumentorTWordParser
WordParser

ParserDocBlock
parserDesc
parserDocBlock

ParserElements
parserClass
parserConst
parserDefine
parserElement
parserFunction
parserGlobal
parserInclude
parserMethod
parserPackagePage
parserTutorial
parserVar

Class: parserClass

Source Location: /phpDocumentor/ParserElements.inc

Class Overview

parserBase
   |
   --parserElement
      |
      --parserClass

Author(s):

Greg Beaver <cellog@php.net>

Version:

$Id: ParserElements.inc 248547 2007-12-19 02:16:49Z ashnazg $

Copyright:

2002-2008 Gregory Beaver

Variables

Methods

Inherited Variables

Class: parserElement

parserElement::$conflicts
parserElement::$docblock
parserElement::$endlinenumber
parserElement::$file
parserElement::$linenumber
parserElement::$name
parserElement::$path

Class: parserBase

parserBase::$value

Inherited Methods

Class: parserElement

parserElement::getEndLineNumber()
parserElement::getFile()
parserElement::getLineNumber()
parserElement::getName()
parserElement::getPackage()
parserElement::getPath()
parserElement::setDocBlock()
parserElement::setEndLineNumber(): Sets the ending line number of elements
parserElement::setFile()
parserElement::setLineNumber(): Set starting line number
parserElement::setName()
parserElement::setPath()

Class: parserBase

parserBase::getType(): gets the type
parserBase::getValue(): gets the value
parserBase::setValue(): sets the given value

Class Details

[line 682]

Tags:

author:	Greg Beaver <cellog@php.net>
version:	$Id: ParserElements.inc 248547 2007-12-19 02:16:49Z ashnazg $
copyright:	2002-2008 Gregory Beaver
since:	1.0rc1

[ Top ]

Class Variables

$curfile = false

[line 725]

Tags:

var:

same as parserElement::$path

Type:

string

[ Top ]

$extends = false

[line 695]

Tags:

var:

false or contents of extends clause in class declaration

Type:

mixed

[ Top ]

$ignore = false

[line 720]

Used to determine whether a class should be ignored or not. Helps maintain integrity of parsing

Tags:

see:

Classes::getParentClass()

Type:

boolean

[ Top ]

$parent = false

[line 714]

Format: array(file, parent) where parent class is found or false if no parent

Type:

mixed

[ Top ]

$sourceLocation = ''

[line 691]

Tags:

see:

parserPage::$sourceLocation

Type:

string

[ Top ]

$tutorial = false

[line 729]

Tags:

var:

either a link to the tutorial associated with this class, or false

Type:

tutorialLink|false

[ Top ]

$type = 'class'

[line 688]

Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'

Tags:

var:

always 'class'

Type:	string
Overrides:	Array

[ Top ]

$_implements = array()

[line 699]

Tags:

var:

a list of interfaces this class implements

Type:

array

[ Top ]

Class Methods

method addImplements [line 1379]

void addImplements(
string
$implements)

Parameters:

string

$implements

[ Top ]

method addTutorial [line 755]

void addTutorial(
parserTutorial
$t, Converter
&$c)

Parameters:

parserTutorial	$t
Converter	&$c

[ Top ]

method getChildClassList [line 1308]

array getChildClassList(
Converter
&$c)

returns a list of all child classes of this class

Tags:

return:	Format: array(parserClass child1,parserClass child2,...)
usedby:	XMLDocBookpeardoc2Converter::generateChildClassList()
usedby:	Converter::generateChildClassList()

Parameters:

Converter

&$c

this function will not work before the Conversion stage of parsing

[ Top ]

method getConflicts [line 776]

mixed getConflicts(
Converter
&$c)

Returns all classes in other packages that have the same name as this class

Tags:

return:	false or an array Format: (package => parserClass of conflicting classes)
usedby:	Converter::getFormattedConflicts()

Parameters:

Converter

&$c

[ Top ]

method getConstNames [line 1034]

array getConstNames(
Converter
&$c)

Tags:

return:

returns a simple array of const name strings

Parameters:

Converter

&$c

this function will not work before the Conversion stage of parsing

[ Top ]

method getConsts [line 1009]

array getConsts(
Converter
&$c)

Tags:

return:

returns a simple array of const objects

Parameters:

Converter

&$c

this function will not work before the Conversion stage of parsing

[ Top ]

method getExtends [line 1396]

boolean getExtends(
[
$raw = false])

Tags:

see:

parserClass::$extends

Parameters:

$raw

[ Top ]

method getImplements [line 1387]

array getImplements(
)

[ Top ]

method getInheritedConsts [line 1225]

array getInheritedConsts(
Converter
&$c, [boolean
$override = false], [
$consts = false])

Tags:

return:

returns an array of consts by parent classname array(name => array(const1,const2..),name2 => array(const1....))

Parameters:

Converter	&$c	this function will not work before the Conversion stage of parsing
boolean	$override	determines whether overriden vars should be included in the list of inherited vars
	$consts

[ Top ]

method getInheritedMethods [line 1051]

array getInheritedMethods(
Converter
&$c, [boolean
$override = false])

Tags:

return:

returns an array of methods by parent classname array(name => array(method1,method2..),name2 => array(method1....))

Parameters:

Converter	&$c	this function will not work before the Conversion stage of parsing
boolean	$override	determines whether overriden methods should be included in the list of inherited methods

[ Top ]

method getInheritedVars [line 1149]

array getInheritedVars(
Converter
&$c, [boolean
$override = true], [
$vars = false])

Tags:

return:

returns an array of vars by parent classname array(name => array(var1,var1..),name2 => array(var1....))

Parameters:

Converter	&$c	this function will not work before the Conversion stage of parsing
boolean	$override	determines whether overriden vars should be included in the list of inherited vars
	$vars

[ Top ]

method getLink [line 789]

mixed getLink(
Converter
$c, [string
$text = false], [
$returnobj = false])

quick way to link to this element

Tags:

return:

converter-specific link to this class

Parameters:

Converter	$c
string	$text	text to display for the link or false for default text
	$returnobj

[ Top ]

method getMethod [line 914]

mixed getMethod(
Converter
&$c, string
$name, [boolean
$inherited = false])

Tags:

return:

parserMethod or false if not found

Parameters:

Converter	&$c	this function will not work before the Conversion stage of parsing
string	$name	method name in this class
boolean	$inherited	determines whether to search inherited methods as well

[ Top ]

method getMethodNames [line 943]

array getMethodNames(
Converter
&$c)

Tags:

return:

returns a simple array of method name strings

Parameters:

Converter

&$c

this function will not work before the Conversion stage of parsing

[ Top ]

method getMethods [line 903]

array getMethods(
Converter
&$c)

Tags:

return:

returns a simple array of method objects

Parameters:

Converter

&$c

this function will not work before the Conversion stage of parsing

[ Top ]

method getModifiers [line 736]

array|false getModifiers(
)

Get the PHP5+ modifiers for this class

(abstract/final/static/private/protected/public)

[ Top ]

method getParent [line 889]

mixed &getParent(
Converter
&$c)

retrieve object that represents the parent class

Tags:

return:

returns the parserClass representation of the parent class, or false if no parent class

Parameters:

Converter

&$c

this function will not work before the Conversion stage of parsing

[ Top ]

method getParentClassTree [line 1289]

array getParentClassTree(
Converter
&$c)

Tags:

return:	Format: array(parentclassname => parserClass/false if no parent, parentclassname2 => ...)
usedby:	CHMdefaultConverter::generateFormattedClassTree()
usedby:	HTMLframesConverter::generateFormattedClassTree()
usedby:	HTMLSmartyConverter::generateFormattedClassTree()
usedby:	XMLDocBookConverter::generateFormattedClassTree()
usedby:	XMLDocBookpeardoc2Converter::generateFormattedClassTree()

Parameters:

Converter

&$c

this function will not work before the Conversion stage of parsing

[ Top ]

method getSourceLocation [line 1337]

string getSourceLocation(
Converter
$c, [boolean
$pearize = false])

Tags:

see:

parserClass::$sourceLocation

Parameters:

Converter	$c
boolean	$pearize

[ Top ]

method getTutorial [line 766]

parserTutorial getTutorial(
)

Get the associated tutorial for this class, if any

Tags:

tutorial:

phpDocumentor Tutorials

[ Top ]

method getVar [line 934]

mixed getVar(
Converter
&$c, string
$name)

Tags:

return:

parserVar or false if not found

Parameters:

Converter	&$c	this function will not work before the Conversion stage of parsing
string	$name	var name in this class

[ Top ]

method getVarNames [line 1018]

array getVarNames(
Converter
&$c)

Tags:

return:

returns a simple array of var name strings

Parameters:

Converter

&$c

this function will not work before the Conversion stage of parsing

[ Top ]

method getVars [line 1000]

array getVars(
Converter
&$c)

Tags:

return:

returns a simple array of var objects

Parameters:

Converter

&$c

this function will not work before the Conversion stage of parsing

[ Top ]

method hasConst [line 991]

boolean hasConst(
Converter
&$c, string
$name)

Tags:

return:

whether this class has a constant of name $name

Parameters:

Converter	&$c	this function will not work before the Conversion stage of parsing
string	$name	class constant name

[ Top ]

method hasMethod [line 961]

boolean hasMethod(
Converter
&$c, string
$name, [boolean
$inherited = false])

Tags:

return:

whether this class has a method of name $name

Parameters:

Converter	&$c	this function will not work before the Conversion stage of parsing
string	$name	method name
boolean	$inherited	determines whether to search inherited methods as well

[ Top ]

method hasVar [line 981]

boolean hasVar(
Converter
&$c, string
$name)

Tags:

return:

whether this class has a var of name $name

Parameters:

Converter	&$c	this function will not work before the Conversion stage of parsing
string	$name	var name

[ Top ]

method isInterface [line 870]

boolean isInterface(
)

Tags:

return:

true if this is an interface class

[ Top ]

method setAccessModifiers [line 879]

void setAccessModifiers(
array
$modifiers)

Use this method to set access modifiers for a class

Parameters:

array

$modifiers

[ Top ]

method setExtends [line 1362]

void setExtends(
string
$extends)

Tags:

see:

parserClass::$extends

Parameters:

string

$extends

[ Top ]

method setInterface [line 862]

void setInterface(
)

Use this method to set the type of class to be an interface

[ Top ]

method setModifiers [line 746]

void setModifiers(
string
$m)

Set the PHP5+ modifiers for this class

(abstract/final/static/private/protected/public)

Parameters:

string

[ Top ]

method setParent [line 805]

void setParent(
string
$p, string
$f, Classes
&$c)

Tags:

see:

Classes::setClassParent()

Parameters:

string	$p	parent class name
string	$f	parent class file
Classes	&$c	Classes object currently calling setParent

[ Top ]

method setParentNoClass [line 854]

void setParentNoClass(
string
$par)

Parameters:

string

$par

parent class name (used by Classes::setClassParent() if parent class not found

[ Top ]

method setSourceLocation [line 1326]

void setSourceLocation(
string
$sl)

Tags:

see:

parserClass::$sourceLocation

Parameters:

string

$sl

[ Top ]

PHP5

Для web разработчика

Dec 21Docs For Class parserClass

Class: parserClass

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Inherited Variables

Class: parserElement

Class: parserBase

Inherited Methods

Class: parserElement

Class: parserBase

Class Details

Tags:

Class Variables

$curfile = false

Tags:

$extends = false

Tags:

$ignore = false

Tags:

$parent = false

$sourceLocation = ''

Tags:

$tutorial = false

Tags:

$type = 'class'

Tags:

$_implements = array()

Tags:

Class Methods

method addImplements [line 1379]

Parameters:

method addTutorial [line 755]

Parameters:

method getChildClassList [line 1308]

Tags:

Parameters:

method getConflicts [line 776]

Tags:

Parameters:

method getConstNames [line 1034]

Tags:

Parameters:

method getConsts [line 1009]

Tags:

Parameters:

method getExtends [line 1396]

Tags:

Parameters:

method getImplements [line 1387]

method getInheritedConsts [line 1225]

Tags:

Parameters:

method getInheritedMethods [line 1051]

Tags:

Parameters:

method getInheritedVars [line 1149]

Tags:

Parameters:

method getLink [line 789]

Tags:

Parameters:

method getMethod [line 914]

Tags:

Parameters:

method getMethodNames [line 943]

Tags:

Parameters:

method getMethods [line 903]

Tags:

Parameters:

method getModifiers [line 736]

method getParent [line 889]

Tags:

Parameters:

Dec 21
Docs For Class parserClass