Docs For Class parserLicenseTag

Description

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserTag
         |
         --parserLinkTag
            |
            --parserLicenseTag

Link to a license, instead of including lines and lines of license information in every file

tutorial: - @license
author: - Greg Beaver <[email protected]>
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_*
license: - LGPL

Class Variables

Summary:

string $keyword

Overrides: Array

Class Constants

Summary:

Method Detail

Summary:

parserLicenseTag parserLicenseTag (string $name, string $link)

string $name: unused?
string $link: URL to link to

Inherited Variables

Inherited Methods

Class parserLicenseTag

Description

Class Variables

Class Constants

Method Detail

Inherited Variables

Inherited Methods

Class parserLicenseTag

Description

represents the "@see" tag

Class Variables

$keyword = 'license' (line 795)

Data type : string

always 'license'

Class Constants

Method Detail

Constructor parserLicenseTag (line 803)

parserLicenseTag parserLicenseTag( string $name, string $link)

set up the license tag

Parameters

Info

Inherited Variables

Inherited Class Variable Summary

Inherited From Class parserTag

parserTag::$type - Type is used by many functions to skip the hassle of

Inherited From Class parserStringWithInlineTags

parserStringWithInlineTags::$value - array of strings and parserInlineTags

Inherited Methods

Inherited Method Summary

Inherited From Class parserLinkTag

parserLinkTag::parserLinkTag() - sets up the link tag

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

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

parserStringWithInlineTags::trimmedStrlen() - equivalent to trim(strlen($string))

Inherited From Class parserBase

parserBase::getType() - gets the type

parserBase::getValue() - gets the value

parserBase::setValue() - sets the given value