CSTranslationCollectorPlugin
extends CSPlugin
in package
This Plugin is called to define Translation Manager Collectors collecting the fields which should be translated.
To be included, it must be placed in a translation subfolder with a file name ending with Collector.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.
- addToJobEditor() : mixed
- collectObjectProxies() : mixed
- fillJobForRecord() : mixed
- forceSetValues() : bool
- Sets whether an update should always update all green and blue elements and not only the green ones to ensure full dataintegrity It may be overwritten in an implementation to force full updates
- getAlternativePluginFolder() : array<string|int, mixed>
- getContext() : mixed
- getContextKeys() : 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.
- getTranslateableKeys() : array<string|int, mixed>
- Returns all available keys which values may be translated for a given TranslationCollector type
- hasLanguageIndependantValues() : bool
- hasLanguageIndependentValues() : bool
- Check if values are language independent
- hasLanguageTagMappingSupport() : bool
- Method that indicates whether if the collector plugin has the language tag mapping support
- isAvailable() : bool
- This method is called to check, whether the plugin is available.
- isAvailableForRecord() : mixed
- limitProxiesToTargetLanguage() : array<string|int, mixed>
- Limit the translatable data depending on the given target language
- 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 —addToJobEditor()
public
addToJobEditor(CSGuiEditorDialog $jobEditor) : mixed
Parameters
- $jobEditor : CSGuiEditorDialog
Tags
Return values
mixed —collectObjectProxies()
public
collectObjectProxies(Translationjob $job[, mixed $additionalParams = array() ]) : mixed
Parameters
- $job : Translationjob
- $additionalParams : mixed = array()
Tags
Return values
mixed —fillJobForRecord()
public
fillJobForRecord(Translationjob $job, Record $record[, Action $action = null ][, mixed $append = false ]) : mixed
Parameters
- $job : Translationjob
- $record : Record
- $action : Action = null
- $append : mixed = false
Tags
Return values
mixed —forceSetValues()
Sets whether an update should always update all green and blue elements and not only the green ones to ensure full dataintegrity It may be overwritten in an implementation to force full updates
public
forceSetValues() : bool
Tags
Return values
bool —whether always all values should be set (default: false)
getAlternativePluginFolder()
public
static getAlternativePluginFolder() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getContext()
public
getContext(Translationjob $job, mixed $classID, mixed $path, mixed $key, mixed $proxyID) : mixed
Parameters
- $job : Translationjob
- $classID : mixed
- $path : mixed
- $key : mixed
- $proxyID : mixed
Tags
Return values
mixed —getContextKeys()
public
getContextKeys(Translationjob $job, mixed $classID, mixed $path) : mixed
Parameters
- $job : Translationjob
- $classID : mixed
- $path : mixed
Tags
Return values
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
getTranslateableKeys()
Returns all available keys which values may be translated for a given TranslationCollector type
public
getTranslateableKeys(Translationjob $job, string $classID, string $path) : array<string|int, mixed>
Parameters
- $job : Translationjob
-
the object of the current job
- $classID : string
-
the classID of the ObjectProxies
- $path : string
-
the path of the ObjectProxies
Tags
Return values
array<string|int, mixed> —the names of all translateable keys in the form {TRANSLATEABLE_KEY => TYPE(TEXT/HTML/...)}
hasLanguageIndependantValues()
public
hasLanguageIndependantValues() : bool
Tags
Return values
bool —hasLanguageIndependentValues()
Check if values are language independent
public
hasLanguageIndependentValues() : bool
Tags
Return values
bool —hasLanguageTagMappingSupport()
Method that indicates whether if the collector plugin has the language tag mapping support
public
hasLanguageTagMappingSupport() : bool
Tags
Return values
bool —whether the language tag mapping is in place (default: false)
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
isAvailableForRecord()
public
isAvailableForRecord(Record $record) : mixed
Parameters
- $record : Record
Tags
Return values
mixed —limitProxiesToTargetLanguage()
Limit the translatable data depending on the given target language
public
limitProxiesToTargetLanguage(array<string|int, mixed> $proxies, int $targetLang) : array<string|int, mixed>
Parameters
- $proxies : array<string|int, mixed>
-
of all ObjectProxies
- $targetLang : int
-
the current target language
Tags
Return values
array<string|int, mixed> —of all ObjectProxies which should be translated into the target language
resetLoadedPlugins()
reset the internal plugins cache for loaded plugins
public
static resetLoadedPlugins() : mixed