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: parserMethod

Source Location: /phpDocumentor/ParserElements.inc

Class Overview

parserBase
   |
   --parserElement
      |
      --parserFunction
         |
         --parserMethod

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

Inherited Methods

Class: parserFunction

parserFunction::addGlobals(): Add all "global $var, $var2" declarations to this function
parserFunction::addParam()
parserFunction::addSource(): Set the source code. Always array in PHP 4.3.0+
parserFunction::addStatics(): Add all "static $var, $var2 = 6" declarations to this function
parserFunction::getConflicts(): Returns all functions in other packages that have the same name as this function
parserFunction::getFunctionCall(): Get a human-friendly description of the function call
parserFunction::getIntricateFunctionCall(): Like getFunctionCall(), but has no English or pre-determined formatting.
parserFunction::getLink(): quick way to link to this element
parserFunction::getParam()
parserFunction::getReturnsReference()
parserFunction::getSource()
parserFunction::hasSource(): Determine whether the source code has been requested via {@source}
parserFunction::listGlobals()
parserFunction::listParams()
parserFunction::listStatics()
parserFunction::setReturnsReference(): sets $returnsreference to true

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 1628]

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

$class = ''

[line 1640]

Tags:

var:

class that contains this method

Type:

string

[ Top ]

$isConstructor = false

[line 1636]

Tags:

var:

whether this method is a constructor

Type:

boolean

[ Top ]

$isDestructor = false

[line 1638]

Tags:

var:

whether this method is a destructor by PEAR standards

Type:

boolean

[ Top ]

$type = 'method'

[line 1634]

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

Tags:

var:

always 'method'

Type:	string
Overrides:	Array

[ Top ]

$_modifiers = array()

[line 1641]

Type:

mixed

[ Top ]

Class Methods

constructor parserMethod [line 1646]

parserMethod parserMethod(
string
$class)

Parameters:

string

$class

[ Top ]

method addParam [line 1657]

void addParam(
string
$name, string
$value, [boolean
$has_default = true], [null|string
$typehint = null])

Overrides parserFunction::addParam() (parent method not documented)

Parameters:

string	$name
string	$value	default value parsed from function definition
boolean	$has_default	indicates whether this parameter has a default value
null\|string	$typehint	class type hint

[ Top ]

method getClass [line 1690]

string getClass(
)

Return name of the class that contains this method

[ Top ]

method getFunctionCall [line 1671]

string getFunctionCall(
)

adds "constructor " to start of function call if $isConstructor is true

Tags:

see:

parserFunction::getFunctionCall()

Overrides parserFunction::getFunctionCall() (Get a human-friendly description of the function call)

[ Top ]

method getImplements [line 1805]

mixed getImplements(
Converter
&$c)

Tags:

return:	parserMethod representing method this method implements from an interface, or false if none
usedby:	Converter::getFormattedMethodImplements()

Parameters:

Converter

&$c

[ Top ]

method getIntricateFunctionCall [line 1678]

void getIntricateFunctionCall(

$converter, 
$paramtags)

Overrides parserFunction::getIntricateFunctionCall() (Like getFunctionCall(), but has no English or pre-determined formatting.)

Parameters:

	$converter
	$paramtags

[ Top ]

method getLink [line 1915]

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

quick way to link to this element

Tags:

return:

converter-specific link to this method

Overrides parserFunction::getLink() (quick way to link to this element)

Parameters:

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

[ Top ]

method getModifiers [line 1699]

string getModifiers(
)

Return name of the class that contains this method

[ Top ]

method getOverrides [line 1718]

mixed getOverrides(
Converter
&$c)

Tags:

return:

parserMethod representing method this method overrides from the parent class, or false if none

Parameters:

Converter

&$c

[ Top ]

method getOverridingMethods [line 1944]

array getOverridingMethods(
Converter
&$c)

Tags:

return:	an array of parserMethods from child classes that override this method
usedby:	Converter::getFormattedDescMethods()

Parameters:

Converter

&$c

[ Top ]

method getOverridingMethodsForClass [line 1956]

array getOverridingMethodsForClass(
Converter
&$c, parserClass
&$class)

Tags:

return:

an array of parserMethods from ALL child classes that override this method in the given class

Parameters:

Converter	&$c
parserClass	&$class

[ Top ]

method setConstructor [line 1927]

void setConstructor(
)

Use this method to tell the parser that this method is the class constructor

[ Top ]

method setDestructor [line 1935]

void setDestructor(
)

Use this method to tell the parser that this method is the class constructor

[ Top ]

method setModifiers [line 1708]

string setModifiers(

$m)

Return name of the class that contains this method

Parameters:

[ Top ]

PHP5

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

Dec 21Docs For Class parserMethod

Class: parserMethod

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Inherited Variables

Class: parserFunction

Class: parserElement

Class: parserBase

Inherited Methods

Class: parserFunction

Class: parserElement

Class: parserBase

Class Details

Tags:

Class Variables

$class = ''

Tags:

$isConstructor = false

Tags:

$isDestructor = false

Tags:

$type = 'method'

Tags:

$_modifiers = array()

Class Methods

constructor parserMethod [line 1646]

Parameters:

method addParam [line 1657]

Parameters:

method getClass [line 1690]

method getFunctionCall [line 1671]

Tags:

method getImplements [line 1805]

Tags:

Parameters:

method getIntricateFunctionCall [line 1678]

Parameters:

method getLink [line 1915]

Tags:

Parameters:

method getModifiers [line 1699]

method getOverrides [line 1718]

Tags:

Parameters:

method getOverridingMethods [line 1944]

Tags:

Parameters:

method getOverridingMethodsForClass [line 1956]

Tags:

Parameters:

method setConstructor [line 1927]

method setDestructor [line 1935]

method setModifiers [line 1708]

Parameters:

Dec 21
Docs For Class parserMethod