Proposal for #46: Implementation of Image helper based on Imagine library #1669

tonydspaniard · 2013-12-28T08:20:16Z

Closes #46

Implements common used methods for Image manipulation:

crop
Yii::$app->image->crop('/path/to/image.jpg', 200, 200, 720, 450);
thumb (keeping aspect ratio)
Yii::$app->image->thumb('/path/to/image.jpg',120, 120);
text
Yii::$app->image->text('/path/to/image.jpg', 'Yii-2 Image', ['font' => 'path/to/font.otf', 'size' => 12, 'color' =>'000']);
watermark
Yii::$app->image->crop('/path/to/image.jpg', /path/to/watermark.jpg' );
frame
Yii::$app->image->frame('/path/to/image.jpg', 5 );

It uses Imagine library. It also contains a method to access Imagine methods directly (ie when used for simple image manipulations):

Yii::$app->image->getImagine()
   ->open('/path/to/image.jpg')
   ->save('/path/to/image.jpg', array('quality' => 50));

Edit: This extension is on WIP, methods are proven to work, if accepted. Then will write the tests

Conflicts: extensions/yii/jui/CHANGELOG.md

* origin/master: Update change log Add active id to options if input widget has a model fixes yiisoft#1550

* upstream: Fixed CSRF token masking issue. improved error message of calling invalid scope method. Fixed repo URL Fixes yiisoft#1650: Added Connection::pdoClass. code style fix. added changelog codestyle fix improved checkIntegrity method Modified extension guidlines fix sphinx command signature fixed bug with forgotten param, fixed behavior for one table integrity fixed sequence reset added postgresql features to reset seq/check integrity

qiangxue · 2013-12-28T15:08:36Z

Looks good to me. @yiisoft/core-developers What's your opinion?

Do you plan to implement more commonly used methods?

tonydspaniard · 2013-12-28T15:29:00Z

@qiangxue the ones included are the most common used. If @yiisoft/core-developers have any suggestions that cannot be easily handled with Imagine would be great to hear it.

creocoder · 2013-12-28T15:52:45Z

extensions/yii/imagine/Image.php

+	/**
+	 * @return array of available drivers.
+	 */
+	public function getAvailableDrivers()


@tonydspaniard About this method implementation. Why not just:

return [static::DRIVER_GD2, static::DRIVER_GMAGICK, static::DRIVER_IMAGICK];

For which goals you use excess/static variable ❓

@creocoder fast typing... fixing

Any other methods to implement?

@tonydspaniard

Any other methods to implement?

Will think about that.

* origin/master:

klimov-paul · 2013-12-28T22:11:30Z

extensions/yii/imagine/Image.php

+	 * @return ManipulatorInterface
+	 */
+	public function watermark($filename, $watermarkFilename, Point $pos = null)
+	{


Different methods interface looks inconstant: here you pass coordinates as an object, while in “crop()” you are using separated $startX, $startY.

klimov-paul · 2013-12-28T22:16:11Z

Any other methods to implement?

Maybe “rotate()”.

qiangxue · 2013-12-28T22:34:00Z

What about resize()? Does thumbnail() do the same thing?

tonydspaniard · 2013-12-28T22:49:04Z

@qiangxue resize() is something very simple to do with access to getImagine(), not worth a method here.

Maybe “rotate()”.

Same goes with rotation. Check results of the following code (frame it and then rotate -8 degrees):

Yii::$app->image->frame($imgPath, 5, '666', 0)
    ->rotate(-8)
    ->save($runtime . '/123456789.jpg', ['quality' => 50]);

samdark · 2013-12-28T23:37:52Z

extensions/yii/imagine/Image.php

+	private $_imagine;
+	/**
+	 * @var string the driver to use. These can be:
+	 * - gd2


Better to provide constants in example or people will use strings directly.

samdark · 2013-12-28T23:43:05Z

Looks OK to me overall.

creocoder · 2013-12-28T23:52:22Z

extensions/yii/imagine/Image.php

+	 * - imagick
+	 * - gmagick
+	 */
+	private $_driver = "gd2";


"gd" => 'gd'

kmergen · 2013-12-29T10:50:51Z

How can I implement extension in my project. Can not find extension in extensions directory

creocoder · 2013-12-29T13:15:09Z

@kmergen This is not merget yet.

klimov-paul · 2013-12-29T13:30:07Z

extensions/yii/imagine/Image.php

+	 * @param integer $y position on image to apply watermark. Defaults to null
+	 * @return ManipulatorInterface
+	 */
+	public function watermark($filename, $watermarkFilename, $x = null, $y = null)


Maybe it is better to pass coordinates as an array. Single argument will simplify the interface as well as cover possible pass of “Point” object:

public function watermark($filename, $watermarkFilename, $point = null) { if (is_array($point)) { list($x, $y) = $point; $point = new Point($x, $y); } elseif ($point instanceof Point) { // do nothing } }

Same strategy can be applied for all methods.

* upstream: (35 commits) Fixes yiisoft#1691: added “viewport” meta tag to layout views. Fixed the issue that query cache returns the same data for the same SQL but different query methods moved section subsection added typo [skip ci] docs about response Fixes yiisoft#1586: `QueryBuilder::buildLikeCondition()` will now escape special characters and use percentage characters by default docs improved csrf docs added Fixes yiisoft#1685: UrlManager::showScriptName should be set true for tests. Fixes yiisoft#1688: ActiveForm is creating duplicated messages in error summary change back the visibility of findTableNames to protected. Typo fix. Fixes yiisoft#1681: Added support for automatically adjusting the "for" attribute of label generated by `ActiveField::label()` Simplified tests. Fixes yiisoft#1631: Charset is now explicitly set to UTF-8 when serving JSON Fixed typo added html layout for mail component in basic app CS fixes. Merge branch 'debug_module_improvements' of github.com:Ragazzo/yii2 into Ragazzo-debug_module_improvements ...

qiangxue · 2013-12-31T20:35:14Z

merged 2df7d0a

qiangxue · 2013-12-31T20:48:00Z

I just review the code. It seems to me the only configurable option is which driver to use. For this reason, how about we turn this into a static helper instead of an application component? The helper can automatically choose which driver to use based on the installed PHP extensions.

cebe · 2014-01-01T11:52:09Z

Sounds good to me. We can have a static property for the driver that is null for autodetect and may be set explicitly.

creocoder · 2014-01-01T14:42:44Z

@cebe Which order for autodetection:

1) Gmagick
2) Imagick
3) Gd2

or

1) Imagick
2) Gmagick
3) Gd2

?

samdark · 2014-01-01T15:13:00Z

Gmagick, Imagick, Gd2 according to performance and efficiency.

qiangxue · 2014-01-01T19:08:12Z

Finished refactoring.

qiangxue · 2014-01-01T19:48:31Z

@tonydspaniard The frame() method doesn't look quite right to me. Currently, the frame is added to the outside of the original image. The $alpha value doesn't make much sense then. IMO, the frame should be added to the inside of the image with alpha value indicating the transparency of the frame. By doing so, we also keep the image size unchanged, which is probably preferable in practice. What do you think?

cebe · 2014-01-01T20:42:51Z

margin could be positive for inside frame or negative for outside frame. alpha should have no effect on outside frame then.

For the text() method I think we should add a position parameter that can be a point or array as it is in the other methods. it is quite uncommon that the position will be default.

cebe · 2014-01-01T20:43:18Z

rest of the code looks really cool to me :)

qiangxue · 2014-01-02T03:56:44Z

I have refactored the text() method as you suggested.

I like your suggestion about the frame margin. I don't know how to implement the inside frame though. @tonydspaniard Do you have any idea?

tonydspaniard and others added 8 commits December 20, 2013 14:02

Add active id to options if input widget has a model fixes yiisoft#1550

48363a3

Update change log

045295e

Merge remote-tracking branch 'upstream/master'

a6cc6da

Conflicts: extensions/yii/jui/CHANGELOG.md

Merge remote-tracking branch 'origin/master'

f03d85d

* origin/master: Update change log Add active id to options if input widget has a model fixes yiisoft#1550

image helper proposal

e86f330

fix merging issues

0efe892

creocoder reviewed Dec 28, 2013
View reviewed changes

tonydspaniard added 3 commits December 28, 2013 17:07

remove use of dumb static variable

7efdad9

Merge remote-tracking branch 'origin/master' into 46-image-helper

6e2e11c

* origin/master:

added frame method

105a0bc

klimov-paul reviewed Dec 28, 2013
View reviewed changes

keep methods interface constant

c7b3d2b

samdark reviewed Dec 28, 2013
View reviewed changes

creocoder reviewed Dec 28, 2013
View reviewed changes

extensions/yii/imagine/Image.php

* - imagick

* - gmagick

*/

private $_driver = "gd2";

Copy link

Contributor

creocoder Dec 28, 2013

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"gd" => 'gd'

klimov-paul reviewed Dec 29, 2013
View reviewed changes

tonydspaniard added 2 commits December 29, 2013 18:32

refactor methods to simplify interface

6694acd

added tests

5316079

tonydspaniard added 5 commits December 29, 2013 21:51

added CHANGELOG entry

bccac04

fix composer.json syntax

fc28927

minor fix on phpDoc

1bde5e0

added README file

52ad66e

qiangxue merged commit 52ad66e into yiisoft:master Dec 31, 2013

tonydspaniard deleted the 46-image-helper branch February 5, 2014 13:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Proposal for #46: Implementation of Image helper based on Imagine library #1669

Proposal for #46: Implementation of Image helper based on Imagine library #1669

tonydspaniard commented Dec 28, 2013

qiangxue commented Dec 28, 2013

tonydspaniard commented Dec 28, 2013

creocoder Dec 28, 2013

tonydspaniard Dec 28, 2013

creocoder Dec 28, 2013

klimov-paul Dec 28, 2013

klimov-paul commented Dec 28, 2013

qiangxue commented Dec 28, 2013

tonydspaniard commented Dec 28, 2013

samdark Dec 28, 2013

samdark commented Dec 28, 2013

creocoder Dec 28, 2013

kmergen commented Dec 29, 2013

creocoder commented Dec 29, 2013

klimov-paul Dec 29, 2013

cebe Dec 29, 2013

qiangxue commented Dec 31, 2013

qiangxue commented Dec 31, 2013

cebe commented Jan 1, 2014

creocoder commented Jan 1, 2014

samdark commented Jan 1, 2014

qiangxue commented Jan 1, 2014

qiangxue commented Jan 1, 2014

cebe commented Jan 1, 2014

cebe commented Jan 1, 2014

qiangxue commented Jan 2, 2014

Proposal for #46: Implementation of Image helper based on Imagine library #1669

Proposal for #46: Implementation of Image helper based on Imagine library #1669

Conversation

tonydspaniard commented Dec 28, 2013

qiangxue commented Dec 28, 2013

tonydspaniard commented Dec 28, 2013

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

klimov-paul commented Dec 28, 2013

qiangxue commented Dec 28, 2013

tonydspaniard commented Dec 28, 2013

Choose a reason for hiding this comment

samdark commented Dec 28, 2013

Choose a reason for hiding this comment

kmergen commented Dec 29, 2013

creocoder commented Dec 29, 2013

Choose a reason for hiding this comment

Choose a reason for hiding this comment

qiangxue commented Dec 31, 2013

qiangxue commented Dec 31, 2013

cebe commented Jan 1, 2014

creocoder commented Jan 1, 2014

samdark commented Jan 1, 2014

qiangxue commented Jan 1, 2014

qiangxue commented Jan 1, 2014

cebe commented Jan 1, 2014

cebe commented Jan 1, 2014

qiangxue commented Jan 2, 2014