├── CropImageAction.php
├── DeleteImageAction.php
├── FormImageWidget.php
├── ImageUploaderBehavior.php
├── LICENSE
├── README.md
└── composer.json
/CropImageAction.php:
--------------------------------------------------------------------------------
1 |
7 | */
8 |
9 | namespace demi\image;
10 |
11 | use Yii;
12 | use Closure;
13 | use yii\base\Action;
14 | use yii\base\InvalidParamException;
15 | use yii\db\ActiveRecord;
16 | use yii\web\ForbiddenHttpException;
17 | use yii\web\NotFoundHttpException;
18 | use yii\web\Response;
19 |
20 | /**
21 | * Standalone action for crop uploaded image
22 | *
23 | * @package demi\image
24 | */
25 | class CropImageAction extends Action
26 | {
27 | /** @var string ClassName of AR model */
28 | public $modelClass;
29 | /** @var string Name for x-offset request param */
30 | public $leftParamName = 'x';
31 | /** @var string Name for y-offset request param */
32 | public $topParamName = 'y';
33 | /** @var string Name for width request param */
34 | public $widthParamName = 'width';
35 | /** @var string Name for height request param */
36 | public $heightParamName = 'height';
37 | /** @var string Name for rotate request param */
38 | public $rotateParamName = 'rotate';
39 | /** @var Closure|bool Closure function to check user access to delete model image */
40 | public $canCrop = true;
41 | /** @var Closure|array|string Closure function to get redirect url on after delete image */
42 | public $redirectUrl;
43 | /** @var Closure|null Closure function to get custom response on after delete image */
44 | public $afterCrop;
45 |
46 | public function run()
47 | {
48 | /* @var $model ActiveRecord|ImageUploaderBehavior */
49 | $model = new $this->modelClass;
50 |
51 | $request = Yii::$app->request;
52 | $pk = $model->getTableSchema()->primaryKey;
53 | $attributes = [];
54 | // forming search condition
55 | foreach ($pk as $primaryKey) {
56 | $pkValue = static::_getRequestParam($primaryKey);
57 | if ($pkValue === null) {
58 | throw new InvalidParamException('You must specify "' . $primaryKey . '" param');
59 | }
60 | $attributes[$primaryKey] = $pkValue;
61 | }
62 |
63 | $x = static::_getRequestParam($this->leftParamName, 0);
64 | $y = static::_getRequestParam($this->topParamName, 0);
65 | $width = static::_getRequestParam($this->widthParamName);
66 | $height = static::_getRequestParam($this->heightParamName);
67 | $rotate = static::_getRequestParam($this->rotateParamName);
68 | if ($width === null || $height === null) {
69 | throw new InvalidParamException("You must specify '{$this->widthParamName}' and '{$this->heightParamName}' params");
70 | }
71 |
72 | $model = $model->find()->where($attributes)->one();
73 |
74 | if (!$model) {
75 | throw new NotFoundHttpException('The requested model does not exist.');
76 | }
77 |
78 | $canCrop = $this->canCrop instanceof Closure ? call_user_func($this->canCrop, $model) : $this->canCrop;
79 | if (!$canCrop) {
80 | throw new ForbiddenHttpException('You are not allowed to crop an image');
81 | }
82 |
83 | // Image deletion
84 | $model->cropImage($x, $y, $width, $height, $rotate);
85 |
86 | // if exist custom response function
87 | if (is_callable($this->afterCrop)) {
88 | return call_user_func($this->afterCrop, $model);
89 | }
90 |
91 | $response = Yii::$app->response;
92 | // if is AJAX request
93 | if ($request->isAjax) {
94 | $response->getHeaders()->set('Vary', 'Accept');
95 | $response->format = Response::FORMAT_JSON;
96 |
97 | return ['status' => 'success'];
98 | }
99 |
100 | $url = $this->redirectUrl instanceof Closure ? call_user_func($this->redirectUrl, $model) : $this->redirectUrl;
101 |
102 | return $response->redirect($url);
103 | }
104 |
105 | /**
106 | * Return param by name from $_POST or $_GET. Post priority
107 | *
108 | * @param string $name
109 | * @param mixed|null $defaultValue
110 | *
111 | * @return array|mixed|null
112 | */
113 | private static function _getRequestParam($name, $defaultValue = null)
114 | {
115 | $value = $defaultValue;
116 | $request = Yii::$app->request;
117 |
118 | $get = $request->get($name, $defaultValue);
119 | $post = $request->post($name, $defaultValue);
120 |
121 | if ($post !== $defaultValue) {
122 | return $post;
123 | } elseif ($get !== $defaultValue) {
124 | return $get;
125 | }
126 |
127 | return $value;
128 | }
129 | }
130 |
--------------------------------------------------------------------------------
/DeleteImageAction.php:
--------------------------------------------------------------------------------
1 |
7 | */
8 |
9 | namespace demi\image;
10 |
11 | use Yii;
12 | use Closure;
13 | use yii\base\Action;
14 | use yii\base\InvalidParamException;
15 | use yii\db\ActiveRecord;
16 | use yii\web\ForbiddenHttpException;
17 | use yii\web\NotFoundHttpException;
18 | use yii\web\Response;
19 |
20 | /**
21 | * Standalone action for delete uploaded image
22 | *
23 | * @package demi\image
24 | */
25 | class DeleteImageAction extends Action
26 | {
27 | /** @var string ClassName of AR model */
28 | public $modelClass;
29 | /** @var Closure|bool Closure function to check user access to delete model image */
30 | public $canDelete = true;
31 | /** @var Closure|array|string Closure function to get redirect url on after delete image */
32 | public $redirectUrl;
33 | /** @var Closure|null Closure function to get custom response on after delete image */
34 | public $afterDelete;
35 |
36 | public function run()
37 | {
38 | /* @var $model ActiveRecord|ImageUploaderBehavior */
39 | $model = new $this->modelClass;
40 |
41 | $request = Yii::$app->request;
42 | $pk = $model->getTableSchema()->primaryKey;
43 | $attributes = [];
44 | // forming search condition
45 | foreach ($pk as $primaryKey) {
46 | $pkValue = static::_getRequestParam($primaryKey);
47 | if ($pkValue === null) {
48 | throw new InvalidParamException('You must specify "' . $primaryKey . '" param');
49 | }
50 | $attributes[$primaryKey] = $pkValue;
51 | }
52 |
53 | $model = $model->find()->where($attributes)->one();
54 |
55 | if (!$model) {
56 | throw new NotFoundHttpException('The requested model does not exist.');
57 | }
58 |
59 | $canDelete = $this->canDelete instanceof Closure ? call_user_func($this->canDelete, $model) : $this->canDelete;
60 | if (!$canDelete) {
61 | throw new ForbiddenHttpException('You are not allowed to delete an image');
62 | }
63 |
64 | // Image deletion
65 | $model->deleteImage(true);
66 |
67 | // if exist custom response function
68 | if (is_callable($this->afterDelete)) {
69 | return call_user_func($this->afterDelete, $model);
70 | }
71 |
72 | $response = Yii::$app->response;
73 | // if is AJAX request
74 | if ($request->isAjax) {
75 | $response->getHeaders()->set('Vary', 'Accept');
76 | $response->format = Response::FORMAT_JSON;
77 |
78 | return ['status' => 'success'];
79 | }
80 |
81 | $url = $this->redirectUrl instanceof Closure ? call_user_func($this->redirectUrl, $model) : $this->redirectUrl;
82 |
83 | return $response->redirect($url);
84 | }
85 |
86 | /**
87 | * Return param by name from $_POST or $_GET. Post priority
88 | *
89 | * @param string $name
90 | * @param mixed|null $defaultValue
91 | *
92 | * @return array|mixed|null
93 | */
94 | private static function _getRequestParam($name, $defaultValue = null)
95 | {
96 | $value = $defaultValue;
97 | $request = Yii::$app->request;
98 |
99 | $get = $request->get($name, $defaultValue);
100 | $post = $request->post($name, $defaultValue);
101 |
102 | if ($post !== $defaultValue) {
103 | return $post;
104 | } elseif ($get !== $defaultValue) {
105 | return $get;
106 | }
107 |
108 | return $value;
109 | }
110 | }
111 |
--------------------------------------------------------------------------------
/FormImageWidget.php:
--------------------------------------------------------------------------------
1 |
7 | */
8 |
9 | namespace demi\image;
10 |
11 | use Yii;
12 | use yii\helpers\Url;
13 | use yii\helpers\Html;
14 | use yii\db\ActiveRecord;
15 | use demi\cropper\Cropper;
16 | use yii\web\JsExpression;
17 | use yii\widgets\InputWidget;
18 |
19 | /**
20 | * Show uploaded image in the form
21 | */
22 | class FormImageWidget extends InputWidget
23 | {
24 | public $imageSrc;
25 | public $deleteUrl;
26 | public $cropUrl;
27 | public $cropPluginOptions = [];
28 | public $messages = [];
29 |
30 | public function init()
31 | {
32 | parent::init();
33 |
34 | if (empty($this->messages['formats'])) {
35 | $this->messages['formats'] = 'Supported formats: {formats}';
36 | }
37 | if (empty($this->messages['fileSize'])) {
38 | $this->messages['fileSize'] = 'Maximum file size: {formattedSize}';
39 | }
40 | if (empty($this->messages['deleteBtn'])) {
41 | $this->messages['deleteBtn'] = 'Delete';
42 | }
43 | if (empty($this->messages['deleteConfirmation'])) {
44 | $this->messages['deleteConfirmation'] = 'Are you sure you want to delete the image?';
45 | }
46 | if (empty($this->messages['cropBtn'])) {
47 | $this->messages['cropBtn'] = 'Crop';
48 | }
49 |
50 | // Crop widget messages
51 | if (empty($this->messages['cropModalTitle'])) {
52 | $this->messages['cropModalTitle'] = 'Select crop area and click "Crop" button';
53 | }
54 | if (empty($this->messages['closeModalBtn'])) {
55 | $this->messages['closeModalBtn'] = 'Close';
56 | }
57 | if (empty($this->messages['cropModalBtn'])) {
58 | $this->messages['cropModalBtn'] = 'Crop selected';
59 | }
60 | }
61 |
62 | public function run()
63 | {
64 | /* @var $model ActiveRecord|ImageUploaderBehavior */
65 | $model = $this->model;
66 | /* @var $behavior ImageUploaderBehavior */
67 | $behavior = $model->getImageBehavior();
68 |
69 | $wigetId = $this->id;
70 | $img_hint = '
';
71 | // Yii::$app->formatter->asShortSize($this->getSizeLimit())
72 | $img_hint .= str_replace('{formats}', $behavior->getImageConfigParam('fileTypes'), $this->messages['formats']);
73 | $img_hint .= '
';
74 | $maxFileSize = $behavior->getImageConfigParam('maxFileSize');
75 | $img_hint .= str_replace('{formattedSize}', Yii::$app->formatter->asShortSize($maxFileSize),
76 | $this->messages['fileSize']);
77 | $img_hint .= '
';
78 |
79 | $imageVal = $model->getAttribute($behavior->getImageConfigParam('imageAttribute'));
80 | if (!$model->isNewRecord && !empty($imageVal)) {
81 | $img_hint .= '';
82 | $img_hint .= '
';
83 | $img_hint .= Html::img($this->imageSrc, ['class' => 'pull-left uploaded-image-preview']);
84 | // $img_hint .= '
';
85 | $img_hint .= '
';
86 | $img_hint .= Html::a($this->messages['deleteBtn'] . '
', '#',
87 | [
88 | 'onclick' => new JsExpression('
89 | if (!confirm(" ' . $this->messages['deleteConfirmation'] . '")) {
90 | return false;
91 | }
92 |
93 | $.ajax({
94 | type: "post",
95 | cache: false,
96 | url: "' . Url::to($this->deleteUrl) . '",
97 | success: function() {
98 | $("#' . $wigetId . '").remove();
99 | }
100 | });
101 |
102 | return false;
103 | '),
104 | 'class' => 'btn btn-danger',
105 | ]);
106 |
107 | if (!empty($this->cropUrl)) {
108 | Yii::$app->response->headers->add('Access-Control-Allow-Origin', '*');
109 | $pluginOptions = $this->cropPluginOptions;
110 | $validatorParams = $behavior->getImageConfigParam('imageValidatorParams');
111 | if (isset($validatorParams['minWidth'])) {
112 | $pluginOptions['minCropBoxWidth'] = $validatorParams['minWidth'];
113 | }
114 | if (isset($validatorParams['minHeight'])) {
115 | $pluginOptions['minCropBoxHeight'] = $validatorParams['minHeight'];
116 | }
117 |
118 | $img_hint .= Cropper::widget([
119 | 'modal' => true,
120 | 'cropUrl' => $this->cropUrl,
121 | 'image' => ImageUploaderBehavior::addPostfixToFile($model->getImageSrc(), '_original'),
122 | 'aspectRatio' => $behavior->getImageConfigParam('aspectRatio'),
123 | 'pluginOptions' => $pluginOptions,
124 | 'messages' => $this->messages,
125 | 'ajaxOptions' => [
126 | 'success' => new JsExpression(<<
getImageConfigParam('imageAttribute');
143 |
144 | return Html::activeFileInput($model, $imgAttr) . $img_hint;
145 | }
146 | }
147 |
--------------------------------------------------------------------------------
/ImageUploaderBehavior.php:
--------------------------------------------------------------------------------
1 |
7 | */
8 |
9 | namespace demi\image;
10 |
11 | use Yii;
12 | use yii\base\Behavior;
13 | use yii\db\ActiveRecord;
14 | use yii\image\drivers\Image_GD;
15 | use yii\image\drivers\Image_Imagick;
16 | use yii\validators\ImageValidator;
17 | use yii\validators\RequiredValidator;
18 | use yii\validators\Validator;
19 | use yii\web\UploadedFile;
20 |
21 | /**
22 | * Model image behavior
23 | *
24 | * @package demi\image
25 | *
26 | * @property ActiveRecord $owner
27 | */
28 | class ImageUploaderBehavior extends Behavior
29 | {
30 | /**
31 | * Name of image attribute where the image will be stored
32 | *
33 | * @var string
34 | */
35 | protected $_imageAttribute = 'image';
36 | /**
37 | * Yii-alias to dir where will be stored subdirectories with images
38 | *
39 | * @var string
40 | */
41 | protected $_savePathAlias = '@frontend/web/images';
42 | /**
43 | * Yii-alias to root project dir, relative path to the image will exclude this part of the full path
44 | *
45 | * @var string
46 | */
47 | protected $_rootPathAlias = '@frontend/web';
48 | /**
49 | * Allowed filetypes
50 | *
51 | * @var string
52 | */
53 | protected $_fileTypes = 'jpg,jpeg,gif,png';
54 | /**
55 | * Max image size (bytes)
56 | *
57 | * @var integer
58 | */
59 | protected $_maxFileSize = 10485760; // 10mb
60 | /**
61 | * List of thumbnails sizes.
62 | * Format: [prefix=>max_width]
63 | * Thumbnails height calculated proportionally automatically
64 | * Prefix '' is special, it determines the max width of the main image
65 | *
66 | * @var array
67 | */
68 | protected $_imageSizes = [];
69 | /**
70 | * Name of default image. Image placed to: webrooot/images/{noImageBaseName}
71 | * You must create all noimage files: noimage.jpg, medium_noimage.jpg, small_noimage.jpg, etc.
72 | *
73 | * @var string
74 | */
75 | protected $_noImageBaseName = 'noimage.png';
76 | /**
77 | * Is image field required
78 | *
79 | * @var boolean
80 | */
81 | protected $_imageRequire = false;
82 | /**
83 | * This params will be passed to \yii\validators\ImageValidator
84 | *
85 | * @var array
86 | */
87 | protected $_imageValidatorParams = [];
88 | /**
89 | * If backend is located on a subdomain 'admin.', and images are uploaded to a directory
90 | * located in the frontend, you can set this param and then getImageSrc() will be return
91 | * path to image without subdomain part even in backend part
92 | *
93 | * @var string
94 | */
95 | protected $_backendSubdomain = 'admin.';
96 | /**
97 | * If backend is located on a route '/admin', and images are uploaded to a directory
98 | * located in the frontend, you can set this param and then getImageSrc() will be return
99 | * path to image without route part even in backend part
100 | *
101 | * @var string
102 | */
103 | protected $_backendRoute = '/admin';
104 | /**
105 | * Tmp field stored already uploaded image
106 | *
107 | * @var string
108 | */
109 | protected $_oldImage = null;
110 | /**
111 | * Cropper config.
112 | * 4/3 or 16/9(wide) or 1/1(square) or any other ratio. Null - free ratio
113 | *
114 | * @var float|null
115 | */
116 | protected $_aspectRatio = null;
117 | /**
118 | * Custom config array
119 | *
120 | * @var array
121 | */
122 | public $imageConfig = [];
123 | /**
124 | * Inner: image component (eg.: yii\image\ImageDriver)
125 | *
126 | * @var object
127 | */
128 | protected static $_imageComponent;
129 |
130 | /**
131 | * @param ActiveRecord $owner
132 | */
133 | public function attach($owner)
134 | {
135 | parent::attach($owner);
136 |
137 | // Apply custom config
138 | foreach ($this->imageConfig as $key => $value) {
139 | $var = '_' . $key;
140 | $this->$var = $value;
141 | }
142 |
143 | // Get webroot path
144 | if (empty($this->_rootPathAlias)) {
145 | $savePathParts = explode('/', $this->_savePathAlias);
146 | // Remove last part
147 | unset($savePathParts[count($savePathParts - 1)]);
148 | // Join parts
149 | $this->_rootPathAlias = implode('/', $savePathParts);
150 | }
151 |
152 | // Attach "required" validator if needed
153 | if ($this->_imageRequire) {
154 | $owner->validators->append(Validator::createValidator(RequiredValidator::className(), $owner,
155 | $this->_imageAttribute));
156 | }
157 |
158 | // Attach "image" validator
159 | $validatorParams = array_merge([
160 | 'extensions' => $this->_fileTypes,
161 | 'maxSize' => $this->_maxFileSize,
162 | 'skipOnEmpty' => true,
163 | ], $this->_imageValidatorParams);
164 |
165 | $validator = Validator::createValidator(ImageValidator::className(), $owner, $this->_imageAttribute,
166 | $validatorParams);
167 | $owner->validators->append($validator);
168 | }
169 |
170 | /**
171 | * Get image config param value
172 | *
173 | * @param string $paramName
174 | *
175 | * @return mixed
176 | */
177 | public function getImageConfigParam($paramName)
178 | {
179 | $name = '_' . $paramName;
180 |
181 | return $this->$name;
182 | }
183 |
184 | /**
185 | * Set new config param value
186 | *
187 | * @param string $paramName
188 | * @param mixed $value
189 | */
190 | public function setImageConfigParam($paramName, $value)
191 | {
192 | $name = '_' . $paramName;
193 |
194 | $this->$name = $value;
195 | }
196 |
197 | public function events()
198 | {
199 | return [
200 | ActiveRecord::EVENT_BEFORE_INSERT => 'beforeSave',
201 | ActiveRecord::EVENT_BEFORE_UPDATE => 'beforeSave',
202 | ActiveRecord::EVENT_AFTER_DELETE => 'deleteImage',
203 | ActiveRecord::EVENT_AFTER_FIND => 'afterFind',
204 | ];
205 | }
206 |
207 | public function beforeSave()
208 | {
209 | $owner = $this->owner;
210 |
211 | $image = $owner->{$this->_imageAttribute};
212 | $image = ($image instanceof UploadedFile) ? $image :
213 | UploadedFile::getInstance($owner, $this->_imageAttribute);
214 |
215 | if ($image instanceof UploadedFile) {
216 | // If new image uploaded - process it, remove old
217 | $new_image = static::uploadImage($image);
218 | if (!empty($new_image)) {
219 | $this->deleteImage();
220 | $owner->{$this->_imageAttribute} = $new_image;
221 | } else {
222 | // If errors - revert old image
223 | $owner->{$this->_imageAttribute} = $this->_oldImage;
224 | }
225 | } else {
226 | // Save model without image uploading - return old image to the field value
227 | $owner->{$this->_imageAttribute} = $this->_oldImage;
228 | }
229 | }
230 |
231 | public function afterFind()
232 | {
233 | $owner = $this->owner;
234 | // Remember old image value
235 | $this->_oldImage = $owner->{$this->_imageAttribute};
236 | }
237 |
238 | /**
239 | * Delete image file and set|save model image field to null
240 | *
241 | * @param bool $updateDb need to update image field in DB
242 | */
243 | public function deleteImage($updateDb = false)
244 | {
245 | $owner = $this->owner;
246 | $DS = DIRECTORY_SEPARATOR;
247 |
248 | $image = str_replace('/', $DS, $this->_oldImage);
249 |
250 | if (!empty($image)) {
251 | $dirName = Yii::getAlias($this->_savePathAlias);
252 | // Remove all resized images
253 | foreach ($this->getImageSizes() as $prefix => $size) {
254 | $file_name = $dirName . $DS . static::addPrefixToFile($image, $prefix);
255 | @unlink($file_name);
256 | }
257 | // Remove original image
258 | @unlink($this->getOriginalImagePath());
259 | }
260 |
261 | // Clear field value
262 | $owner->{$this->_imageAttribute} = null;
263 | $this->_oldImage = null;
264 |
265 | if ($updateDb) {
266 | $owner->update(false, [$this->_imageAttribute]);
267 | }
268 | }
269 |
270 | /**
271 | * Get image sizes
272 | *
273 | * @return array
274 | */
275 | protected function getImageSizes()
276 | {
277 | if (is_callable($this->_imageSizes)) {
278 | return call_user_func($this->_imageSizes, $this->owner);
279 | } else {
280 | return $this->_imageSizes;
281 | }
282 | }
283 |
284 | /**
285 | * Save uploaded image
286 | *
287 | * @param UploadedFile $image
288 | *
289 | * @return string Image field value or NULL if error
290 | */
291 | protected function uploadImage(UploadedFile $image)
292 | {
293 | $DS = DIRECTORY_SEPARATOR;
294 | // Max width for uploaded original image
295 | $maxWidth = 1500;
296 | $namePart = uniqid();
297 | $name = $namePart . '.' . $image->extension; // New filename
298 | $imageFolder = Yii::getAlias($this->_savePathAlias); // Куда загружать изображение
299 | // Creates new random subdir for images
300 | $rnddir = static::getRandomDir($imageFolder);
301 | $fullImagePath = $imageFolder . $DS . $rnddir . $DS . $name; // Full image path
302 | if ($image->saveAs($fullImagePath)) {
303 | // Reduce image if image is very large
304 | $imageComponent = static::getImageComponent();
305 | $imageInfo = getimagesize($fullImagePath);
306 | $img_width = $imageInfo[0];
307 | if ($img_width > $maxWidth) {
308 | /* @var $image_o Image_GD|Image_Imagick */
309 | $image_o = $imageComponent->load($fullImagePath);
310 | $image_o->resize($maxWidth, static::getMaxHeight($maxWidth));
311 | $image_o->save($fullImagePath);
312 | }
313 |
314 | // Save original file
315 | $originalImage = $imageFolder . $DS . $rnddir . $DS . $namePart . '_original.' . $image->extension;
316 | @copy($fullImagePath, $originalImage);
317 | // If image successfully saved - make resized copies
318 | $sizes = $this->getImageSizes();
319 | $imageInfo = getimagesize($fullImagePath);
320 | $img_width = $imageInfo[0];
321 | $img_height = $imageInfo[1];
322 |
323 | // Crop image if set aspectRatio value
324 | if ($this->_aspectRatio) {
325 | $isVertical = $img_width < $img_height;
326 |
327 | if (!$isVertical) {
328 | $width = $img_height * $this->_aspectRatio;
329 | $height = $width / $this->_aspectRatio;
330 | } else {
331 | $height = $img_width / $this->_aspectRatio;
332 | $width = $height * $this->_aspectRatio;
333 | }
334 | /* @var $image_c Image_GD|Image_Imagick */
335 | $image_c = $imageComponent->load($fullImagePath);
336 | $image_c->crop($width, $height);
337 | $img_width = $width;
338 | $image_c->save($fullImagePath);
339 | }
340 |
341 | // If the image is NOT wider than it should be - remove main size from the list of resize sizes
342 | if ($img_width <= $sizes['']) {
343 | unset($sizes['']);
344 | }
345 |
346 | // Do resize
347 | $rez = static::resizeAndSave($imageFolder . $DS . $rnddir, $name, $sizes);
348 | // Successfull
349 | if ($rez === true) {
350 | return $rnddir . '/' . $name;
351 | } else {
352 | // Error - remove resized copies
353 | foreach ($this->getImageSizes() as $size) {
354 | $file_name = $imageFolder . $DS . $rnddir . $DS . static::addPrefixToFile($name, $size);
355 | @unlink($file_name);
356 | }
357 |
358 | return null;
359 | }
360 | }
361 |
362 | return null;
363 | }
364 |
365 | /**
366 | * Add file prefix
367 | * For example addPrefixToFile("dirname/50b3d1ad130d0.png", "normal_") returned "dirname/normal_50b3d1ad130d0.png"
368 | *
369 | * @param string $path Main image path
370 | * @param string $prefix Size prefix
371 | *
372 | * @return string Main image path with size prefix
373 | */
374 | public static function addPrefixToFile($path, $prefix = null)
375 | {
376 | if ($prefix === null || $prefix == '') {
377 | return $path;
378 | }
379 |
380 | $path = str_replace('\\', '/', $path);
381 | $dir = explode('/', $path);
382 | $lastIndex = count($dir) - 1;
383 | $dir[$lastIndex] = $prefix . $dir[$lastIndex];
384 |
385 | return implode('/', $dir);
386 | }
387 |
388 | /**
389 | * Add file postfix
390 | * For example addPrefixToFile("dirname/50b3d1ad130d0.png", "_normal") returned "dirname/50b3d1ad130d0_normal.png"
391 | *
392 | * @param string $path Main image path
393 | * @param string $postfix Size postfix
394 | *
395 | * @return string Main image path with size postfix
396 | */
397 | public static function addPostfixToFile($path, $postfix = null)
398 | {
399 | if ($postfix === null || $postfix == '') {
400 | return $path;
401 | }
402 |
403 | $parts = explode('.', $path);
404 |
405 | if (count($parts) === 1) {
406 | return $postfix . $path;
407 | }
408 |
409 | $parts[count($parts) - 2] .= $postfix;
410 |
411 | return implode('.', $parts);
412 | }
413 |
414 | /**
415 | * Return image path for web
416 | *
417 | * @param string $size Size prefix
418 | *
419 | * @return string Image src path, can be value for Html::image()
420 | */
421 | public function getImageSrc($size = null)
422 | {
423 | $owner = $this->owner;
424 |
425 | $prefix = '';
426 | if (Yii::$app->request instanceof \yii\web\Request) {
427 | $prefix = Yii::$app->request->baseUrl;
428 | $host = Yii::$app->request->hostInfo;
429 | // If current application is backend - return absolute frontend image path
430 | if (!empty($this->_backendSubdomain) && strpos($host, $this->_backendSubdomain) !== false) {
431 | $prefix = str_replace($this->_backendSubdomain, '', $host) . $prefix;
432 | }
433 | if (!empty($this->_backendRoute) && strpos($prefix, $this->_backendRoute) !== false) {
434 | $prefix = str_replace($this->_backendRoute, '', $prefix);
435 | }
436 | }
437 |
438 | $image = $owner->{$this->_imageAttribute};
439 | if (empty($image)) {
440 | if (isset($this->getImageSizes()[$size])) {
441 | return $prefix . '/images/' . static::addPrefixToFile($this->_noImageBaseName, $size);
442 | }
443 |
444 | return $prefix . '/images/' . $this->_noImageBaseName;
445 | }
446 |
447 | $root = Yii::getAlias($this->_rootPathAlias); // Webroot
448 | $path = Yii::getAlias($this->_savePathAlias); // Uploading dir
449 | $path = str_replace($root, '', $path); // Remove server path
450 | $path = str_replace('\\', '/', $path); // Replace "\" to "/"
451 | $folder = $prefix . '/' . trim($path, '/') . '/';
452 |
453 | if (!empty($size)) {
454 | return $folder . static::addPrefixToFile($image, $size);
455 | } else {
456 | return $folder . $image;
457 | }
458 | }
459 |
460 | /**
461 | * Creates new directory by path (if doesn't exists)
462 | *
463 | * @param string $path Primary uploading directory path
464 | *
465 | * @return string Path to created random dir
466 | */
467 | public static function getRandomDir($path)
468 | {
469 | $DS = DIRECTORY_SEPARATOR;
470 | $max_scatter = 9; // Directory names max range 0..$max_scatter
471 | $levels = 3; // Nested level
472 | $dirs = [];
473 | for ($i = 1; $i <= $levels; $i++) {
474 | $dirs[] = (string)rand(0, $max_scatter);
475 | }
476 | $dir_path = implode($DS, $dirs);
477 | $full_path = rtrim($path, '/\\') . $DS . $dir_path;
478 |
479 | if (!is_dir($full_path)) {
480 | if (YII_DEBUG) {
481 | mkdir($full_path, 0777, true);
482 | } else {
483 | shell_exec('mkdir -m 0777 -p ' . $full_path);
484 | }
485 | if (!YII_DEBUG && isset($dirs[0])) {
486 | shell_exec('chmod -R 0777 ' . $path . $DS . $dirs[0] . $DS . '*');
487 | }
488 | }
489 |
490 | $dir_path = str_replace('\\', '/', $dir_path);
491 |
492 | return ltrim($dir_path, '/');
493 | }
494 |
495 | /**
496 | * Make resized images
497 | *
498 | * @param string $dir Random directory path
499 | * @param string $fileName Primary filename
500 | * @param mixed $resizeWidth integer(wide): one resize - rewrite primary file.
501 | * array: resize for each item.
502 | * array format:
503 | *
504 | * array('prefix1'=>sizeWidth1, 'prefix2'=>sizeWidth2)
505 | *
506 | *
507 | * @return boolean TRUE if successfull, FALSE otherwise
508 | * @todo Crop max height instead validaton error message?
509 | */
510 | public static function resizeAndSave($dir, $fileName, $resizeWidth)
511 | {
512 | $DS = DIRECTORY_SEPARATOR;
513 |
514 | // Full original image path
515 | $fullPath = $dir . $DS . $fileName;
516 |
517 | if (!@file_exists($fullPath)) {
518 | // if original file doesn't exists - breack
519 | return false;
520 | }
521 |
522 | try {
523 | $imageComponent = static::getImageComponent();
524 | $image_r = $imageComponent->load($fullPath);
525 | /* @var $image_r Image_GD|Image_Imagick */
526 | if (is_array($resizeWidth)) {
527 | foreach ($resizeWidth as $prefix => $width) {
528 | $image_r->resize($width, static::getMaxHeight($width));
529 | $image_r->save($dir . $DS . $prefix . $fileName);
530 | }
531 | } else {
532 | $image_r->resize($resizeWidth, static::getMaxHeight($resizeWidth));
533 | $image_r->save($fullPath);
534 | }
535 | } catch (\Exception $e) {
536 | return false;
537 | }
538 |
539 | return true;
540 | }
541 |
542 | /**
543 | * Get image component
544 | *
545 | * @return \yii\image\ImageDriver
546 | */
547 | public static function getImageComponent()
548 | {
549 | // Get image component
550 | if (is_object(static::$_imageComponent)) {
551 | $imageComponent = static::$_imageComponent;
552 | } else {
553 | $imageComponent = Yii::createObject([
554 | 'class' => 'yii\image\ImageDriver',
555 | ]);
556 | // Store component for future using
557 | static::$_imageComponent = $imageComponent;
558 | }
559 |
560 | return $imageComponent;
561 | }
562 |
563 | /**
564 | * Returns the maximum height of the image relative to the specified width
565 | *
566 | * @param integer $width
567 | *
568 | * @return integer
569 | */
570 | public static function getMaxHeight($width)
571 | {
572 | return $width * 2;
573 | }
574 |
575 | /**
576 | * Return instance of current behavior
577 | *
578 | * @return self $this
579 | */
580 | public function getImageBehavior()
581 | {
582 | return $this;
583 | }
584 |
585 | /**
586 | * Return server path to original image src
587 | *
588 | * @return string
589 | */
590 | public function getOriginalImagePath()
591 | {
592 | $savePath = Yii::getAlias($this->_savePathAlias);
593 | $image = $this->_oldImage;
594 |
595 | return static::addPostfixToFile($savePath . DIRECTORY_SEPARATOR . $image, '_original');
596 | }
597 |
598 | /**
599 | * Crop original image and resave resized images
600 | *
601 | * @param int $x
602 | * @param int $y
603 | * @param int $width
604 | * @param int $height
605 | * @param int $rotate
606 | *
607 | * @return bool
608 | */
609 | public function cropImage($x, $y, $width, $height, $rotate)
610 | {
611 | $DS = DIRECTORY_SEPARATOR;
612 | $savePath = Yii::getAlias($this->_savePathAlias);
613 | $imageSrc = $this->owner->{$this->_imageAttribute};
614 | $fullImagePath = $savePath . $DS . $imageSrc;
615 |
616 | $imageComponent = static::getImageComponent();
617 | /* @var $image Image_GD|Image_Imagick */
618 | $image = $imageComponent->load($this->getOriginalImagePath());
619 |
620 | $image->crop($width, $height, $x, $y);
621 | $image->rotate($rotate);
622 |
623 | $image->save($fullImagePath);
624 |
625 | $sizes = $this->getImageSizes();
626 | unset($sizes['']);
627 |
628 | $pathParts = explode('/', str_replace('\\', '/', $imageSrc));
629 | $filename = array_pop($pathParts);
630 |
631 | // Make resize
632 | return static::resizeAndSave($savePath . $DS . implode($DS, $pathParts), $filename, $sizes);
633 | }
634 | }
635 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | yii2-image-uploader
2 | ===================
3 |
4 | Yii2 behavior for upload image to model
5 |
6 | Installation
7 | ------------
8 | Add to composer.json in your project
9 | ```json
10 | {
11 | "require": {
12 | "yurkinx/yii2-image": "dev-master",
13 | "demi/image": "~1.0"
14 | }
15 | }
16 | ```
17 | then run command
18 | ```code
19 | composer update
20 | ```
21 |
22 | Configuration
23 | -------------
24 | In model file add image uploader behavior:
25 | ```php
26 | /**
27 | * @inheritdoc
28 | */
29 | public function behaviors()
30 | {
31 | return [
32 | 'imageUploaderBehavior' => [
33 | 'class' => 'demi\image\ImageUploaderBehavior',
34 | 'imageConfig' => [
35 | // Name of image attribute where the image will be stored
36 | 'imageAttribute' => 'image',
37 | // Yii-alias to dir where will be stored subdirectories with images
38 | 'savePathAlias' => '@frontend/web/images/products',
39 | // Yii-alias to root project dir, relative path to the image will exclude this part of the full path
40 | 'rootPathAlias' => '@frontend/web',
41 | // Name of default image. Image placed to: webrooot/images/{noImageBaseName}
42 | // You must create all noimage files: noimage.jpg, medium_noimage.jpg, small_noimage.jpg, etc.
43 | 'noImageBaseName' => 'noimage.jpg',
44 | // List of thumbnails sizes.
45 | // Format: [prefix=>max_width]
46 | // Thumbnails height calculated proportionally automatically
47 | // Prefix '' is special, it determines the max width of the main image
48 | 'imageSizes' => [
49 | '' => 1000,
50 | 'medium_' => 270,
51 | 'small_' => 70,
52 | 'my_custom_size' => 25,
53 | ],
54 | // This params will be passed to \yii\validators\ImageValidator
55 | 'imageValidatorParams' => [
56 | 'minWidth' => 400,
57 | 'minHeight' => 300,
58 | // Custom validation errors
59 | // see more in \yii\validators\ImageValidator::init() and \yii\validators\FileValidator::init()
60 | 'tooBig' => Yii::t('yii', 'The file "{file}" is too big. Its size cannot exceed {formattedLimit}.'),
61 | ],
62 | // Cropper config
63 | 'aspectRatio' => 4 / 3, // or 16/9(wide) or 1/1(square) or any other ratio. Null - free ratio
64 | // default config
65 | 'imageRequire' => false,
66 | 'fileTypes' => 'jpg,jpeg,gif,png',
67 | 'maxFileSize' => 10485760, // 10mb
68 | // If backend is located on a subdomain 'admin.', and images are uploaded to a directory
69 | // located in the frontend, you can set this param and then getImageSrc() will be return
70 | // path to image without subdomain part even in backend part
71 | 'backendSubdomain' => 'admin.',
72 | // or if backend located by route '/admin/*'
73 | 'backendRoute' => '/admin',
74 | ],
75 | ],
76 | ];
77 | }
78 | ```
79 |
80 | PHPdoc for model:
81 | ```php
82 | /**
83 | * @method getImageSrc($size = null)
84 | * @property string $imageSrc
85 | */
86 | ```
87 |
88 | Usage
89 | -----
90 | In any view file:
91 | ```php
92 | // big(mainly) image
93 | Html::img($model->getImageSrc());
94 | // or shortly
95 | Html::img($model->imageSrc);
96 |
97 | // medium image
98 | Html::img($model->getImageSrc('medium_'));
99 |
100 | // small image
101 | Html::img($model->getImageSrc('small_'));
102 |
103 | // image size "my_custom_size"
104 | Html::img($model->getImageSrc('my_custom_size'));
105 | ```
106 |
107 | _form.php
108 | ```php
109 | ['enctype' => 'multipart/form-data'],
111 | ]); ?>
112 |
113 | = $form->field($model, 'image')->widget('demi\image\FormImageWidget', [
114 | 'imageSrc' => $model->getImageSrc('medium_'),
115 | 'deleteUrl' => ['deleteImage', 'id' => $model->getPrimaryKey()],
116 | 'cropUrl' => ['cropImage', 'id' => $model->getPrimaryKey()],
117 | // cropper options https://github.com/fengyuanchen/cropper/blob/master/README.md#options
118 | 'cropPluginOptions' => [],
119 | // Translated messages
120 | 'messages' => [
121 | // {formats} and {formattedSize} will replaced by widget to actual values
122 | 'formats' => Yii::t('app', 'Supported formats: {formats}'),
123 | 'fileSize' => Yii::t('app', 'Maximum file size: {formattedSize}'),
124 | 'deleteBtn' => Yii::t('app', 'Delete'),
125 | 'deleteConfirmation' => Yii::t('app', 'Are you sure you want to delete the image?'),
126 | // Cropper
127 | 'cropBtn' => Yii::t('app', 'Crop'),
128 | 'cropModalTitle' => Yii::t('app', 'Select crop area and click "Crop" button'),
129 | 'closeModalBtn' => Yii::t('app', 'Close'),
130 | 'cropModalBtn' => Yii::t('app', 'Crop selected'),
131 | ],
132 | ]) ?>
133 | ```
134 |
135 | Bonus: DELETE and CROP image actions!
136 | -----
137 | Add this code to you controller:
138 | ```php
139 | /**
140 | * @inheritdoc
141 | */
142 | public function actions()
143 | {
144 | return [
145 | 'deleteImage' => [
146 | 'class' => 'demi\image\DeleteImageAction',
147 | 'modelClass' => Post::className(),
148 | 'canDelete' => function ($model) {
149 | /* @var $model \yii\db\ActiveRecord */
150 | return $model->user_id == Yii::$app->user->id;
151 | },
152 | 'redirectUrl' => function ($model) {
153 | /* @var $model \yii\db\ActiveRecord */
154 | // triggered on !Yii::$app->request->isAjax, else will be returned JSON: {status: "success"}
155 | return ['post/view', 'id' => $model->primaryKey];
156 | },
157 | 'afterDelete' => function ($model) {
158 | /* @var $model \yii\db\ActiveRecord */
159 | // You can customize response by this function, e.g. change response:
160 | if (Yii::$app->request->isAjax) {
161 | Yii::$app->response->getHeaders()->set('Vary', 'Accept');
162 | Yii::$app->response->format = yii\web\Response::FORMAT_JSON;
163 |
164 | return ['status' => 'success', 'message' => 'Image deleted'];
165 | } else {
166 | return Yii::$app->response->redirect(['post/view', 'id' => $model->primaryKey]);
167 | }
168 | },
169 | ],
170 | 'cropImage' => [
171 | 'class' => 'demi\image\CropImageAction',
172 | 'modelClass' => Post::className(),
173 | 'redirectUrl' => function ($model) {
174 | /* @var $model Post */
175 | // triggered on !Yii::$app->request->isAjax, else will be returned JSON: {status: "success"}
176 | return ['update', 'id' => $model->id];
177 | },
178 | ],
179 | ];
180 | }
181 | ```
182 |
--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "demi/image",
3 | "description": "Yii2 behavior for upload image to model",
4 | "keywords": ["yii2", "image", "upload", "behavior", "resize"],
5 | "homepage": "https://github.com/demisang/yii2-image-uploader#readme",
6 | "type": "yii2-extension",
7 | "license": "GPL-3.0-or-later",
8 | "authors": [
9 | {
10 | "name": "Ivan Orlov",
11 | "email": "gnasimed@gmail.com",
12 | "homepage": "https://orlov.io/",
13 | "role": "Creator"
14 | }
15 | ],
16 | "support": {
17 | "issues": "https://github.com/demisang/yii2-image-uploader/issues",
18 | "source": "https://github.com/demisang/yii2-image-uploader"
19 | },
20 | "require": {
21 | "php": ">=5.4.0",
22 | "yiisoft/yii2": "*",
23 | "yurkinx/yii2-image": "dev-master",
24 | "demi/cropper": "~1.0"
25 | },
26 | "autoload": {
27 | "psr-4": {
28 | "demi\\image\\": ""
29 | }
30 | }
31 | }
32 |
--------------------------------------------------------------------------------