Contentserv PHP API

CSDataQualityEditor extends CSGuiEditorPlugin
in package

This plugins may extend any CSGuiEditor used in CONTENTSERV.

It contains methods which are called after or before some methods in the plugged CSGuiEditor. To be included, it must be placed in a gui subfolder with a file name ending with Editor.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.
construct()  : void
This method is called after the constructor has been called.
getAlternativePluginFolder()  : array<string|int, mixed>
getClass()  : string
Returns the name of the CSGuiComponent class the plugin matches for
getForwardURL()  : mixed
Returns the forwardURL the plugin matches for
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
Checks and returns whether this Plugin is responsible for the given CSGuiComponent
makeHtml()  : void
This method is called to define rights using the utility methods.
modifyEditbuilderFieldOptions()  : array<string|int, mixed>
Modifies the given input field options. THe plugin must alter the additionalOptions-array and return it so the framework knows that it was changed. Please note that every plugin gets the original array of options and not the altered one, so it may happen that array keys get overwritten.
prepareEditbuilderField()  : string
Changes the input for a given field
prepareEditbuilderFieldLabel()  : null|string
Changes the label for a given field. It is expected that this method creates the complete html string for the field label. The framework is not adding anything to the html string, including icons for information or configuration.
resetLoadedPlugins()  : mixed
reset the internal plugins cache for loaded plugins

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 —

construct()

This method is called after the constructor has been called.

public construct(CSGuiComponent $oCSGuiComponent) : void

It could be overwritten in the plugin

Parameters
$oCSGuiComponent : CSGuiComponent

the component which should be extended

Tags
Return values
void —

getAlternativePluginFolder()

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

getClass()

Returns the name of the CSGuiComponent class the plugin matches for

public getClass() : string
Tags
inheritdoc
Return values
string —

the class name of the CSGuiComponent the plugin is available for

getForwardURL()

Returns the forwardURL the plugin matches for

public getForwardURL() : mixed
Tags
Return values
mixed —

either a string or an array of strings with the forward parameter the plugin is available for

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

isAvailable()

Checks and returns whether this Plugin is responsible for the given CSGuiComponent

public isAvailable([mixed $oGuiEditor = null ]) : bool
Parameters
$oGuiEditor : mixed = null
Tags
inheritdoc
Return values
bool —

whether this plugin handles the given component

modifyEditbuilderFieldOptions()

Modifies the given input field options. THe plugin must alter the additionalOptions-array and return it so the framework knows that it was changed. Please note that every plugin gets the original array of options and not the altered one, so it may happen that array keys get overwritten.

public modifyEditbuilderFieldOptions(CSGuiEditor $csGuiEditor, string $fieldName, mixed $fieldType, string $value, mixed $isDisabled, mixed $additionalOptions) : array<string|int, mixed>
Parameters
$csGuiEditor : CSGuiEditor

The current editor

$fieldName : string

The name of the field

$fieldType : mixed

The type of the field

$value : string

The value of the field

$isDisabled : mixed
$additionalOptions : mixed
Tags
access

public

Return values
array<string|int, mixed> —

THe modified options array

prepareEditbuilderField()

Changes the input for a given field

public prepareEditbuilderField(CSGuiEditor $csGuiEditor, string $fieldName, mixed $fieldType, string $value, array<string|int, mixed> $additionalStyle, mixed $additionalOptions, bool $isDisabled) : string
Parameters
$csGuiEditor : CSGuiEditor

the current editor

$fieldName : string

the name of the field

$fieldType : mixed

the type of the field

$value : string

the value of the field

$additionalStyle : array<string|int, mixed>

additional styles which should be appended to the input

$additionalOptions : mixed
$isDisabled : bool

whether the input is disabled

Tags
Return values
string —

the alternative html representation of the field or null to use the default representation

prepareEditbuilderFieldLabel()

Changes the label for a given field. It is expected that this method creates the complete html string for the field label. The framework is not adding anything to the html string, including icons for information or configuration.

public prepareEditbuilderFieldLabel(CSGuiEditor $oGuiEditor, string $sFieldName, mixed $mFieldType, string $sFieldLabel, string $sFieldDescription, array<string|int, mixed> $aAdditionalOptions, bool $bIsDisabled) : null|string
Parameters
$oGuiEditor : CSGuiEditor

The current editor

$sFieldName : string

The name of the field

$mFieldType : mixed

The type of the field

$sFieldLabel : string

The original field label that is shown in the editor.

$sFieldDescription : string

The original field description that is shown in the editor.

$aAdditionalOptions : array<string|int, mixed>

AdditionalOptions for this field

$bIsDisabled : bool

Whether the input is disabled

Tags
Return values
null|string —

The alternative html representation of the field label or null to use the default representation

resetLoadedPlugins()

reset the internal plugins cache for loaded plugins

public static resetLoadedPlugins() : mixed
Tags
@return

void;

access

public

Return values
mixed — 

        

        
    




    

    

                

    

        

            
Search results