Table of Contents
Hierarchy Plugins
VuFind® uses several families of classes to support its hierarchies and collections functionality.
Hierarchy Driver Plugin Details
Hierarchy drivers control the way VuFind® represents records that are arranged in hierarchies.
Default Namespace: \VuFind\Hierarchy\Driver
Base Class: \VuFind\Hierarchy\Driver\AbstractBase
Service Locator Configuration Section in module.config.php: ['vufind']['plugin_managers']['hierarchy_driver']
Service Manager Name for Service Locator: VuFind\HierarchyDriverPluginManager (VuFind® 2.x-4.x), VuFind\Hierarchy\Driver\PluginManager (VuFind® 5.0+)
See the General Plugin Information page for more details on VuFind® plugins.
Hierarchy Tree Data Formatter Plugin Details
Hierarchy tree data formatters convert VuFind®'s internal hierarchy representation to different output formats (i.e. XML vs. JSON). These plugins were introduced in VuFind® 2.5 to make hierarchy encoding more flexible and less redundant.
Default Namespace: \VuFind\Hierarchy\TreeDataFormatter
Base Class: \VuFind\Hierarchy\TreeDataFormatter\AbstractBase
Service Locator Configuration Section in module.config.php: ['vufind']['plugin_managers']['hierarchy_treedataformatter']
Service Manager Name for Service Locator: VuFind\HierarchyTreeDataFormatterPluginManager (VuFind® 2.x-4.x), VuFind\Hierarchy\TreeDataFormatter\PluginManager (VuFind® 5.0+)
See the General Plugin Information page for more details on VuFind® plugins.
Hierarchy Tree Data Source Plugin Details
Hierarchy tree data sources load hierarchical information for use in VuFind® (usually from file or from the Solr index).
Default Namespace: \VuFind\Hierarchy\TreeDataSource
Base Class: \VuFind\Hierarchy\TreeDataSource\AbstractBase
Service Locator Configuration Section in module.config.php: ['vufind']['plugin_managers']['hierarchy_treedatasource']
Service Manager Name for Service Locator: VuFind\HierarchyTreeDataSourcePluginManager (VuFind® 2.x-4.x), VuFind\Hierarchy\TreeDataSource\PluginManager (VuFind® 5.0+)
See the General Plugin Information page for more details on VuFind® plugins.
Hierarchy Tree Renderer Plugin Details
Hierarchy tree renderers help process and prepare hierarchy data for display.
Default Namespace: \VuFind\Hierarchy\TreeRenderer
Base Class: \VuFind\Hierarchy\TreeRenderer\AbstractBase
Service Locator Configuration Section in module.config.php: ['vufind']['plugin_managers']['hierarchy_treerenderer']
Service Manager Name for Service Locator: VuFind\HierarchyTreeRendererPluginManager (VuFind® 2.x-4.x), VuFind\Hierarchy\TreeRenderer\PluginManager (VuFind® 5.0+)
See the General Plugin Information page for more details on VuFind® plugins.