Class: parserFileSourceTag

Source Location: /phpDocumentor/DocBlockTags.inc

Class parserFileSourceTag

Class Overview

represents "@filesource"

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

Located in /phpDocumentor/DocBlockTags.inc [line 717]

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

Author(s):

Greg Beaver <[email protected]>

Information Tags:

Version:	$Id: DocBlockTags.inc,v 1.8 2006/10/24 04:18:14 cellog Exp $
Tutorial:	@filesource

Properties

Methods

[ Top ]

Direct descendents

Child Class	Description
parserExampleTag	represents "@example"

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From parserTag

parserTag::$type

Inherited From parserStringWithInlineTags

parserStringWithInlineTags::$value

Inherited From parserTag

parserTag::parserTag()

Set up the tag

parserTag::Convert()

parserTag::getString()

parserTag::HandleEvent()

Called by the parserDescParser when processing a description.

Inherited From 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))

Inherited From parserBase

parserBase::getType()

parserBase::getValue()

parserBase::setValue()

[ Top ]

Property Summary

string	$keyword	Always "filesource"
string	$path
array	$source

[ Top ]

Method Summary

parserFileSourceTag	parserFileSourceTag()	Set $source to $value, and set up path
string	Convert()	Return a link to the highlighted source and generate the source
void	ConvertSource()
output	getSourceLink()
void	writeSource()

[ Top ]

Properties

string $keyword = 'filesource' [line 723]

Always "filesource"

Redefinition of:

parserTag::$keyword: tag name (see, access, etc.)

Redefined in descendants as:

parserExampleTag::$keyword : always "example"

[ Top ]

string $path [line 727]

[ Top ]

array $source [line 725]

[ Top ]

Methods

Constructor parserFileSourceTag [line 739]

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

string Convert(
Converter
&$c 
)

Return a link to the highlighted source and generate the source

Parameters:

Converter

&$c:

API Tags:

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

Redefinition of:

parserTag::Convert()

[ Top ]

ConvertSource [line 763]

void ConvertSource(
Converter
&$c 
)

Parameters:

Converter

&$c:

API Tags:

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

Redefined in descendants as:

parserExampleTag::ConvertSource()

[ Top ]

getSourceLink [line 788]

output getSourceLink(
Converter
&$c 
)

Parameters:

Converter

&$c:

API Tags:

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

Redefined in descendants as:

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

[ Top ]

writeSource [line 778]

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

Parameters:

Converter	&$c:
string	$source:	highlighted source code

API Tags:

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

[ Top ]

Documentation generated on Tue, 24 Oct 2006 09:22:16 -0500 by phpDocumentor 1.3.1

	phpDocumentor DocBlockTags

[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]