ILIAS  release_5-2 Revision v5.2.25-18-g3f80b82851
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().

58  {
59  $this->setObjId($obj_id);
60 
61  $this->plugin_hook_object = ilCloudConnector::getPluginHookClass($service_name);
62  if (!is_object($this->plugin_hook_object))
63  {
65  }
66  $this->admin_config_object = new ilCloudPluginConfig($this->plugin_hook_object->getPluginConfigTableName());
67  if (!$this->read())
68  {
69  $this->create();
70  }
71 
73  {
74  // in the context of deleting, it's possible that the ilObjCloud with this obj_id is already pushing up the daisies
75  // so instantiating it would lead to an error
76  if ($obj_id == 0 || ilObjCloud::_exists($obj_id, false, 'cld')) {
78  }
79  }
81  }
setCloudModulObject($cloud_modul_object)
Class ilCloudPluginConfig.
static getPluginHookClass($service_name)
static _exists($a_id, $a_reference=false, $a_type=null)
Class ilObjCloud.
Class ilCloudException.
+ Here is the call graph for this function:

Member Function Documentation

◆ create()

ilCloudPlugin::create ( )

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

Referenced by __construct().

192 {}
+ Here is the caller graph for this function:

◆ doDelete()

ilCloudPlugin::doDelete ( )

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

196 {}

◆ doUpdate()

ilCloudPlugin::doUpdate ( )

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

194 {}

◆ getAdminConfigObject()

ilCloudPlugin::getAdminConfigObject ( )
Returns

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

References $admin_config_object.

111  {
113  }

◆ getCloudModulObject()

ilCloudPlugin::getCloudModulObject ( )
Returns
ilObjCloud

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

176  {
178  }

◆ getMaxFileSize()

ilCloudPlugin::getMaxFileSize ( )
Returns
int

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

160  {
161  return $this->max_file_size;
162  }

◆ getObjId()

ilCloudPlugin::getObjId ( )
Returns

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

References $obj_id.

95  {
96  return $this->obj_id;
97  }

◆ getOwnerId()

ilCloudPlugin::getOwnerId ( )

$return integer

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

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

◆ getPluginHookObject()

ilCloudPlugin::getPluginHookObject ( )
Returns

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

References $plugin_hook_object.

Referenced by getTableName().

103  {
105  }
+ Here is the caller graph for this function:

◆ getTableName()

ilCloudPlugin::getTableName ( )
Returns
string

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

References getPluginHookObject().

127  {
128  return $this->getPluginHookObject()->getPluginTableName();
129  }
+ Here is the call graph for this function:

◆ read()

ilCloudPlugin::read ( )

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

Referenced by __construct().

190 {}
+ Here is the caller graph for this function:

◆ setCloudModulObject()

ilCloudPlugin::setCloudModulObject (   $cloud_modul_object)
Parameters
$cloud_modul_object

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

Referenced by __construct().

168  {
169  $this->cloud_modul_object = $cloud_modul_object;
170  }
+ Here is the caller graph for this function:

◆ setMaxFileSize()

ilCloudPlugin::setMaxFileSize (   $max_file_size)
Parameters
boolean$async_drawingpublic 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 151 of file class.ilCloudPlugin.php.

152  {
153  $this->max_file_size = $max_file_size;
154  }

◆ setObjId()

ilCloudPlugin::setObjId (   $obj_id)
Parameters
$obj_id

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

References $obj_id.

Referenced by __construct().

87  {
88  $this->obj_id = $obj_id;
89  }
+ Here is the caller graph for this function:

◆ setPluginHookObject()

ilCloudPlugin::setPluginHookObject (   $plugin_hook_object)
Parameters
\ilCloudHookPlugin$plugin_hook_object

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

References $plugin_hook_object.

119  {
120  $this->plugin_hook_object = $plugin_hook_object;
121  }

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: