rex_effect_insert_image
extends rex_effect_abstract
in package
Branded ein Bild mit einem Wasserzeichen.
Table of Contents
Properties
- $media : rex_managed_media
- $params : array<string, mixed>
- effekt parameter.
Methods
- __construct() : mixed
- execute() : void
- getName() : string
- getParams() : array<int, array{label: string, name: string, type: "int"|"float"|"string"|"select"|"media", default?: mixed, notice?: string, prefix?: string, suffix?: string, attributes?: array, options?: array}>
- Returns a array of array items each describing a spec of a input field with which the enduser can configure parameters for this effect.
- setMedia() : void
- setParams() : void
- keepTransparent() : void
Properties
$media
public
rex_managed_media
$media
$params
effekt parameter.
public
array<string, mixed>
$params
= []
Methods
__construct()
public
__construct() : mixed
execute()
public
execute() : void
getName()
public
getName() : string
Return values
stringgetParams()
Returns a array of array items each describing a spec of a input field with which the enduser can configure parameters for this effect.
public
getParams() : array<int, array{label: string, name: string, type: "int"|"float"|"string"|"select"|"media", default?: mixed, notice?: string, prefix?: string, suffix?: string, attributes?: array, options?: array}>
Example: return [ [ 'label' => rex_i18n::msg('...'), -> a short user-friendly field label 'notice' => rex_i18n::msg('...'), -> additional description. 'name' => 'contrast', -> name of your parameter. this will be the index within $this->params 'type' => 'int', -> scalar storage type 'default' => '', -> default value ], // ... the next input-field spec ];
Return values
array<int, array{label: string, name: string, type: "int"|"float"|"string"|"select"|"media", default?: mixed, notice?: string, prefix?: string, suffix?: string, attributes?: array, options?: array}>setMedia()
public
setMedia(rex_managed_media $media) : void
Parameters
- $media : rex_managed_media
setParams()
public
setParams(array<string, mixed> $params) : void
Parameters
- $params : array<string, mixed>
keepTransparent()
protected
keepTransparent(GdImage $gdImage) : void
Parameters
- $gdImage : GdImage