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

\image

+

Image Class of the back-end application

+

Management of images

+ + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ __construct()
+ action()
+
+
+ No public properties found +
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ $app
+ $libClass
+
+
+ N/A +
+
+
+
+ createImage()
+ listImage()
+ detailsImage()
+ updateImage()
+ deleteImage()
+ reactivateImage()
+ desactivateImage()
+ uploadImage()
+ downloadImage()
+ addMemberImage()
+ listMemberImage()
+ detailMemberImage()
+ removeMemberImage()
+ updateMemberImage()
+
+
+ No private properties found +
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$app

+ 
$app : \App
+

+ + +

Type

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

$libClass

+ 
$libClass : \OpenStack\Image
+

+ + +

Type

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

Methods

+ +
+ +
+
+ +
+

__construct()

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

Image constructor

+ + +

Parameters

+ + + + + + +
\App$app

the main app object

+ + +

Returns

+ \image + —

Object

+ +
+
+ +
+ +
+
+ +
+

action()

+ + 
action(String  $action) : void
+

Execute an action

+ + +

Parameters

+ + + + + + +
String$action

name of another function of this class

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

createImage()

+ + 
createImage() : void
+

Create a new image

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

listImage()

+ + 
listImage() : void
+

List the images of the server

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

detailsImage()

+ + 
detailsImage() : void
+

Details about an image

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

updateImage()

+ + 
updateImage() : void
+

Update informations about an image

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

deleteImage()

+ + 
deleteImage() : void
+

Delete an image

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

reactivateImage()

+ + 
reactivateImage() : void
+

Reactive an image

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

desactivateImage()

+ + 
desactivateImage() : void
+

Desactivaate an image

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

uploadImage()

+ + 
uploadImage() : void
+

Upload an image

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

downloadImage()

+ + 
downloadImage() : void
+

Download an image

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

addMemberImage()

+ + 
addMemberImage() : void
+

Add a member to image

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

listMemberImage()

+ + 
listMemberImage() : void
+

List members of an image

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

detailMemberImage()

+ + 
detailMemberImage() : void
+

Show details of a member of an image

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

removeMemberImage()

+ + 
removeMemberImage() : void
+

Remove a member of an image

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

updateMemberImage()

+ + 
updateMemberImage() : void
+

Update a member of an image

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