1
|
|
|
<?php |
2
|
|
|
/** |
3
|
|
|
* ImageOptimize 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\jobs; |
12
|
|
|
|
13
|
|
|
use nystudio107\imageoptimize\fields\OptimizedImages as OptimizedImagesField; |
14
|
|
|
|
15
|
|
|
use Craft; |
16
|
|
|
use craft\base\ElementInterface; |
17
|
|
|
use craft\base\Field; |
18
|
|
|
use craft\console\Application as ConsoleApplication; |
19
|
|
|
use craft\elements\Asset; |
20
|
|
|
use craft\elements\db\ElementQuery; |
21
|
|
|
use craft\helpers\App; |
22
|
|
|
use craft\queue\BaseJob; |
23
|
|
|
|
24
|
|
|
use nystudio107\imageoptimize\ImageOptimize; |
25
|
|
|
use yii\base\Exception; |
26
|
|
|
|
27
|
|
|
/** |
|
|
|
|
28
|
|
|
* @author nystudio107 |
|
|
|
|
29
|
|
|
* @package ImageOptimize |
|
|
|
|
30
|
|
|
* @since 1.4.8 |
|
|
|
|
31
|
|
|
*/ |
|
|
|
|
32
|
|
|
class ResaveOptimizedImages extends BaseJob |
33
|
|
|
{ |
34
|
|
|
// Properties |
35
|
|
|
// ========================================================================= |
36
|
|
|
|
37
|
|
|
/** |
|
|
|
|
38
|
|
|
* @var array|null The element criteria that determines which elements should be resaved |
39
|
|
|
*/ |
40
|
|
|
public $criteria; |
41
|
|
|
|
42
|
|
|
/** |
|
|
|
|
43
|
|
|
* @var int|null The id of the field to resave images for, or null for all images |
44
|
|
|
*/ |
45
|
|
|
public $fieldId; |
46
|
|
|
|
47
|
|
|
// Public Methods |
48
|
|
|
// ========================================================================= |
49
|
|
|
|
50
|
|
|
/** |
|
|
|
|
51
|
|
|
* @inheritdoc |
52
|
|
|
*/ |
|
|
|
|
53
|
|
|
public function execute($queue) |
54
|
|
|
{ |
55
|
|
|
// Let's save ourselves some trouble and just clear all the caches for this element class |
56
|
|
|
Craft::$app->getTemplateCaches()->deleteCachesByElementType(Asset::class); |
|
|
|
|
57
|
|
|
|
58
|
|
|
// Now find the affected element IDs |
59
|
|
|
/** @var ElementQuery $query */ |
|
|
|
|
60
|
|
|
$query = Asset::find(); |
61
|
|
|
if (!empty($this->criteria)) { |
62
|
|
|
Craft::configure($query, $this->criteria); |
63
|
|
|
} |
64
|
|
|
$query |
65
|
|
|
->offset(null) |
66
|
|
|
->limit(null) |
67
|
|
|
->orderBy(null); |
68
|
|
|
|
69
|
|
|
if (Craft::$app instanceof ConsoleApplication) { |
70
|
|
|
echo $this->description.PHP_EOL; |
71
|
|
|
} |
72
|
|
|
|
73
|
|
|
$totalElements = $query->count(); |
74
|
|
|
$currentElement = 0; |
75
|
|
|
|
76
|
|
|
/** @var ElementInterface $element */ |
|
|
|
|
77
|
|
|
foreach ($query->each() as $element) { |
78
|
|
|
// Find each OptimizedImages field and process it |
79
|
|
|
$layout = $element->getFieldLayout(); |
80
|
|
|
if ($layout !== null) { |
81
|
|
|
$fields = $layout->getFields(); |
82
|
|
|
/** @var $field Field */ |
|
|
|
|
83
|
|
|
foreach ($fields as $field) { |
84
|
|
|
if ($field instanceof OptimizedImagesField && $element instanceof Asset) { |
85
|
|
|
if ($this->fieldId === null || $field->id == $this->fieldId) { |
86
|
|
|
if (Craft::$app instanceof ConsoleApplication) { |
87
|
|
|
echo $currentElement . '/' . $totalElements |
88
|
|
|
. ' - processing asset: ' . $element->title |
89
|
|
|
. ' from field: ' . $field->name . PHP_EOL; |
90
|
|
|
} |
91
|
|
|
try { |
92
|
|
|
ImageOptimize::$plugin->optimizedImages->updateOptimizedImageFieldData($field, $element); |
93
|
|
|
} catch (Exception $e) { |
94
|
|
|
Craft::error($e->getMessage(), __METHOD__); |
95
|
|
|
if (Craft::$app instanceof ConsoleApplication) { |
96
|
|
|
echo '[error]: ' |
97
|
|
|
. $e->getMessage() |
98
|
|
|
. ' while processing ' |
99
|
|
|
. $currentElement . '/' . $totalElements |
100
|
|
|
. ' - processing asset: ' . $element->title |
101
|
|
|
. ' from field: ' . $field->name . PHP_EOL; |
102
|
|
|
} |
103
|
|
|
} |
104
|
|
|
} |
105
|
|
|
} |
106
|
|
|
} |
107
|
|
|
} |
108
|
|
|
$this->setProgress($queue, $currentElement++ / $totalElements); |
109
|
|
|
} |
110
|
|
|
} |
111
|
|
|
|
112
|
|
|
// Protected Methods |
113
|
|
|
// ========================================================================= |
114
|
|
|
|
115
|
|
|
/** |
|
|
|
|
116
|
|
|
* @inheritdoc |
117
|
|
|
*/ |
|
|
|
|
118
|
|
|
protected function defaultDescription(): string |
119
|
|
|
{ |
120
|
|
|
return Craft::t('app', 'Resaving {class} elements', [ |
|
|
|
|
121
|
|
|
'class' => App::humanizeClass(Asset::class), |
122
|
|
|
]); |
|
|
|
|
123
|
|
|
} |
124
|
|
|
} |
125
|
|
|
|