Class DatasetViewTree

Description

View for hierarchical datasets

Uses the template "dataset.view.tree" for output.

Located in /phpsatk-lib/global/org.eenterphace.sat.xdo.dataset.view.tree/dataset.view.tree.php (line 35)

PHPTAL
   |
   --TemplateTAL
      |
      --DatasetViewTree
Method Summary
DatasetViewTree __construct (DatasetHierarchical $tree, mixed $field, [mixed $title = null], DatasetHierarchical $dataset)
void addAction (string $caption, string $by, [string $icon = null], string $app, mixed $path, [string $args = ''], string $pathPath)
void addLink (string $caption, string $app, [string $path = '/'], [string $args = ''], [string $icon = false])
void setReference (string $by, string $app, string $path, [string $args = ''])
Methods
Constructor __construct (line 50)

Adds all needed data to the template

  • access: public
DatasetViewTree __construct (DatasetHierarchical $tree, mixed $field, [mixed $title = null], DatasetHierarchical $dataset)
  • DatasetHierarchical $dataset: Dataset to display

Redefinition of:
TemplateTAL::__construct()
Initializes a new PHPTAL Template
addAction (line 97)

Adds a action

Multiple actions are supported. They will be displayed as links in each row.

  • access: public
  • todo: use template strings
void addAction (string $caption, string $by, [string $icon = null], string $app, mixed $path, [string $args = ''], string $pathPath)
  • string $caption: Action title
  • string $by: Field value to pass to the referenced resource
  • string $icon: URL of an icon to display istead of the title
  • string $app: Application reference points to
  • string $pathPath: reference points to
  • string $args: Additional arguments to pass (query string)
addLink (line 127)

Adds a link to the page navigation box

Use this to link to actions which are associated with the dataset. (e.g. Add)

  • access: public
void addLink (string $caption, string $app, [string $path = '/'], [string $args = ''], [string $icon = false])
  • string $caption: Link caption
  • string $app: Application to link to
  • string $path: Path to link to
  • string $args: Arguments to pass with the link
  • string $icon: Icon
setReference (line 71)

Adds a reference to another resource to a table column

Only one reference is supported.

  • access: public
  • todo: use template strings
void setReference (string $by, string $app, string $path, [string $args = ''])
  • string $by: Field value to pass to the referenced resource
  • string $app: Application reference points to
  • string $path: Path reference points to
  • string $args: Additional arguments to pass (query string)

Inherited Methods

Inherited From TemplateTAL

TemplateTAL::__construct()
TemplateTAL::getType()
TemplateTAL::prepare()
TemplateTAL::render()
TemplateTAL::renderDOM()

Documentation generated on Mon, 21 May 2007 10:34:57 +0200 by phpDocumentor 1.3.0RC5