Class tutorialLink

Description
Variable Summary
string $section
string $title
string $type
Method Summary
void addLink (string $section, string $path, string $name, string $package, string $subpackage, [string $title = false], [string $category = false])
Variables
string $section = '' (line 336)
string $title = false (line 337)
string $type = 'tutorial' (line 335)

Redefinition of:
abstractLink::$type
element type linked to.

Inherited Variables

Inherited from abstractLink

abstractLink::$category
abstractLink::$fileAlias
abstractLink::$name
abstractLink::$package
abstractLink::$path
abstractLink::$subpackage
Methods
addLink (line 353)

sets up the link

void addLink (string $section, string $path, string $name, string $package, string $subpackage, [string $title = false], [string $category = false])
  • string $section: section/subsection name
  • string $path: full path to file containing element
  • string $name: page name, as configured by Parser::parse
  • string $package: package element is in
  • string $subpackage: subpackage element is in
  • string $title: title of tutorial
  • string $category: optional category that documentation is in

Redefinition of:
abstractLink::addLink()
sets up the link

Inherited Methods

Inherited From abstractLink

abstractLink::addLink()

Documentation generated on Mon, 05 Dec 2011 21:11:49 -0600 by phpDocumentor 1.4.4