Merge pull request #10186 from SidRoberts/image

[2.0.x] Tidied up Image component (docblocks, comments, use statements).

Author: andresgutierrez

phalcon/image/adapter.zep

@@ -20,11 +20,9 @@
 namespace Phalcon\Image;
 
 use Phalcon\Image;
-use Phalcon\Image\Adapter;
-use Phalcon\Image\Exception;
 
 /**
- * Phalcon\Image
+ * Phalcon\Image\Adapter
  *
  * All image adapters must use this class
  */
@@ -37,34 +35,34 @@ abstract class Adapter
 
 	protected _realpath { get };
 
-    /**
-     * Image width
-     *
-     * @var int
-     */
+	/**
+	 * Image width
+	 *
+	 * @var int
+	 */
 	protected _width { get };
 
-    /**
-     * Image height
-     *
-     * @var int
-     */
+	/**
+	 * Image height
+	 *
+	 * @var int
+	 */
 	protected _height { get };
 
-    /**
-     * Image type
-     *
-     * Driver dependent
-     *
-     * @var int
-     */
+	/**
+	 * Image type
+	 *
+	 * Driver dependent
+	 *
+	 * @var int
+	 */
 	protected _type { get };
 
-    /**
-     * Image mime type
-     *
-     * @var string
-     */
+	/**
+	 * Image mime type
+	 *
+	 * @var string
+	 */
 	protected _mime { get };
 
 	protected static _checked = false;
@@ -353,8 +351,6 @@ abstract class Adapter
 
 	/**
  	 * Composite one image onto another
- 	 *
- 	 * @param Phalcon\Image\Adapter watermark
  	 */
 	public function mask(<Adapter> watermark) -> <Adapter>
 	{

phalcon/image/adapter/gd.zep

@@ -19,11 +19,15 @@
 
 namespace Phalcon\Image\Adapter;
 
-class Gd extends \Phalcon\Image\Adapter implements \Phalcon\Image\AdapterInterface
+use Phalcon\Image\Adapter;
+use Phalcon\Image\AdapterInterface;
+use Phalcon\Image\Exception;
+
+class Gd extends Adapter implements AdapterInterface
 {
 	protected static _checked = false;
 
-	public static function check()
+	public static function check() -> boolean
 	{
 		var version, info, matches;
 
@@ -32,7 +36,7 @@ class Gd extends \Phalcon\Image\Adapter implements \Phalcon\Image\AdapterInterfa
 		}
 
 		if !function_exists("gd_info") {
-			throw new \Phalcon\Image\Exception("GD is either not installed or not enabled, check your configuration");
+			throw new Exception("GD is either not installed or not enabled, check your configuration");
 		}
 
 		let version = null;
@@ -46,7 +50,7 @@ class Gd extends \Phalcon\Image\Adapter implements \Phalcon\Image\AdapterInterfa
 		}
 
 		if !version_compare(version, "2.0.1", ">=") {
-			throw new \Phalcon\Image\Exception("Phalcon\\Image\\Adapter\\GD requires GD version '2.0.1' or greater, you have " . version);
+			throw new Exception("Phalcon\\Image\\Adapter\\GD requires GD version '2.0.1' or greater, you have " . version);
 		}
 
 		let self::_checked = true;
@@ -94,9 +98,9 @@ class Gd extends \Phalcon\Image\Adapter implements \Phalcon\Image\AdapterInterfa
 					break;
 				default:
 					if this->_mime {
-						throw new \Phalcon\Image\Exception("Installed GD does not support " . this->_mime . " images");
+						throw new Exception("Installed GD does not support " . this->_mime . " images");
 					} else {
-						throw new \Phalcon\Image\Exception("Installed GD does not support such images");
+						throw new Exception("Installed GD does not support such images");
 					}
 					break;
 			}
@@ -105,7 +109,7 @@ class Gd extends \Phalcon\Image\Adapter implements \Phalcon\Image\AdapterInterfa
 
 		} else {
 			if !width || !height {
-				throw new \Phalcon\Image\Exception("Failed to create image from file " . this->_file);
+				throw new Exception("Failed to create image from file " . this->_file);
 			}
 
 			let this->_image = imagecreatetruecolor(width, height);
@@ -304,7 +308,7 @@ class Gd extends \Phalcon\Image\Adapter implements \Phalcon\Image\AdapterInterfa
 		let this->_height = imagesy(reflection);
 	}
 
-	protected function _watermark(<\Phalcon\Image\Adapter> watermark, int offsetX, int offsetY, int opacity)
+	protected function _watermark(<Adapter> watermark, int offsetX, int offsetY, int opacity)
 	{
 		var overlay, color;
 		int width, height;
@@ -351,7 +355,7 @@ class Gd extends \Phalcon\Image\Adapter implements \Phalcon\Image\AdapterInterfa
 			}
 
 			if !s0 || !s1 || !s4 || !s5 {
-				throw new \Phalcon\Image\Exception("Call to imagettfbbox() failed");
+				throw new Exception("Call to imagettfbbox() failed");
 			}
 
 			let width  = abs(s4 - s0) + 10;
@@ -386,7 +390,7 @@ class Gd extends \Phalcon\Image\Adapter implements \Phalcon\Image\AdapterInterfa
 		}
 	}
 
-	protected function _mask(<\Phalcon\Image\Adapter> mask)
+	protected function _mask(<Adapter> mask)
 	{
 		var maskImage, newimage, tempImage, color, index, r, g, b;
 		int mask_width, mask_height, x, y, alpha;
@@ -558,7 +562,7 @@ class Gd extends \Phalcon\Image\Adapter implements \Phalcon\Image\AdapterInterfa
 			return ob_get_clean();
 		}
 
-		throw new \Phalcon\Image\Exception("Installed GD does not support '" . ext . "' images");
+		throw new Exception("Installed GD does not support '" . ext . "' images");
 	}
 
 	protected function _create(int width, int height)

phalcon/image/adapter/imagick.zep

@@ -19,6 +19,8 @@
 
 namespace Phalcon\Image\Adapter;
 
+use Phalcon\Image\Adapter;
+use Phalcon\Image\AdapterInterface;
 use Phalcon\Image\Exception;
 
 /**
@@ -34,17 +36,15 @@ use Phalcon\Image\Exception;
  * }
  *</code>
  */
-class Imagick extends \Phalcon\Image\Adapter implements \Phalcon\Image\AdapterInterface
+class Imagick extends Adapter implements AdapterInterface
 {
 	protected static _version = 0;
 	protected static _checked = false;
 
 	/**
 	 * Checks if Imagick is enabled
-	 *
-	 * @return  boolean
 	 */
-	public static function check()
+	public static function check() -> boolean
 	{
 		if self::_checked {
 			return true;
@@ -64,7 +64,7 @@ class Imagick extends \Phalcon\Image\Adapter implements \Phalcon\Image\AdapterIn
 	}
 
 	/**
-	 * \Phalcon\Image\Imagick constructor
+	 * \Phalcon\Image\Adapter\Imagick constructor
 	 */
 	public function __construct(string! file, int width = null, int height = null)
 	{
@@ -108,7 +108,6 @@ class Imagick extends \Phalcon\Image\Adapter implements \Phalcon\Image\AdapterIn
 			let this->_realpath = this->_file;
 		}
 
-
 		let this->_width = this->_image->getImageWidth();
 		let this->_height = this->_image->getImageHeight();
 		let this->_type = this->_image->getImageType();
@@ -346,7 +345,7 @@ class Imagick extends \Phalcon\Image\Adapter implements \Phalcon\Image\AdapterIn
 	/**
 	 * Execute a watermarking.
 	 */
-	protected function _watermark(<\Phalcon\Image\Adapter> image, int offsetX, int offsetY, int opacity)
+	protected function _watermark(<Adapter> image, int offsetX, int offsetY, int opacity)
 	{
 		var watermark, ret;
 
@@ -435,9 +434,9 @@ class Imagick extends \Phalcon\Image\Adapter implements \Phalcon\Image\AdapterIn
 	/**
 	 * Composite one image onto another
 	 *
-	 * @param \Phalcon\Image\Adapter $mask mask Image instance
+	 * @param Adapter $mask mask Image instance
 	 */
-	protected function _mask(<\Phalcon\Image\Adapter> image)
+	protected function _mask(<Adapter> image)
 	{
 		var mask, ret;
 

phalcon/image/adapterinterface.zep

@@ -27,9 +27,9 @@ interface AdapterInterface
 	public function flip(int direction);
 	public function sharpen(int amount);
 	public function reflection(int height, int opacity = 100, boolean fadeIn = false);
-	public function watermark(<\Phalcon\Image\Adapter> watermark, int offsetX = 0, int offsetY = 0, int opacity = 100);
+	public function watermark(<Adapter> watermark, int offsetX = 0, int offsetY = 0, int opacity = 100);
 	public function text(string text, int offsetX = 0, int offsetY = 0, int opacity = 100, string color = "000000", int size = 12, string fontfile = null);
-	public function mask(<\Phalcon\Image\Adapter> watermark);
+	public function mask(<Adapter> watermark);
 	public function background(string color, int opacity = 100);
 	public function blur(int radius);
 	public function pixelate(int amount);