6 * Every database object action providing images for .wcfImageViewer() must implement this interface.
8 * @author Alexander Ebert
9 * @copyright 2001-2019 WoltLab GmbH
10 * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
11 * @package WoltLabSuite\Core\Data
13 interface IImageViewerAction
16 * Validates parameters to load the next images.
18 public function validateLoadNextImages();
21 * Returns a list of images, array indices given for 'images' are discarded (series and series 'url' are optional).
22 * The first response (offset = 0) must return the total number of images.
24 * Each requests contains three parameters:
25 * - offset: number of already loaded image
26 * - maximumHeight: image provided in 'url' must be as close as possible to this value
27 * - maximumWidth: see above
28 * - targetImageID: preload all images which are before the target image id as well as the next X images (optional, always present but might be '0')
30 * Each image can specify a link which should not point to the image itself, instead it should provide a viewable
31 * page directly related to the image (e.g. photo page). The 'fullURL' parameter is optional and results in the
32 * link "View original image" and should lead to the original exceeding lager than the image specified with 'url'.
34 * Expected return value:
40 * [ 'fullURL' => 'http://example.com/path/to/full/image.png', ]
41 * [ 'link' => 'http://example.com/index.php/123-MyImage/', ]
42 * 'title' => 'My first picture',
43 * 'url' => 'http://example.com/path/to/large/image.png',
46 * 'thumbnail' => array(
48 * 'url' => 'http://example.com/path/to/thumbnail.png',
51 * [ 'series' => array(
52 * 'title' => 'My image series,
53 * [ 'link' => 'http://example.com/link/to/image/series/ ]
56 * 'avatarURL' => 'http://link/to/avatar.png',
57 * 'link' => 'http://example.com/index.php/123-FooBar/',
58 * 'username' => 'FooBar'
68 public function loadNextImages();