Refactoring of comments beginning

server/core/Compute.php

@@ -4,170 +4,170 @@ use OpenCloud\Common\Error;
 
 class compute 
 {
-        /** @var App $app protected, contains the main app object */
-        protected $app;
+	/** @var App $app protected, contains the main app object */
+	protected $app;
 
-        /** @var OpenStack\Identity $libClass protected, contains the library Compute object */
-        protected $libClass;
+	/** @var OpenStack\Identity $libClass protected, contains the library Compute object */
+	protected $libClass;
 
 
-	    public function __construct($app)
-    	{
-       	         $this->app = $app;
-        	 $this->libClass = $app->getLibClass("Compute");
-    	}
+	public function __construct($app)
+	{
+		$this->app = $app;
+		$this->libClass = $app->getLibClass("Compute");
+	}
 	/**
 	* Execute an action
 	*
 	* @param String $action name of another function of this class
 	*
-	* @return void
+	* @return NULL
 	*/
 	public function action($action){
 		
-		 $this->{$action.""}();
+		$this->{$action.""}();
 		
 	}
-    	/**
-     	* List servers.
-     	* @return array
-     	*/
-        public function listServers()
-        {
+	/**
+			* List servers.
+			* @return array
+			*/
+	public function listServers()
+	{
 		try{
 			$serverList = $this->libClass->listServers(true);
 			$servers = Array();
 			foreach($serverList as $server){
-			$servers[$server->id] = Array();
-			$server->flavor->retrieve();
-			$server->image->retrieve();
-			$server->retrieve();
-			$servers[$server->id]["id"]  = $server->id;
-			$servers[$server->id]["name"] = $server->name;
-			$servers[$server->id]["image"] = $server->image; 
-			$servers[$server->id]["ram"] = $server->flavor->ram;
-			$servers[$server->id]["disk"] = $server->flavor->disk;
-			$servers[$server->id]["flavor"] = $server->flavor; 
-			$servers[$server->id]["status"] = $server->status;
-			$servers[$server->id]["created"] = $server->created;
-			$servers[$server->id]["updated"] = $server->updated;
-			$servers[$server->id]["ipv4"] = $server->ipv4;
-			$servers[$server->id]["ipv6"] = $server->ipv6;
-			$servers[$server->id]["progress"] = $server->progress;
-			$servers[$server->id]["hostId"] = $server->hostId;
-			$servers[$server->id]["tenantId"] = $server->tenantId;
-			$servers[$server->id]["userId"] = $server->userId;
-			$servers[$server->id]["taskState"] = $server->taskState;
-			$servers[$server->id]["addresses"] = $server->addresses;
-			$servers[$server->id]["links"] = $server->links;
-			$servers[$server->id]["metadata"] = $server->metadata;
+				$servers[$server->id] = Array();
+				$server->flavor->retrieve();
+				$server->image->retrieve();
+				$server->retrieve();
+				$servers[$server->id]["id"]  = $server->id;
+				$servers[$server->id]["name"] = $server->name;
+				$servers[$server->id]["image"] = $server->image; 
+				$servers[$server->id]["ram"] = $server->flavor->ram;
+				$servers[$server->id]["disk"] = $server->flavor->disk;
+				$servers[$server->id]["flavor"] = $server->flavor; 
+				$servers[$server->id]["status"] = $server->status;
+				$servers[$server->id]["created"] = $server->created;
+				$servers[$server->id]["updated"] = $server->updated;
+				$servers[$server->id]["ipv4"] = $server->ipv4;
+				$servers[$server->id]["ipv6"] = $server->ipv6;
+				$servers[$server->id]["progress"] = $server->progress;
+				$servers[$server->id]["hostId"] = $server->hostId;
+				$servers[$server->id]["tenantId"] = $server->tenantId;
+				$servers[$server->id]["userId"] = $server->userId;
+				$servers[$server->id]["taskState"] = $server->taskState;
+				$servers[$server->id]["addresses"] = $server->addresses;
+				$servers[$server->id]["links"] = $server->links;
+				$servers[$server->id]["metadata"] = $server->metadata;
 			}
 			$this->app->setOutput("Servers", $servers);
 		}
 		catch(BadResponseError $e){
 			$this->app->getErrorInstance()->BadResponseHandler($e);
-        	}
+		}
 		catch(UserInputError $e){
 			$this->app->getErrorInstance()->UserInputHandler($e);
-	        }
+		}
 		catch(BaseError $e){
 			$this->app->getErrorInstance()->BaseErrorHandler($e);
-	        }
+		}
 		catch(NotImplementedError $e){
 			$this->app->getErrorInstance()->NotImplementedHandler($e);
-	        }
+		}
 		catch(Exception $e){
 			$this->app->getErrorInstance()->OtherException($e);
-	        }
-                return;
-        }
-        /**
-         * List flavors.
-         * @return array
-         */
-        public function listFlavors()
-        {
+		}
+		return;
+	}
+	/**
+				* List flavors.
+				* @return array
+				*/
+	public function listFlavors()
+	{
 		try{
 			$flavorList = $this->libClass->listFlavors();
 			$flavors = Array();
 			foreach($flavorList as $flavor){
-			$flavors[$flavor->id] = Array();
-			$flavor->retrieve();
-			$flavors[$flavor->id]["id"]  = $flavor->id;
-			$flavors[$flavor->id]["name"] = $flavor->name;
-			$flavors[$flavor->id]["ram"] = $flavor->ram;
-			$flavors[$flavor->id]["disk"] = $flavor->disk;
-			$flavors[$flavor->id]["vcpus"] = $flavor->vcpus;
-			$flavors[$flavor->id]["links"] = $flavor->links;
-		}
-		$this->app->setOutput("Flavors", $flavors);
+				$flavors[$flavor->id] = Array();
+				$flavor->retrieve();
+				$flavors[$flavor->id]["id"]  = $flavor->id;
+				$flavors[$flavor->id]["name"] = $flavor->name;
+				$flavors[$flavor->id]["ram"] = $flavor->ram;
+				$flavors[$flavor->id]["disk"] = $flavor->disk;
+				$flavors[$flavor->id]["vcpus"] = $flavor->vcpus;
+				$flavors[$flavor->id]["links"] = $flavor->links;
+			}
+			$this->app->setOutput("Flavors", $flavors);
 		}
 		catch(BadResponseError $e){
 			$this->app->getErrorInstance()->BadResponseHandler($e);
-        	}
+		}
 		catch(UserInputError $e){
 			$this->app->getErrorInstance()->UserInputHandler($e);
-	        }
+		}
 		catch(BaseError $e){
 			$this->app->getErrorInstance()->BaseErrorHandler($e);
-	        }
+		}
 		catch(NotImplementedError $e){
 			$this->app->getErrorInstance()->NotImplementedHandler($e);
-	        }
+		}
 		catch(Exception $e){
 			$this->app->getErrorInstance()->OtherException($e);
-	        }
-                return;
-        }
-        /**
-         * List images.
-         * @return array
-         */
-        public function listImages()
-        {
-               	try{
+		}
+		return;
+	}
+	/**
+				* List images.
+				* @return array
+				*/
+	public function listImages()
+	{
+		try{
 			$imageList = $this->libClass->listImages();
 			$images = Array();
 			foreach($imageList as $image){
-			$images[$image->id] = Array();
-			$image->retrieve();
-			$images[$image->id]["id"]  = $image->id;
-			$images[$image->id]["name"] = $image->name;
-			$images[$image->id]["status"] = $image->status;
-			$images[$image->id]["created"] = $image->created;
-			$images[$image->id]["updated"] = $image->updated;
-			$images[$image->id]["minDisk"] = $image->minDisk;
-			$images[$image->id]["minRam"] = $image->minRam;
-			$images[$image->id]["progress"] = $image->progress;
-			$images[$image->id]["links"] = $image->links;
-			$images[$image->id]["metadata"] = $image->metadata;
-		}
-		$this->app->setOutput("Images", $images);
+				$images[$image->id] = Array();
+				$image->retrieve();
+				$images[$image->id]["id"]  = $image->id;
+				$images[$image->id]["name"] = $image->name;
+				$images[$image->id]["status"] = $image->status;
+				$images[$image->id]["created"] = $image->created;
+				$images[$image->id]["updated"] = $image->updated;
+				$images[$image->id]["minDisk"] = $image->minDisk;
+				$images[$image->id]["minRam"] = $image->minRam;
+				$images[$image->id]["progress"] = $image->progress;
+				$images[$image->id]["links"] = $image->links;
+				$images[$image->id]["metadata"] = $image->metadata;
+			}
+			$this->app->setOutput("Images", $images);
 		}
 		catch(BadResponseError $e){
 			$this->app->getErrorInstance()->BadResponseHandler($e);
-        	}
+		}
 		catch(UserInputError $e){
 			$this->app->getErrorInstance()->UserInputHandler($e);
-	        }
+		}
 		catch(BaseError $e){
 			$this->app->getErrorInstance()->BaseErrorHandler($e);
-	        }
+		}
 		catch(NotImplementedError $e){
 			$this->app->getErrorInstance()->NotImplementedHandler($e);
-	        }
+		}
 		catch(Exception $e){
 			$this->app->getErrorInstance()->OtherException($e);
-	        }
-                return;
-        }
-       /**
-         * Get server details.
-         * @return array
-         */
-        public function getServer()
-        {
-	       	try{
+		}
+		return;
+	}
+	/**
+				* Get server details.
+				* @return array
+				*/
+	public function getServer()
+	{
+		try{
 			$serverId = $this->app->getPostParam("serverId");
 			if(!isset($serverId)){
 				$this->app->setOutput("Error", "Server ID is missing!");
@@ -180,27 +180,27 @@ class compute
 		}
 		catch(BadResponseError $e){
 			$this->app->getErrorInstance()->BadResponseHandler($e);
-        	}
+		}
 		catch(UserInputError $e){
 			$this->app->getErrorInstance()->UserInputHandler($e);
-	        }
+		}
 		catch(BaseError $e){
 			$this->app->getErrorInstance()->BaseErrorHandler($e);
-	        }
+		}
 		catch(NotImplementedError $e){
 			$this->app->getErrorInstance()->NotImplementedHandler($e);
-	        }
+		}
 		catch(Exception $e){
 			$this->app->getErrorInstance()->OtherException($e);
-	        }
-                return;
-        }
-        /**
-         * Get flavor details.
-         * @return array
-         */
-        public function getFlavor()
-        {
+		}
+		return;
+	}
+	/**
+				* Get flavor details.
+				* @return array
+				*/
+	public function getFlavor()
+	{
 		try{
 			$flavorId = $this->app->getPostParam("flavorId");
 			if(!isset($serverId)){
@@ -214,27 +214,27 @@ class compute
 		}
 		catch(BadResponseError $e){
 			$this->app->getErrorInstance()->BadResponseHandler($e);
-        	}
+		}
 		catch(UserInputError $e){
 			$this->app->getErrorInstance()->UserInputHandler($e);
-	        }
+		}
 		catch(BaseError $e){
 			$this->app->getErrorInstance()->BaseErrorHandler($e);
-	        }
+		}
 		catch(NotImplementedError $e){
 			$this->app->getErrorInstance()->NotImplementedHandler($e);
-	        }
+		}
 		catch(Exception $e){
 			$this->app->getErrorInstance()->OtherException($e);
-	        }
-                return;
-        }
-        /**
-         * Get image details.
-         * @return array
-         */
-        public function getImage()
-        {
+		}
+		return;
+	}
+	/**
+				* Get image details.
+				* @return array
+				*/
+	public function getImage()
+	{
 		try{
 			$imageId = $this->app->getPostParam("imageId");
 			if(!isset($serverId)){
@@ -248,27 +248,27 @@ class compute
 		}
 		catch(BadResponseError $e){
 			$this->app->getErrorInstance()->BadResponseHandler($e);
-        	}
+		}
 		catch(UserInputError $e){
 			$this->app->getErrorInstance()->UserInputHandler($e);
-	        }
+		}
 		catch(BaseError $e){
 			$this->app->getErrorInstance()->BaseErrorHandler($e);
-	        }
+		}
 		catch(NotImplementedError $e){
 			$this->app->getErrorInstance()->NotImplementedHandler($e);
-	        }
+		}
 		catch(Exception $e){
 			$this->app->getErrorInstance()->OtherException($e);
-	        }
-                return;
-        }
-        /**
-         * Create server.
-         * @return array
-         */ 
-        public function createServer()
-        {
+		}
+		return;
+	}
+	/**
+				* Create server.
+				* @return array
+				*/ 
+	public function createServer()
+	{
 		try{
 			$name = $this->app->getPostParam("name");
 			$imageId = $this->app->getPostParam("imageId");
@@ -282,28 +282,28 @@ class compute
 		}
 		catch(BadResponseError $e){
 			$this->app->getErrorInstance()->BadResponseHandler($e);
-        	}
+		}
 		catch(UserInputError $e){
 			$this->app->getErrorInstance()->UserInputHandler($e);
-	        }
+		}
 		catch(BaseError $e){
 			$this->app->getErrorInstance()->BaseErrorHandler($e);
-	        }
+		}
 		catch(NotImplementedError $e){
 			$this->app->getErrorInstance()->NotImplementedHandler($e);
-	        }
+		}
 		catch(Exception $e){
 			$this->app->getErrorInstance()->OtherException($e);
-	        }
+		}
 		return;
-        }
- 
+	}
+
 	/**
 	* update a server
-	* @return void
+	* @return NULL
 	*/
-        public function updateServer()
-        {
+	public function updateServer()
+	{
 		try{
 			$serverId = $this->app->getPostParam("serverId");
 			$newName = $this->app->getPostParam("newName");
@@ -329,27 +329,27 @@ class compute
 		}
 		catch(BadResponseError $e){
 			$this->app->getErrorInstance()->BadResponseHandler($e);
-        	}
+		}
 		catch(UserInputError $e){
 			$this->app->getErrorInstance()->UserInputHandler($e);
-	        }
+		}
 		catch(BaseError $e){
 			$this->app->getErrorInstance()->BaseErrorHandler($e);
-	        }
+		}
 		catch(NotImplementedError $e){
 			$this->app->getErrorInstance()->NotImplementedHandler($e);
-	        }
+		}
 		catch(Exception $e){
 			$this->app->getErrorInstance()->OtherException($e);
-	        }
-                return;
-        }
+		}
+		return;
+	}
 	/**
 	* Delete a server
-	* @return void
+	* @return NULL
 	*/
-        public function deleteServer()
-        {
+	public function deleteServer()
+	{
 		try{
 			$serverId = $this->app->getPostParam("serverId");
 			if(!isset($serverId)){
@@ -363,27 +363,27 @@ class compute
 		}
 		catch(BadResponseError $e){
 			$this->app->getErrorInstance()->BadResponseHandler($e);
-        	}
+		}
 		catch(UserInputError $e){
 			$this->app->getErrorInstance()->UserInputHandler($e);
-	        }
+		}
 		catch(BaseError $e){
 			$this->app->getErrorInstance()->BaseErrorHandler($e);
-	        }
+		}
 		catch(NotImplementedError $e){
 			$this->app->getErrorInstance()->NotImplementedHandler($e);
-	        }
+		}
 		catch(Exception $e){
 			$this->app->getErrorInstance()->OtherException($e);
-	        }
-                return;
-        }
+		}
+		return;
+	}
 	/**
 	* Change the password of a server
-	* @return void
+	* @return NULL
 	*/
-        public function changePassword()
-        {
+	public function changePassword()
+	{
 		try{
 			$serverId = $this->app->getPostParam("serverId");
 			$password = $this->app->getPostParam("newPassword");
@@ -398,27 +398,27 @@ class compute
 		}
 		catch(BadResponseError $e){
 			$this->app->getErrorInstance()->BadResponseHandler($e);
-        	}
+		}
 		catch(UserInputError $e){
 			$this->app->getErrorInstance()->UserInputHandler($e);
-	        }
+		}
 		catch(BaseError $e){
 			$this->app->getErrorInstance()->BaseErrorHandler($e);
-	        }
+		}
 		catch(NotImplementedError $e){
 			$this->app->getErrorInstance()->NotImplementedHandler($e);
-	        }
+		}
 		catch(Exception $e){
 			$this->app->getErrorInstance()->OtherException($e);
-	        }
+		}
 		return;
-        }
-        /**
+	}
+	/**
 	* Reboot a server
-	* @return void
+	* @return NULL
 	*/
-        public function reboot()
-        {
+	public function reboot()
+	{
 		try{
 			$serverId = $this->app->getPostParam("serverId");
 			if(!isset($serverId)){
@@ -432,74 +432,74 @@ class compute
 		}
 		catch(BadResponseError $e){
 			$this->app->getErrorInstance()->BadResponseHandler($e);
-        	}
+		}
 		catch(UserInputError $e){
 			$this->app->getErrorInstance()->UserInputHandler($e);
-	        }
+		}
 		catch(BaseError $e){
 			$this->app->getErrorInstance()->BaseErrorHandler($e);
-	        }
+		}
 		catch(NotImplementedError $e){
 			$this->app->getErrorInstance()->NotImplementedHandler($e);
-	        }
+		}
 		catch(Exception $e){
 			$this->app->getErrorInstance()->OtherException($e);
-	        }
-                return;
-        }
-       	/**
+		}
+		return;
+	}
+	/**
 	* Rebuild a server
-	* @return void
+	* @return NULL
 	*/
-        public function rebuild()
-        {
-               	$serverId = $this->app->getPostParam("serverId");
-               	$imageId = $this->app->getPostParam("imageId");
-               	$newName = $this->app->getPostParam("newName");
-               	$adminPass = $this->app->getPostParam("adminPass");
+	public function rebuild()
+	{
+		$serverId = $this->app->getPostParam("serverId");
+		$imageId = $this->app->getPostParam("imageId");
+		$newName = $this->app->getPostParam("newName");
+		$adminPass = $this->app->getPostParam("adminPass");
 		if(!isset($serverId)|| !isset($imageId) || isset($newName) || isset($adminPass)) {
 			$this->app->setOutput("Error", "You'll have to provide server ID and the new image, name and admin password!");
 			return;
-		try{
-			$serverId = $this->app->getPostParam("serverId");
-			$imageId = $this->app->getPostParam("imageId");
-			$newName = $this->app->getPostParam("newName");
-			$adminPass = $this->app->getPostParam("adminPass");
-			if(!isset($serverId)|| !isset($imageId) || isset($newName) || isset($adminPass)){
-				$this->app->setOutput("Error", "You'll have to provide server ID and the new image, name and admin password!");
-				return;
-			}
-			$opt = array('id' => $serverId);
-			$server = $this->libClass->getServer($opt);
-			$attr = array('imageId' => $imageId, 'name' => $newName, 'adminPass' => $adminPass); 
-			$server->rebuild($attr);
-			$this->app->setOutput("Success", $serverId." has been rebuilt successfully with the new image.");
-		}
-		catch(BadResponseError $e){
-			$this->app->getErrorInstance()->BadResponseHandler($e);
-        	}
-		catch(UserInputError $e){
-			$this->app->getErrorInstance()->UserInputHandler($e);
-	        }
-		catch(BaseError $e){
-			$this->app->getErrorInstance()->BaseErrorHandler($e);
-	        }
-		catch(NotImplementedError $e){
-			$this->app->getErrorInstance()->NotImplementedHandler($e);
-	        }
-		catch(Exception $e){
-			$this->app->getErrorInstance()->OtherException($e);
-	        }
-                return;
-        }
+			try{
+				$serverId = $this->app->getPostParam("serverId");
+				$imageId = $this->app->getPostParam("imageId");
+				$newName = $this->app->getPostParam("newName");
+				$adminPass = $this->app->getPostParam("adminPass");
+				if(!isset($serverId)|| !isset($imageId) || isset($newName) || isset($adminPass)){
+					$this->app->setOutput("Error", "You'll have to provide server ID and the new image, name and admin password!");
+					return;
 				}
-       	/**
+				$opt = array('id' => $serverId);
+				$server = $this->libClass->getServer($opt);
+				$attr = array('imageId' => $imageId, 'name' => $newName, 'adminPass' => $adminPass); 
+				$server->rebuild($attr);
+				$this->app->setOutput("Success", $serverId." has been rebuilt successfully with the new image.");
+			}
+			catch(BadResponseError $e){
+				$this->app->getErrorInstance()->BadResponseHandler($e);
+			}
+			catch(UserInputError $e){
+				$this->app->getErrorInstance()->UserInputHandler($e);
+			}
+			catch(BaseError $e){
+				$this->app->getErrorInstance()->BaseErrorHandler($e);
+			}
+			catch(NotImplementedError $e){
+				$this->app->getErrorInstance()->NotImplementedHandler($e);
+			}
+			catch(Exception $e){
+				$this->app->getErrorInstance()->OtherException($e);
+			}
+			return;
+		}
+	}
+	/**
 	* Resize a server
 	* A call to this method has to be followed by either confirmResize or revertResize
-	* @return void
+	* @return NULL
 	*/
-        public function resize()
-        {
+	public function resize()
+	{
 		try{
 			$serverId = $this->app->getPostParam("serverId");
 			$newFlavorId = $this->app->getPostParam("newFlavorId");
@@ -513,27 +513,27 @@ class compute
 		}
 		catch(BadResponseError $e){
 			$this->app->getErrorInstance()->BadResponseHandler($e);
-        	}
+		}
 		catch(UserInputError $e){
 			$this->app->getErrorInstance()->UserInputHandler($e);
-	        }
+		}
 		catch(BaseError $e){
 			$this->app->getErrorInstance()->BaseErrorHandler($e);
-	        }
+		}
 		catch(NotImplementedError $e){
 			$this->app->getErrorInstance()->NotImplementedHandler($e);
-	        }
+		}
 		catch(Exception $e){
 			$this->app->getErrorInstance()->OtherException($e);
-	        }
-                return;
-        }
-        /**
+		}
+		return;
+	}
+	/**
 	* Confirm resize operation on a server
-	* @return void
+	* @return NULL
 	*/
-        public function confirmResize()
-        {
+	public function confirmResize()
+	{
 		try{
 			$serverId = $this->app->getPostParam("serverId");
 			if(!isset($serverId)){
@@ -547,27 +547,27 @@ class compute
 		}
 		catch(BadResponseError $e){
 			$this->app->getErrorInstance()->BadResponseHandler($e);
-        	}
+		}
 		catch(UserInputError $e){
 			$this->app->getErrorInstance()->UserInputHandler($e);
-	        }
+		}
 		catch(BaseError $e){
 			$this->app->getErrorInstance()->BaseErrorHandler($e);
-	        }
+		}
 		catch(NotImplementedError $e){
 			$this->app->getErrorInstance()->NotImplementedHandler($e);
-	        }
+		}
 		catch(Exception $e){
 			$this->app->getErrorInstance()->OtherException($e);
-	        }
-                return;
-        }
-        /**
+		}
+		return;
+	}
+	/**
 	* Revert resize operation on a server
-	* @return void
+	* @return NULL
 	*/
-        public function revertResize()
-        {
+	public function revertResize()
+	{
 		try{
 			$serverId = $this->app->getPostParam("serverId");
 			if(!isset($serverId)){
@@ -581,28 +581,28 @@ class compute
 		}
 		catch(BadResponseError $e){
 			$this->app->getErrorInstance()->BadResponseHandler($e);
-        	}
+		}
 		catch(UserInputError $e){
 			$this->app->getErrorInstance()->UserInputHandler($e);
-	        }
+		}
 		catch(BaseError $e){
 			$this->app->getErrorInstance()->BaseErrorHandler($e);
-	        }
+		}
 		catch(NotImplementedError $e){
 			$this->app->getErrorInstance()->NotImplementedHandler($e);
-	        }
+		}
 		catch(Exception $e){
 			$this->app->getErrorInstance()->OtherException($e);
-	        }
-                return;
-        }
+		}
+		return;
+	}
 	/**
 	* List private and public addresses of a server
-	* @return void
+	* @return NULL
 	*/
-        
-        public function listAddresses(array $options = [])
-        {
+	
+	public function listAddresses(array $options = [])
+	{
 		try{
 			$serverId = $this->app->getPostParam("serverId");
 			if(!isset($serverId)){
@@ -616,20 +616,20 @@ class compute
 		}
 		catch(BadResponseError $e){
 			$this->app->getErrorInstance()->BadResponseHandler($e);
-        	}
+		}
 		catch(UserInputError $e){
 			$this->app->getErrorInstance()->UserInputHandler($e);
-	        }
+		}
 		catch(BaseError $e){
 			$this->app->getErrorInstance()->BaseErrorHandler($e);
-	        }
+		}
 		catch(NotImplementedError $e){
 			$this->app->getErrorInstance()->NotImplementedHandler($e);
-	        }
+		}
 		catch(Exception $e){
 			$this->app->getErrorInstance()->OtherException($e);
-	        }
-                return;
-        }
+		}
+		return;
+	}
 }
- 
+