Class: abstractLink

Source Location: /phpDocumentor/LinkClasses.inc

Class Overview [line 61]


Variables

Constants

Methods


Child classes:

pageLink
procedural page link
functionLink
function link
defineLink
define link
globalLink
global variable link
classLink
class link
methodLink
method link
tutorialLink
tutorial link

Inherited Variables

Inherited Constants

Inherited Methods



Class Details

linking classes parent

Tags:

[ Top ]


Class Variables

$category =  ''

[line 77]

Type: string

Overrides:

[ Top ]

$fileAlias =  ''

[line 70]

phpdoc alias _phpdoc_inc for phpdoc.inc

Type: string

Overrides:

[ Top ]

$name =  ''

[line 76]

Type: string

Overrides:

[ Top ]

$package =  ''

[line 78]

Type: string

Overrides:

[ Top ]

$path

[line 66]

Type: string

Overrides:

[ Top ]

$subpackage =  ''

[line 79]

Type: string

Overrides:

[ Top ]

$type =  ''

[line 75]

element type linked to.

can only be a documentable element

Type: string

Overrides:

[ Top ]


Class Methods

addLink

void addLink( string $path, string $fileAlias, string $name, string $package, string $subpackage, [string $category = false])

[line 94]

sets up the link

Overridden in child classes as:

methodLink::addLink()
sets up the link
tutorialLink::addLink()
sets up the link

Parameters:

  • string $path - full path to file containing element
  • string $fileAlias - page name, as configured by Parser::parse
  • string $name - element name
  • string $package - package element is in
  • string $subpackage - subpackage element is in
  • string $category - optional category that documentation is in

[ Top ]


Class Constants


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