File Core/src/Filesystem/Thumbnail.php | BEdita API doc

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169

<?php
/**
 * BEdita, API-first content management framework
 * Copyright 2018 ChannelWeb Srl, Chialab Srl
 *
 * This file is part of BEdita: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * See LICENSE.LGPL or <http://gnu.org/licenses/lgpl-3.0.html> for more details.
 */

namespace BEdita\Core\Filesystem;

use BEdita\Core\Filesystem\Exception\InvalidStreamException;
use BEdita\Core\Filesystem\Exception\InvalidThumbnailOptionsException;
use BEdita\Core\Filesystem\Thumbnail\AsyncGenerator;
use BEdita\Core\Filesystem\Thumbnail\GlideGenerator;
use BEdita\Core\Model\Entity\Stream;
use Cake\Core\Configure;
use Cake\Core\StaticConfigTrait;
use Cake\Utility\Hash;

/**
 * High level interface for thumbnails.
 *
 * @since 4.0.0
 */
class Thumbnail
{
    use StaticConfigTrait;

    /**
     * Thumbnail registry.
     *
     * @var \BEdita\Core\Filesystem\ThumbnailRegistry
     */
    protected static $_registry;

    /**
     * An array mapping URL schemes to fully qualified Thumbnail generator class names.
     *
     * @var array
     */
    protected static $_dsnClassMap = [
        'glide' => GlideGenerator::class,
        'async' => AsyncGenerator::class,
    ];

    /**
     * Setter for thumbnails registry.
     *
     * @param \BEdita\Core\Filesystem\ThumbnailRegistry|null $registry Thumbnail generator registry.
     * @return void
     */
    public static function setRegistry(?ThumbnailRegistry $registry = null)
    {
        static::$_registry = $registry;
    }

    /**
     * Getter for thumbnails registry.
     *
     * @return \BEdita\Core\Filesystem\ThumbnailRegistry
     */
    public static function getRegistry()
    {
        if (!isset(static::$_registry)) {
            static::$_registry = new ThumbnailRegistry();
        }

        return static::$_registry;
    }

    /**
     * Get a generator by name.
     *
     * @param string $name Name of generator to get.
     * @return \BEdita\Core\Filesystem\GeneratorInterface
     */
    public static function getGenerator($name)
    {
        $registry = static::getRegistry();

        if ($registry->has($name)) {
            return $registry->get($name);
        }

        return $registry->load($name, static::getConfig($name));
    }

    /**
     * Generate a thumbnail for a stream.
     *
     * @param \BEdita\Core\Model\Entity\Stream $stream Stream to generate thumbnail for.
     * @param string|array $options Preset name, or array of thumbnail options.
     * @return array Generated thumbnail URL and ready status.
     */
    public static function get(Stream $stream, $options = 'default')
    {
        if ($stream->get('private_url')) {
            return [
                'url' => null,
                'ready' => false,
                'acceptable' => false,
            ];
        }
        $options = self::getOptions($options);

        $generator = Hash::get($options, 'generator', 'default');
        unset($options['generator']);

        $generator = static::getGenerator($generator);
        $url = $generator->getUrl($stream, $options);
        $ready = $generator->exists($stream, $options);
        if (!$ready) {
            try {
                $ready = $generator->generate($stream, $options);
            } catch (InvalidStreamException $e) {
                $acceptable = false;
                $message = $e->getMessage();
            }
        }

        $res = compact('url', 'ready');
        if (isset($acceptable, $message)) {
            $res += compact('acceptable', 'message');
        }

        return $res;
    }

    /**
     * Get options for thumbnail generation.
     *
     * @param string|array $options Preset name, or array of options.
     * @return array
     */
    protected static function getOptions($options)
    {
        if (is_string($options)) {
            $key = sprintf('Thumbnails.presets.%s', $options);
            if (!Configure::check($key)) {
                throw new InvalidThumbnailOptionsException(__d('bedita', 'Preset "{0}" not found', $options));
            }
            $options = Configure::read($key);
        } elseif (!Configure::read('Thumbnails.allowAny')) {
            throw new InvalidThumbnailOptionsException(__d('bedita', 'Thumbnails can only be generated for one of the configured presets'));
        }

        return $options;
    }

    /**
     * Delete all generated thumbnails for a stream.
     *
     * @param \BEdita\Core\Model\Entity\Stream $stream Stream to delete thumbnails for.
     * @return void
     */
    public static function delete(Stream $stream)
    {
        $generators = static::configured();
        foreach ($generators as $generator) {
            static::getGenerator($generator)->delete($stream);
        }
    }
}

Namespaces

Classes

Interfaces