Contentserv PHP API

CSDataFlowImportLoaderPlugin extends CSPlugin
in package

This class represents the parent class of all plugin apis and offers some utilitiy methods which should be available in every plugin.

Tags
since

CS17.0

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.
addConfigField()  : mixed
Allows the plugin to add custom configuration fields to the editor it is opened with
addConfigFields()  : void
Overwrite this method to add your config fields
getActiveJob()  : CSActiveScriptJob
getActiveJobID()  : int
Internal method to get the job id
getActiveScript()  : CSActiveScript
getActiveScriptID()  : int
Internal method
getAlternativePluginFolder()  : array<string|int, mixed>
getConfigValue()  : string
Returns the value for a config field
getField()  : CSItemApiField
Retrieves a field from the loader objects
getIcon()  : string
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.
getLoaderFields()  : array<string|int, CSDataFlowExtractionField>
getMetaData()  : CSMetaData
Returns the CSMetaData of the current plugin.
getModule()  : CSModule
Returns the module, if the plugin is defined within a module.
getObject()  : CSItemApiItem
Retrieves an object the loader can write to
getObjectForID()  : CSItemApiItem
Retrieves an object the loader can write to
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
This method is called to check, whether the plugin is available.
resetLoadedPlugins()  : mixed
reset the internal plugins cache for loaded plugins
setActiveJobID()  : mixed
Internal method to connect this plugin with an {@see CSActiveJob}
setActiveScriptID()  : mixed
Internal method
setEditor()  : void
Internal method used to connect this plugin with an editor

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 —

addConfigField()

Allows the plugin to add custom configuration fields to the editor it is opened with

public addConfigField(string $sName, string $sLabel, string $sType[, string $sDefault = '' ][, array<string|int, string> $aOptions = array() ]) : mixed
Parameters
$sName : string

the name of the option

$sLabel : string

the visual label of the option

$sType : string

the type of the option, see CSGuiEditor for more examples

$sDefault : string = ''

the default value the option should have

$aOptions : array<string|int, string> = array()

further options, see CSGuiEditor for more examples

Tags
Return values
mixed —

addConfigFields()

Overwrite this method to add your config fields

public addConfigFields() : void
Tags
Return values
void —

getAlternativePluginFolder()

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

getConfigValue()

Returns the value for a config field

public getConfigValue(string $sName[, string $sDefault = '' ]) : string
Parameters
$sName : string

the name of the field

$sDefault : string = ''

the default if the value is empty

Tags
Return values
string —

the value of the config field

getIcon()

public getIcon() : string
Tags
Return values
string —

the icon representation of the script as relative URL

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

getLoaderFields()

public getLoaderFields() : array<string|int, CSDataFlowExtractionField>
Tags
Return values
array<string|int, CSDataFlowExtractionField> —

array with all fields the loader can write to

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

getObject()

Retrieves an object the loader can write to

public getObject([string $sKey = null ][, bool $bAutoCreate = true ]) : CSItemApiItem
Parameters
$sKey : string = null

the ExternalKey of the object

$bAutoCreate : bool = true

if true the object will be created on the fly if it does not exist

Tags
Return values
CSItemApiItem —

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

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()

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 —

setActiveJobID()

Internal method to connect this plugin with an {@see CSActiveJob}

public setActiveJobID(int $iActiveJobID) : mixed
Parameters
$iActiveJobID : int
Tags
Return values
mixed —

setActiveScriptID()

Internal method

public setActiveScriptID(mixed $iActiveScriptID) : mixed
Parameters
$iActiveScriptID : mixed

the active script this plugin is connected with

Tags
Return values
mixed — 

        

        
    




    

    

                

    

        

            
Search results