-
Notifications
You must be signed in to change notification settings - Fork 611
/
ImageTransformIndex.php
166 lines (141 loc) · 3.75 KB
/
ImageTransformIndex.php
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
<?php
/**
* @link https://craftcms.com/
* @copyright Copyright (c) Pixel & Tonic, Inc.
* @license https://craftcms.github.io/license/
*/
namespace craft\models;
use craft\base\imagetransforms\ImageTransformerInterface;
use craft\base\Model;
use craft\helpers\ImageTransforms;
use craft\validators\DateTimeValidator;
use DateTime;
use yii\base\InvalidConfigException;
/**
* Class ImageTransformIndex model.
*
* @property ImageTransform $transform
* @author Pixel & Tonic, Inc. <support@pixelandtonic.com>
* @since 4.0.0
*/
class ImageTransformIndex extends Model
{
/**
* @var int|null ID
*/
public ?int $id = null;
/**
* @var int|null Asset ID
*/
public ?int $assetId = null;
/**
* @var string The image transformer
* @phpstan-var class-string<ImageTransformerInterface>
*/
public string $transformer = ImageTransform::DEFAULT_TRANSFORMER;
/**
* @var string|null Filename
*/
public ?string $filename = null;
/**
* @var string|null Format
*/
public ?string $format = null;
/**
* @var string|null Location
*/
public ?string $transformString = null;
/**
* @var bool File exists
*/
public bool $fileExists = false;
/**
* @var bool In progress
*/
public bool $inProgress = false;
/**
* @var bool Transform generation failed
*/
public bool $error = false;
/**
* @var DateTime|null Date indexed
*/
public ?DateTime $dateIndexed = null;
/**
* @var DateTime|null Date updated
*/
public ?DateTime $dateUpdated = null;
/**
* @var DateTime|null Date created
*/
public ?DateTime $dateCreated = null;
/**
* @var string|null Detected format
*/
public ?string $detectedFormat = null;
/**
* @var ImageTransform|null The transform associated with this index
*/
private ?ImageTransform $_transform = null;
/**
* @inheritdoc
*/
public function init(): void
{
parent::init();
// Only respect inProgress if it's been less than 30 seconds since the last time the index was updated
if ($this->inProgress) {
$duration = time() - ($this->dateUpdated?->getTimestamp() ?? 0);
if ($duration > 30) {
$this->inProgress = false;
}
}
}
/**
* @inheritdoc
*/
protected function defineRules(): array
{
$rules = parent::defineRules();
$rules[] = [['id', 'assetId', 'volumeId'], 'number', 'integerOnly' => true];
$rules[] = [['dateIndexed', 'dateUpdated', 'dateCreated'], DateTimeValidator::class];
return $rules;
}
/**
* Use the folder name as the string representation.
*
* @return string
*/
public function __toString(): string
{
return (string)$this->id;
}
/**
* Returns the transform associated with this index.
*
* @return ImageTransform
* @throws InvalidConfigException if [[transformString]] is invalid
*/
public function getTransform(): ImageTransform
{
if (isset($this->_transform)) {
return $this->_transform;
}
if (($this->_transform = ImageTransforms::normalizeTransform($this->transformString)) === null) {
throw new InvalidConfigException('Invalid transform string: ' . $this->transformString);
}
if ($this->format) {
$this->_transform->format = $this->format;
}
return $this->_transform;
}
/**
* Sets the transform associated with this index.
*
* @param ImageTransform $transform
*/
public function setTransform(ImageTransform $transform): void
{
$this->_transform = $transform;
}
}