CSMamExportPresetPlugin
extends CSPlugin
in package
The CSMamExportPresetPlugin is a plugin to define additional parameters to Mam presets To be included, it must be placed in a plugins/mam/presets sub folder with a file name ending with ExportPresetPlugin.php.
Tags
Table of Contents
- PRESET_TYPE_IMAGE = 1
- defines the preset type
- PRESET_TYPE_VIDEO = 2
- __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.
- addEditorFields() : mixed
- Adds editor field to the gui editor.
- getAlternativePluginFolder() : array<string|int, mixed>
- getAvailableFileTypes() : array<string|int, mixed>
- Returns the file types of the preset.
- getDownloadName() : null
- Returns the download name for the given CSMamFile and preset.
- getFieldName() : string
- Returns the field name for a given key.
- getFieldValue() : mixed
- Returns the field value for a given key and preset.
- 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.
- getName() : mixed
- Returns the name of the export preset plugin.
- 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.
- hasType() : bool
- Checks if the current preset has the specified type.
- isAvailable() : bool
- This method is called to check, whether the plugin is available.
- process() : CSFileStream
- Executes the process of the export preset plugin for the current file (Record ID).
- processFile() : string
- Executes the process of the export preset plugin for the current file (Record ID).
- resetLoadedPlugins() : mixed
- reset the internal plugins cache for loaded plugins
Constants
PRESET_TYPE_IMAGE
defines the preset type
public
mixed
PRESET_TYPE_IMAGE
= 1
Tags
PRESET_TYPE_VIDEO
public
mixed
PRESET_TYPE_VIDEO
= 2
Tags
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 —addEditorFields()
Adds editor field to the gui editor.
public
addEditorFields(CSGuiEditor $csGuiEditor) : mixed
Parameters
- $csGuiEditor : CSGuiEditor
Tags
Return values
mixed —getAlternativePluginFolder()
public
static getAlternativePluginFolder() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getAvailableFileTypes()
Returns the file types of the preset.
public
getAvailableFileTypes(CSMamExportPreset $preset) : array<string|int, mixed>
Parameters
- $preset : CSMamExportPreset
-
The ExportPreset
Tags
Return values
array<string|int, mixed> —getDownloadName()
Returns the download name for the given CSMamFile and preset.
public
getDownloadName(CSMamFile $oCSMamFile, CSMamExportPreset $oPreset) : null
Parameters
- $oCSMamFile : CSMamFile
- $oPreset : CSMamExportPreset
Tags
Return values
null —getFieldName()
Returns the field name for a given key.
public
getFieldName(string $sKey) : string
Parameters
- $sKey : string
Tags
Return values
string —getFieldValue()
Returns the field value for a given key and preset.
public
getFieldValue(string $sKey, CSMamExportPreset $oPreset) : mixed
Parameters
- $sKey : string
- $oPreset : CSMamExportPreset
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
getName()
Returns the name of the export preset plugin.
public
getName() : mixed
Tags
Return values
mixed —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
hasType()
Checks if the current preset has the specified type.
public
final hasType(int $iType) : bool
Parameters
- $iType : int
Tags
Return values
bool —True, if the current preset has the specified type, otherwise 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
process()
Executes the process of the export preset plugin for the current file (Record ID).
public
final process(int $iMamFileId, CSMamExportPreset $oPreset[, bool $bDieOnError = false ]) : CSFileStream
Parameters
- $iMamFileId : int
- $oPreset : CSMamExportPreset
- $bDieOnError : bool = false
Tags
Return values
CSFileStream —a file stream object of the processed file.
processFile()
Executes the process of the export preset plugin for the current file (Record ID).
public
processFile(int $iMamFileId, CSMamExportPreset $oPreset[, bool $dieOnError = false ]) : string
Parameters
- $iMamFileId : int
- $oPreset : CSMamExportPreset
- $dieOnError : bool = false
Tags
Return values
string —The local path of the processed file.
resetLoadedPlugins()
reset the internal plugins cache for loaded plugins
public
static resetLoadedPlugins() : mixed