CSRecordImporterPlugin
extends CSPlugin
in package
This Plugin offers the possibility to change various function in the CSRecordImporter To be included, it must be placed in any plugins/core/import subfolder with a file name ending with "RecordImporter.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.
- disableSafeMode() : bool
- This function is used to disable the SafeMode functionality entirely(including the GUI Components)
- 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
- This method is called to check, whether the plugin is available.
- resetLoadedPlugins() : mixed
- reset the internal plugins cache for loaded plugins
- updateChangedDataBeforeImport() : array<string|int, mixed>
- This function is called when the importer has already identified the differences from the database and the importFile. It can be used to check / manipulate the values right before the import starts.
- updateDataBeforeImport() : array<string|int, mixed>
- This function can be used to manipulate the raw data right after the fileupload for the CSRecordImporter.
- updateExportDataAfterImport() : array<string|int, mixed>
- This function manipulates the export array on already changed records by CSRecordImporter (used for the comparison right after the import where checks are made if the values are really in the database as wished).
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 —disableSafeMode()
This function is used to disable the SafeMode functionality entirely(including the GUI Components)
public
disableSafeMode() : bool
FALSE (default for Items with the CHECKOUT-Interface) means that the SafeMode is active (including GUI Components) TRUE means that the SafeMode will be disabled completely for the import
Tags
Return values
bool —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()
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 values
mixed —updateChangedDataBeforeImport()
This function is called when the importer has already identified the differences from the database and the importFile. It can be used to check / manipulate the values right before the import starts.
public
updateChangedDataBeforeImport(array<string|int, mixed> $array, object $oRecord) : array<string|int, mixed>
the key of the first-dimension is the Record-ID. the second dimension contains the changes of this item (the fieldnames are used as key).
Example:
array(
[201] => array(
[0] => array( //complete CSV line fot he specific id (here 201)
[Label] => 'New Label', //new value
[FieldName#123] => 'New FieldValue',
...
),
[1] => array(
[Label] => array( //changed field
[0] => 'Label', //old value of the field
[1] => 'New Label' //new value of the field
),
[FieldName#123] => array(
[0] => 'FieldValue',
[1] => 'New FieldValue'
),
...
),
[202] => array (
...
)
)
Parameters
- $array : array<string|int, mixed>
-
An array including only changes
- $oRecord : object
-
A record containing the type of Record
Tags
Return values
array<string|int, mixed> —updateDataBeforeImport()
This function can be used to manipulate the raw data right after the fileupload for the CSRecordImporter.
public
updateDataBeforeImport(array<string|int, mixed> $aCSVData, object $oRecord) : array<string|int, mixed>
$aCSVData is an 1:1 2-dimensional array-representation of the uploaded file. The first Dimension represents the line. The second dimension contains all values for one item (the field descriptions are the keys of the array-buckets).
Example:
array(
[0] => array( //first item
[Label] => 'Label', //value
[FieldName#123] => 'FieldValue',
...
),
[1] => array( //second item
[Label] => 'Label2',
[FieldName#123] => 'FieldValue2',
...
),
...
)
Parameters
- $aCSVData : array<string|int, mixed>
-
An array representing the file
- $oRecord : object
-
A record containing the type of Record
Tags
Return values
array<string|int, mixed> —The manipulated value-array
updateExportDataAfterImport()
This function manipulates the export array on already changed records by CSRecordImporter (used for the comparison right after the import where checks are made if the values are really in the database as wished).
public
updateExportDataAfterImport(array<string|int, mixed> $array, object $oRecord) : array<string|int, mixed>
Parameters
- $array : array<string|int, mixed>
- $oRecord : object
-
A record containing the type of Record