Class: parserFileSourceTag

Source Location: /PhpDocumentor-1.4.0RC1/phpDocumentor/DocBlockTags.inc

Class Overview

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

represents "@filesource"

Author(s):

Greg Beaver <cellog at php.net>

Version:

$Id: DocBlockTags.inc,v 1.10 2007/04/19 20:20:57 ashnazg Exp $

Variables

Methods

Child classes:

parserExampleTag: represents "@example"

Inherited Variables

Class: parserTag

parserTag::$type

Class: parserStringWithInlineTags

parserStringWithInlineTags::$value

Inherited Methods

Class: parserTag

parserTag::parserTag(): Set up the tag
parserTag::Convert()
parserTag::getString()
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
parserStringWithInlineTags::hasInlineTag(): Determine whether the string contains any inline tags
parserStringWithInlineTags::setSource(): Pass source code to any {@source} tags contained within the string for later conversion.
parserStringWithInlineTags::trimmedStrlen(): equivalent to trim(strlen($string))

Class: parserBase

parserBase::getType()
parserBase::getValue()
parserBase::setValue()

Class Details

[line 793]
represents "@filesource"

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

Tutorial: @filesource
Author: Greg Beaver <cellog@php.net>
Version: $Id: DocBlockTags.inc,v 1.10 2007/04/19 20:20:57 ashnazg Exp $

[ Top ]

Class Variables

$keyword = 'filesource'

[line 799]

Always "filesource"

Type:	string
Overrides:	Array

[ Top ]

$path =

[line 803]

Type:

string

[ Top ]

$source =

[line 801]

Type:

array

[ Top ]

Method Detail

parserFileSourceTag (Constructor) [line 815]

parserFileSourceTag parserFileSourceTag(
string
$filepath, array
$value)

Set $source to $value, and set up path

Parameters:

string	`$filepath`	—
array	`$value`	—	output from phpDocumentorTWordParser::getFileSource()

[ Top ]

Convert [line 828]

string Convert(
Converter
&$c)

Return a link to the highlighted source and generate the source

Return: output from getSourceLink()
Uses: parserFileSourceTag::ConvertSource() - generate source code and write it out

Overrides parserTag::Convert() (parent method not documented)

Parameters:

Converter &$c —

[ Top ]

ConvertSource [line 839]

void ConvertSource(
Converter
&$c)

Usedby: parserFileSourceTag::Convert() - generate source code and write it out
Uses: parserFileSourceTag::writeSource()
Uses: phpDocumentor_HighlightParser - highlights source code

Overridden in child classes as:

parserExampleTag::ConvertSource()

Parameters:

Converter &$c —

[ Top ]

getSourceLink [line 864]

output getSourceLink(
Converter
&$c)

Return: from getSourceLink()
Uses: Converter::getSourceLink()

Overridden in child classes as:

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

Parameters:

Converter &$c —

[ Top ]

writeSource [line 854]

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

Usedby: parserExampleTag::ConvertSource()
Usedby: parserFileSourceTag::ConvertSource()
Uses: Converter::writeSource() - export highlighted file source

Parameters:

Converter	`&$c`	—
string	`$source`	—	highlighted source code

[ Top ]