From f4d12bf72a943d6a8965f21a11eefbb05d2a5483 Mon Sep 17 00:00:00 2001 From: Eole Date: Wed, 27 Apr 2016 22:52:25 +0200 Subject: Add Documentation --- server/doc/classes/App.html | 844 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 844 insertions(+) create mode 100644 server/doc/classes/App.html (limited to 'server/doc/classes/App.html') diff --git a/server/doc/classes/App.html b/server/doc/classes/App.html new file mode 100644 index 0000000..c0e8568 --- /dev/null +++ b/server/doc/classes/App.html @@ -0,0 +1,844 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ + + +
+
+
+
+ +
+
+
+
+
+
+ + + +

\App

+

App Class of the back-end application

+

This class allow the communication between the front-end application and +the library which allow to send requests to an Openstack instance.

+ + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ __construct()
+ setToken()
+ checkToken()
+ getLibClass()
+ authenticate()
+ deauthenticate()
+ getPostParam()
+ setPostParam()
+ setOutput()
+ getErrorInstance()
+ show()
+
+
+ No public properties found +
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $openstack
+ $postParams
+ $tokenClass
+ $tokenPost
+ $errorClass
+ $output
+
+
+ N/A +
+
+
+
+ No private methods found +
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$openstack

+ 
$openstack : \OpenStack\OpenStack
+

+ + +

Type

+ \OpenStack\OpenStack + — protected, contains the main library object
+
+ +
+ +
+
+ +
+

$postParams

+ 
$postParams : Array
+

+ + +

Type

+ Array + — protected, contains the post parameters
+
+ +
+ +
+
+ +
+

$tokenClass

+ 
$tokenClass : \genTokenOptions
+

+ + +

Type

+ \genTokenOptions + — protected, contains the class object for the authentication override of the library
+
+ +
+ +
+
+ +
+

$tokenPost

+ 
$tokenPost : String
+

+ + +

Type

+ String + — protected, contains the token given in parameter
+
+ +
+ +
+
+ +
+

$errorClass

+ 
$errorClass : \errorManagement
+

+ + +

Type

+ \errorManagement + — protected, contains the errorManagement object
+
+ +
+ +
+
+ +
+

$output

+ 
$output : Array
+

+ + +

Type

+ Array + — protected, contains the result for the API call
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

__construct()

+ + 
__construct(Array  $args) : \App
+

App constructor

+ + +

Parameters

+ + + + + + +
Array$args

Args for the OpenStack Library

+ + +

Returns

+ \App + —

object

+ +
+
+ +
+ +
+
+ +
+

setToken()

+ + 
setToken(String  $token)
+

Set the class var $tokenPost and load the token +into the genTokenOptions Class

+ + +

Parameters

+ + + + + + +
String$token

token to be set

+ + + +
+
+ +
+ +
+
+ +
+

checkToken()

+ + 
checkToken() : Boolean
+

Check the expiration of the token

+ + + + +

Returns

+ Boolean + —

if the token is not expired

+ +
+
+ +
+ +
+
+ +
+

getLibClass()

+ + 
getLibClass(String  $service) : \Core
+

Get the service Class given the name in parameter

+ + +

Parameters

+ + + + + + +
String$service

Name of the service

+ + +

Returns

+ \Core + —

object

+ +
+
+ +
+ +
+
+ +
+

authenticate()

+ + 
authenticate() : void
+

Generate the token for the different services in OpenStack

+ + + + + +
+
+ +
+ +
+
+ +
+

deauthenticate()

+ + 
deauthenticate() : void
+

Revoke the openstack services' token

+ + + + + +
+
+ +
+ +
+
+ +
+

getPostParam()

+ + 
getPostParam(String  $name) : Object
+

Retrieve a post parameter given its name

+ + +

Parameters

+ + + + + + +
String$name

Expected post parameter's name

+ + +

Returns

+ Object + —

Post value

+ +
+
+ +
+ +
+
+ +
+

setPostParam()

+ + 
setPostParam(String  $param, Object  $value) : void
+

Set a post parameter for automating task

+ + +

Parameters

+ + + + + + + + + + + +
String$param

Name for the Post entry

Object$value

Value for the Post entry

+ + + +
+
+ +
+ +
+
+ +
+

setOutput()

+ + 
setOutput(String  $key, Array  $out) : void
+

Set a new output message

+ + +

Parameters

+ + + + + + + + + + + +
String$key

Array key for the message

Array$out

Message's value

+ + + +
+
+ +
+ +
+
+ +
+

getErrorInstance()

+ + 
getErrorInstance() : \errorManagement
+

Retrieve the errorManagement instance Object

+ + + + +

Returns

+ \errorManagement + —

object

+ +
+
+ +
+ +
+
+ +
+

show()

+ + 
show() : void
+

Output the messages to be send to the client

+ + + + + +
+
+ +
+ +
+
+ + + + +
+ + + -- cgit v1.2.3