mujma: Added comments for ImageEditor?.php, fixed JSON bug, added status message after saving, added tmp folder delete after editing.

(merged from branches/gsoc)


git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/cms/trunk@41882 467b73ca-7a2a-4603-9d3b-597d59a354a9

code/ImageEditor.php

@@ -1,18 +1,28 @@
 <?php
+/**
+ * This Controller handles all operation needed for ImageEditor to work(expect for GD operations).
+ * 
+*/
 
 	class ImageEditor extends Controller {
 		
 		public $fileToEdit = "";
 		
-		public function __construct() {
+		/**
-		}
+		 * Includes all JS required for ImageEditor. This method requires setting
-		
+		 * a fileToEdit URL in POST.
+		 *
+		 * @return String
+		*/ 
 		public function index() {
 			Requirements::clear();
 			Requirements::javascript("jsparty/prototype.js");
 			Requirements::javascript("jsparty/scriptaculous/scriptaculous.js");
 			Requirements::javascript("/cms/javascript/ImageEditor/Require.js");
 			Requirements::javascript("cms/javascript/ImageEditor/ImageEditor.js");
+			Requirements::javascript("jsparty/loader.js");
+			Requirements::javascript("jsparty/behaviour.js");
+			Requirements::javascript("cms/javascript/LeftAndMain.js");
 			Requirements::css("cms/css/ImageEditor/ImageEditor.css");
 
 			if(!isset($this->requestParams['fileToEdit'])) $this->raiseError();
@@ -22,12 +32,16 @@
 			return $this->renderWith(__CLASS__);
 		}
 		
-		private function raiseError() 
+		/**
-		{
+		 * Method is used for manipulating photos.
-			Debug::friendlyError(500,"Bad arguments",__FILE__,__LINE__,'');
+		 * Method requires two params set in POST
-			exit();	
+		 * 	file - file on which operation will be performed
-		}
+		 *  command - name of operation(crop|rotate|resize)
-		
+		 * 
+		 * Each operation requires additional parameters.
+		 *
+		 * @return String - JSON array with image properties (width,height,url).
+		*/ 
 		public function manipulate() {
 			$fileName = $this->requestParams['file'];
 			$command = $this->requestParams['command'];
@@ -53,9 +67,20 @@
 			}
 			$rand = md5(rand(1,100000));
 			$gd->writeTo('../assets/tmp/' . $rand . '.jpg');
-			$this->returnImage($gd,'assets/tmp/' . $rand . '.jpg');	
+			return $this->getImageInfoInJSON($gd,'../assets/tmp/' . $rand . '.jpg');	
 		}
 		
+		/**
+		 * Method is used for saving photos.
+		 * Method requires two params set in POST
+		 * 	originalFile - this file will be replaced by second file
+		 *  editedFile - this file will replace first file.
+		 * 
+		 * After replacing original file all thumbnails created from it are removed.
+		 *
+		 * @return String - Message that everything went ok.
+		*/ 
+		
 		public function save() {
 			if(isset($this->requestParams['originalFile']) && isset($this->requestParams['editedFile'])) {
 				$originalFile = $this->requestParams['originalFile'];
@@ -73,18 +98,44 @@
 			} else {
 				$this->raiseError();
 			}
+			return "parent.parent.parent.statusMessage('Image saved','good',false);";
 		}
 		
-		private function returnImage(GD $gd,$strFile)
+		/**
-		{
+		 * Method is invoked when ImageEditor is closed whether image is saved or not.
-			list($width, $height) = getimagesize('../' . $strFile);		
+		 * 
-			echo json_encode(array(
+		 * /assets/tmp is folder where we store temporary images created during editing so 
-								'fileName' => $strFile,
+		 * after closing they are no necessity to keep them.
-								'width' => $width,
+		 * 
-								'height' => $height)
+		 * @return null
-							);
+		*/ 
+		
+		public function close() {
+			Filesystem::removeFolder('../assets/tmp');
 		}
 		
+		/**
+		 * Method return JSON array containing info about image.
+		 * 
+		 * @param gd - GD object used for retrieving info about image
+		 * @param file 
+		 * 
+		 * @return string JSON array explained in manipulate method comment
+		*/ 
+		
+		private function getImageInfoInJSON(GD $gd,$file)
+		{
+			return '{"fileName":"' . $file . '","width":' . $gd->getWidth() . ',"height":' . $gd->getHeight() . '}';
+		}
+		
+		/**
+		 * Method converts thumbnail file name to file name of it's "parent"
+		 * 
+		 * @param file - name of thumbnail file
+		 * 
+		 * @return string name of parent file.
+		*/ 
+		
 		private function file2Origin($file) {
 			$file = str_replace('_resampled/','',$file);
 			$file = str_replace('_resampled/','',$file);
@@ -92,11 +143,27 @@
 			$this->checkFileExists($file);
 			return $file;
 		}
+		/**
+		 * Method converts URL of file to file path in file system.
+		 * 
+		 * @param url - url of file
+		 * 
+		 * @return string path of file in file system
+		*/ 
 		
 		private function url2File($url) {
 			return '..' . substr($url,strpos($url,'/assets'));
 		}
 		
+		/**
+		 * Method checks if file exists and have proper name and extension.
+		 * 
+		 * If any of constraints aren't fulfilled method will generate error.
+		 * 
+		 * @param url - url of file
+		 * 
+		 * @return boolean 
+		*/ 
 		
 		private function checkFileExists($url) {
 			$pathInfo = pathinfo($url);
@@ -123,5 +190,18 @@
 				$this->raiseError();
 			}		
 		}
+		
+		/**
+		 * Method raiser error. Error is showed using statusMessage function.
+		 * 
+		 * @param message - error message
+		 * 
+		*/ 
+		
+		private function raiseError($message = "") 
+		{
+			echo "parent.parent.parent.statusMessage('Error: " . $message . "','bad',false);";
+			exit();	
+		}
 	}
 ?>

javascript/ImageEditor/ImageEditor.js

@@ -38,5 +38,6 @@ var ImageEditor = {
 	onClose: function() {
 		window.parent.frames[1].location.reload(1);
 		Element.hide(window.frameElement);
+		imageTransformation.close();
 	}		
 }

javascript/ImageEditor/ImageTransformation.js

@@ -7,6 +7,7 @@ var ImageTransformation = {
 		this.rotate = ImageTransformation.rotate.bind(this);
 		this.crop = ImageTransformation.crop.bind(this);	
 		this.save = ImageTransformation.save.bind(this);
+		this.close = ImageTransformation.close.bind(this);
 	},
 		
 	resize: function(width,height) {
@@ -70,10 +71,22 @@ var ImageTransformation = {
 		 	method: 'post',
 			postBody: 'command=save&editedFile=' + editedFile + '&originalFile=' + originalFile,
 			onSuccess: function(transport) {
+				eval(transport.responseText);
 				imageEditor.onClose();
 			},
 		 };
 		 new Ajax.Request('admin/ImageEditor/save', options);
+	},
+	
+	close: function() {
+		var options = {
+		 	method: 'post',
+			postBody: '',
+			onSuccess: function(transport) {
+				eval(transport.responseText);
+			},
+		 };
+		 new Ajax.Request('admin/ImageEditor/close', options);
 	}
 }