ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilCloudConnector Class Reference

ilCloudConnector class Needed to check if a a plugin making a conncection to a service like GoogleDrive (simply named "service" is active or not. More...

+ Collaboration diagram for ilCloudConnector:

Static Public Member Functions

static getActiveServices ()
 
static checkServiceActive ($name)
 
static getServiceClass ($service_name, $obj_id, $connect=true)
 
static getPluginClass ($service_name, $obj_id, $cloud_module_object=null)
 
static getPluginHookClass ($service_name)
 
static getSettingsGUIClass (ilCloudPluginService $plugin_service_class)
 
static getActionListGUIClass (ilCloudPluginService $plugin_service_class)
 
static getItemCreationListGUIClass (ilCloudPluginService $plugin_service_class)
 
static getInitGUIClass (ilCloudPluginService $plugin_service_class)
 
static getFileTreeGUIClass (ilCloudPluginService $plugin_service_class, ilCloudFileTree $file_tree)
 
static getCreateFolderGUIClass (ilCloudPluginService $plugin_service_class)
 
static getUploadGUIClass (ilCloudPluginService $plugin_service_class)
 
static getDeleteGUIClass (ilCloudPluginService $plugin_service_class)
 
static getHeaderActionGUIClass (ilCloudPluginService $plugin_service_class)
 
static getCreationGUIClass (ilCloudPluginService $plugin_service_class)
 
static getInfoScreenGUIClass (ilCloudPluginService $plugin_service_class)
 

Static Protected Member Functions

static getFullClassName ($service_name, $class_name)
 

Detailed Description

ilCloudConnector class Needed to check if a a plugin making a conncection to a service like GoogleDrive (simply named "service" is active or not.

Further the getXXXClass functions of this class are used to check if a given class is extended and if so returning the extended version and if not returning the core version.

Author
Timon Amstutz timon.nosp@m..ams.nosp@m.tutz@.nosp@m.ilub.nosp@m..unib.nosp@m.e.ch
Version
$Id$

Definition at line 30 of file class.ilCloudConnector.php.

Member Function Documentation

◆ checkServiceActive()

static ilCloudConnector::checkServiceActive (   $name)
static
Parameters
string$name
Returns
bool
Exceptions
ilCloudException

Definition at line 59 of file class.ilCloudConnector.php.

60 {
61 if (!$name)
62 {
64 }
65
66 if (array_key_exists($name, ilCloudConnector::getActiveServices()))
67 {
68 return true;
69 } else
70 {
72 }
73 }
Class ilCloudException.

References getActiveServices(), ilCloudException\NO_SERVICE_SELECTED, and ilCloudException\SERVICE_NOT_ACTIVE.

Referenced by ilObjCloudAccess\_checkAccess(), ilObjCloudGUI\executeCommand(), and ilCloudPluginInitGUI\initGUI().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getActionListGUIClass()

static ilCloudConnector::getActionListGUIClass ( ilCloudPluginService  $plugin_service_class)
static
Parameters
$service_name
$obj_id
Returns
ilCloudPluginActionListGUI

Definition at line 152 of file class.ilCloudConnector.php.

153 {
154 $class_name = ilCloudConnector::getFullClassName($plugin_service_class->getPluginHookObject()->getPluginName(), "ActionListGUI");
155 return new $class_name($plugin_service_class);
156 }
static getFullClassName($service_name, $class_name)
getPluginHookObject()
For shorter access.

References getFullClassName(), and ilCloudPluginService\getPluginHookObject().

Referenced by ilObjCloudGUI\asyncGetActionListContent(), ilObjCloudGUI\executeCommand(), and ilCloudPluginFileTreeGUI\getItemHtml().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getActiveServices()

static ilCloudConnector::getActiveServices ( )
static
Returns
array
Exceptions
ilCloudException

Definition at line 37 of file class.ilCloudConnector.php.

38 {
39 global $ilPluginAdmin;
40
41 $cloud_services = $ilPluginAdmin->getActivePluginsForSlot("Modules", "Cloud", "cldh");
42 if (!$cloud_services)
43 {
45 }
46 $services_names = array();
47 foreach ($cloud_services as $service)
48 {
49 $services_names[$service] = $service;
50 }
51 return $services_names;
52 }

References ilCloudException\NO_SERVICE_ACTIVE.

Referenced by checkServiceActive(), ilObjCloudGUI\executeCommand(), getServiceClass(), and ilObjCloudGUI\initCreateForm().

+ Here is the caller graph for this function:

◆ getCreateFolderGUIClass()

static ilCloudConnector::getCreateFolderGUIClass ( ilCloudPluginService  $plugin_service_class)
static
Parameters
string$name
int$obj_id
Returns
ilCloudPluginCreateFolderGUI

Definition at line 197 of file class.ilCloudConnector.php.

198 {
199 $class_name = ilCloudConnector::getFullClassName($plugin_service_class->getPluginHookObject()->getPluginName(), "CreateFolderGUI");
200 return new $class_name($plugin_service_class);
201 }

References getFullClassName(), and ilCloudPluginService\getPluginHookObject().

Referenced by ilObjCloudGUI\executeCommand().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getCreationGUIClass()

static ilCloudConnector::getCreationGUIClass ( ilCloudPluginService  $plugin_service_class)
static
Parameters
ilCloudPluginService$plugin_service_class
Returns
ilCloudPluginCreationGUI

Definition at line 238 of file class.ilCloudConnector.php.

239 {
240 $class_name = ilCloudConnector::getFullClassName($plugin_service_class->getPluginHookObject()->getPluginName(), "CreationGUI");
241 return new $class_name($plugin_service_class);
242 }

References getFullClassName(), and ilCloudPluginService\getPluginHookObject().

Referenced by ilObjCloudGUI\afterSave(), and ilObjCloudGUI\initCreateForm().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getDeleteGUIClass()

static ilCloudConnector::getDeleteGUIClass ( ilCloudPluginService  $plugin_service_class)
static
Parameters
ilCloudPluginService$plugin_service_class
Returns
ilCloudPluginDeleteGUI

Definition at line 218 of file class.ilCloudConnector.php.

219 {
220 $class_name = ilCloudConnector::getFullClassName($plugin_service_class->getPluginHookObject()->getPluginName(), "DeleteGUI");
221 return new $class_name($plugin_service_class);
222 }

References getFullClassName(), and ilCloudPluginService\getPluginHookObject().

Referenced by ilObjCloudGUI\executeCommand().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getFileTreeGUIClass()

static ilCloudConnector::getFileTreeGUIClass ( ilCloudPluginService  $plugin_service_class,
ilCloudFileTree  $file_tree 
)
static
Parameters
$service_name
$obj_id
ilCloudPluginFileTree
Returns
ilCloudPluginFileTreeGUI

Definition at line 186 of file class.ilCloudConnector.php.

187 {
188 $class_name = ilCloudConnector::getFullClassName($plugin_service_class->getPluginHookObject()->getPluginName(), "FileTreeGUI");
189 return new $class_name($plugin_service_class, $file_tree);
190 }

References getFullClassName(), and ilCloudPluginService\getPluginHookObject().

Referenced by ilObjCloudGUI\asyncGetBlock(), and ilObjCloudGUI\executeCommand().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getFullClassName()

static ilCloudConnector::getFullClassName (   $service_name,
  $class_name 
)
staticprotected
Parameters
string$service_name
string$class_name
Returns
string

Definition at line 80 of file class.ilCloudConnector.php.

81 {
82 if (file_exists("./Customizing/global/plugins/Modules/Cloud/CloudHook/" . $service_name . "/classes/class.il" .$service_name . $class_name.".php"))
83 {
84 include_once("./Customizing/global/plugins/Modules/Cloud/CloudHook/" . $service_name . "/classes/class.il" .$service_name . $class_name.".php");
85 $class_full_name = "il" . $service_name . $class_name;
86 return $class_full_name;
87 }
88 return "ilCloudPlugin" .$class_name;
89 }

Referenced by getActionListGUIClass(), getCreateFolderGUIClass(), getCreationGUIClass(), getDeleteGUIClass(), getFileTreeGUIClass(), getHeaderActionGUIClass(), getInfoScreenGUIClass(), getInitGUIClass(), getItemCreationListGUIClass(), getPluginClass(), getPluginHookClass(), getServiceClass(), getSettingsGUIClass(), and getUploadGUIClass().

+ Here is the caller graph for this function:

◆ getHeaderActionGUIClass()

static ilCloudConnector::getHeaderActionGUIClass ( ilCloudPluginService  $plugin_service_class)
static
Parameters
ilCloudPluginService$plugin_service_class
Returns
ilCloudPluginHeaderActionGUI

Definition at line 228 of file class.ilCloudConnector.php.

229 {
230 $class_name = ilCloudConnector::getFullClassName($plugin_service_class->getPluginHookObject()->getPluginName(), "HeaderActionGUI");
231 return new $class_name($plugin_service_class);
232 }

References getFullClassName(), and ilCloudPluginService\getPluginHookObject().

Referenced by ilObjCloudGUI\addHeaderAction(), and ilObjCloudGUI\executeCommand().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getInfoScreenGUIClass()

static ilCloudConnector::getInfoScreenGUIClass ( ilCloudPluginService  $plugin_service_class)
static
Parameters
ilCloudPluginService$plugin_service_class
Returns
ilCloudPluginInfoScreenGUI

Definition at line 248 of file class.ilCloudConnector.php.

249 {
250 $class_name = ilCloudConnector::getFullClassName($plugin_service_class->getPluginHookObject()->getPluginName(), "InfoScreenGUI");
251 return new $class_name($plugin_service_class);
252 }

References getFullClassName(), and ilCloudPluginService\getPluginHookObject().

Referenced by ilObjCloudGUI\infoScreen().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getInitGUIClass()

static ilCloudConnector::getInitGUIClass ( ilCloudPluginService  $plugin_service_class)
static
Parameters
string$name
int$obj_id
Returns
ilCloudPluginInitGUI

Definition at line 174 of file class.ilCloudConnector.php.

175 {
176 $class_name = ilCloudConnector::getFullClassName($plugin_service_class->getPluginHookObject()->getPluginName(), "InitGUI");
177 return new $class_name($plugin_service_class);
178 }

References getFullClassName(), and ilCloudPluginService\getPluginHookObject().

Referenced by ilObjCloudGUI\executeCommand(), and ilObjCloudGUI\render().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getItemCreationListGUIClass()

static ilCloudConnector::getItemCreationListGUIClass ( ilCloudPluginService  $plugin_service_class)
static
Parameters
string$name
int$obj_id
Returns
ilCloudPluginItemCreationListGUI

Definition at line 163 of file class.ilCloudConnector.php.

164 {
165 $class_name = ilCloudConnector::getFullClassName($plugin_service_class->getPluginHookObject()->getPluginName(), "ItemCreationListGUI");
166 return new $class_name($plugin_service_class);
167 }

References getFullClassName(), and ilCloudPluginService\getPluginHookObject().

Referenced by ilCloudPluginInitGUI\addToolbar(), and ilObjCloudGUI\executeCommand().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getPluginClass()

static ilCloudConnector::getPluginClass (   $service_name,
  $obj_id,
  $cloud_module_object = null 
)
static
Parameters
string$name
int$obj_id
Returns
ilCloudPlugin

Definition at line 119 of file class.ilCloudConnector.php.

120 {
121 $class_name = ilCloudConnector::getFullClassName($service_name, "");
122 return new $class_name($service_name, $obj_id, $cloud_module_object);
123 }

References getFullClassName().

Referenced by ilCloudPluginService\__construct(), ilObjCloud\doDelete(), ilCloudPluginInitGUI\initGUI(), and ilCloudFileTree\uploadFileToService().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getPluginHookClass()

static ilCloudConnector::getPluginHookClass (   $service_name)
static
Parameters
string$name
int$obj_id
Returns
ilCloudHookPlugin

Definition at line 130 of file class.ilCloudConnector.php.

131 {
132 $class_name = ilCloudConnector::getFullClassName($service_name, "Plugin");
133 return new $class_name($service_name);
134 }

References getFullClassName().

Referenced by ilCloudPlugin\__construct(), and ilObjCloudGUI\initCreateForm().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getServiceClass()

static ilCloudConnector::getServiceClass (   $service_name,
  $obj_id,
  $connect = true 
)
static
Parameters
string$name
int$obj_id
bool$connect
Returns
ilCloudPluginService
Exceptions
ilCloudException

Definition at line 97 of file class.ilCloudConnector.php.

98 {
99 if (!$service_name)
100 {
102 }
103
104 if (array_key_exists($service_name, ilCloudConnector::getActiveServices()))
105 {
106 $class_name = ilCloudConnector::getFullClassName($service_name, "Service");
107 return new $class_name($service_name, $obj_id);
108 } else
109 {
111 }
112 }

References getActiveServices(), getFullClassName(), ilCloudException\NO_SERVICE_SELECTED, and ilCloudException\SERVICE_NOT_ACTIVE.

Referenced by ilCloudFileTree\__construct(), ilCloudFileTree\addFolderToService(), ilCloudFileTree\addItemsFromService(), ilCloudFileTree\deleteFromService(), ilCloudFileTree\downloadFromService(), ilObjCloudGUI\executeCommand(), ilObjCloudGUI\initCreateForm(), ilObjCloudGUI\serviceAuth(), and ilCloudFileTree\uploadFileToService().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getSettingsGUIClass()

static ilCloudConnector::getSettingsGUIClass ( ilCloudPluginService  $plugin_service_class)
static
Parameters
string$name
int$obj_id
Returns
ilCloudPluginSettingsGUI

Definition at line 141 of file class.ilCloudConnector.php.

142 {
143 $class_name = ilCloudConnector::getFullClassName($plugin_service_class->getPluginHookObject()->getPluginName(), "SettingsGUI");
144 return new $class_name($plugin_service_class);
145 }

References getFullClassName(), and ilCloudPluginService\getPluginHookObject().

Referenced by ilObjCloudGUI\executeCommand().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getUploadGUIClass()

static ilCloudConnector::getUploadGUIClass ( ilCloudPluginService  $plugin_service_class)
static
Parameters
string$name
int$obj_id
Returns
ilCloudPluginUploadGUI

Definition at line 208 of file class.ilCloudConnector.php.

209 {
210 $class_name = ilCloudConnector::getFullClassName($plugin_service_class->getPluginHookObject()->getPluginName(), "UploadGUI");
211 return new $class_name($plugin_service_class);
212 }

References getFullClassName(), and ilCloudPluginService\getPluginHookObject().

Referenced by ilObjCloudGUI\executeCommand().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

The documentation for this class was generated from the following file: