ilCloudPlugin Class Reference

Class ilCloudPlugin. More...

Collaboration diagram for ilCloudPlugin:

Public Member Functions
	__construct ($service_name, $obj_id, $cloud_modul_object=null)
	setObjId ($obj_id)
	getObjId ()
	getPluginHookObject ()
	getAdminConfigObject ()
	setPluginHookObject ($plugin_hook_object)
	getTableName ()
	setMaxFileSize ($max_file_size)
	getMaxFileSize ()
	setCloudModulObject ($cloud_modul_object)
	getCloudModulObject ()
	getOwnerId ()
	$return integer More...
	read ()
	create ()
	doUpdate ()
	doDelete ()

Protected Attributes
	$obj_id
	$plugin_hook_object
	$table_name = ""
	$admin_config_object
	$cloud_modul_object
	$max_file_size = 25

Detailed Description

Class ilCloudPlugin.

Base Class for the model of the plugin. Probably will be extended by most plugins.

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 17 of file class.ilCloudPlugin.php.

Constructor & Destructor Documentation

__construct()

ilCloudPlugin::__construct	(		$service_name,
			$obj_id,
			$cloud_modul_object = null
	)

Parameters

$obj_id

Definition at line 57 of file class.ilCloudPlugin.php.

References $cloud_modul_object, $obj_id, ilObject2\_exists(), create(), ilCloudConnector\getPluginHookClass(), ilCloudException\PLUGIN_HOOK_COULD_NOT_BE_INSTANTIATED, read(), setCloudModulObject(), and setObjId().

    {
        $this->setObjId($obj_id);

        $this->plugin_hook_object = ilCloudConnector::getPluginHookClass($service_name);
        if (!is_object($this->plugin_hook_object)) {
            throw new ilCloudException(ilCloudException::PLUGIN_HOOK_COULD_NOT_BE_INSTANTIATED);
        }
        $this->admin_config_object = new ilCloudPluginConfig($this->plugin_hook_object->getPluginConfigTableName());
        if (!$this->read()) {
            $this->create();
        }

        if (!$cloud_modul_object) {
            // in the context of deleting, it's possible that the ilObjCloud with this obj_id is already pushing up the daisies
            // so instantiating it would lead to an error
            if ($obj_id == 0 || ilObjCloud::_exists($obj_id, false, 'cld')) {
                $cloud_modul_object = new ilObjCloud($obj_id, false);
            }
        }
        $this->setCloudModulObject($cloud_modul_object);
    }

Here is the call graph for this function:

Member Function Documentation

create()

ilCloudPlugin::create

(

)

Definition at line 191 of file class.ilCloudPlugin.php.

Referenced by __construct().

    {
    }

Here is the caller graph for this function:

doDelete()

ilCloudPlugin::doDelete

(

)

Definition at line 199 of file class.ilCloudPlugin.php.

    {
    }

doUpdate()

ilCloudPlugin::doUpdate

(

)

Definition at line 195 of file class.ilCloudPlugin.php.

    {
    }

getAdminConfigObject()

ilCloudPlugin::getAdminConfigObject

(

)

Returns

Definition at line 107 of file class.ilCloudPlugin.php.

References $admin_config_object.

    {
        return $this->admin_config_object;
    }

getCloudModulObject()

ilCloudPlugin::getCloudModulObject

(

)

Returns

ilObjCloud

Definition at line 172 of file class.ilCloudPlugin.php.

    {
        return $this->cloud_modul_object;
    }

getMaxFileSize()

ilCloudPlugin::getMaxFileSize

(

)

Returns

int

Definition at line 156 of file class.ilCloudPlugin.php.

    {
        return $this->max_file_size;
    }

getObjId()

ilCloudPlugin::getObjId

(

)

Returns

Definition at line 91 of file class.ilCloudPlugin.php.

References $obj_id.

    {
        return $this->obj_id;
    }

getOwnerId()

ilCloudPlugin::getOwnerId

(

)

$return integer

Definition at line 180 of file class.ilCloudPlugin.php.

    {
        include_once("./Modules/Cloud/classes/class.ilObjCloud.php");
        $cloud_object = new ilObjCloud($this->getObjId(), false);
        return $cloud_object->getOwnerId();
    }

getPluginHookObject()

ilCloudPlugin::getPluginHookObject

(

)

Returns

Definition at line 99 of file class.ilCloudPlugin.php.

References $plugin_hook_object.

Referenced by getTableName().

    {
        return $this->plugin_hook_object;
    }

Here is the caller graph for this function:

getTableName()

ilCloudPlugin::getTableName

(

)

Returns

string

Definition at line 123 of file class.ilCloudPlugin.php.

References getPluginHookObject().

    {
        return $this->getPluginHookObject()->getPluginTableName();
    }

Here is the call graph for this function:

read()

ilCloudPlugin::read

(

)

Definition at line 187 of file class.ilCloudPlugin.php.

Referenced by __construct().

    {
    }

Here is the caller graph for this function:

setCloudModulObject()

ilCloudPlugin::setCloudModulObject

(

$cloud_modul_object

)

Parameters

$cloud_modul_object

Definition at line 164 of file class.ilCloudPlugin.php.

Referenced by __construct().

    {
        $this->cloud_modul_object = $cloud_modul_object;
    }

Here is the caller graph for this function:

setMaxFileSize()

ilCloudPlugin::setMaxFileSize

(

$max_file_size

)

Parameters

boolean

$async_drawing

public function setAsyncDrawing($async_drawing) { $this->async_drawing = $async_drawing; }

/**

Returns

boolean

public function getAsyncDrawing() { return $this->async_drawing; }

Parameters

int

$max_file_size

Definition at line 148 of file class.ilCloudPlugin.php.

    {
        $this->max_file_size = $max_file_size;
    }

setObjId()

ilCloudPlugin::setObjId

(

$obj_id

)

Parameters

$obj_id

Definition at line 83 of file class.ilCloudPlugin.php.

References $obj_id.

Referenced by __construct().

    {
        $this->obj_id = $obj_id;
    }

Here is the caller graph for this function:

setPluginHookObject()

ilCloudPlugin::setPluginHookObject

(

$plugin_hook_object

)

Parameters

\ilCloudHookPlugin

$plugin_hook_object

Definition at line 115 of file class.ilCloudPlugin.php.

References $plugin_hook_object.

    {
        $this->plugin_hook_object = $plugin_hook_object;
    }

Field Documentation

$admin_config_object

ilCloudPlugin::$admin_config_object

protected

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

Referenced by getAdminConfigObject().

$cloud_modul_object

ilCloudPlugin::$cloud_modul_object

protected

Definition at line 42 of file class.ilCloudPlugin.php.

Referenced by __construct().

$max_file_size

ilCloudPlugin::$max_file_size = 25

protected

Definition at line 47 of file class.ilCloudPlugin.php.

$obj_id

ilCloudPlugin::$obj_id

protected

Definition at line 22 of file class.ilCloudPlugin.php.

Referenced by __construct(), getObjId(), and setObjId().

$plugin_hook_object

ilCloudPlugin::$plugin_hook_object

protected

Definition at line 27 of file class.ilCloudPlugin.php.

Referenced by getPluginHookObject(), and setPluginHookObject().

$table_name

ilCloudPlugin::$table_name = ""

protected

Definition at line 32 of file class.ilCloudPlugin.php.

---

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

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