CSNavigatorPlugin
extends CSPlugin
in package
This Plugin extends the left navigator SlidePane.
To be included, it must be placed in any plugins/core subfolder with a file name ending with Navigator.php.
Tags
Table of Contents
- __call() : mixed|string
- All method calls which are not defined within the plugin are forwarded to the module Therefore it is possible to get, e.g. the label by calling the getSuiteName() method.
- _construct() : void
- The construct method may be used to initialize custom plugin properties it is called immediately after instantiating the plugin all arguments passed to the getPlugins method are also available in this method.
- addAlternativePluginFolder() : void
- A path to a specific folder in which should be search for plugins.
- addDefaultPane() : mixed
- This method can be used to create a standard navigator pane in the slidebar
- extendCSHelp() : void
- This method is called to extend the internal CSHelp objects to add some additional help menus depending on rights e.g. to the navigator
- extendHelpMenu() : void
- This method is called to add custom items to the navigator help menu
- extendProjectMenu() : void
- This method is called to add tools to the project menu
- extendSlidePane() : void
- This method is called to add slides to the navigator slidebar If standard slides should be added it is possible to use the addDefaultPane method,
- extendToolMenu() : void
- This method is called to add tools to the navigator tool menu
- extendViewMenu() : void
- This method is called to add views to the navigator view menu
- getAlternativePluginFolder() : array<string|int, mixed>
- getLevel() : int
- The getLevel method may be overwritten in the plugins and defines the order, the plugins are called, where the highest level is called first.
- getMetaData() : CSMetaData
- Returns the CSMetaData of the current plugin.
- getModule() : CSModule
- Returns the module, if the plugin is defined within a module.
- getPlugin() : CSPlugin|null
- Returns a CSPlugin for the given plugin type and plugin class name.
- getPluginChooser() : array<string|int, mixed>
- Returns an array all defined CSPlugins for the current plugin type
- getPluginData() : mixed
- getPluginDefinitionFile() : string
- Returns the path to the file, the plugin is defined.
- getPluginName() : mixed
- getPlugins() : array<string|int, CSPlugin>
- Returns all defined CSPlugins for the current plugin type It should be used to get all matching plugins for a given plugin api.
- getPluginsInModule() : array<string|int, mixed>
- Returns all CSPlugins for the current plugin type which are defined within the given module It should be used to get all matching plugins for a given plugin api.
- isAvailable() : bool
- To be available the plugin must not defined in or module or the user must have the right to use the module
- resetLoadedPlugins() : mixed
- reset the internal plugins cache for loaded plugins
- updateRightTitle() : string
- This method is called to update the right title of the navigatormenu
Methods
__call()
All method calls which are not defined within the plugin are forwarded to the module Therefore it is possible to get, e.g. the label by calling the getSuiteName() method.
public
__call(mixed $methodName, mixed $methodArguments) : mixed|string
Parameters
- $methodName : mixed
- $methodArguments : mixed
Tags
Return values
mixed|string —_construct()
The construct method may be used to initialize custom plugin properties it is called immediately after instantiating the plugin all arguments passed to the getPlugins method are also available in this method.
public
_construct() : void
Tags
Return values
void —addAlternativePluginFolder()
A path to a specific folder in which should be search for plugins.
public
static addAlternativePluginFolder(mixed $sPluginFolder) : void
Parameters
- $sPluginFolder : mixed
Tags
Return values
void —addDefaultPane()
This method can be used to create a standard navigator pane in the slidebar
public
addDefaultPane(CSGuiSlidePane $csGuiSlidePane, string $treeURL, string $mainURL[, string $name = '' ][, CSGuiMixedTree $icon = '' ][, string $treeFrameID = '' ]) : mixed
Parameters
- $csGuiSlidePane : CSGuiSlidePane
-
the CSGuiSlidePane to add the slide to
- $treeURL : string
-
the url of the treepane, which should be shown
- $mainURL : string
-
the url of the main frame, which should be shown when clicking on the slide
- $name : string = ''
-
the label of the slidepane
- $icon : CSGuiMixedTree = ''
-
the tree to add additional subtrees
- $treeFrameID : string = ''
-
the optional ID of the treeframe, if it is required to access the tree frame
Tags
Return values
mixed —extendCSHelp()
This method is called to extend the internal CSHelp objects to add some additional help menus depending on rights e.g. to the navigator
public
extendCSHelp(CSHelp $csHelp[, bool $forRights = true ]) : void
Parameters
- $csHelp : CSHelp
-
the help to add additional menus
- $forRights : bool = true
-
whether the help for the rights should be extended
Tags
Return values
void —extendHelpMenu()
This method is called to add custom items to the navigator help menu
public
extendHelpMenu(CSGuiPopup $csGuiPopup) : void
Parameters
- $csGuiPopup : CSGuiPopup
-
the popup to add additional menus
Tags
Return values
void —extendProjectMenu()
This method is called to add tools to the project menu
public
extendProjectMenu(CSGuiPopup $csGuiPopup) : void
Parameters
- $csGuiPopup : CSGuiPopup
-
the popup to add additional menus
Tags
Return values
void —extendSlidePane()
This method is called to add slides to the navigator slidebar If standard slides should be added it is possible to use the addDefaultPane method,
public
extendSlidePane(CSGuiSlidePane $csGuiSlidePane) : void
Parameters
- $csGuiSlidePane : CSGuiSlidePane
-
the slidebar to add slides
Tags
Return values
void —extendToolMenu()
This method is called to add tools to the navigator tool menu
public
extendToolMenu(CSGuiPopup $csGuiPopup) : void
Parameters
- $csGuiPopup : CSGuiPopup
-
the popup to add additional menus
Tags
Return values
void —extendViewMenu()
This method is called to add views to the navigator view menu
public
extendViewMenu(CSGuiPopup $csGuiPopup) : void
Parameters
- $csGuiPopup : CSGuiPopup
-
the popup to add additional menus
Tags
Return values
void —getAlternativePluginFolder()
public
static getAlternativePluginFolder() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getLevel()
The getLevel method may be overwritten in the plugins and defines the order, the plugins are called, where the highest level is called first.
public
getLevel() : int
The method can also be set for all plugins within a module by overwriting the modules getLevel method.
Tags
Return values
int —the level of the plugin where it is called
getMetaData()
Returns the CSMetaData of the current plugin.
public
getMetaData() : CSMetaData
Tags
Return values
CSMetaData —getModule()
Returns the module, if the plugin is defined within a module.
public
getModule() : CSModule
This method can be used in the plugin api and the plugin wherever access to the defining module is required. If it is used in the Api, it should be noticed that this method may return null, if the plugin is directly defined in the projects or admin.local plugins directory.
Tags
Return values
CSModule —the module object, if the plugin defined in a module or null otherwise
getPlugin()
Returns a CSPlugin for the given plugin type and plugin class name.
public
static getPlugin(string $pluginApiPath, string $className[, mixed $arguments = NULL ]) : CSPlugin|null
As standard behaviour the module subfolder is guessed from the forward URL parameter. If a plugin should point to something in a special module subfolder, this scope can be added by adding the module name in squared bracket at the end of the $pluginApiPath, e.g. 'core/api/plugins/CSRecordPlugin.php[pms]' to get all CSRecordPlugins defined for pms records.
Parameters
- $pluginApiPath : string
-
The relative path in filesystem for the requested plugin api (optional: ending with the module subfolder).
- $className : string
-
The target plugin class name, which should be loaded.
- $arguments : mixed = NULL
-
one or multiple arguments which should be passed to the isAvailable method.
Tags
Return values
CSPlugin|null —Returns the requested plugin for the given parameter.
getPluginChooser()
Returns an array all defined CSPlugins for the current plugin type
public
static getPluginChooser(string $pluginApiPath[, mixed $arguments = NULL ]) : array<string|int, mixed>
Parameters
- $pluginApiPath : string
-
the relative path in filesystem for the requested plugin api (optional: ending with the module subfolder).
- $arguments : mixed = NULL
-
one ore multiple arguments which should be passed to the isAvailable method.
Tags
Return values
array<string|int, mixed> —of CSPlugins in the form [CLASSNAME => LABEL] where the CLASSNAME may be used in the CSPlugin::getPlugin method
getPluginData()
public
getPluginData() : mixed
Tags
Return values
mixed —getPluginDefinitionFile()
Returns the path to the file, the plugin is defined.
public
getPluginDefinitionFile() : string
Tags
Return values
string —the path to the plugin
getPluginName()
public
getPluginName() : mixed
Tags
Return values
mixed —getPlugins()
Returns all defined CSPlugins for the current plugin type It should be used to get all matching plugins for a given plugin api.
public
static getPlugins(string $pluginApiPath[, mixed $arguments = NULL ]) : array<string|int, CSPlugin>
As standard behaviour the module subfolder is guessed from the forward URL parameter. If a plugin should point to something in a special module subfolder, this scope can be added by adding the module name in squared bracket at the end of the $pluginApiPath, e.g. 'core/api/plugins/CSRecordPlugin.php[pms]' to get all CSRecordPlugins defined for pms records.
Parameters
- $pluginApiPath : string
-
the relative path in filesystem for the requested plugin api (optional: ending with the module subfolder).
- $arguments : mixed = NULL
-
one ore multiple arguments which should be passed to the isAvailable method.
Tags
Return values
array<string|int, CSPlugin> —array of CSPlugin objects matching the defined plugin criteria
getPluginsInModule()
Returns all CSPlugins for the current plugin type which are defined within the given module It should be used to get all matching plugins for a given plugin api.
public
static getPluginsInModule(string $moduleName, string $pluginApiPath[, mixed $sFileNamePattern = '' ][, mixed $arguments = NULL ]) : array<string|int, mixed>
Parameters
- $moduleName : string
-
the module which should be searched for plugins
- $pluginApiPath : string
-
the relative path in filesystem for the requested plugin api.
- $sFileNamePattern : mixed = ''
- $arguments : mixed = NULL
-
one ore multiple arguments which should be passed to the isAvailable method.
Tags
Return values
array<string|int, mixed> —of CSPlugin objects matching the defined plugin criterias
isAvailable()
To be available the plugin must not defined in or module or the user must have the right to use the module
public
isAvailable() : bool
Tags
Return values
bool —whether the plugin is available
resetLoadedPlugins()
reset the internal plugins cache for loaded plugins
public
static resetLoadedPlugins() : mixed
Tags
Return values
mixed —updateRightTitle()
This method is called to update the right title of the navigatormenu
public
updateRightTitle(string $rightTitle) : string
Parameters
- $rightTitle : string
-
the old right title which should be updated
Tags
Return values
string —the new right title