Contentserv PHP API

CSTaskSettingPlugin extends CSPlugin
in package

The CSTaskSettingPlugin is plugin to modify the project manager default behaviour.

It must be placed in the projectmanager/tasks folder with the name ending with Setting.php

Tags
since

CS12

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.
getAlternativePluginFolder()  : array<string|int, mixed>
getDueDates()  : array<string|int, mixed>
This method can overwrite and extend the due date filters It can define the name, the from and the to date and whether the planned or normal due date should be filtered.
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.
getPriorities()  : array<string|int, mixed>
Returns the available priorities
isAvailable()  : bool
This method is called to check, whether the plugin is available.
resetLoadedPlugins()  : mixed
reset the internal plugins cache for loaded plugins
updateSpecialFavorites()  : array<string|int, mixed>
This method can overwrite and extend the "special" favorit nodes in the Projectmanagers tree It can define the label, icon, the SQL-Filter for tasklists and the values to update, if a task is dropped onto it.

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 —

getAlternativePluginFolder()

public static getAlternativePluginFolder() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —

getDueDates()

This method can overwrite and extend the due date filters It can define the name, the from and the to date and whether the planned or normal due date should be filtered.

public getDueDates(array<string|int, mixed> $dueDates) : array<string|int, mixed>

The array has the following form, where all settings are optional: {[KEY] => { 'label' => [LABEL], 'icon' => [ICON], 'field' => [TASK_FIELD], 'from' => [DATE], 'to' => [DATE] } } Notes:

  • label defines the label. If it is not defined GUI_TREE_[KEY] or [KEY] is used
  • icon points to an image relative to the admin directory
  • field defines the name of the Taskfield, e.g. DueFrom, PlannedDueTo
  • from defines the optional start of the filter
  • to defines the optional end of the filter
Parameters
$dueDates : array<string|int, mixed>

all defined due dates

Tags
Return values
array<string|int, mixed> —

the prepared dates

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
access

public

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

getPriorities()

Returns the available priorities

public getPriorities([CSGuiEditor $csGuiEditor = false ]) : array<string|int, mixed>
Parameters
$csGuiEditor : CSGuiEditor = false

if requested for an editor the editor is given to be able to react on the editors content

Tags
Return values
array<string|int, mixed> —

the priorities in the form priority (as integer) => label

isAvailable()

This method is called to check, whether the plugin is available.

public isAvailable() : bool

If further arguments are added to the CSPlugin::getPlugins call, they are added as arguments to this method.

For simpler usage of the plugin concept: This method should be overwritten with the correct signature for a plugin call, if arguments are passed.

Tags
Return values
bool —

whether the plugin is available for the given arguments

resetLoadedPlugins()

reset the internal plugins cache for loaded plugins

public static resetLoadedPlugins() : mixed
Tags
@return

void;

access

public

Return values
mixed —

updateSpecialFavorites()

This method can overwrite and extend the "special" favorit nodes in the Projectmanagers tree It can define the label, icon, the SQL-Filter for tasklists and the values to update, if a task is dropped onto it.

public updateSpecialFavorites(array<string|int, mixed> $favorites) : array<string|int, mixed>

The array has the following form, where all settings are optional: {[KEY] => { 'parent' => [KEY] 'icon' => [ICON], 'label' => [LABEL], 'setFilterValue' => {[FIELD1]=>[VALUE1]}, 'setSqlFilter' => [FILTER], 'setSessionValue' => {[SESSIONNAME1] => [VALUE1]} 'setValues' => {[KEY1]=>[VALUE1]} } } Notes:

  • parent can be set to display the favorite within another
  • icon points to an image relative to the admin directory
  • label defines the label. If it is not defined GUI_TREE_[KEY] or [KEY] is used
  • All the setSqlFilter is passed to the CSGuiList::setSqlFilter() method. Therefore task fields should have the "item" Prefix, e.g. "item.OwnerID=12".
  • The setFilterValue are passed to the CSGuiList::setFilterValue() method.
  • The setSessionValue is passed to the CSGuiList::setSessionValue method to define additional settings.
  • setValues describes all values which must be set, if a task is dropped onto the favorite
Parameters
$favorites : array<string|int, mixed>

all defined favorites

Tags
Return values
array<string|int, mixed> —

the prepared nodes


        

        
    




    

    

                

    

        

            
Search results