Refactoring of comments beginning

This commit is contained in:
EoleDev 2016-04-26 20:42:31 +02:00
parent 477dc82182
commit 5263cf00a2
13 changed files with 1535 additions and 1744 deletions

View file

@ -22,9 +22,9 @@ use OpenCloud\Common\Error\UserInputError;
*/
class network{
/** @var App $app protected, contains the main app object */
/** @var App $app protected, contains the main app object */
protected $app;
/** @var OpenStack\Network $libClass protected, contains the library Network object */
/** @var OpenStack\Network $libClass protected, contains the library Network object */
protected $libClass;
@ -49,11 +49,11 @@ class network{
*
* @param String $action name of another function of this class
*
* @return void
* @return NULL
*/
public function action($action){
$this->{$action.""}();
$this->{$action.""}();
}
@ -65,7 +65,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 void
* @return NULL
*/
private function create_network()
{
@ -102,19 +102,19 @@ class network{
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);
}
}
}
@ -136,7 +136,7 @@ class network{
*
*
*
* @return void
* @return NULL
*/
private function create_subnet()
@ -200,24 +200,24 @@ class network{
try
{
$subnet = $this->libClass->createSubnet($options);
$subnet = $this->libClass->createSubnet($options);
}
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);
}
}
}
@ -233,36 +233,36 @@ class network{
try
{
$ln = $this->libClass->listNetworks();
$list_ids = array();
foreach($ln as $n)
{
$list_ids[] = $n->id;
}
}
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);
}
}
$this->app->setOutput("ListNetworkIds", $list_ids);
$this->app->setOutput("ListNetworkIds", $list_ids);
}
/**
@ -276,37 +276,37 @@ class network{
try
{
$ln = $this->libClass->listNetworks();
$list_names = array();
foreach($ln as $n)
{
$list_names[] = $n->name;
}
}
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);
}
}
$this->app->setOutput("ListNetworkNames", $list_names);
$this->app->setOutput("ListNetworkNames", $list_names);
}
/**
* List the CIDR of the SUBNETS
@ -317,32 +317,32 @@ class network{
{
try
{
$ls = $this->libClass->listSubnets();
$list_cidr = array();
foreach ($ls as $subnet)
{
$list_cidr[] = $subnet->cidr;
}
$ls = $this->libClass->listSubnets();
$list_cidr = array();
foreach ($ls as $subnet)
{
$list_cidr[] = $subnet->cidr;
}
$this->app->setOutput("ListCidr", $list_cidr);
$this->app->setOutput("ListCidr", $list_cidr);
}
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);
}
}
}
/**
* retrieve a specific network
@ -364,21 +364,21 @@ class network{
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);
}
}
$this->app->setOutput("Network", $network);
$this->app->setOutput("Network", $network);
}
/**
@ -401,21 +401,21 @@ class network{
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);
}
}
return $network;
return $network;
}
/**
@ -437,21 +437,21 @@ class network{
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);
}
}
$this->app->setOutput("Subnet", subnet);
}
/**
* internal function
@ -472,21 +472,21 @@ class network{
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);
}
}
return $subnet;
}
/**
@ -498,11 +498,11 @@ class network{
* @param String tenantId Owner of network. Only admin users can specify a tenant ID other than their own
*
*
* @return void
* @return NULL
**/
private function updateNetwork()
{
private function updateNetwork()
{
$options = array();
$name = $this->app->getPostParam("name");
$shared = $this->app->getPostParam("shared");
@ -524,25 +524,25 @@ class network{
{
$networkId = $this->app->getPostParam("networkId");
$network = getNetworkP($networkId);
$network->update($options);
}
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);
}
}
}
/**
@ -561,11 +561,11 @@ class network{
* @param String allocationPools Subranges of the CIDR available for dynamic allocation to ports
*
*
* @return void
* @return NULL
**/
private function updateSubnet()
{
{
$options = array();
$name = $this->app->getPostParam("name");
$networkId = $this->app->getPostParam("networkId");
@ -596,19 +596,19 @@ class network{
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);
}
}
}
/**
@ -617,10 +617,10 @@ class network{
* @param String networkId ID if network which we want to delete
*
*
* @return void
* @return NULL
**/
private function deleteNetwork()
{
{
try
{
$networkId = $this->app->getPostParam("networkId");
@ -630,19 +630,19 @@ class network{
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);
}
}
}
/**
@ -651,10 +651,10 @@ class network{
* @param String subnetId ID if network which we want to delete
*
*
* @return void
* @return NULL
**/
private function deleteSubnet()
{
{
try
{
$subnetId = $this->app->getPostParam("subnetId");
@ -664,19 +664,19 @@ class network{
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);
}
}
}
/**
@ -692,7 +692,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 void
* @return NULL
*/
private function createPort()
@ -751,19 +751,19 @@ class network{
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);
}
}
}
/**
@ -781,19 +781,19 @@ class network{
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);
}
}
}
/**
@ -813,20 +813,20 @@ class network{
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);
}
}
}
/**
@ -846,20 +846,20 @@ class network{
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);
}
}
}
@ -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 void
* @return NULL
*/
private function updatePort()
{
@ -935,28 +935,28 @@ class network{
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);
}
}
}
/**
* Delete a port given
*
* @param String portId id of port which we wante to delete
* @return void
* @return NULL
*/
private function deletePort()
{
{
try
{
@ -967,19 +967,19 @@ class network{
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);
}
}
}
/**
@ -988,7 +988,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 void
* @return NULL
*/
private function createSecurityGroup()
@ -1012,20 +1012,20 @@ class network{
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);
}
}
}
/**
@ -1040,7 +1040,7 @@ class network{
*@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
*
* @return void
* @return NULL
*/
private function createSecurityGroupRule()
{
@ -1093,19 +1093,19 @@ class network{
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);
}
}
}
@ -1124,19 +1124,19 @@ class network{
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);
}
}
}
@ -1150,26 +1150,26 @@ class network{
{
try
{
$this->app->setOutput("listSecurityGroupeRule", $this->libClass->listSecurityGroupRules());
$this->app->setOutput("listSecurityGroupeRule", $this->libClass->listSecurityGroupRules());
}
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);
}
}
}
/**
@ -1189,20 +1189,20 @@ class network{
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);
}
}
}
/**
@ -1221,28 +1221,28 @@ class network{
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);
}
}
}
/**
* Delete a specific Security Groupe given
* @param securityGroupeId ID of security Groupe which we want to get
* @return void
* @return NULL
*/
private function deleteSecurityGroupe()
{
{
try
{
$securityGroupId = $this->app->getPostParam("securityGroupeId");
@ -1252,18 +1252,18 @@ class network{
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);
}
}
}
}