CSMamImageServerPlugin
extends CSPlugin
in package
The CSMamImageServerPlugin is plugin to hook into ImageServer processes.
To be included, it must be placed in a plugins/mam/imageserver subfolder with a file name ending with ImageServer.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.
- checkSecurityID() : int
- This method handles the security check for requested images. If this method returns a null-value (empty string, null, false etc) the ImageServer itself is performing the security check. Otherwise the mam file id for the requested file has to be returned
- getAlternativePluginFolder() : array<string|int, mixed>
- getImageFile() : CSFileStream|null
- This method is called by the ImageServer to query the src file of the image that is requested by the url The mam file object may be empty (ID=0).
- getImageSrc() : string
- This method is called by the ImageServer to query the src file of the image that is requested by the url The mam file object may be empty (ID=0).
- 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.
- handleTransformations() : bool
- This method tells the image server whether the plugin itself has handled any transformations depending on the image server parameters. If it returns true, no further transformations are performed by the image server.
- isAvailable() : bool
- This method is called to check, whether the plugin is available.
- onBeforeOperations() : void
- This method is called by the ImageServer before any operation is performed.
- 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 —checkSecurityID()
This method handles the security check for requested images. If this method returns a null-value (empty string, null, false etc) the ImageServer itself is performing the security check. Otherwise the mam file id for the requested file has to be returned
public
checkSecurityID(string $sMamFileID, array<string|int, mixed> $aParameters) : int
Parameters
- $sMamFileID : string
-
The mam file id as passed in the ImageServer url. In most cases consisting of the security id, the mam file id and the project name
- $aParameters : array<string|int, mixed>
-
All parameters of the image server that has been passed in the GET-url
Tags
Return values
int —the id of the requested mam file
getAlternativePluginFolder()
public
static getAlternativePluginFolder() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getImageFile()
This method is called by the ImageServer to query the src file of the image that is requested by the url The mam file object may be empty (ID=0).
public
getImageFile(CSMamFile|MamFile $oMamFile, array<string|int, mixed> $aParameters) : CSFileStream|null
Parameters
- $oMamFile : CSMamFile|MamFile
-
The mam file object for the requested file
- $aParameters : array<string|int, mixed>
-
All parameters of the image server that has been passed in the GET-url
Tags
Return values
CSFileStream|null —The file stream API object.
getImageSrc()
This method is called by the ImageServer to query the src file of the image that is requested by the url The mam file object may be empty (ID=0).
public
getImageSrc(CSMamFile $oMamFile, array<string|int, mixed> $aParameters) : string
Parameters
- $oMamFile : CSMamFile
-
The mam file object for the requested file
- $aParameters : array<string|int, mixed>
-
All parameters of the image server that has been passed in the GET-url
Tags
Return values
string —the src of the requested image
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
handleTransformations()
This method tells the image server whether the plugin itself has handled any transformations depending on the image server parameters. If it returns true, no further transformations are performed by the image server.
public
handleTransformations(CSMamFile $oMamFile, CSFileStream $oImageFile, array<string|int, mixed> $aParameters) : bool
Parameters
- $oMamFile : CSMamFile
-
The mam file object for the requested file
- $oImageFile : CSFileStream
-
The file stream returned by the getImageFile-method
- $aParameters : array<string|int, mixed>
-
All parameters of the image server that has been passed in the GET-url
Tags
Return values
bool —true if no further transformations should be performed, otherwise false (default)
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
onBeforeOperations()
This method is called by the ImageServer before any operation is performed.
public
onBeforeOperations(CSMamFile $oMamFile, array<string|int, mixed> &$aParameters, CSFileStream &$oImageFile, string &$sCacheFile) : void
It can be used to create any other cache folder (if needed) before any operations is triggered or to manipulate the cache file it self.
Parameters
- $oMamFile : CSMamFile
-
The MamFile object which is processes
- $aParameters : array<string|int, mixed>
-
Various ImageServer parameters
- $oImageFile : CSFileStream
-
The file stream returned by the getImageFile-method
- $sCacheFile : string
-
A cache file which is used to apply any operation to.
Tags
Return values
void —resetLoadedPlugins()
reset the internal plugins cache for loaded plugins
public
static resetLoadedPlugins() : mixed