Inheritance diagram for ilObjCloud:

Collaboration diagram for ilObjCloud:

Public Member Functions
	__construct ($a_ref_id=0, $a_reference=true)
	Constructor.
	initType ()
	doCreate ()
	Create object.
	doRead ()
	Read data from db.
	doUpdate ()
	Update data.
	doDelete ()
	Delete data from db.
	doClone ($a_target_id, $a_copy_id, $new_obj)
	Do Cloning.
	setOnline ($a_val)
	Set online.
	getOnline ()
	Get online.
	setRootFolder ($a_val, $no_check=false)
	Set root_folder, this may only be changed by the owner of the object.
	getRootFolder ()
	Get root_folder.
	setRootId ($a_val, $no_check=false)
	Set root_id.
	getRootId ()
	Get root_id.
	setServiceName ($a_val)
	Set service.
	getServiceName ()
	Get service.
	setOwnerId ($owner_id)
	getOwnerId ()
	currentUserIsOwner ()
	setAuthComplete ($auth_complete)
	getAuthComplete ()
Public Member Functions inherited from ilObject2
	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not)
	read ($a_force_db=false)
	Read data from db.
	getId ()
	get object id public
	setId ($a_id)
	set object id public
	setRefId ($a_id)
	set reference id public
	getRefId ()
	get reference id public
	getType ()
	get object type public
	setType ($a_type)
	set object type public
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions
	getTitle ()
	get object title public
	getUntranslatedTitle ()
	get untranslated object title public
	setTitle ($a_title)
	set object title
	getDescription ()
	get object description
	setDescription ($a_desc)
	set object description
	getLongDescription ()
	get object long description (stored in object_description)
	getImportId ()
	get import id
	setImportId ($a_import_id)
	set import id
	getOwner ()
	get object owner
	getOwnerName ()
	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id
	setOwner ($a_owner)
	set object owner
	getCreateDate ()
	get create date public
	getLastUpdateDate ()
	get last update date public
	setObjDataRecord ($a_record)
	set object_data record (note: this method should only be called from the ilObjectFactory class)
	create ($a_clone_mode=false)
	update ()
	update object in db
	MDUpdateListener ($a_element)
	Meta data update listener.
	createMetaData ()
	create meta data entry
	updateMetaData ()
	update meta data entry
	deleteMetaData ()
	delete meta data entry
	updateOwner ()
	update owner of object in db
	_getIdForImportId ($a_import_id)
	get current object id for import id (static)
	_lookupOwner ($a_id)
	lookup object owner
	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update
	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects.
	_setDeletedDate ($a_ref_id)
	only called in ilTree::saveSubTree
	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes
	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes
	_writeTitle ($a_obj_id, $a_title)
	write title to db (static)
	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static)
	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static)
	_isInTrash ($a_ref_id)
	checks wether object is in trash
	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash
	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type
	putInTree ($a_parent_ref)
	maybe this method should be in tree object!?
	setPermissions ($a_parent_ref)
	set permissions of object
	createReference ()
	creates reference for object
	countReferences ()
	count references of object
	delete ()
	delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!!
	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) public
	notify ($a_event, $a_ref_id, $a_parent_non_rbac_id, $a_node_id, $a_params=0)
	notifys an object about an event occured Based on the event passed, each object may decide how it reacts.
	setRegisterMode ($a_bool)
	isUserRegistered ($a_user_id=0)
	requireRegistration ()
	appendCopyInfo ($a_target_id, $a_copy_id)
	Prepend Copy info if object with same name exists in that container.
	cloneMetaData ($target_obj)
	Copy meta data.
	cloneObject ($a_target_id, $a_copy_id=null, $a_omit_tree=false)
	Clone object permissions, put in tree ...
	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies.
Public Member Functions inherited from ilObject
	ilObject ($a_id=0, $a_reference=true)
	Constructor public.
	getDiskUsage ()
	Gets the disk usage of the object in bytes.
	create ()
	create
	setParentRolePermissions ($a_parent_ref)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g courses, groups for building permission intersections with non_member templates.
	applyDidacticTemplate ($a_tpl_id)
	Apply template.
	getXMLZip ()
	getHTMLDirectory ()
	_lookupCreationDate ($a_id)
	Lookup creation date.

Protected Attributes
	$online = false
	$service = ""
	$root_folder = ""
	$owner_id = 0
	$auth_complete = false

Additional Inherited Members
Static Public Member Functions inherited from ilObject2
static	_lookupObjIdByImportId ($a_import_id)
static	_getAllReferences ($a_id)
	get all reference ids of object
static	_lookupTitle ($a_id)
	lookup object title
static	_getIdsForTitle ($title, $type= '', $partialmatch=false)
static	_lookupDescription ($a_id)
	lookup object description
static	_lookupObjId ($a_id)
static	_lookupType ($a_id, $a_reference=false)
	lookup object type
static	_lookupObjectId ($a_ref_id)
	lookup object id
static	_exists ($a_id, $a_reference=false)
static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type.
static	_prepareCloneSelection ($a_ref_ids, $new_type)
static	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
	Get icon for repository item.
Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
	max length of object title
const	DESC_LENGTH = 128
	$ilias
	$lng
	$id
	$ref_id
	$type
	$title
	$untranslatedTitle
	$desc
	$long_desc
	$owner
	$create_date
	$last_update
	$import_id
	$register = false
	$referenced
	$objectList
	$max_title
	$max_desc
	$add_dots
	$obj_data_record
	object_data record
Protected Member Functions inherited from ilObject2
	beforeCreate ()
	beforeUpdate ()
	doMDUpdateListener ($a_element)
	beforeMDUpdateListener ($a_element)
	doCreateMetaData ()
	beforeCreateMetaData ()
	doUpdateMetaData ()
	beforeUpdateMetaData ()
	beforeDelete ()
	doCloneObject ($new_obj, $a_target_id, $a_copy_id=null)
	beforeCloneObject ()

Detailed Description

Class ilObjCloud.

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

Definition at line 16 of file class.ilObjCloud.php.

Constructor & Destructor Documentation

ilObjCloud::__construct	(	$a_ref_id = `0`,
		$a_reference = `true`
	)

Constructor.

public

Reimplemented from ilObject2.

Definition at line 49 of file class.ilObjCloud.php.

    {
        parent::__construct($a_ref_id, $a_reference);
    }

Member Function Documentation

ilObjCloud::currentUserIsOwner ( )

Returns: bool

Definition at line 288 of file class.ilObjCloud.php.

References $ilUser, and getOwnerId().

Referenced by setRootFolder(), and setRootId().

    {
        global $ilUser;
        return $ilUser->getId() == $this->getOwnerId();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjCloud::doClone	(	$a_target_id,
		$a_copy_id,
		$new_obj
	)

Do Cloning.

Definition at line 150 of file class.ilObjCloud.php.

References $ilDB, ilCopyWizardOptions\_getInstance(), getAuthComplete(), getOnline(), getOwnerId(), getRootFolder(), getRootId(), and getServiceName().

    {
        global $ilDB;
        //copy online status if object is not the root copy object
        $cp_options = ilCopyWizardOptions::_getInstance($a_copy_id);
        if(!$cp_options->isRootNode($this->getRefId()))
        {
            $new_obj->setOnline($this->getOnline());
        }
        $new_obj->setRootFolder($this->getRootFolder());
        $new_obj->getRootId($this->getRootId());
        $new_obj->setServiceName($this->getServiceName());
        $new_obj->serOwnerId($this->getOwnerId());
        $new_obj->setAuthComplete($this->getAuthComplete());
        $new_obj->update();
    }

Here is the call graph for this function:

ilObjCloud::doCreate ( )

Create object.

The owner of the cloud Object is only set once, when the object is created. This prevents, that users access data of a cloud folder which they are not authorized to through changing the root_path of the cloud_folder

Reimplemented from ilObject2.

Definition at line 65 of file class.ilObjCloud.php.

References $ilDB, $ilUser, getOwnerId(), and setOwnerId().

    {
        global $ilDB, $ilUser;
        $this->setOwnerId($ilUser->getId());
        $ilDB->manipulate("INSERT INTO il_cld_data " .
            "(id, is_online, service, root_folder, root_id, owner_id, auth_complete) VALUES (" .
            $ilDB->quote($this->getId(), "integer") . "," .
            $ilDB->quote("", "integer")  . "," .
            $ilDB->quote("", "text")    . "," .
            $ilDB->quote("", "text")    . "," .
            $ilDB->quote("", "text")    . "," .
            $ilDB->quote($this->getOwnerId(), "integer") . "," .
            $ilDB->quote("", "integer") .
            ")");
    }

Here is the call graph for this function:

ilObjCloud::doDelete ( )

Delete data from db.

Reimplemented from ilObject2.

Definition at line 128 of file class.ilObjCloud.php.

References $ilDB, ilObject2\getId(), ilCloudConnector\getPluginClass(), and getServiceName().

    {
        global $ilDB;
        if ($this->getServiceName() != null)
        {
            $plugin_class = ilCloudConnector::getPluginClass($this->getServiceName(), $this->getId());
            if ($plugin_class)
            {
                $plugin_class->doDelete($this->getId());
            }
        }
        $ilDB->manipulate("DELETE FROM il_cld_data WHERE " .
            " id = " . $ilDB->quote($this->getId(), "integer")
        );
    }

Here is the call graph for this function:

ilObjCloud::doRead ( )

Read data from db.

Reimplemented from ilObject2.

Definition at line 89 of file class.ilObjCloud.php.

References $ilDB, setAuthComplete(), setOnline(), setOwnerId(), setRootFolder(), setRootId(), and setServiceName().

    {
        global $ilDB;
        $set = $ilDB->query("SELECT * FROM il_cld_data " .
            " WHERE id = " . $ilDB->quote($this->getId(), "integer"));
        while ($rec = $ilDB->fetchAssoc($set))
        {
            $this->setOnline($rec["is_online"]);
            $this->setRootFolder($rec["root_folder"]);
            $this->setRootId($rec["root_id"]);
            $this->setServiceName($rec["service"]);
            $this->setOwnerId($rec["owner_id"]);
            $this->setAuthComplete($rec["auth_complete"]);
        }
    }

Here is the call graph for this function:

ilObjCloud::doUpdate ( )

Update data.

Reimplemented from ilObject2.

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

References $ilDB.

    {
        global $ilDB;
        $ilDB->manipulate($up = "UPDATE il_cld_data SET " .
                " is_online = " . $ilDB->quote($this->getOnline(), "integer") . "," .
                " service = " . $ilDB->quote($this->getServiceName(), "text") . "," .
                " root_folder = " . $ilDB->quote($this->getRootFolder(), "text") . "," .
                " root_id = " . $ilDB->quote($this->getRootId(), "text") . "," .
                " owner_id = " . $ilDB->quote($this->getOwnerId(), "integer") . "," .
                " auth_complete = " . $ilDB->quote($this->getAuthComplete(), "integer") .
                " WHERE id = " . $ilDB->quote($this->getId(), "integer")
        );
    }

ilObjCloud::getAuthComplete ( )

Returns: boolean

Definition at line 305 of file class.ilObjCloud.php.

References $auth_complete.

Referenced by doClone().

    {
        return $this->auth_complete;
    }

Here is the caller graph for this function:

ilObjCloud::getOnline ( )

Get online.

Returns: boolean online

Definition at line 189 of file class.ilObjCloud.php.

References $online.

Referenced by doClone().

    {
        return $this->online;
    }

Here is the caller graph for this function:

ilObjCloud::getOwnerId ( )

Returns: int

Definition at line 280 of file class.ilObjCloud.php.

References $owner_id.

Referenced by currentUserIsOwner(), doClone(), and doCreate().

    {
        return $this->owner_id;
    }

Here is the caller graph for this function:

ilObjCloud::getRootFolder ( )

Get root_folder.

Returns: string root_folder

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

References $root_folder.

Referenced by doClone(), and setRootFolder().

    {
        return $this->root_folder;
    }

Here is the caller graph for this function:

ilObjCloud::getRootId ( )

Get root_id.

Returns: string root_id

Definition at line 244 of file class.ilObjCloud.php.

Referenced by doClone(), and setRootId().

    {
        return $this->root_id;
    }

Here is the caller graph for this function:

ilObjCloud::getServiceName ( )

Get service.

Returns: string service

Definition at line 264 of file class.ilObjCloud.php.

Referenced by ilObjCloudGUI\afterSave(), doClone(), doDelete(), and ilObjCloudGUI\serviceAuth().

    {
        return $this->service_name;
    }

Here is the caller graph for this function:

ilObjCloud::initType ( )

Reimplemented from ilObject2.

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

    {
        $this->type = "cld";
    }

ilObjCloud::setAuthComplete ( $auth_complete )

Parameters

boolean $auth_complete

Definition at line 297 of file class.ilObjCloud.php.

References $auth_complete.

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

    {
        $this->auth_complete = $auth_complete;
    }

Here is the caller graph for this function:

ilObjCloud::setOnline ( $a_val )

Set online.

Parameters

boolean online

Definition at line 179 of file class.ilObjCloud.php.

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

    {
        $this->online = $a_val;
    }

Here is the caller graph for this function:

ilObjCloud::setOwnerId ( $owner_id )

Parameters

int $owner_id

Definition at line 272 of file class.ilObjCloud.php.

References $owner_id.

Referenced by doCreate(), and doRead().

    {
        $this->owner_id = $owner_id;
    }

Here is the caller graph for this function:

ilObjCloud::setRootFolder	(	$a_val,
		$no_check = `false`
	)

Set root_folder, this may only be changed by the owner of the object.

This is due too security constraints. The parameter $no_check could be used by plugins for which these constraint is not an issue.

Parameters

string root_folder

Definition at line 200 of file class.ilObjCloud.php.

References currentUserIsOwner(), getRootFolder(), ilCloudUtil\normalizePath(), and ilCloudException\PERMISSION_TO_CHANGE_ROOT_FOLDER_DENIED.

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

    {
        if($this->currentUserIsOwner() || $no_check || $this->getRootFolder() == null)
        {
            $a_val             = ilCloudUtil::normalizePath($a_val);
            $this->root_folder = $a_val;
        }
        else
        {
            throw new ilCloudException(ilCloudException::PERMISSION_TO_CHANGE_ROOT_FOLDER_DENIED);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjCloud::setRootId	(	$a_val,
		$no_check = `false`
	)

Set root_id.

Parameters

string root_id

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

References currentUserIsOwner(), getRootId(), and ilCloudException\PERMISSION_TO_CHANGE_ROOT_FOLDER_DENIED.

Referenced by doRead().

    {
        if ($this->currentUserIsOwner() || $no_check || $this->getRootId() == null)
        {
            $this->root_id = $a_val;
        } else
        {
            throw new ilCloudException(ilCloudException::PERMISSION_TO_CHANGE_ROOT_FOLDER_DENIED);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjCloud::setServiceName ( $a_val )

Set service.

Parameters

string service

Definition at line 254 of file class.ilObjCloud.php.

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

    {
        $this->service_name = $a_val;
    }

Here is the caller graph for this function:

Field Documentation

ilObjCloud::$auth_complete = false

protected

Definition at line 41 of file class.ilObjCloud.php.

Referenced by getAuthComplete(), and setAuthComplete().

ilObjCloud::$online = false

protected

Definition at line 21 of file class.ilObjCloud.php.

Referenced by getOnline().

ilObjCloud::$owner_id = 0

protected

Definition at line 36 of file class.ilObjCloud.php.

Referenced by getOwnerId(), and setOwnerId().

ilObjCloud::$root_folder = ""

protected

Definition at line 31 of file class.ilObjCloud.php.

Referenced by getRootFolder().

ilObjCloud::$service = ""

protected

Definition at line 26 of file class.ilObjCloud.php.

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

Modules/Cloud/classes/class.ilObjCloud.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation