AbstractBase
in package
Hierarchy interface class.
Interface Hierarchy based drivers. This should be extended to implement functionality for specific Hierarchy Systems (i.e. Calm etc.).
Tags
Table of Contents
- $config : Config
- Driver configuration
- $dataManager : PluginManager
- Tree data source plugin manager
- $enabled : bool
- Are trees globally enabled?
- $rendererManager : PluginManager
- Tree renderer plugin manager
- __construct() : mixed
- Constructor
- getCollectionLinkType() : string
- Get Collection Link Type
- getTreeCacheTime() : int
- Get tree cache time in seconds
- getTreeRenderer() : object
- Returns the actual object for generating trees
- getTreeRendererType() : string
- Returns the Tree Renderer Type
- getTreeSettings() : array<string|int, mixed>
- Get Tree Settings
- getTreeSource() : object
- Returns the Source of the Tree
- getTreeSourceType() : string
- Get Tree Data Source Type
- render() : string
- Render the tree for a given record.
- showTree() : bool
- Find out whether or not to show the tree
- treeSorting() : bool
- Check if sorting is enabled in the hierarchy Options
Properties
$config
Driver configuration
protected
Config
$config
$dataManager
Tree data source plugin manager
protected
PluginManager
$dataManager
$enabled
Are trees globally enabled?
protected
bool
$enabled
= true
$rendererManager
Tree renderer plugin manager
protected
PluginManager
$rendererManager
Methods
__construct()
Constructor
public
__construct(Config $config, PluginManager $dataManager, PluginManager $rendererManager[, array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $config : Config
-
Configuration
- $dataManager : PluginManager
-
Tree data source plugin manager
- $rendererManager : PluginManager
-
Tree renderer plugin manager
- $options : array<string|int, mixed> = []
-
Extra options (if any)
Return values
mixed —getCollectionLinkType()
Get Collection Link Type
public
abstract getCollectionLinkType() : string
Return values
string —getTreeCacheTime()
Get tree cache time in seconds
public
abstract getTreeCacheTime() : int
Return values
int —getTreeRenderer()
Returns the actual object for generating trees
public
getTreeRenderer(AbstractBase $driver) : object
Parameters
- $driver : AbstractBase
-
Record driver
Return values
object —getTreeRendererType()
Returns the Tree Renderer Type
public
abstract getTreeRendererType() : string
Return values
string —getTreeSettings()
Get Tree Settings
public
abstract getTreeSettings() : array<string|int, mixed>
Returns all the configuration settings for a hierarchy tree
Return values
array<string|int, mixed> —The values of the configuration setting
getTreeSource()
Returns the Source of the Tree
public
getTreeSource() : object
Return values
object —The tree data source object
getTreeSourceType()
Get Tree Data Source Type
public
abstract getTreeSourceType() : string
Return values
string —render()
Render the tree for a given record.
public
render(AbstractBase $driver, string $context, string $mode, string $hierarchyID, array<string|int, mixed> $options) : string
Parameters
- $driver : AbstractBase
-
Record driver
- $context : string
-
Context in which the tree is being created
- $mode : string
-
Type of tree required
- $hierarchyID : string
-
Hierarchy ID to get the tree for
- $options : array<string|int, mixed>
-
Additional options for the renderer
Return values
string —showTree()
Find out whether or not to show the tree
public
abstract showTree() : bool
Return values
bool —treeSorting()
Check if sorting is enabled in the hierarchy Options
public
abstract treeSorting() : bool