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

Class: parserStringWithInlineTags

Source Location: /phpDocumentor/ParserData.inc

Class parserStringWithInlineTags

Class Overview

Used to represent strings that contain inline tags, so that they can be properly parsed at link time

Located in /phpDocumentor/ParserData.inc [line 776]

parserBase
   |
   --parserStringWithInlineTags
Author(s): Information Tags:
Version:  Release: @[email protected]
Copyright:  2002-2008 Gregory Beaver
Link:  http://pear.php.net/PhpDocumentor
Link:  http://www.phpdoc.org
Todo:  CS cleanup - change package to PhpDocumentor
Since:  1.0rc1
License:  LGPL

Properties

Methods

[ Top ]
Descendants
Child Class Description
parserCData Represents <![CDATA[ ]]> sections.
parserXMLDocBookTag a standard XML DocBook Tag
parserCode Used for <code> in a description
parserPre Used for <pre> in a description
parserB Used for <b> in a description
parserI Used for <i> in a description
parserDescVar Used for <var> in a description
parserSamp Used for <samp> in a description
parserKbd Used for <kbd> in a description
parserBr Used for <br> in a description
parserList Used for lists <ol> and <ul>
parserTag used to represent standard tags like @access, etc.
parserPackagePage
parserDesc represents a short or long description in a DocBlock (parserDocBlock)

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From parserBase

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

[ Top ]
Property Summary
string   $type   Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'...
array   $value   array of strings and parserInlineTags

[ Top ]
Method Summary
void   add()   equivalent to the . operator ($a = $b . $c)
string   Convert()   Use to convert the string to a real string with all inline tags parsed and linked
string   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)
bool   hasInlineTag()   Determine whether the string contains any inline tags
void   setSource()   Pass source code to any {@source} tags contained within the string for later conversion.
integer   trimmedStrlen()   equivalent to trim(strlen($string))

[ Top ]
Properties
string   $type = '_string' [line 784]

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

always '_string'


Redefinition of:
parserBase::$type
Type is used by many functions to skip the hassle of if

Redefined in descendants as:
  • parserTag::$type : Type is used by many functions to skip the hassle of
  • parserPackagePage::$type : Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
  • parserTutorial::$type : Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
  • parserDesc::$type : Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'

[ Top ]
array   $value = array() [line 795]

array of strings and parserInlineTags

Format: array(string1,string2,parserInlineTag1,string3,parserInlineTag2,...)


Redefinition of:
parserBase::$value
set to different things by its descendants

[ Top ]
Methods
add  [line 804]

  void add( mixed $stringOrInlineTag  )

equivalent to the . operator ($a = $b . $c)

Parameters:
mixed   $stringOrInlineTag:  either a string or a parserInlineTag


Redefined in descendants as:

[ Top ]
Convert  [line 924]

  string Convert( Converter &$converter, [bool $postprocess = true], [bool $trim = true]  )

Use to convert the string to a real string with all inline tags parsed and linked

Parameters:
Converter   &$converter:  the output converter
bool   $postprocess:  true if one needs to postprocess
bool   $trim:  false if the output should not be trimmed

API Tags:
See:  Converter::returnSee()

Information Tags:
Todo:  CS cleanup - rename to convert for camelCase rule

Redefined in descendants as:

[ Top ]
getString  [line 896]

  string getString( [bool $trim = true]  )

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)

Parameters:
bool   $trim:  whether to trim the string

API Tags:
Return:  trimmed value
Uses:  parserInlineTag::getString() - removes inline tag length, as it is indeterminate until conversion.


Redefined in descendants as:

[ Top ]
hasInlineTag  [line 835]

  bool hasInlineTag( )

Determine whether the string contains any inline tags


Information Tags:
Tutorial:  phpDocumentor Inline tags

[ Top ]
setSource  [line 853]

  void setSource( string|array $source  )

Pass source code to any {@source} tags contained within the string for later conversion.

Parameters:
string|array   $source:  source code ready to be highlighted


[ Top ]
trimmedStrlen  [line 868]

  integer trimmedStrlen( )

equivalent to trim(strlen($string))


API Tags:
Return:  length of the string this object represents


[ Top ]

Documentation generated on Tue, 06 Dec 2011 07:20:40 -0600 by phpDocumentor 1.4.4