ThumbHelper::initialize() - Code Metrics - Inspection of "Introduce cache for ThumbHelper" - bedita/web-tools - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#41)

by Paolo

created 2021-05-05 14:40 UTC

ThumbHelper::initialize() A

↳ Parent: ThumbHelper

Complexity

Conditions	2
Paths	2

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	2
nc	2
nop	1
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php
declare(strict_types=1);

/**
 * BEdita, API-first content management framework
 * Copyright 2019 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\WebTools\View\Helper;

use BEdita\WebTools\ApiClientProvider;
use Cake\Cache\Cache;
use Cake\Log\LogTrait;
use Cake\Utility\Hash;
use Cake\View\Helper;

/**
 * Helper to obtain thumbnail url
 */
class ThumbHelper extends Helper
{
    use LogTrait;

    /**
     * Default config for this helper.
     *
     * @var array
     */
    protected $_defaultConfig = [
        'cache' => '_thumbs_',
    ];

    /**
     * @var int Thumb not available
     */
    public const NOT_AVAILABLE = -10;

    /**
     * @var int Thumb not ready
     */
    public const NOT_READY = -20;

    /**
     * @var int Thumb not acceptable
     */
    public const NOT_ACCEPTABLE = -30;

    /**
     * @var int Thumb has no url
     */
    public const NO_URL = -40;

    /**
     * @var int Thumb is OK
     */
    public const OK = 1;

    /**
     * Use 'default' as fallback if no cache configuration is found.
     *
     * @param array $config The configuration settings provided to this helper.
     * @return void
     */
    public function initialize(array $config): void
    {
        if (Cache::getConfig($this->getConfig('cache')) === null) {
            $this->setConfig('cache', 'default');
        }
    }

    /**
     * Verify status of image thumb.
     * Return int representing status.
     * Possible values:
     *
     *   NOT_AVAILABLE: something went wrong during api call
     *   NOT_READY: thumb is available, but not ready
     *   NOT_ACCEPTABLE: image is not acceptable, api won't create thumb
     *   NO_URL: url not present in api response
     *   OK: thumb available, ready and with a proper url
     *
     * @param int|string $imageId The image ID
     * @param array|null $options The thumbs options
     * @param string|null $url The thumb url to populate when static::OK
     * @return int|null
     */
    public function status($imageId, ?array $options = ['preset' => 'default'], &$url = ''): ?int
    {
        if (empty($imageId) && empty($options['ids'])) {
            return static::NOT_ACCEPTABLE;
        }
        try {
            $apiClient = ApiClientProvider::getApiClient();
            $response = $apiClient->thumbs($imageId, $options);
            if (empty($response['meta']['thumbnails'][0])) {
                return static::NOT_AVAILABLE;
            }
            $thumb = $response['meta']['thumbnails'][0];
            // check thumb is ready
            if (!$this->isReady($thumb)) {
                return static::NOT_READY;
            }
            // check thumb is acceptable
            if (!$this->isAcceptable($thumb)) {
                return static::NOT_ACCEPTABLE;
            }
            // check thumb has url
            if (!$this->hasUrl($thumb)) {
                return static::NO_URL;
            }
            $url = $thumb['url'];
        } catch (\Exception $e) {
            $this->log($e->getMessage(), 'error');

            return static::NOT_AVAILABLE;
        }

        return static::OK;
    }

    /**
     * Obtain thumbnail using API thumbs.
     *
     * @param int $imageId The image ID.
     * @param array|null $options The thumbs options.
     * @return string|int The url if available, the status code otherwise (see Thumb constants).
     */
    public function url($imageId, $options)
    {
        $url = null;
        $status = $this->status($imageId, $options, $url);
        if ($status === static::OK) {
            return $url;
        }

        return $status;
    }

    /**
     * Verify if thumb is acceptable
     *
     * @param array $thumb The thumbnail data
     * @return bool the acceptable flag
     */
    private function isAcceptable($thumb = []): bool
    {
        if (isset($thumb['acceptable']) && $thumb['acceptable'] === false) {
            return false;
        }

        return true;
    }

    /**
     * Verify if thumb is ready
     *
     * @param array $thumb The thumbnail data
     * @return bool the ready flag
     */
    private function isReady($thumb = []): bool
    {
        if (!empty($thumb['ready']) && $thumb['ready'] === true) {
            return true;
        }

        return false;
    }

    /**
     * Verify if thumb has url
     *
     * @param array $thumb The thumbnail data
     * @return bool the url availability
     */
    private function hasUrl($thumb = []): bool
    {
        if (!empty($thumb['url'])) {
            return true;
        }

        return false;
    }

    /**
     * Retrieve thumb URL using cache.
     * Silently fail with log if no image 'id' is found in array.
     *
     * @param  array  $image   Image object array containing at least `id`
     * @param  string $options Thumb options
     * @return string
     */
    public function getUrl(array $image, array $options = []): string
    {
        if (empty($image['id'])) {
            $this->log(sprintf('Missing image ID - %s', json_encode($image)), 'warning');

            return '';
        }
        $thumbHash = md5((string)Hash::get($image, 'meta.media_url') . json_encode($options));
        $key = sprintf('%d_%s', $image['id'], $thumbHash);

        return (string)Cache::remember(
            $key,
            function () use ($image, $options) {
                return $this->url($image['id'], $options);
            },
            $this->getConfig('cache')
        );
    }
}


1			<?php
2			declare(strict_types=1);
3
4			/**
5			* BEdita, API-first content management framework
6			* Copyright 2019 ChannelWeb Srl, Chialab Srl
7			*
8			* This file is part of BEdita: you can redistribute it and/or modify
9			* it under the terms of the GNU Lesser General Public License as published
10			* by the Free Software Foundation, either version 3 of the License, or
11			* (at your option) any later version.
12			*
13			* See LICENSE.LGPL or <http://gnu.org/licenses/lgpl-3.0.html> for more details.
14			*/
15			namespace BEdita\WebTools\View\Helper;
16
17			use BEdita\WebTools\ApiClientProvider;
18			use Cake\Cache\Cache;
19			use Cake\Log\LogTrait;
20			use Cake\Utility\Hash;
21			use Cake\View\Helper;
22
23			/**
24			* Helper to obtain thumbnail url
25			*/
26			class ThumbHelper extends Helper
27			{
28			use LogTrait;
29
30			/**
31			* Default config for this helper.
32			*
33			* @var array
34			*/
35			protected $_defaultConfig = [
36			'cache' => '_thumbs_',
37			];
38
39			/**
40			* @var int Thumb not available
41			*/
42			public const NOT_AVAILABLE = -10;
43
44			/**
45			* @var int Thumb not ready
46			*/
47			public const NOT_READY = -20;
48
49			/**
50			* @var int Thumb not acceptable
51			*/
52			public const NOT_ACCEPTABLE = -30;
53
54			/**
55			* @var int Thumb has no url
56			*/
57			public const NO_URL = -40;
58
59			/**
60			* @var int Thumb is OK
61			*/
62			public const OK = 1;
63
64			/**
65			* Use 'default' as fallback if no cache configuration is found.
66			*
67			* @param array $config The configuration settings provided to this helper.
68			* @return void
69			*/
70			public function initialize(array $config): void
71			{
72			if (Cache::getConfig($this->getConfig('cache')) === null) {
73			$this->setConfig('cache', 'default');
74			}
75			}
76
77			/**
78			* Verify status of image thumb.
79			* Return int representing status.
80			* Possible values:
81			*
82			* NOT_AVAILABLE: something went wrong during api call
83			* NOT_READY: thumb is available, but not ready
84			* NOT_ACCEPTABLE: image is not acceptable, api won't create thumb
85			* NO_URL: url not present in api response
86			* OK: thumb available, ready and with a proper url
87			*
88			* @param int\|string $imageId The image ID
89			* @param array\|null $options The thumbs options
90			* @param string\|null $url The thumb url to populate when static::OK
91			* @return int\|null
92			*/
93			public function status($imageId, ?array $options = ['preset' => 'default'], &$url = ''): ?int
94			{
95			if (empty($imageId) && empty($options['ids'])) {
96			return static::NOT_ACCEPTABLE;
97			}
98			try {
99			$apiClient = ApiClientProvider::getApiClient();
100			$response = $apiClient->thumbs($imageId, $options);
101			if (empty($response['meta']['thumbnails'][0])) {
102			return static::NOT_AVAILABLE;
103			}
104			$thumb = $response['meta']['thumbnails'][0];
105			// check thumb is ready
106			if (!$this->isReady($thumb)) {
107			return static::NOT_READY;
108			}
109			// check thumb is acceptable
110			if (!$this->isAcceptable($thumb)) {
111			return static::NOT_ACCEPTABLE;
112			}
113			// check thumb has url
114			if (!$this->hasUrl($thumb)) {
115			return static::NO_URL;
116			}
117			$url = $thumb['url'];
118			} catch (\Exception $e) {
119			$this->log($e->getMessage(), 'error');
120
121			return static::NOT_AVAILABLE;
122			}
123
124			return static::OK;
125			}
126
127			/**
128			* Obtain thumbnail using API thumbs.
129			*
130			* @param int $imageId The image ID.
131			* @param array\|null $options The thumbs options.
132			* @return string\|int The url if available, the status code otherwise (see Thumb constants).
133			*/
134			public function url($imageId, $options)
135			{
136			$url = null;
137			$status = $this->status($imageId, $options, $url);
138			if ($status === static::OK) {
139			return $url;
140			}
141
142			return $status;
143			}
144
145			/**
146			* Verify if thumb is acceptable
147			*
148			* @param array $thumb The thumbnail data
149			* @return bool the acceptable flag
150			*/
151			private function isAcceptable($thumb = []): bool
152			{
153			if (isset($thumb['acceptable']) && $thumb['acceptable'] === false) {
154			return false;
155			}
156
157			return true;
158			}
159
160			/**
161			* Verify if thumb is ready
162			*
163			* @param array $thumb The thumbnail data
164			* @return bool the ready flag
165			*/
166			private function isReady($thumb = []): bool
167			{
168			if (!empty($thumb['ready']) && $thumb['ready'] === true) {
169			return true;
170			}
171
172			return false;
173			}
174
175			/**
176			* Verify if thumb has url
177			*
178			* @param array $thumb The thumbnail data
179			* @return bool the url availability
180			*/
181			private function hasUrl($thumb = []): bool
182			{
183			if (!empty($thumb['url'])) {
184			return true;
185			}
186
187			return false;
188			}
189
190			/**
191			* Retrieve thumb URL using cache.
192			* Silently fail with log if no image 'id' is found in array.
193			*
194			* @param array $image Image object array containing at least `id`
195			* @param string $options Thumb options
196			* @return string
197			*/
198			public function getUrl(array $image, array $options = []): string
199			{
200			if (empty($image['id'])) {
201			$this->log(sprintf('Missing image ID - %s', json_encode($image)), 'warning');
202
203			return '';
204			}
205			$thumbHash = md5((string)Hash::get($image, 'meta.media_url') . json_encode($options));
206			$key = sprintf('%d_%s', $image['id'], $thumbHash);
207
208			return (string)Cache::remember(
209			$key,
210			function () use ($image, $options) {
211			return $this->url($image['id'], $options);
212			},
213			$this->getConfig('cache')
214			);
215			}
216			}
217

bedita / web-tools

Pull Request — master (#41)

ThumbHelper::initialize() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like