Class Version

A thumbnail version.

ICanBoogie\Modules\Thumbnailer\Version implements ICanBoogie\ToArray

Namespace: ICanBoogie\Modules\Thumbnailer
Located at vendor/icanboogie-modules/thumbnailer/lib/version.php

Methods summary

`public static ICanBoogie\Modules\Thumbnailer\Version`	# `from_uri( string $uri )` Returns version options extracted from the URI. Returns version options extracted from the URI. Options are extracted from the pathinfo (`width`, `height`, `method`, and `format`) as well as from the query string. Parameters `$uri` `string` $uri The URI from which options should be extracted. Returns `ICanBoogie\Modules\Thumbnailer\Version`
`public static array`	# `normalize( array $options )` Normalizes thumbnail options. Normalizes thumbnail options. Parameters `$options` `array` $options Returns `array`
`public static array`	# `filter( array $options )` Filter thumbnail options. Filter thumbnail options. Options than match default values are removed. The options are normalized using normalize_options() before they are filtered. Parameters `$options` `array` $options Returns `array` The filtered thumbnail options.
`public static array`	# `shorten( array $options )` Shorten option names. Shorten option names. Note: Extraneous options are not filtered. Parameters `$options` `array` $options Returns `array`
`public static array`	# `widen( array $options )` Widen option names. Widen option names. Note: Extraneous options are not filtered. Parameters `$options` `array` $options Returns `array`
`public static array`	# `unserialize( string $serialized_options )` Unserialize serialized options. Unserialize serialized options. Parameters `$serialized_options` `string` $serialized_options Returns `array`
`public static string`	# `serialize( array $options )` Serializes options. Serializes options. Parameters `$options` `array` $options Returns `string`
`public`	# `__construct( string\|array $options )` Initializes and normalizes options. Initializes and normalizes options. Parameters `$options` `string\|array` $options
`public mixed`	# `__get( string $property )` Returns an option's value. Returns an option's value. Parameters `$property` `string` $property Returns `mixed`
`public`	# `__set( string $property, mixed $value )` Sets an option's value. Sets an option's value. Parameters `$property` `string` $property `$value` `mixed` $value
`public string`	# `__toString( )` Returns a string representation of the instance. Returns a string representation of the instance. Returns `string` See `ICanBoogie\Modules\Thumbnailer\Version::serialize()`
`public array`	# `to_array( integer $flags = 0 )` Returns the instance as an array. Returns the instance as an array. Parameters `$flags` `integer` $flags A bitmask of one or more of the following flags: - `ICanBoogie\Modules\Thumbnailer\Version::ARRAY_FILTER` The options are filtered with `ICanBoogie\Modules\Thumbnailer\Version::filter()`. - `ICanBoogie\Modules\Thumbnailer\Version::ARRAY_SHORTEN` The options are shortened with `ICanBoogie\Modules\Thumbnailer\Version::shorten()`. Returns `array` Implementation of `ICanBoogie\ToArray::to_array()`

Magic methods summary

Constants summary

`integer`	`ARRAY_SHORTEN`	`1`	# Option for the `ICanBoogie\Modules\Thumbnailer\Version::to_array()` method. Option for the `ICanBoogie\Modules\Thumbnailer\Version::to_array()` method.
`integer`	`ARRAY_FILTER`	`2`	# Option for the `ICanBoogie\Modules\Thumbnailer\Version::to_array()` method. Option for the `ICanBoogie\Modules\Thumbnailer\Version::to_array()` method.

Properties summary

`public static array[string]mixed`	`$defaults`	# Options and their default value. Options and their default value.
`public static array[string]string`	`$shorthands`	# Options shorthands. Options shorthands.
`protected mixed`	`$options`	#

Magic properties

`public string`	`$background`	# Thumbnail background. Defaults to "transparent". Thumbnail background. Defaults to "transparent".
`public string`	`$default`	# Thumbnail fallback image. Defaults to `null`. Thumbnail fallback image. Defaults to `null`.
`public string`	`$format`	# Thumbnail format. Defaults to "jpeg". Thumbnail format. Defaults to "jpeg".
`public string`	`$filter`	# Thumbnail filter. Defaults to `null`. Thumbnail filter. Defaults to `null`.
`public integer`	`$height`	# Thumbnail height. Defaults to `null`. Thumbnail height. Defaults to `null`.
`public string`	`$method`	# Thumbnail resizing method. Default to "fill". Thumbnail resizing method. Default to "fill".
`public boolean`	`$no_interlace`	# Should the thumbnail not be interlaced. Default to `false`. Should the thumbnail not be interlaced. Default to `false`.
`public boolean`	`$no_upscale`	# Should the thumbnail not be upscaled. Default to `false`. Should the thumbnail not be upscaled. Default to `false`.
`public string`	`$overlay`	# Thumbnail overlay path. Defaults to `null`. Thumbnail overlay path. Defaults to `null`.
`public string`	`$path`	# Path to the directory of the source image. Defaults to `null`. Path to the directory of the source image. Defaults to `null`.
`public integer`	`$quality`	# Quality of the compression. Only applicable to JPEG. Defaults to 85. Quality of the compression. Only applicable to JPEG. Defaults to 85.
`public string`	`$src`	# Path to the source image. Defaults to `null`. Path to the source image. Defaults to `null`.
`public integer`	`$width`	# The width of the image. Defaults to `null`. The width of the image. Defaults to `null`.
`public string`	`$b`	# Alias to $background. Alias to $background.
`public string`	`$d`	# Alias to $default. Alias to $default.
`public string`	`$f`	# Alias to $format. Alias to $format.
`public string`	`$ft`	# Alias to $filter. Alias to $filter.
`public integer`	`$h`	# Alias to $height. Alias to $height.
`public string`	`$m`	# Alias to $method. Alias to $method.
`public boolean`	`$ni`	# Alias to $no_interlace. Alias to $no_interlace.
`public boolean`	`$nu`	# Alias to $no_upscale. Alias to $no_upscale.
`public string`	`$o`	# Alias to $overlay. Alias to $overlay.
`public string`	`$p`	# Alias to $path. Alias to $path.
`public integer`	`$q`	# Alias to $quality. Alias to $quality.
`public string`	`$s`	# Alias to $src. Alias to $src.
`public string`	`$w`	# alias to $width. alias to $width.

Namespaces

Classes

Exceptions

Constants

Class Version

Methods summary

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

See

Parameters

Returns

Implementation of

Magic methods summary

Constants summary

Properties summary

Magic properties