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)
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 60 of file class.ilCloudConnector.php.

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

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

    {
        if (!$name)
        {
            throw new ilCloudException(ilCloudException::NO_SERVICE_SELECTED);
        }

        if (array_key_exists($name, ilCloudConnector::getActiveServices()))
        {
            return true;
        } else
        {
            throw new ilCloudException(ilCloudException::SERVICE_NOT_ACTIVE, $name);
        }
    }

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 153 of file class.ilCloudConnector.php.

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

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

    {
        $class_name = ilCloudConnector::getFullClassName($plugin_service_class->getPluginHookObject()->getPluginName(), "ActionListGUI");
        return new $class_name($plugin_service_class);
    }

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.

References $DIC, array, and ilCloudException\NO_SERVICE_ACTIVE.

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

    {
        global $DIC;
        $ilPluginAdmin = $DIC['ilPluginAdmin'];

        $cloud_services = $ilPluginAdmin->getActivePluginsForSlot("Modules", "Cloud", "cldh");
        if (!$cloud_services)
        {
            throw new ilCloudException(ilCloudException::NO_SERVICE_ACTIVE);
        }
        $services_names = array();
        foreach ($cloud_services as $service)
        {
            $services_names[$service] = $service;
        }
        return $services_names;
    }

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 198 of file class.ilCloudConnector.php.

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

Referenced by ilObjCloudGUI\executeCommand().

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

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 239 of file class.ilCloudConnector.php.

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

Referenced by ilObjCloudGUI\initCreateForm().

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

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 219 of file class.ilCloudConnector.php.

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

Referenced by ilObjCloudGUI\executeCommand().

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

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 187 of file class.ilCloudConnector.php.

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

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

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

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 81 of file class.ilCloudConnector.php.

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

    {
        if (file_exists("./Customizing/global/plugins/Modules/Cloud/CloudHook/" . $service_name . "/classes/class.il" .$service_name . $class_name.".php"))
        {
            include_once("./Customizing/global/plugins/Modules/Cloud/CloudHook/" . $service_name . "/classes/class.il" .$service_name . $class_name.".php");
            $class_full_name = "il" . $service_name . $class_name;
            return $class_full_name;
        }
        return "ilCloudPlugin" .$class_name;
    }

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 229 of file class.ilCloudConnector.php.

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

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

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

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 249 of file class.ilCloudConnector.php.

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

Referenced by ilObjCloudGUI\infoScreenForward().

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

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 175 of file class.ilCloudConnector.php.

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

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

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

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 164 of file class.ilCloudConnector.php.

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

getPluginClass()

static ilCloudConnector::getPluginClass (   $service_name,   $obj_id  )

static

Parameters

string	$name
int	$obj_id

Returns

ilCloudPlugin

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

References getFullClassName().

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

    {
        $class_name = ilCloudConnector::getFullClassName($service_name, "");
        return new $class_name($service_name, $obj_id);
    }

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 131 of file class.ilCloudConnector.php.

References getFullClassName().

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

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

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 98 of file class.ilCloudConnector.php.

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().

    {
        if (!$service_name)
        {
            throw new ilCloudException(ilCloudException::NO_SERVICE_SELECTED);
        }

        if (array_key_exists($service_name, ilCloudConnector::getActiveServices()))
        {
            $class_name    = ilCloudConnector::getFullClassName($service_name, "Service");
            return new $class_name($service_name, $obj_id);
        } else
        {
            throw new ilCloudException(ilCloudException::SERVICE_NOT_ACTIVE, $service_name);
        }
    }

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 142 of file class.ilCloudConnector.php.

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

Referenced by ilObjCloudGUI\executeCommand().

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

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 209 of file class.ilCloudConnector.php.

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

Referenced by ilObjCloudGUI\executeCommand().

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

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:

• Modules/Cloud/classes/class.ilCloudConnector.php