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

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

Author(s):

Greg Beaver <[email protected]>

Information Tags:

Tutorial:	@filesource
Version:	Release: @VER@
Copyright:	2002-2008 Gregory Beaver
Link:	http://pear.php.net/PhpDocumentor
Link:	http://www.phpdoc.org
Todo:	CS cleanup - change package to PhpDocumentor
Todo:	CS cleanup - change classname to PhpDocumentor_*
Since:	1.2
License:	LGPL

Properties

Methods

[ Top ]

Descendants

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()

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.

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 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 {@source} tags contained within the string for later conversion.

parserStringWithInlineTags::trimmedStrlen()

equivalent to trim(strlen($string))

Inherited From parserBase

parserBase::getType()

gets the type

parserBase::getValue()

gets the value

parserBase::setValue()

sets the given value

[ 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()	convert the source code
output	getSourceLink()	gets path to the sourcecode file
void	writeSource()	have the output converter write the source code

[ Top ]

Properties

string $keyword = 'filesource' [line 1067]

Always "filesource"

Redefinition of:

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

Redefined in descendants as:

parserExampleTag::$keyword : always "example"

[ Top ]

string $path [line 1075]

[ Top ]

array $source [line 1071]

[ Top ]

Methods

Constructor parserFileSourceTag [line 1090]

parserFileSourceTag parserFileSourceTag(
string
$filepath, array
$value 
)

Set $source to $value, and set up path

Parameters:

string	$filepath:	the file's path
array	$value:	output from phpDocumentorTWordParser::getFileSource()

[ Top ]

Convert [line 1106]

string Convert(
Converter
&$c 
)

Return a link to the highlighted source and generate the source

Parameters:

Converter

&$c:

the output converter

API Tags:

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

Information Tags:

Todo:

CS cleanup - rename to convert for camelCase rule

Redefinition of:

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

[ Top ]

ConvertSource [line 1124]

void ConvertSource(
Converter
&$c 
)

convert the source code

Parameters:

Converter

&$c:

the output converter

API Tags:

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

Information Tags:

Todo:	CS cleanup - rename to convertSource for camelCase rule
Todo:	what's up with all the "return" statements? can they _all_ be removed?

Redefined in descendants as:

parserExampleTag::ConvertSource() : convert the source code

[ Top ]

getSourceLink [line 1158]

output getSourceLink(
Converter
&$c 
)

gets path to the sourcecode file

Parameters:

Converter

&$c:

the output converter

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

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

have the output converter write the source code

Parameters:

Converter	&$c:	the output converter
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, 06 Dec 2011 07:18:09 -0600 by phpDocumentor 1.4.4

	phpDocumentor DocBlockTags

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