AbstractImagePreset extends AbstractPreset
Abstract class implements common image preset code
only to be used within EXT:install
Table of Contents
Properties
- $configurationManager : ConfigurationManager
- $configurationValues : array<string|int, mixed>
- $defaultExecutableSearchPaths : array<string|int, mixed>
- $foundPath : string
- $name : string
- $postValues : array<string|int, mixed>
- $priority : int
- $readonlyConfigurationValues : array<string|int, mixed>
Methods
- __construct() : mixed
- getConfigurationValues() : array<string|int, mixed>
- Get configuration values to activate prefix
- getFoundPath() : string
- Path where executable was found
- getIsActive() : bool
- Wrapper for isActive, used in fluid
- getIsAvailable() : bool
- Wrapper for isAvailable, used in fluid
- getName() : string
- Get name of preset
- getPriority() : int
- Get priority of preset
- isActive() : bool
- Check is preset is currently active on the system.
- isAvailable() : bool
- Find out if GraphicsMagick is available
- setPostValues() : mixed
- Set POST values
- cleanUpPath() : string
- Consolidate between Windows and Unix and add trailing slash im missing
- findExecutableInPath() : mixed
- Find executable in path, wrapper for specific ImageMagick/GraphicsMagick find methods.
- getSearchPaths() : array<string|int, mixed>
- Get list of paths to search for image handling executables
Properties
$configurationManager
protected
ConfigurationManager
$configurationManager
$configurationValues
protected
array<string|int, mixed>
$configurationValues
= []
Configuration values handled by this preset
$defaultExecutableSearchPaths
protected
array<string|int, mixed>
$defaultExecutableSearchPaths
= ['/usr/local/bin/', '/opt/local/bin/', '/usr/bin/', '/usr/X11R6/bin/', '/opt/bin/', 'C:/php/ImageMagick/', 'C:/php/GraphicsMagick/', 'C:/apache/ImageMagick/', 'C:/apache/GraphicsMagick/']
Default paths to search for executable, with trailing slash
$foundPath
protected
string
$foundPath
= ''
Absolute path with found executable
$name
protected
string
$name
= ''
Name of preset, must be set by extending classes
$postValues
protected
array<string|int, mixed>
$postValues
= []
List of $POST values
$priority
protected
int
$priority
= 50
Default priority of preset
$readonlyConfigurationValues
protected
array<string|int, mixed>
$readonlyConfigurationValues
= []
Configuration values that are visible but not editable via presets GUI
Methods
__construct()
public
__construct([ConfigurationManager|null $configurationManager = null ]) : mixed
Parameters
- $configurationManager : ConfigurationManager|null = null
getConfigurationValues()
Get configuration values to activate prefix
public
getConfigurationValues() : array<string|int, mixed>
Return values
array<string|int, mixed> —Configuration values needed to activate prefix
getFoundPath()
Path where executable was found
public
getFoundPath() : string
Return values
string —Found path
getIsActive()
Wrapper for isActive, used in fluid
public
getIsActive() : bool
Return values
bool —TRUE if preset is active
getIsAvailable()
Wrapper for isAvailable, used in fluid
public
getIsAvailable() : bool
Return values
bool —TRUE if preset is available
getName()
Get name of preset
public
getName() : string
Return values
string —Name
getPriority()
Get priority of preset
public
getPriority() : int
Return values
int —Priority, usually between 0 and 100
isActive()
Check is preset is currently active on the system.
public
isActive() : bool
Overwrites parent method to ignore processor_path setting
Return values
bool —TRUE if preset is active
isAvailable()
Find out if GraphicsMagick is available
public
isAvailable() : bool
Return values
bool —TRUE if GraphicsMagick executable is found in path
setPostValues()
Set POST values
public
setPostValues(array<string|int, mixed> $postValues) : mixed
Parameters
- $postValues : array<string|int, mixed>
-
Post values of feature
cleanUpPath()
Consolidate between Windows and Unix and add trailing slash im missing
protected
cleanUpPath(string $path) : string
Parameters
- $path : string
-
Given path
Return values
string —Cleaned up path
findExecutableInPath()
Find executable in path, wrapper for specific ImageMagick/GraphicsMagick find methods.
protected
abstract findExecutableInPath(array<string|int, mixed> $searchPaths) : mixed
Parameters
- $searchPaths : array<string|int, mixed>
getSearchPaths()
Get list of paths to search for image handling executables
protected
getSearchPaths() : array<string|int, mixed>
Return values
array<string|int, mixed> —List of paths to search for