phpDocumentor
[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]
Packages:
phpDocumentor
Converters
Cpdf
HTML_TreeMenu
Smarty
tests
XML_Beautifier


Tutorials/Manuals:
В пакете: Files:
actions.php
builder.php
Classes.inc
clone.inc.php
clone5.inc.php
common.inc.php
config.php
EventStack.inc
HighlightParserTests.php
IntermediateParser.inc
IntermediateParserTests.php
Io.inc
new_phpdoc.php
ParserClassTests.php
ParserDescCleanup.inc
ParserPageTests.php
phpdoc.inc
phpdoc.php
phpDocumentorSetupTests.php
phpDocumentorTParserTests.php
ProceduralPages.inc
Publisher.inc
Setup.inc.php
top.php
utilities.php

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

Source Location: /phpDocumentor/ParserElements.inc

Class Overview

parserBase
   |
   --parserElement
      |
      --parserDefine



Author(s):

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


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

$type =  'define'

[line 1989]

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



Tags:

var:  always 'define'

Type:  string
Overrides:  Array


[ Top ]


Class Methods

method getConflicts [line 2011]

mixed getConflicts( Converter &$c)

Returns all defines in other packages that have the same name as this define



Tags:

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


Parameters:

Converter  &$c 

[ Top ]

method getLink [line 1997]

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

quick way to link to this element



Tags:

return:  converter-specific link to this define


Parameters:

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

[ Top ]
    Поддержать сайт на родительском проекте КГБ