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

Class: abstractLink

Source Location: /phpDocumentor/LinkClasses.inc

Class Overview


linking classes parent


Author(s):

Version:

  • Release: @VER@

Copyright:

  • 2002-2008 Gregory Beaver

Variables

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

Class Details



[ Top ]


Class Variables

$category =  ''

[line 77]


Type:   string


[ Top ]

$fileAlias =  ''

[line 70]

phpdoc alias _phpdoc_inc for phpdoc.inc


Type:   string


[ Top ]

$name =  ''

[line 76]


Type:   string


[ Top ]

$package =  ''

[line 78]


Type:   string


[ Top ]

$path =

[line 66]


Type:   string


[ Top ]

$subpackage =  ''

[line 79]


Type:   string


[ Top ]

$type =  ''

[line 75]

element type linked to.

can only be a documentable element



Type:   string


[ Top ]



Class Methods


method addLink [line 94]

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

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 ]


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