Backgroundfill

Extends \Joomla\Image\ImageFilter

Image Filter class fill background with color;

deprecated
since

1.0

deprecated

The joomla/image package is deprecated

Methods

__construct

Class constructor.

__construct(resource $handle) 
inherited
since

1.0

throws

\InvalidArgumentException

\RuntimeException

Arguments

$handle

resourceThe image resource on which to apply the filter.

execute

Method to apply a filter to an image resource.

execute(array $options = array()) : void
inherited abstract
since

1.0

Arguments

$options

arrayAn array of options for the filter.

getLogger

Get the logger.

getLogger() : \Psr\Log\LoggerInterface
inherited
since

1.0

Response

\Psr\Log\LoggerInterface

sanitizeColor

Method to sanitize color values and/or convert to an array

sanitizeColor(mixed $input) : array
since

1.0

note

'#FF0000FF' returns an array with alpha of 0 (opaque)

Arguments

$input

mixedAssociative array of colors and alpha, or hex RGBA string when alpha FF is opaque. Defaults to black and opaque alpha

Response

arrayAssociative array of red, green, blue and alpha

setLogger

Sets a logger instance on the object

setLogger(\Psr\Log\LoggerInterface $logger) : \Joomla\Image\Image
inherited
since

1.0

Arguments

$logger

\Psr\Log\LoggerInterfaceA PSR-3 compliant logger.

Response

\Joomla\Image\ImageThis object for message chaining.

Properties

handle

The image resource handle.

inherited
since

1.0

Type(s)

resource

logger

Logger object

inherited
since

1.0

Type(s)

\Psr\Log\LoggerInterface