End of comments

server/config.inc.php

@@ -1,6 +1,6 @@
 <?php
 /**
-* File containing the code for the API door.
+* File containing global config options for the API.
 *
 * @version 1.0 Initialisation of this file
 * @since 1.0 Core application's file
@@ -15,7 +15,7 @@ $config = Array();
 
 $config["modules_enabled"] = "";
 $config["urlAuth"] = "http://148.60.11.31:5000/v3";
-$config["tokenTime"] = 60; //minute = 60
+$config["tokenTime"] = 60; //minutes
 ?>
 
 	

server/core/App.php

@@ -9,7 +9,9 @@
 * 
 */
 
-//Library token management override
+/*
+* Library token management override
+*/
 include_once("core/LibOverride/genTokenOptions.php");
 include_once("core/ErrorManagement.php");
 
@@ -28,7 +30,7 @@ use OpenCloud\Common\Error\UserInputError;
 */
 class App{
 	
-	/** @var Openstack $openstack protected, contains the main library object */
+	/** @var OpenStack\OpenStack $openstack protected, contains the main library object */
 	protected $openstack;
 	/** @var Array $postParams protected, contains the post parameters */
 	protected $postParams;
@@ -124,7 +126,7 @@ class App{
 	/**
 	* Generate the token for the different services in OpenStack
 	*
-	* @return NULL
+	* @return void
 	*/
 	public function authenticate(){
 		
@@ -150,7 +152,7 @@ class App{
 	/**
 	* Revoke the openstack services' token
 	*
-	* @return NULL
+	* @return void
 	*/
 	public function deauthenticate(){
 		
@@ -197,7 +199,7 @@ class App{
 	* @param String $param Name for the Post entry
 	* @param Object $value Value for the Post entry
 	*
-	* @return NULL
+	* @return void
 	*/
 	public function setPostParam($param, $value){
 		
@@ -211,7 +213,7 @@ class App{
 	* @param String $key Array key for the message
 	* @param Array $out Message's value
 	*
-	* @return NULL
+	* @return void
 	*/
 	public function setOutput($key, $out){
 		
@@ -233,7 +235,7 @@ class App{
 	/**
 	* Output the messages to be send to the client
 	*
-	* @return NULl
+	* @return void
 	*/
 	public function show(){
 		echo json_encode($this->output);

server/core/Automating.php

@@ -14,21 +14,31 @@ include("Network.php");
 include("Compute.php");
 include("NetworkLayer3.php");
 
-class automating{
+/**
+* automating Class of the back-end application
+*
+* Contains the different function to automate some action
+*
+*/
+class automating implements Core{
 
-	/** @var App $app protected, contains the main app object */
+	/** @var App $compute protected, contains a Core compute object */
 	protected $compute;
+	/** @var App $image protected, contains a Core image object */
 	protected $image;
+	/** @var App $network protected, contains a Core network object */
 	protected $network;
+	/** @var App $networkLayer3 protected, contains a Core networkLayer3 object */
 	protected $networkLayer3;
+	/** @var App $app protected, contains the main app object */
 	protected $app;
 	
 	/**
-	* Our library's app constructor for all server app objects
+	* automating class constructor
 	*
-	* @param App $app the main app object, e.g. compute, image, network, etc.
+	* @param App $app the main app object
 	*
-	* @return
+	* @return automating Object
 	*/
 	public function __construct($app){
 		$this->app = $app;
@@ -43,7 +53,7 @@ class automating{
 	*
 	* @param String $action name of another function of this class
 	*
-	* @return NULL
+	* @return void
 	*/
 	public function action($action){
 		$this->{$action.""}();	
@@ -57,7 +67,7 @@ class automating{
 	* @param String $serverName name ofthe new server
 	* @param String $flavor kind of server
 	*	
-	* @return NULL
+	* @return void
 	*/
 	private function createPublicServer()
 	{

server/core/Compute.php

@@ -1,37 +1,62 @@
 <?php
-//namespace istic-openstack\Server\core;
+/**
+* File containing the compute Class.
+*
+* @version 1.0 Initialisation of this file
+* @since 1.0 Core application's file
+* 
+* @author  bhupi
+* 
+*/
+
 use OpenCloud\Common\Error;
 
-class compute 
+/**
+* Compute Class of the back-end application
+*
+* Management of Servers
+*
+*/
+class compute implements Core
 {
 	/** @var App $app protected, contains the main app object */
 	protected $app;
 
-	/** @var OpenStack\Identity $libClass protected, contains the library Compute object */
+	/** @var OpenStack\Compute $libClass protected, contains the library Compute object */
 	protected $libClass;
 
 
+	/**
+	* Compute constructor
+	*
+	* @param App $args the main app object
+	*
+	* @return compute Object
+	*/
 	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 NULL
+	* @return void
 	*/
 	public function action($action){
 		
 		$this->{$action.""}();
 		
 	}
+	
 	/**
-			* List servers.
+	* List servers.
-			* @return array
+	*
-			*/
+	* @return void
+	*/
 	public function listServers()
 	{
 		try{
@@ -79,12 +104,13 @@ class compute
 		catch(Exception $e){
 			$this->app->getErrorInstance()->OtherException($e);
 		}
-		return;
 	}
+	
 	/**
-				* List flavors.
+	* List flavors.
-				* @return array
+	*
-				*/
+	* @return void
+	*/
 	public function listFlavors()
 	{
 		try{
@@ -117,12 +143,13 @@ class compute
 		catch(Exception $e){
 			$this->app->getErrorInstance()->OtherException($e);
 		}
-		return;
 	}
+	
 	/**
-				* List images.
+	* List images.
-				* @return array
+	*
-				*/
+	* @return void
+	*/
 	public function listImages()
 	{
 		try{
@@ -159,12 +186,13 @@ class compute
 		catch(Exception $e){
 			$this->app->getErrorInstance()->OtherException($e);
 		}
-		return;
 	}
+	
 	/**
-				* Get server details.
+	* Get server details.
-				* @return array
+	*
-				*/
+	* @return void
+	*/
 	public function getServer()
 	{
 		try{
@@ -193,12 +221,13 @@ class compute
 		catch(Exception $e){
 			$this->app->getErrorInstance()->OtherException($e);
 		}
-		return;
 	}
+	
 	/**
-				* Get flavor details.
+	* Get flavor details.
-				* @return array
+	*
-				*/
+	* @return void
+	*/
 	public function getFlavor()
 	{
 		try{
@@ -227,12 +256,12 @@ class compute
 		catch(Exception $e){
 			$this->app->getErrorInstance()->OtherException($e);
 		}
-		return;
 	}
+	
 	/**
-				* Get image details.
+	* Get image details.
-				* @return array
+	* @return array
-				*/
+	*/
 	public function getImage()
 	{
 		try{
@@ -261,12 +290,13 @@ class compute
 		catch(Exception $e){
 			$this->app->getErrorInstance()->OtherException($e);
 		}
-		return;
 	}
+	
 	/**
-				* Create server.
+	* Create server.
-				* @return array
+	*
-				*/ 
+	* @return void
+	*/ 
 	public function createServer()
 	{
 		try{
@@ -295,12 +325,12 @@ class compute
 		catch(Exception $e){
 			$this->app->getErrorInstance()->OtherException($e);
 		}
-		return;
 	}
 
 	/**
 	* update a server
-	* @return NULL
+	*
+	* @return void
 	*/
 	public function updateServer()
 	{
@@ -342,11 +372,12 @@ class compute
 		catch(Exception $e){
 			$this->app->getErrorInstance()->OtherException($e);
 		}
-		return;
 	}
+	
 	/**
 	* Delete a server
-	* @return NULL
+	*
+	* @return void
 	*/
 	public function deleteServer()
 	{
@@ -376,11 +407,12 @@ class compute
 		catch(Exception $e){
 			$this->app->getErrorInstance()->OtherException($e);
 		}
-		return;
 	}
+	
 	/**
 	* Change the password of a server
-	* @return NULL
+	*
+	* @return void
 	*/
 	public function changePassword()
 	{
@@ -411,11 +443,12 @@ class compute
 		catch(Exception $e){
 			$this->app->getErrorInstance()->OtherException($e);
 		}
-		return;
 	}
+	
 	/**
 	* Reboot a server
-	* @return NULL
+	*
+	* @return void
 	*/
 	public function reboot()
 	{
@@ -445,11 +478,12 @@ class compute
 		catch(Exception $e){
 			$this->app->getErrorInstance()->OtherException($e);
 		}
-		return;
 	}
+	
 	/**
 	* Rebuild a server
-	* @return NULL
+	*
+	* @return void
 	*/
 	public function rebuild()
 	{
@@ -490,13 +524,15 @@ class compute
 			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 NULL
+	*
+	* @return void
 	*/
 	public function resize()
 	{
@@ -526,11 +562,12 @@ class compute
 		catch(Exception $e){
 			$this->app->getErrorInstance()->OtherException($e);
 		}
-		return;
 	}
+	
 	/**
 	* Confirm resize operation on a server
-	* @return NULL
+	*
+	* @return void
 	*/
 	public function confirmResize()
 	{
@@ -560,11 +597,12 @@ class compute
 		catch(Exception $e){
 			$this->app->getErrorInstance()->OtherException($e);
 		}
-		return;
 	}
+	
 	/**
 	* Revert resize operation on a server
-	* @return NULL
+	*
+	* @return void
 	*/
 	public function revertResize()
 	{
@@ -594,14 +632,14 @@ class compute
 		catch(Exception $e){
 			$this->app->getErrorInstance()->OtherException($e);
 		}
-		return;
 	}
+	
 	/**
 	* List private and public addresses of a server
-	* @return NULL
+	*
+	* @return void
 	*/
-	
+	public function listAddresses()
-	public function listAddresses(array $options = [])
 	{
 		try{
 			$serverId = $this->app->getPostParam("serverId");
@@ -629,7 +667,6 @@ class compute
 		catch(Exception $e){
 			$this->app->getErrorInstance()->OtherException($e);
 		}
-		return;
 	}
 }
 

server/core/CoreInterface.php

@@ -1,15 +1,26 @@
 <?php
 /**
-* File containing Core Interface
+* File containing Core Interface.
+* 
+*/
+
+/**
+* Interface for the main classes of the API
 *
 * @version 1.0 Initialisation of this file
 * @since 1.0 Core application's file
 * 
 * @author Eole 'eoledev at outlook . fr'
-* 
 */
 interface Core{
 	
+	/**
+	* Execute an action in the class
+	*
+	* @param String $action Function to be called
+	*
+	* @return void
+	*/
 	public function action($action);
 	
 }

server/core/ErrorManagement.php

@@ -1,6 +1,6 @@
 <?php
 /**
-* File containing the Errormanagement Class.
+* File containing the errorManagement Class.
 *
 * @version 1.0 Initialisation of this file
 * @since 1.0 Core application's file
@@ -14,8 +14,14 @@ use OpenCloud\Common\Error\BaseError;
 use OpenCloud\Common\Error\NotImplementedError;
 use OpenCloud\Common\Error\UserInputError;
 
-
+/**
+* errorManagement Class of the back-end application
+*
+* Management of error
+*
+*/
 Class errorManagement{
+	
 	/** @var App $app protected, contains the main app object */
 	protected $app;
 	
@@ -37,7 +43,7 @@ Class errorManagement{
 	*
 	* @param Exception $error the exception triggered
 	*
-	* @return NULL
+	* @return void
 	*/
 	public function BaseErrorHandler($error){
 		$this->app->setOutput("Error", "BaseError");
@@ -48,7 +54,7 @@ Class errorManagement{
 	*
 	* @param Exception $error the exception triggered
 	*
-	* @return NULL
+	* @return void
 	*/
 	public function BadResponseHandler($error){
 		$statusCode = $error->getResponse()->getStatusCode();
@@ -88,7 +94,7 @@ Class errorManagement{
 	*
 	* @param Exception $error the exception triggered
 	*
-	* @return NULL
+	* @return void
 	*/
 	public function NotImplementedHandler($error){
 		$this->app->setOutput("Error", "Internal error (not implemented yet), please contact an administrator");
@@ -99,7 +105,7 @@ Class errorManagement{
 	*
 	* @param Exception $error the exception triggered
 	*
-	* @return NULL
+	* @return void
 	*/
 	public function UserInputHandler($error){
 		$this->app->setOutput("Error", "UserInputError");
@@ -110,7 +116,7 @@ Class errorManagement{
 	*
 	* @param Exception $error the exception triggered
 	*
-	* @return NULL
+	* @return void
 	*/
 	public function OtherException($error){
 		$this->app->setOutput("Error", $error->getMessage());

server/core/Identity.php

@@ -2,11 +2,10 @@
 /**
 * File containing the identity Class.
 *
-* @version 1.0 Initialisation of this file
+*/
-* @since 1.0 Core application's file
+
-* 
+/**
-* @author Eole 'eoledev at outlook . fr'
+* Import the Error of the Library
-* 
 */
 use OpenCloud\Common\Error;
 
@@ -15,6 +14,11 @@ use OpenCloud\Common\Error;
 *
 * This class implements the management for the identity request
 *
+* @version 1.0 Initialisation of this file
+* @since 1.0 Core application's file
+* 
+* @author Eole 'eoledev at outlook . fr'
+* 
 */
 class identity implements Core{
 
@@ -29,7 +33,7 @@ class identity implements Core{
 	*
 	* @param App $app the main app object
 	*
-	* @return identity
+	* @return identity Object
 	*/
 	public function __construct($app){
 
@@ -43,7 +47,7 @@ class identity implements Core{
 	*
 	* @param String $action name of another function of this class
 	*
-	* @return NULL
+	* @return void
 	*/
 	public function action($action){
 		
@@ -61,7 +65,7 @@ class identity implements Core{
 	* @param String $type Required Type of credential : ec2, cert...
 	* @param String $userId Required Id of the user which own the credential
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function addCredential(){
 		
@@ -99,7 +103,7 @@ class identity implements Core{
 	/**
 	* List the credentials for a given user.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function listCredentials(){
 		try{
@@ -127,7 +131,7 @@ class identity implements Core{
 	*
 	* @param String $credentialId Required credential id for which it retrieve the details
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function showCredential(){
 		$credentId = $this->app->getPostParam("credentialId");
@@ -164,7 +168,7 @@ class identity implements Core{
 	* @param JsonString $blob Required credentials information with this structure for ec2: "{\"access\":\"181920\",\"secret\":\"secretKey\"}"
 	* @param String $type Required Type of credential : ec2, cert...
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function updateCredential(){
 		
@@ -206,7 +210,7 @@ class identity implements Core{
 	*
 	* @param String $credentialId Required credential id to delete
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function deleteCredential(){
 		
@@ -244,7 +248,7 @@ class identity implements Core{
 	* @param String $enabled Optional Domain enabled or not : value true or false
 	* @param String $name Required Domain Name
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function addDomain(){
 		
@@ -289,7 +293,7 @@ class identity implements Core{
 	/**
 	* Retrieve the different domain's list.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function listDomains(){
 		
@@ -318,7 +322,7 @@ class identity implements Core{
 	*
 	* @param String $domainId Required Domain id for which it retrieve the details
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function showDomain(){
 		
@@ -356,7 +360,7 @@ class identity implements Core{
 	* @param String $enabled Optional Domain enabled or not : value true or false
 	* @param String $name Required Domain Name
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function updateDomain(){
 		
@@ -404,7 +408,7 @@ class identity implements Core{
 	*
 	* @param String $domainId Required Domain id to delete
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function deleteDomain(){
 		
@@ -437,7 +441,7 @@ class identity implements Core{
 	/**
 	* Retrieve the different roles of a given user in a domain.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function listRolesDomainUser(){
 		
@@ -472,7 +476,7 @@ class identity implements Core{
 	/**
 	* Grant a role to a given user in a domain.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function grantRoleDomainUser(){
 		$domId = $this->app->getPostParam("domainId");
@@ -510,7 +514,7 @@ class identity implements Core{
 	/**
 	* Verify that a user has a given role in a domain.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function checkRoleDomainUser(){
 		$domId = $this->app->getPostParam("domainId");
@@ -549,7 +553,7 @@ class identity implements Core{
 	/**
 	* Delete a role for a given user in a domain.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function revokeRoleDomainUser(){
 		$domId = $this->app->getPostParam("domainId");
@@ -587,7 +591,7 @@ class identity implements Core{
 	/**
 	* Retrieve the roles of a given group in a domain.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function listRolesDomainGroup(){
 		$domId = $this->app->getPostParam("domainId");
@@ -622,7 +626,7 @@ class identity implements Core{
 	/**
 	* Add a role to a given group in a domain.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function grantRoleDomainGroup(){
 		$domId = $this->app->getPostParam("domainId");
@@ -660,7 +664,7 @@ class identity implements Core{
 	/**
 	* Verify that a role is associated with a given group in a domain.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function checkRoleDomainGroup(){
 		$domId = $this->app->getPostParam("domainId");
@@ -699,7 +703,7 @@ class identity implements Core{
 	/**
 	* Delete a role for a given group in a domain.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function revokeRoleDomainGroup(){
 		$domId = $this->app->getPostParam("domainId");
@@ -738,7 +742,7 @@ class identity implements Core{
 	/**
 	* Add an endpoint to the Openstack instance
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function addEndpoint(){
 		$servId = $this->app->getPostParam("serviceId");
@@ -778,7 +782,7 @@ class identity implements Core{
 	/**
 	* Retrieve the endpoint for the given id
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function getEndpoint(){
 		
@@ -810,7 +814,7 @@ class identity implements Core{
 	/**
 	* Retrieve the list of the different endpoints
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function listEndpoints(){
 		
@@ -836,7 +840,7 @@ class identity implements Core{
 	/**
 	* Update a given endpoint
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function updateEndpoint(){
 		//Not Implemented Yet
@@ -845,7 +849,7 @@ class identity implements Core{
 	/**
 	* Delete a given endpoint
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function deleteEndpoint(){
 		$endId = $this->app->getPostParam("endpointId");
@@ -877,7 +881,7 @@ class identity implements Core{
 	/**
 	* Add a group.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function addGroup(){
 		//Not Implemented Yet
@@ -886,7 +890,7 @@ class identity implements Core{
 	/**
 	* Retrieve the group's list.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function listGroups(){
 		//Not Implemented Yet
@@ -895,7 +899,7 @@ class identity implements Core{
 	/**
 	* Retrieve the details of a given group.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function showGroup(){
 		//Not Implemented Yet
@@ -904,7 +908,7 @@ class identity implements Core{
 	/**
 	* Update a given group.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function updateGroup(){
 		//Todo Argument Optional
@@ -945,7 +949,7 @@ class identity implements Core{
 	/**
 	* Delete the given group.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function deleteGroup(){
 		
@@ -979,7 +983,7 @@ class identity implements Core{
 	/**
 	* Retrieve the users of a given group.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function listGroupUsers(){
 		
@@ -1013,7 +1017,7 @@ class identity implements Core{
 	/**
 	* Add a user to a group.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function addGroupUser(){
 		
@@ -1048,7 +1052,7 @@ class identity implements Core{
 	/**
 	* Remove a user from a given group.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function removeGroupUser(){
 		
@@ -1083,7 +1087,7 @@ class identity implements Core{
 	/**
 	* Check if a group contains a given user.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function checkGroupUser(){
 		
@@ -1118,7 +1122,7 @@ class identity implements Core{
 	/**
 	* @todo
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function addPolicies(){
 		//Not Implemented Yet
@@ -1127,7 +1131,7 @@ class identity implements Core{
 	/**
 	* @todo
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function listPolicies(){
 		//Not Implemented Yet
@@ -1136,7 +1140,7 @@ class identity implements Core{
 	/**
 	* @todo
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function showPolicie(){
 		//Not Implemented Yet
@@ -1146,7 +1150,7 @@ class identity implements Core{
 	/**
 	* @todo
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function updatePolicies(){
 		//Not Implemented Yet
@@ -1155,7 +1159,7 @@ class identity implements Core{
 	/**
 	* @todo
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function deletePolicies(){
 		//Not Implemented Yet
@@ -1164,7 +1168,7 @@ class identity implements Core{
 	/**
 	* Add a project.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function addProject(){
 		//Todo Parameters Optional
@@ -1201,7 +1205,7 @@ class identity implements Core{
 	/**
 	* Retrieve the different projects.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function listProjects(){
 		
@@ -1227,7 +1231,7 @@ class identity implements Core{
 	/**
 	* Retrieve the details of a given project.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function showProject(){
 		
@@ -1260,7 +1264,7 @@ class identity implements Core{
 	/**
 	* Update a given project.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function updateProject(){
 		//Todo Parameters Optionnal
@@ -1300,7 +1304,7 @@ class identity implements Core{
 	/**
 	* Delete a given project.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function deleteProject(){
 		$projId = $this->app->getPostParam("projId");
@@ -1333,7 +1337,7 @@ class identity implements Core{
 	/**
 	* List the roles of a given user in a project.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function listRolesProjectUser(){
 		
@@ -1370,7 +1374,7 @@ class identity implements Core{
 	/**
 	* Grant a role to an user in a project.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function grantRoleProjectUser(){
 		
@@ -1409,7 +1413,7 @@ class identity implements Core{
 	/**
 	* Check if a given user has a role in a project.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function checkRoleProjectUser(){
 		$projId = $this->app->getPostParam("projetId");
@@ -1450,7 +1454,7 @@ class identity implements Core{
 	/**
 	* Delete a role for a given user in a project.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function revokeRoleProjectUser(){
 		
@@ -1489,7 +1493,7 @@ class identity implements Core{
 	/**
 	* List the roles of a group in a project.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function listRolesProjectGroup(){
 		
@@ -1525,7 +1529,7 @@ class identity implements Core{
 	/**
 	* Add a role to a group in a project.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function grantRoleProjectGroup(){
 		
@@ -1564,7 +1568,7 @@ class identity implements Core{
 	/**
 	* Check if a group has a given role in a project.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function checkRoleProjectGroup(){
 		
@@ -1605,7 +1609,7 @@ class identity implements Core{
 	/**
 	* Delete a role for a group in a project.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function revokeRoleProjectGroup(){
 		
@@ -1644,7 +1648,7 @@ class identity implements Core{
 	/**
 	* Add a role.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function addRole(){
 		
@@ -1678,7 +1682,7 @@ class identity implements Core{
 	/**
 	* List the different roles
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function listRoles(){
 
@@ -1704,7 +1708,7 @@ class identity implements Core{
 	/**
 	* List the different assignments for a given role
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function listRoleAssignements(){
 		
@@ -1730,7 +1734,7 @@ class identity implements Core{
 	/**
 	* Add a service.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function addService(){
 		$name = $this->app->getPostParam("name");
@@ -1765,7 +1769,7 @@ class identity implements Core{
 	/**
 	* Retrieve the different services.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function listServices(){
 		
@@ -1791,7 +1795,7 @@ class identity implements Core{
 	/**
 	* Retrieve the details for a given service.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function showService(){
 		$servId = $this->app->getPostParam("serviceId");
@@ -1822,7 +1826,7 @@ class identity implements Core{
 	/**
 	* Delete a given service.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function deleteService(){
 		
@@ -1856,7 +1860,7 @@ class identity implements Core{
 	/**
 	* Generate a new token for a given user id.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function genTokenUserID(){
 		
@@ -1894,7 +1898,7 @@ class identity implements Core{
 	/**
 	* Generate a new token for a given user name.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function genTokenUserName(){
 		$username = $this->app->getPostParam("username");
@@ -1936,7 +1940,7 @@ class identity implements Core{
 	/**
 	* Generate a new token from another token ID.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function genTokenID(){
 		
@@ -1972,7 +1976,7 @@ class identity implements Core{
 	/**
 	* Generate a new token scoped by a project ID.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function genTokenScopedProjectID(){
 		
@@ -2014,7 +2018,7 @@ class identity implements Core{
 	/**
 	* Generate a new token scoped by a project name.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function genTokenScopedProjectName(){
 		
@@ -2062,7 +2066,7 @@ class identity implements Core{
 	/**
 	* Check if a token is validate.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function validateToken(){
 		
@@ -2098,7 +2102,7 @@ class identity implements Core{
 	/**
 	* Delete a given token.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function revokeToken(){
 		
@@ -2130,7 +2134,7 @@ class identity implements Core{
 	/**
 	* Add a new user.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function addUser(){
 		//Todo Optionnal Parameter
@@ -2175,7 +2179,7 @@ class identity implements Core{
 	/**
 	* Retrieve the different users.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function listUsers(){
 		
@@ -2201,7 +2205,7 @@ class identity implements Core{
 	/**
 	* Retrieve the details of a given user.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function showUser(){
 		
@@ -2234,7 +2238,7 @@ class identity implements Core{
 	/**
 	* Update a given user.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function updateUser(){
 		
@@ -2273,7 +2277,7 @@ class identity implements Core{
 	/**
 	* Delete a given user.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function deleteUser(){
 		
@@ -2306,7 +2310,7 @@ class identity implements Core{
 	/**
 	* Retrieve the groups which contains a given user.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function listUserGroups(){
 		
@@ -2340,7 +2344,7 @@ class identity implements Core{
 	/**
 	* Retrieve the projects which contains a given user.
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function listUserProjects(){
 		

server/core/Image.php

@@ -7,8 +7,8 @@
 * 
 * @author Evan Pisani 'yogg at epsina . com'
 * 
-* @todo Complete the functions with errors detection and finish the descriptions
 */
+
 use OpenCloud\Common\Error\BadResponseError;
 use OpenCloud\Common\Error\BaseError;
 use OpenCloud\Common\Error\NotImplementedError;
@@ -27,7 +27,7 @@ class image implements Core{
 	/** @var App $app protected, contains the main app object */
 	protected $app;
 	
-	/** @var OpenStack\Identity $libClass protected, contains the library Identity object */
+	/** @var OpenStack\Image $libClass protected, contains the library Image object */
 	protected $libClass;
 	
 	/**
@@ -35,7 +35,7 @@ class image implements Core{
 	*
 	* @param App $app the main app object
 	*
-	* @return Image
+	* @return image Object
 	*/
 	public function __construct($app){
 		if(!isset($app)){
@@ -51,7 +51,7 @@ class image implements Core{
 	*
 	* @param String $action name of another function of this class
 	*
-	* @return NULL
+	* @return void
 	*/
 	public function action($action){
 		$this->{$action.""}();	
@@ -62,7 +62,7 @@ class image implements Core{
 	*
 	* @param array $opt Options for the image creation (name is required, others are optionals)
 	*
-	* @return Image
+	* @return void
 	*/
 	private function createImage(){
 		$opt = $this->app->getPostParam("opt");
@@ -141,7 +141,7 @@ class image implements Core{
 	/**
 	* List the images of the server
 	*
-	* @return List of Image
+	* @return void
 	*/
 	private function listImage(){
 		try{
@@ -171,7 +171,7 @@ class image implements Core{
 	*
 	* @param String $id Identifier of the image
 	*	
-	* @return Image
+	* @return void
 	*/
 	private function detailsImage(){
 		$id = $this->app->getPostParam("id");
@@ -209,7 +209,7 @@ class image implements Core{
 	* @param String $id id of the image
 	* @param array  $opt Options for the image creation
 	*	
-	* @return Image
+	* @return void
 	*/
 
 	private function updateImage(){
@@ -272,7 +272,7 @@ class image implements Core{
 	*
 	* @param String $id Identifier of the image
 	*	
-	* @return NULL
+	* @return void
 	*/
 	private function deleteImage(){
 		$id = $this->app->getPostParam("id");
@@ -302,11 +302,11 @@ class image implements Core{
 	}
 
 	/**
-	* Resactive an image
+	* Reactive an image
 	*
 	* @param String $id Identifier of the image
 	*	
-	* @return NULL
+	* @return void
 	*/
 	private function reactivateImage(){
 		$id = $this->app->getPostParam("id");
@@ -339,11 +339,11 @@ class image implements Core{
 	}
 
 	/**
-	* Desactive an image
+	* Desactivaate an image
 	*
 	* @param String $id Identifier of the image
 	*
-	* @return NULL	
+	* @return void	
 	*/
 	private function desactivateImage(){
 		$id = $this->app->getPostParam("id");
@@ -380,7 +380,7 @@ class image implements Core{
 	* @param String $id Identifier of the image
 	* @param String $file_name Path of the image
 	*	
-	* @return NULL
+	* @return void
 	*/
 	private function uploadImage(){
 		$id = $this->app->getPostParam("id");
@@ -422,7 +422,7 @@ class image implements Core{
 	*
 	* @param String $id Identifier of the image
 	*
-	* @return Stream
+	* @return void
 	*/
 	private function downloadImage(){
 		$id = $this->app->getPostParam("id");
@@ -459,7 +459,7 @@ class image implements Core{
 	* @param String $image_id Identifier of the image
 	* @param String $member_id Identifier of the member
 	*	
-	* @return Member
+	* @return void
 	*/
 	private function addMemberImage(){
 		$image_id = $this->app->getPostParam("image_id");
@@ -501,7 +501,7 @@ class image implements Core{
 	*
 	* @param String $image_id identifier of the image
 	*
-	* @return List of Member 	
+	* @return void
 	*/
 	private function listMemberImage(){
 		$image_id = $this->app->getPostParam("image_id");
@@ -545,7 +545,7 @@ class image implements Core{
 	* @param String $image_id Identifier of the image
 	* @param String $member_id Identifier of the member
 	*
-	* @return Member
+	* @return void
 	*/
 	private function detailMemberImage(){
 		$image_id = $this->app->getPostParam("image_id");
@@ -591,7 +591,7 @@ class image implements Core{
 	* @param String $image_id Identifier of the image
 	* @param String $member_id Identifier of the member
 	*	
-	* @return NULL
+	* @return void
 	*/
 	private function removeMemberImage(){
 		$image_id = $this->app->getPostParam("image_id");
@@ -637,7 +637,7 @@ class image implements Core{
 	* @param String $member_id Identifier of the member
 	* @param String $status New status for the member
 	*
-	* @return NULL	
+	* @return void
 	**/
 	private function updateMemberImage(){
 		$image_id = $this->app->getPostParam("image_id");

server/core/LibOverride/genTokenOptions.php

@@ -1,4 +1,14 @@
 <?php
+/**
+* File containing the override of the authentication for the Library.
+*
+* @version 1.0 Initialisation of this file
+* @since 1.0 Core application's file
+* 
+* @author Eole 'eoledev at outlook . fr'
+* 
+* @todo Check with the API, the condition and test the revoke token implementation
+*/
 
 use GuzzleHttp\Client;
 use OpenCloud\Common\Transport\HandlerStack;
@@ -9,21 +19,38 @@ use OpenCloud\Common\Auth\Token;
 use OpenCloud\Common\Transport\Utils;
 use OpenStack\Identity\v3\Models;
 
+/**
+* genTokenOptions Class
+*
+* This class allow the generation of tokens for openstack, and to inject 
+* those tokens into the library. Which allow to do a proper login only once
+* and not for each request
+*
+*/
 class genTokenOptions
 {
+	/** @var Array $optionsGlobal private, contains the options common for the different tokens */
 	private $optionsGlobal;
-	
+	/** @var Array $backup private, contains all the informations about the different tokens. It contains the information send to the clients */
-	private $stack;
 	private $backup = [];
+	/** @var GuzzleHttp\Client $httpClient private, contains a default Client to construct some OpenStack library object */
 	private $httpClient;
 
+	/**
+	* genTokenOptions constructor
+	*
+	* @param Array $options Options to create the objects in the library
+	*												AuthUrl is the main options required
+	*
+	* @return genTokenOptions Object
+	*/
 	public function __construct($options){
 		
-		$this->stack = HandlerStack::create();
+		$stack = HandlerStack::create();
 
 		$httpClient = new Client([
 		'base_uri' => Utils::normalizeUrl($options['authUrl']),
-		'handler'  => $this->stack,
+		'handler'  => $stack,
 		]);
 		
 		$this->httpClient = $httpClient;
@@ -38,8 +65,13 @@ class genTokenOptions
 	}
 
 	/**
-		* @codeCoverageIgnore
+	* Add a debug for the library
-		*/
+	*
+	* @param array $options Debug options, cf library
+	* @param HandlerStack $stack pointer to a HandlerStack object
+	*
+	* @return void
+	*/
 	private function addDebugMiddleware(array $options, HandlerStack &$stack)
 	{
 		if (!empty($options['debugLog'])
@@ -50,12 +82,20 @@ class genTokenOptions
 		}
 	}
 
+	/**
+	* Check the expiration time of a token
+	*
+	* @return boolean if the token is not expired
+	*/
 	public function checkToken(){
-		//error_log(print_r($this->backup['time'], true), 0);
 		return $this->backup['time'] > time();
-		//return true;
 	}
 	
+	/**
+	* Generate a new token for the Identity service
+	*
+	* @return void
+	*/
 	public function genIdentityToken(){
 		$options = $this->optionsGlobal['Common'];
 		$options['catalogName'] = 'false';
@@ -81,12 +121,24 @@ class genTokenOptions
 		$this->optionsGlobal['Identity'] = $options;
 	}
 	
+	/**
+	* Revoke the token for the Identity Service
+	*
+	* @return void
+	*/
 	public function revokeIdentityToken(){
 		$token = $this->unserializeToken($this->backup['Identity']['token']);
 		$this->optionsGlobal['Common']['identityService']->revokeToken($token->id);
 		
 	}
 	
+	/**
+	* Load a token for the Identity Service
+	*
+	* @param String $opt serialized token
+	*
+	* @return void
+	*/
 	public function loadIdentityBackup($opt){
 		$options = $this->optionsGlobal['Common'];
 		$options['catalogName'] = 'false';
@@ -112,6 +164,11 @@ class genTokenOptions
 		
 	}
 	
+	/**
+	* Generate a new token for the Image service
+	*
+	* @return void
+	*/
 	public function genImageToken(){
 		$options = $this->optionsGlobal['Common'];
 		$options['catalogName'] = 'glance';
@@ -135,12 +192,24 @@ class genTokenOptions
 		$this->optionsGlobal['Image'] = $options;
 	}
 	
+	/**
+	* Revoke the token for the Image Service
+	*
+	* @return void
+	*/
 	public function revokeImageToken(){
 		$token = $this->unserializeToken($this->backup['Image']['token']);
 		$this->optionsGlobal['Common']['identityService']->revokeToken($token->id);
 		
 	}
 	
+	/**
+	* Load a token for the Image Service
+	*
+	* @param String $opt serialized token
+	*
+	* @return void
+	*/
 	public function loadImageBackup($opt){
 		$options = $this->optionsGlobal['Common'];
 		$options['catalogName'] = 'glance';
@@ -165,6 +234,11 @@ class genTokenOptions
 		$this->optionsGlobal['Image'] = $options;
 	}
 	
+	/**
+	* Generate a new token for the Metwork service
+	*
+	* @return void
+	*/
 	public function genNetworkToken(){
 		$options = $this->optionsGlobal['Common'];
 		$options['catalogName'] = 'neutron';
@@ -188,12 +262,24 @@ class genTokenOptions
 		$this->optionsGlobal['Network'] = $options;
 	}
 	
+	/**
+	* Revoke the token for the Network Service
+	*
+	* @return void
+	*/
 	public function revokeNetworkToken(){
 		$token = $this->unserializeToken($this->backup['Network']['token']);
 		$this->optionsGlobal['Common']['identityService']->revokeToken($token->id);
 		
 	}
 	
+	/**
+	* Load a token for the Network Service
+	*
+	* @param String $opt serialized token
+	*
+	* @return void
+	*/
 	public function loadNetworkBackup($opt){
 		$options = $this->optionsGlobal['Common'];
 		$options['catalogName'] = 'neutron';
@@ -218,6 +304,11 @@ class genTokenOptions
 		$this->optionsGlobal['Network'] = $options;
 	}
 	
+	/**
+	* Generate a new token for the Compute service
+	*
+	* @return void
+	*/
 	public function genComputeToken(){
 		$options = $this->optionsGlobal['Common'];
 		$options['catalogName'] = 'nova';
@@ -241,12 +332,24 @@ class genTokenOptions
 		$this->optionsGlobal['Compute'] = $options;
 	}
 	
+	/**
+	* Revoke the token for the Compute Service
+	*
+	* @return void
+	*/
 	public function revokeComputeToken(){
 		$token = $this->unserializeToken($this->backup['Compute']['token']);
 		$this->optionsGlobal['Common']['identityService']->revokeToken($token->id);
 		
 	}
 	
+	/**
+	* Load a token for the Compute Service
+	*
+	* @param String $opt serialized token
+	*
+	* @return void
+	*/
 	public function loadComputeBackup($opt){
 		
 		$options = $this->optionsGlobal['Common'];
@@ -272,10 +375,16 @@ class genTokenOptions
 		$this->optionsGlobal['Compute'] = $options;
 	}
 
+	/**
+	* Save the token given a service name
+	*
+	* @param String $name name of the service to save
+	* @param Array $data token and baseUrl for the service
+	*
+	* @return void
+	*/
 	private function saveBackup($name, $data){
 		$token = $this->serializeToken($data["token"]);
-		//$path = "core/LibOverride/projectTokenData/".$token['saved']["project"]["name"];
-		//error_log("Path a ecrire ".print_r($path, true), 0);
 		file_put_contents("core/LibOverride/projectTokenData/".$token['saved']["project"]["name"], serialize($token['saved']));
 		$this->backup['time'] = $token['time'];
 		$this->backup["roles"] = $token["roles"];
@@ -284,10 +393,22 @@ class genTokenOptions
 		$this->backup[$name] = array('token' => $token["token"], 'baseUrl' => $data["baseUrl"] );
 	}
 	
+	/**
+	* Retrieve the tokens saved
+	*
+	* @return String tokens serialized
+	*/
 	public function getBackup(){
 		return serialize($this->backup);
 	}
 	
+	/**
+	* Load tokens into the library
+	*
+	* @param String $back tokens serialized
+	*
+	* @return void
+	*/
 	public function loadBackup($back){
 		
 		$backup = unserialize($back);
@@ -302,10 +423,24 @@ class genTokenOptions
 		
 	}
 	
+	/**
+	* Retrieve the common options for a service
+	*
+	* @param String $service name of the service
+	*
+	* @return array Options to create the library class corresponding to this service
+	*/
 	public function getOptions($service){
 		return $this->optionsGlobal[$service];
 	}
 	
+	/**
+	* Serialize a given token
+	*
+	* @param Array $token token to be serialized
+	*
+	* @return String token serialized
+	*/
 	private function serializeToken($token){
 		global $config;
 		$tokenSerialized = [];
@@ -358,6 +493,15 @@ class genTokenOptions
 		return $tokenSerialized;
 	}
 	
+	/**
+	* Unserialize a token
+	*
+	* Unserialize a token and recreate the architecture of the library token
+	*
+	* @param String $tokenSerialized the token to be unserialized
+	*
+	* @return OpenCloud\Common\Auth\Token the token unserialized
+	*/
 	private function unserializeToken($tokenSerialized){
 		$Saved = file_get_contents("core/LibOverride/projectTokenData/".$this->backup["project"]);
 		$Saved = unserialize($Saved);

server/core/Network.php

@@ -7,7 +7,6 @@
 * 
 * @author KABIR Othmane
 * 
-* @todo Complete the functions with errors detection and finish the descriptions
 */
 use OpenCloud\Common\Error\BadResponseError;
 use OpenCloud\Common\Error\BaseError;
@@ -17,11 +16,10 @@ use OpenCloud\Common\Error\UserInputError;
 /**
 * Network Class of the back-end application
 *
-* ADD CLASS DESCRIPTION
+* Management of Networks
 *
 */
-
+class network implements Core{ 
-class network{ 
 	/** @var App $app protected, contains the main app object */	
 	protected $app;
 	/** @var OpenStack\Network $libClass protected, contains the library Network object */	
@@ -29,15 +27,12 @@ class network{
 	
 	
 	/**
-	* Image constructor
+	* Network constructor
 	*
 	* @param App $app the main app object
 	*
-	* @return Network
+	* @return network Object
 	*/
-	
-
-	
 	public function __construct($app){
 		$this->app = $app;
 		$this->libClass = $app->getLibClass("Network");
@@ -49,7 +44,7 @@ class network{
 	*
 	* @param String $action name of another function of this class
 	*
-	* @return NULL
+	* @return void
 	*/
 	public function action($action){
 		
@@ -65,7 +60,7 @@ class network{
 	* @param String shared Specifies whether the network resource can be accessed by any tenant
 	* @param String tenantId Owner of network. Only admin users can specify a tenant ID other than their own
 	* 
-	* @return NULL
+	* @return void
 	*/
 	private function create_network()
 	{
@@ -134,9 +129,7 @@ class network{
 	* @param BOOLEAN enableDhcp Specifies whether DHCP is enabled for this subnet
 	* @param String allocationPools Subranges of the CIDR available for dynamic allocation to ports
 	* 	
-	*  	
+	* @return void
-	* 
-	* @return NULL
 	*/
 
 	private function create_subnet()
@@ -225,7 +218,7 @@ class network{
 	/**
 	* List the ID of the NETWORKS
 	*
-	* @return List of Networks ID
+	* @return void
 	*/
 
 	private function list_network_ids()
@@ -276,18 +269,12 @@ class network{
 		try
 		{
 			$ln = $this->libClass->listNetworks();
-			
 			$list_names = array();
-
 			
 			foreach($ln as $n)
 			{
-				
 				$list_names[] =  $n->name;
-				
-
 			}
-			
 		}
 		catch(BadResponseError $e)
 		{
@@ -308,10 +295,11 @@ class network{
 
 		$this->app->setOutput("ListNetworkNames", $list_names);
 	}
+	
 	/**
 	* List the CIDR of the SUBNETS
 	*
-	* @return List of SUBNETS CIDR
+	* @return void
 	*/
 	private function list_cidr()
 	{
@@ -344,10 +332,13 @@ class network{
 			$this->app->getErrorInstance->NotImplementedHandler($e);
 		}	
 	}
+	
 	/**
 	* retrieve a specific network
+	*
 	* @param networkId ID of network which we want to get
-	* @return Network
+	*
+	* @return void
 	*/ 
 	private function getNetwork()
 	{
@@ -383,8 +374,10 @@ class network{
 	
 	/**
 	* internal function
+	*
 	* @param String netId ID of network which we want to get
-	* @return Network
+	*
+	* @return OpenStack\Network
 	*/
 	private function getNetworkP($netId)
 	{
@@ -420,8 +413,10 @@ class network{
 
 	/**
 	* retrieve a specific subnet
+	*
 	* @param subnetId ID of subnet which we want to get
-	* @return subnet
+	*
+	* @return void
 	*/
 	private function getSubnet()
 	{
@@ -455,8 +450,10 @@ class network{
 	}
 	/**
 	* internal function
+	*
 	* @param String subnetId ID of subnet which we want to get
-	* @return subnet
+	*
+	* @return OpenStack\Subnet
 	*/
 	private function getSubnetP($subnetId)
 	{
@@ -498,7 +495,7 @@ class network{
 	* @param String tenantId Owner of network. Only admin users can specify a tenant ID other than their own
 	* 
 	*
-	* @return NULL	
+	* @return void	
 	**/	
 
 	private function updateNetwork()
@@ -561,7 +558,7 @@ class network{
 	* @param String allocationPools Subranges of the CIDR available for dynamic allocation to ports
 	* 
 	*
-	* @return NULL	
+	* @return void	
 	**/	
 
 	private function updateSubnet()
@@ -616,8 +613,7 @@ class network{
 	*
 	* @param String networkId ID if network which we want to delete
 	* 
-	*
+	* @return void	
-	* @return NULL	
 	**/	
 	private function deleteNetwork()
 	{
@@ -650,8 +646,7 @@ class network{
 	*
 	* @param String subnetId ID if network which we want to delete
 	* 
-	*
+	* @return void	
-	* @return NULL	
 	**/
 	private function deleteSubnet()
 	{
@@ -692,7 +687,7 @@ class network{
 	* @param String securityGroups 	Specifies the IDs of any security groups associated with this port
 	* @param String tenantId 	Owner of the port. Only admin users can specify a tenant ID other than their own.
 	*	
-	* @return NULL
+	* @return void
 	*/
 	
 	private function createPort()
@@ -769,7 +764,7 @@ class network{
 	/**
 	* List the of ports
 	*
-	* @return List of ports
+	* @return void
 	*/
 
 	private function listPorts()
@@ -798,8 +793,10 @@ class network{
 
 	/**
 	* retrieve a specific port given
+	*
 	* @param portId ID of port which we want to get
-	* @return port
+	*
+	* @return void
 	*/
 
 	private function getPort()
@@ -831,8 +828,11 @@ class network{
 
 	/**
 	* internal function
+	*
 	* retrieve a specific port given
+	*
 	* @param portId ID of port which we want to get
+	*
 	* @return port
 	*/
 
@@ -876,7 +876,7 @@ class network{
 	* @param String securityGroups 	Specifies the IDs of any security groups associated with this port
 	* @param String tenantId 	Owner of the port. Only admin users can specify a tenant ID other than their own.
 	*	
-	* @return NULL
+	* @return void
 	*/
 	private function updatePort()
 	{
@@ -953,7 +953,8 @@ class network{
 	* Delete a port given
 	*
 	* @param String portId 	id of port which we wante to delete
-	* @return NULL
+	*
+	* @return void
 	*/
 	private function deletePort()
 	{
@@ -988,7 +989,7 @@ class network{
 	* @param String name 	A human-readable name for the security group. This name might not be unique
 	* @param String description 	Description of the security group
 	*	
-	* @return NULL
+	* @return void
 	*/
 
 	private function createSecurityGroup()
@@ -1032,15 +1033,15 @@ class network{
 	* Create a new security groupe 
 	*
 	* @param String securityGroupId 	The security group ID to associate with this security group rule.
-	* @param String direction 	The direction in which the security group rule is applied. For a compute instance, an ingress security group 		*				rule is applied to incoming (ingress) traffic for that instance. An egress rule is applied 						to traffic leaving the instance.
+	* @param String direction 	The direction in which the security group rule is applied. For a compute instance, an ingress security group rule is applied to incoming (ingress) traffic for that instance. An egress rule is applied to traffic leaving the instance.
 	* @param String ethertype 	Must be IPv4 or IPv6, and addresses represented in CIDR must match the ingress or egress rules.	
-	* @param String portRangeMin 	The minimum port number in the range that is matched by the security group rule. If the protocol is TCP or 						UDP, this value must be less than or equal to the value of the portRangeMax attribute. If the protocol is 						ICMP, this value must be an ICMP type
+	* @param String portRangeMin 	The minimum port number in the range that is matched by the security group rule. If the protocol is TCP or UDP, this value must be less than or equal to the value of the portRangeMax attribute. If the protocol is ICMP, this value must be an ICMP type
-	*@param String portRangeMax 	The maximum port number in the range that is matched by the security group rule. If the protocol is TCP or 						UDP, this value must be less than or equal to the value of the portRangeMax attribute. If the protocol is 						ICMP, this value must be an ICMP type.
+	* @param String portRangeMax 	The maximum port number in the range that is matched by the security group rule. If the protocol is TCP or UDP, this value must be less than or equal to the value of the portRangeMax attribute. If the protocol is ICMP, this value must be an ICMP type.
-	*@param String protocol 	The protocol that is matched by the security group rule
+	* @param String protocol 	The protocol that is matched by the security group rule
-	*@param String remoteGroupId 	The remote group ID to be associated with this security group rule. You can specify either remoteGroupId or 						remoteGroupPrefix
+	* @param String remoteGroupId 	The remote group ID to be associated with this security group rule. You can specify either remoteGroupId or remoteGroupPrefix
-	*@param String remoteIpPrefix 	The remote IP prefix to be associated with this security group rule. You can specify either remoteGroupId or 						remoteGroupPrefix
+	* @param String remoteIpPrefix 	The remote IP prefix to be associated with this security group rule. You can specify either remoteGroupId or remoteGroupPrefix
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function createSecurityGroupRule()
 	{
@@ -1112,7 +1113,7 @@ class network{
 	/**
 	* List of Security Groupes
 	*
-	* @return List of Security Groupes
+	* @return void
 	*/
 
 	private function listSecurityGroupe()
@@ -1143,7 +1144,7 @@ class network{
 	/**
 	* List of Security Groupe Rules
 	*
-	* @return List of Security Groupe Rules
+	* @return void
 	*/
 
 	private function listSecurityGroupeRule()
@@ -1174,8 +1175,10 @@ class network{
 	
 	/**
 	* retrieve a specific Security Groupe given
+	*
 	* @param securityGroupeId ID of security Groupe which we want to get
-	* @return securityGroupe
+	*
+	* @return void
 	*/
 
 	private function getSecurityGroupe()
@@ -1207,9 +1210,12 @@ class network{
 	
 	/**
 	* internal function
+	*
 	* retrieve a specific Security Groupe given
+	*
 	* @param securityGroupeId ID of security Groupe which we want to get
-	* @return securityGroupe
+	*
+	* @return securityGroup
 	*/
 	private function getSecurityGroupeP($securityGroupeId)
 	{
@@ -1238,8 +1244,10 @@ class network{
 	}
 	/**
 	* Delete a specific Security Groupe given
+	*
 	* @param securityGroupeId ID of security Groupe which we want to get
-	* @return NULL
+	*
+	* @return void
 	*/
 	private function deleteSecurityGroupe()
 	{	

server/core/NetworkLayer3.php

@@ -1,41 +1,41 @@
 <?php
 /**
-* File containing the FloatingIp Class.
+* File containing the networkLayer3 Class.
 *
 * @version 1.0 Initialisation of this file
 * @since 1.0 Core application's file
 * 
 * @author Evan Pisani 'yogg at epsina . com'
 * 
-* @todo Complete the functions with errors detection and finish the descriptions
 */
+
 use OpenCloud\Common\Error\BadResponseError;
 use OpenCloud\Common\Error\BaseError;
 use OpenCloud\Common\Error\NotImplementedError;
 use OpenCloud\Common\Error\UserInputError;
 
-//include("CoreInterface.php");
+include("CoreInterface.php");
 
 /**
-* Image Class of the back-end application
+* networkLayer3 Class of the back-end application
 *
-* Management of images
+* Management of networkLayer3
 *
 */
-class networkLayer3 { 
+class networkLayer3 implements Core{ 
 
 	/** @var App $app protected, contains the main app object */
 	protected $app;
 	
-	/** @var OpenStack\Identity $libClass protected, contains the library Identity object */
+	/** @var OpenStack\NetworkLayer3 $libClass protected, contains the library NetworkLayer3 object */
 	protected $libClass;
 	
 	/**
-	* floatingip constructor
+	* networkLayer3 constructor
 	*
 	* @param App $app the main app object
 	*
-	* @return networkLayer3
+	* @return networkLayer3 Object
 	*/
 	public function __construct($app){
 		if(!isset($app)){
@@ -51,7 +51,7 @@ class networkLayer3 {
 	*
 	* @param String $action name of another function of this class
 	*
-	* @return NULL
+	* @return void
 	*/
 	public function action($action){
 		$this->{$action.""}();	
@@ -61,7 +61,7 @@ class networkLayer3 {
 	/**
 	* List floatingip
 	* 
-	* @return list of the floatingip
+	* @return void
 	*/
 	private function listFloatingIp(){
 		try{
@@ -91,7 +91,7 @@ class networkLayer3 {
 	*
 	* @param array $opt Options for the floating ip creation (floatingNetworkId is required)
 	*
-	* @return floatingip
+	* @return void
 	*/
 	private function createFloatingIp(){
 		$opt = $this->app->getPostParam("opt");
@@ -126,7 +126,7 @@ class networkLayer3 {
 	*
 	* @param String id the id of the floatingip
 	*
-	* @return floatingip details
+	* @return void
 	*/
 	private function getFloatingIp(){
 		$id = $this->app->getPostParam("id");
@@ -175,7 +175,7 @@ class networkLayer3 {
 	*
 	* @param id the id of the floatingip to update
 	* 
-	* @return NULL
+	* @return void
 	*/
 	private function updateFloatingIp(){
 		$id = $this->app->getPostParam("id");
@@ -224,7 +224,7 @@ class networkLayer3 {
 	*
 	* @param string floatingip_id the floating-ip id to delete
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function deleteFloatingIp(){
 		$id = $this->app->getPostParam("id");
@@ -273,7 +273,7 @@ class networkLayer3 {
 	*
 	* @param string floatingip_id the floating-ip id to retrieve
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function retrieveFloatingIp(){
 		$id = $this->app->getPostParam("id");
@@ -326,7 +326,7 @@ class networkLayer3 {
 	*					adminStateUp (optionnal)
 	*					name (optionnal)
 	*
-	* @return router
+	* @return void
 	*/
 	private function createRouter(){
 		$opt = $this->app->getPostParam("opt");
@@ -359,7 +359,7 @@ class networkLayer3 {
 	/**
 	* List routers
 	* 
-	* @return list of the routers
+	* @return void
 	*/
 	private function listRouters(){
 		try{
@@ -389,7 +389,7 @@ class networkLayer3 {
 	*
 	* @param String id the id of the router
 	*
-	* @return router details
+	* @return void
 	*/
 	private function getRouter(){
 		$id = $this->app->getPostParam("id");
@@ -437,7 +437,7 @@ class networkLayer3 {
 	*
 	* @param string router the router to delete
 	*
-	* @return NULL
+	* @return void
 	*/
 	private function deleteRouter(){
 		$id = $this->app->getPostParam("id");
@@ -485,7 +485,7 @@ class networkLayer3 {
 	*
 	* @param id the id of the floatingip to update
 	* 
-	* @return NULL
+	* @return void
 	*/
 	private function updateRouter(){
 		$id = $this->app->getPostParam("id");

server/index.php

@@ -9,6 +9,8 @@
 * 
 */
 
+/*
+*/
 //loading dependencies
 require "vendor/autoload.php";
 //Include general config file

server/init.php

@@ -1,14 +1,17 @@
 <?php
 /**
-* File containing the initialisation of the API.
+ * File containing the initialisation of the API.
-*
+ *
-* @version 1.0 Initialisation of this file
+ * @version 1.0 Initialisation of this file
-* @since 1.0 Core application's file
+ * @since 1.0 Core application's file
-* 
+ * 
-* @author Eole 'eoledev at outlook . fr'
+ * @author Eole 'eoledev at outlook . fr'
-* 
+ * 
-*/
+ */
 
+/*
+* Include Main Api Class
+*/ 
 include_once("core/App.php");
 
 $user = "";