1
|
|
|
<?php |
2
|
|
|
/** |
3
|
|
|
* Image Optimize plugin for Craft CMS 3.x |
4
|
|
|
* |
5
|
|
|
* Automatically optimize images after they've been transformed |
6
|
|
|
* |
7
|
|
|
* @link https://nystudio107.com |
|
|
|
|
8
|
|
|
* @copyright Copyright (c) 2017 nystudio107 |
|
|
|
|
9
|
|
|
*/ |
|
|
|
|
10
|
|
|
|
11
|
|
|
namespace nystudio107\imageoptimize\variables; |
12
|
|
|
|
13
|
|
|
use nystudio107\imageoptimize\ImageOptimize; |
14
|
|
|
use nystudio107\imageoptimize\imagetransforms\ImageTransformInterface; |
15
|
|
|
use nystudio107\imageoptimize\models\OptimizedImage; |
16
|
|
|
|
17
|
|
|
use craft\elements\Asset; |
18
|
|
|
use craft\helpers\Template; |
19
|
|
|
|
20
|
|
|
/** |
|
|
|
|
21
|
|
|
* @author nystudio107 |
|
|
|
|
22
|
|
|
* @package ImageOptimize |
|
|
|
|
23
|
|
|
* @since 1.4.0 |
|
|
|
|
24
|
|
|
*/ |
|
|
|
|
25
|
|
|
class ImageOptimizeVariable extends ManifestVariable |
26
|
|
|
{ |
27
|
|
|
// Public Methods |
28
|
|
|
// ========================================================================= |
29
|
|
|
|
30
|
|
|
/** |
31
|
|
|
* Render the lazy load JavaScript shim |
32
|
|
|
* |
33
|
|
|
* @param array $scriptAttrs |
|
|
|
|
34
|
|
|
* @param array $variables |
|
|
|
|
35
|
|
|
* @return string |
|
|
|
|
36
|
|
|
*/ |
37
|
|
|
public function renderLazyLoadJs($scriptAttrs = [], $variables = []) |
38
|
|
|
{ |
39
|
|
|
return Template::raw(ImageOptimize::$plugin->optimize->renderLazyLoadJs($scriptAttrs, $variables)); |
40
|
|
|
} |
41
|
|
|
|
42
|
|
|
/** |
43
|
|
|
* Return an SVG box as a placeholder image |
44
|
|
|
* |
45
|
|
|
* @param $width |
|
|
|
|
46
|
|
|
* @param $height |
|
|
|
|
47
|
|
|
* @param string|null $color |
|
|
|
|
48
|
|
|
* |
49
|
|
|
* @return \Twig_Markup|null |
50
|
|
|
*/ |
51
|
|
|
public function placeholderBox($width, $height, $color = null) |
52
|
|
|
{ |
53
|
|
|
return Template::raw(ImageOptimize::$plugin->placeholder->generatePlaceholderBox($width, $height, $color)); |
54
|
|
|
} |
55
|
|
|
|
56
|
|
|
/** |
|
|
|
|
57
|
|
|
* @param Asset $asset |
|
|
|
|
58
|
|
|
* @param array $variants |
|
|
|
|
59
|
|
|
* @param bool $generatePlaceholders |
|
|
|
|
60
|
|
|
* |
61
|
|
|
* @return OptimizedImage|null |
62
|
|
|
*/ |
63
|
|
|
public function createOptimizedImages( |
64
|
|
|
Asset $asset, |
65
|
|
|
$variants = null, |
66
|
|
|
$generatePlaceholders = false |
67
|
|
|
) { |
68
|
|
|
// Override our settings for lengthy operations, since we're doing this via Twig |
69
|
|
|
ImageOptimize::$generatePlaceholders = $generatePlaceholders; |
70
|
|
|
|
71
|
|
|
return ImageOptimize::$plugin->optimizedImages->createOptimizedImages($asset, $variants); |
|
|
|
|
72
|
|
|
} |
73
|
|
|
|
74
|
|
|
/** |
75
|
|
|
* Returns whether `.webp` is a format supported by the server |
76
|
|
|
* |
77
|
|
|
* @return bool |
78
|
|
|
*/ |
79
|
|
|
public function serverSupportsWebP(): bool |
80
|
|
|
{ |
81
|
|
|
$result = false; |
82
|
|
|
$variantCreators = ImageOptimize::$plugin->optimize->getActiveVariantCreators(); |
83
|
|
|
foreach ($variantCreators as $variantCreator) { |
84
|
|
|
if ($variantCreator['creator'] === 'cwebp' && $variantCreator['installed']) { |
85
|
|
|
$result = true; |
86
|
|
|
} |
87
|
|
|
} |
88
|
|
|
|
89
|
|
|
return $result; |
90
|
|
|
} |
91
|
|
|
|
92
|
|
|
/** |
93
|
|
|
* Creates an Image Transform with a given config. |
94
|
|
|
* |
95
|
|
|
* @param mixed $config The Image Transform’s class name, or its config, |
96
|
|
|
* with a `type` value and optionally a `settings` value |
97
|
|
|
* |
98
|
|
|
* @return null|ImageTransformInterface The Image Transform |
99
|
|
|
*/ |
100
|
|
|
public function createImageTransformType($config): ImageTransformInterface |
101
|
|
|
{ |
102
|
|
|
return ImageOptimize::$plugin->optimize->createImageTransformType($config); |
103
|
|
|
} |
104
|
|
|
|
105
|
|
|
/** |
106
|
|
|
* Return whether we are running Craft 3.1 or later |
107
|
|
|
* |
108
|
|
|
* @return bool |
109
|
|
|
*/ |
110
|
|
|
public function craft31(): bool |
111
|
|
|
{ |
112
|
|
|
return ImageOptimize::$craft31; |
113
|
|
|
} |
114
|
|
|
} |
115
|
|
|
|