API Documentation
\

\Ansel_ImageGenerator_Screen

ImageGenerator to create the screen view - image sized for slideshow view.

New thumbnail generators can be dropped in and will be made available by Ansel providing:

  1. The class name is as: AnselImageGenerator{type}Thumb and filename matches, i.e. {type}Thumb.php where {type} is the unique name for your thumbnail type.

  2. Implements a _create() method that applies the effects to the image (see existing generators for how this works).

  3. If a matching "stack" generator is desired, that should be named similarly: AnselImageGenerator{type}ThumbStack with matching filename: {type}ThumbStack.php

Copyright 2007-2017 Horde LLC (http://www.horde.org/)

See the enclosed file LICENSE for license information (GPL). If you did not receive this file, see http://www.horde.org/licenses/gpl.

Summary

Methods
Properties
Constants
__construct()
create()
factory()
$need
$title
No constants found
_getStackImages()
_create()
$_image
$_params
$_dimensions
$_style
N/A
No private methods found
No private properties found
N/A

Properties

$need

$need : array

Array of required, supported features for this ImageGenerator to work

Type

array

$title

$title : string

Human readable title for this thumbnail style.

Type

string

$_image

$_image : \Ansel_Image

Ansel_Image object that this view is created from.

Type

\Ansel_Image

$_params

$_params : array

Parameters for this view

Type

array

$_dimensions

$_dimensions : array

Image dimensions

Type

array

$_style

$_style : \Ansel_Style

Cache the style

Type

\Ansel_Style

Methods

__construct()

__construct(  $params) : \Horde_ImageGenerator

Const'r

Parameters

$params

Returns

\Horde_ImageGenerator

create()

create() : mixed

Create and cache the view.

Returns

mixed —

Views used as gallery key images return Horde_Image, other views return boolean

factory()

factory(string  $type, array  $params = array()) : \Ansel_ImageGenerator

Horde_ImageGenerator factory

Parameters

string $type

The type of concrete instance to return.
array $params

Additional parameters needed for the instance.

Throws

\Ansel_Exception

Returns

\Ansel_ImageGenerator

_getStackImages()

_getStackImages() : array

Utility function to return an array of Horde_Images to use in building a stack. Returns a random set of 5 images from the gallery, or the explicitly set key image plus 4 others.

Returns

array —

An array of Horde_Image objects.

_create()

_create() : boolean

Returns

boolean