TIP_Hierarchy

Introduction

A content module with a hierarchy as data model

Source file

/Type/module/content/hierarchy.php

Extends

TIP_Content

Properties

master : TIP_Content

The reference to the master module

access

protected

master_field : string

The field in "master" to join to the primary key of this hierarchy

access

protected

parent_field : string

The field in this hierarchy that specifies the parent of a row

access

protected

count_field : string

The field in "master" that keeps track of the number of children rows

access

protected

action : string

The action to be used by the renderer

deprecated

yes

access

protected

levels : int

Maximum number of levels to keep online (before enabling AHAH)

access

protected

Leave it null to not use AHAH at all. This means the whole tree is generated on every page.

self_reference : boolean

Set to true to automatically generate a self-reference as the

access

protected

first child on every container

Methods

checkOptions (&$options)

&$options

lines

81 - 100

static

yes

access

protected

__construct ($options)

Constructor

$options

array
Properties values

lines

109 - 112

access

protected

Initializes a TIP_Hierarchy instance.

tagDescriptor ($params) : string|null

Echo a row descriptor

$params

string
Parameters of the tag

lines

243 - 259

access

protected

Outputs the full path (as generated by the row renderer) of the row with $params id.

tagShow ($params) : string|null

Echo the hierarchy

$params

string
Parameters of the tag

lines

269 - 284

access

protected

Overrides the default tagShow() to disable the page indexing if the current selected row is a container. In $params you can specify the custom action to use: if left empty, the default action (configured for this module) will be used.