Thumbnail
in package
implements
FilterInterface
A thumbnail filter.
Table of Contents
Interfaces
- FilterInterface
- Interface for imagine filters.
Properties
- $filter : string
- $settings : int|string
- $size : BoxInterface
Methods
- __construct() : mixed
- Constructs the Thumbnail filter.
- apply() : ImageInterface
- Applies scheduled transformation to an ImageInterface instance.
Properties
$filter
private
string
$filter
$settings
private
int|string
$settings
$size
private
BoxInterface
$size
Methods
__construct()
Constructs the Thumbnail filter.
public
__construct(BoxInterface $size[, int|string $settings = ImageInterface::THUMBNAIL_INSET ][, string $filter = ImageInterface::FILTER_UNDEFINED ]) : mixed
Parameters
- $size : BoxInterface
- $settings : int|string = ImageInterface::THUMBNAIL_INSET
-
One or more of the ManipulatorInterface::THUMBNAIL_ flags (joined with |). It may be a string for backward compatibility with old constant values that were strings.
- $filter : string = ImageInterface::FILTER_UNDEFINED
-
See ImageInterface::FILTER_... constants
apply()
Applies scheduled transformation to an ImageInterface instance.
public
apply(ImageInterface $image) : ImageInterface
Parameters
- $image : ImageInterface
Tags
Return values
ImageInterface —returns the processed ImageInterface instance