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/automating.html | 548 +++++++++++++++++++++++++++++++++++++ 1 file changed, 548 insertions(+) create mode 100644 server/doc/classes/automating.html (limited to 'server/doc/classes/automating.html') diff --git a/server/doc/classes/automating.html b/server/doc/classes/automating.html new file mode 100644 index 0000000..e8e88b7 --- /dev/null +++ b/server/doc/classes/automating.html @@ -0,0 +1,548 @@ + + + + + + API Documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + API Documentation + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ + + +
+
+
+
+ +
+
+
+
+
+
+ + + +

\automating

+

automating Class of the back-end application

+

Contains the different function to automate some action

+ + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ __construct()
+ action()
+
+
+ No public properties found +
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $compute
+ $image
+ $network
+ $networkLayer3
+ $app
+
+
+ N/A +
+
+
+
+ createPublicServer()
+
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$compute

+ 
$compute : \App
+

+ + +

Type

+ \App + — protected, contains a Core compute object
+
+ +
+ +
+
+ +
+

$image

+ 
$image : \App
+

+ + +

Type

+ \App + — protected, contains a Core image object
+
+ +
+ +
+
+ +
+

$network

+ 
$network : \App
+

+ + +

Type

+ \App + — protected, contains a Core network object
+
+ +
+ +
+
+ +
+

$networkLayer3

+ 
$networkLayer3 : \App
+

+ + +

Type

+ \App + — protected, contains a Core networkLayer3 object
+
+ +
+ +
+
+ +
+

$app

+ 
$app : \App
+

+ + +

Type

+ \App + — protected, contains the main app object
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

__construct()

+ + 
__construct(\App  $app) : \automating
+

automating class constructor

+ + +

Parameters

+ + + + + + +
\App$app

the main app object

+ + +

Returns

+ \automating + —

Object

+ +
+
+ +
+ +
+
+ +
+

action()

+ + 
action(String  $action) : void
+

Execute an action

+ + +

Parameters

+ + + + + + +
String$action

name of another function of this class

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

createPublicServer()

+ + 
createPublicServer() : void
+

create a new server and associate a public ip

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