Ansel_Api::getGalleryKeyImage PHP Method

Ansel_Api Class Documentation Show file Open project: horde/horde

getGalleryKeyImage() public method

Returns the id of the specified gallery's key image.

public getGalleryKeyImage ( integer $gallery_id, array $params = [] ) : integer
$gallery_id	integer	The gallery id.
$params	array	Additional parameters: (string)scope Application scope, if not the default (string)style A named style to use, if not ansel_default (string)slug Ignore gallery_id, and use this as the slug
return	integer	The key image id.

    public function getGalleryKeyImage($gallery_id, array $params = array())
    {
        if (!empty($params['scope'])) {
            $GLOBALS['injector']->getInstance('Ansel_Config')->set('scope', $params['scope']);
        }
        if (!empty($params['slug'])) {
            $gallery = $GLOBALS['injector']->getInstance('Ansel_Storage')->getGalleryBySlug($params['slug']);
        } else {
            $gallery = $GLOBALS['injector']->getInstance('Ansel_Storage')->getGallery($gallery_id);
        }
        $style = empty($params['style']) ? Ansel::getStyleDefinition('ansel_default') : Ansel::getStyleDefinition($params['style']);
        return $gallery->getKeyImage($style);
    }

Ansel_Api

_getImageData

browse

commentCallback

count

countGalleries

createGallery

galleryExists

getGalleries

getGalleryKeyImage

getGalleryStyles

getImageContent