Class: parserFileSourceTag

Source Location: /phpDocumentor/DocBlockTags.inc

Class Overview [line 1061]

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserTag
         |
         --parserFileSourceTag

Variables

Constants

Methods


Child classes:

parserExampleTag
represents "@example"

Inherited Variables

Inherited Constants

Inherited Methods

Class: parserTag

parserTag::parserTag()
Set up the tag
parserTag::Convert()
Perform the output conversion on this parserTag using the output converter that is passed in
parserTag::getString()
Returns the text minus any inline tags
parserTag::HandleEvent()
Called by the parserDescParser when processing a description.

Class: parserStringWithInlineTags

parserStringWithInlineTags::add()
equivalent to the . operator ($a = $b . $c)
parserStringWithInlineTags::Convert()
Use to convert the string to a real string with all inline tags parsed and linked
parserStringWithInlineTags::getString()
return the string unconverted (all inline tags are taken out - this should only be used in pre-parsing to see if any other text is in the string)
parserStringWithInlineTags::hasInlineTag()
Determine whether the string contains any inline tags
parserStringWithInlineTags::setSource()
Pass source code to any [email protected]} tags contained within the string for later conversion.
parserStringWithInlineTags::trimmedStrlen()
equivalent to trim(strlen($string))

Class: parserBase

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


Class Details

represents "@filesource"

Use this to create a link to a highlighted phpxref-style source file listing

Tags:

[ Top ]


Class Variables

$keyword =  'filesource'

[line 1067]

Always "filesource"

Type: string

Overrides: Array

[ Top ]

$path

[line 1075]

Type: string

Overrides:

[ Top ]

$source

[line 1071]

Type: array

Overrides:

[ Top ]


Class Methods

parserFileSourceTag

parserFileSourceTag parserFileSourceTag( string $filepath, array $value)

[line 1090]

Set $source to $value, and set up path

Parameters:

[ Top ]

Convert

string Convert( Converter &$c)

[line 1106]

Return a link to the highlighted source and generate the source

Tags:

Overrides parserTag::Convert() (Perform the output conversion on this parserTag using the output converter that is passed in)

Parameters:

[ Top ]

ConvertSource

void ConvertSource( Converter &$c)

[line 1124]

convert the source code

Tags:

Overridden in child classes as:

parserExampleTag::ConvertSource()
convert the source code

Parameters:

[ Top ]

getSourceLink

output getSourceLink( Converter &$c)

[line 1158]

gets path to the sourcecode file

Tags:

Overridden in child classes as:

parserExampleTag::getSourceLink()
Retrieve a converter-specific link to the example

Parameters:

[ Top ]

writeSource

void writeSource( Converter &$c, string $source)

[line 1145]

have the output converter write the source code

Tags:

Parameters:

  • Converter &$c - the output converter
  • string $source - highlighted source code

[ Top ]


Class Constants


Documentation generated on Tue, 06 Dec 2011 07:05:38 -0600 by phpDocumentor 1.4.4