ILIAS  Release_4_2_x_branch Revision 61807
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions
ilObject2 Class Reference

Class ilObject2 This is an intermediate progress of ilObject class. More...

+ Inheritance diagram for ilObject2:
+ Collaboration diagram for ilObject2:

Public Member Functions

 __construct ($a_id=0, $a_reference=true)
 Constructor public.
 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
 _lookupObjectId ($a_ref_id)
 lookup object id
 _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
 createRoleFolder ()
 creates a local role folder
 _exists ($a_id, $a_reference=false)
 checks if an object exists in object_data
 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
 applyDidacticTemplate ($a_tpl_id)
 Apply template.
 getXMLZip ()
 getHTMLDirectory ()

Static Public Member Functions

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 _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.
- Static Public Member Functions inherited from ilObject
static _prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
 Prepare copy wizard object selection.
static collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
 Collect deletion dependencies.
static getDeletionDependencies ($a_obj_id)
 Get deletion dependencies.

Protected Member Functions

 initType ()
 doRead ()
 doCreate ()
 beforeCreate ()
 doUpdate ()
 beforeUpdate ()
 doMDUpdateListener ($a_element)
 beforeMDUpdateListener ($a_element)
 doCreateMetaData ()
 beforeCreateMetaData ()
 doUpdateMetaData ()
 beforeUpdateMetaData ()
 doDelete ()
 beforeDelete ()
 doCloneObject ($new_obj, $a_target_id, $a_copy_id=null)
 beforeCloneObject ()

Additional Inherited Members

- Data Fields inherited from ilObject
const TITLE_LENGTH = 128
 max length of object title
 $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

Detailed Description

Class ilObject2 This is an intermediate progress of ilObject class.

Please do not ust it yet.

Author
Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

Definition at line 14 of file class.ilObject2.php.

Constructor & Destructor Documentation

ilObject2::__construct (   $a_id = 0,
  $a_reference = true 
)

Constructor public.

Parameters
integerreference_id or object_id
booleantreat the id as reference_id (true) or object_id (false)

Reimplemented in ilObjFile, and ilVerificationObject.

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

References ilObject\ilObject(), and initType().

{
$this->initType();
parent::ilObject($a_id, $a_reference);
}

+ Here is the call graph for this function:

Member Function Documentation

ilObject2::_exists (   $a_id,
  $a_reference = false 
)
final

checks if an object exists in object_data

public

Parameters
integerobject id or reference id
booleanture if id is a reference, else false (default)
Returns
boolean true if object exists

Reimplemented from ilObject.

Definition at line 241 of file class.ilObject2.php.

{ return parent::_exists($a_id, $a_reference); }
static ilObject2::_getAllReferences (   $a_id)
staticfinal

get all reference ids of object

Parameters
int$a_idobject id

Reimplemented from ilObject.

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

{ return parent::_getAllReferences($a_id); }
static ilObject2::_getIcon (   $a_obj_id = "",
  $a_size = "big",
  $a_type = "",
  $a_offline = false 
)
staticfinal

Get icon for repository item.

Parameters
intobject id
stringsize (big, small, tiny)
stringobject type
booleantrue: offline, false: online

Reimplemented from ilObject.

Definition at line 279 of file class.ilObject2.php.

{ return parent::_getIcon($a_obj_id, $a_size, $a_type, $a_offline); }
ilObject2::_getIdForImportId (   $a_import_id)
final

get current object id for import id (static)

Parameters
int$a_import_idimport id
Returns
int id

Reimplemented from ilObject.

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

{ return parent::_getIdForImportId($a_import_id); }
static ilObject2::_getIdsForTitle (   $title,
  $type = '',
  $partialmatch = false 
)
staticfinal

Reimplemented from ilObject.

Definition at line 193 of file class.ilObject2.php.

References ilObject\$title, and ilObject\$type.

{ return parent::_getIdsForTitle($title, $type, $partialmatch); }
ilObject2::_getLastUpdateOfObjects (   $a_objs)
final

Get last update for a set of media objects.

Parameters
array

Reimplemented from ilObject.

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

{ return parent::_getLastUpdateOfObjects($a_objs); }
static ilObject2::_getObjectsByType (   $a_obj_type = "",
  $a_owner = "" 
)
staticfinal

Get objects by type.

Reimplemented from ilObject.

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

{ return parent::_getObjectsByType($a_obj_type, $a_owner); }
ilObject2::_getObjectsDataForType (   $a_type,
  $a_omit_trash = false 
)
final

get all objects of a certain type

Parameters
string$a_typedesired object type
boolean$a_omit_trashomit objects, that are in trash only (default: false)
Returns
array array of object data arrays ("id", "title", "type", "description")

Reimplemented from ilObject.

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

{ return parent::_getObjectsDataForType($a_type, $a_omit_trash); }
ilObject2::_hasUntrashedReference (   $a_obj_id)
final

checks wether an object has at least one reference that is not in trash

Reimplemented from ilObject.

Definition at line 206 of file class.ilObject2.php.

{ return parent::_hasUntrashedReference($a_obj_id); }
ilObject2::_isInTrash (   $a_ref_id)
final

checks wether object is in trash

Reimplemented from ilObject.

Definition at line 205 of file class.ilObject2.php.

{ return parent::_isInTrash($a_ref_id); }
ilObject2::_lookupDeletedDate (   $a_ref_id)
final

only called in ilObjectGUI::insertSavedNodes

Reimplemented from ilObject.

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

{ return parent::_lookupDeletedDate($a_ref_id); }
static ilObject2::_lookupDescription (   $a_id)
staticfinal

lookup object description

Parameters
int$a_idobject id

Reimplemented from ilObject.

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

{ return parent::_lookupDescription($a_id); }
ilObject2::_lookupLastUpdate (   $a_id,
  $a_as_string = false 
)
final

lookup last update

Parameters
int$a_idobject id

Reimplemented from ilObject.

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

{ return parent::_lookupLastUpdate($a_id, $a_as_string); }
ilObject2::_lookupObjectId (   $a_ref_id)
final

lookup object id

Parameters
int$a_idobject id

Reimplemented from ilObject.

Definition at line 207 of file class.ilObject2.php.

{ return parent::_lookupObjectId($a_ref_id); }
static ilObject2::_lookupObjId (   $a_id)
staticfinal

Reimplemented from ilObject.

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

{ return parent::_lookupObjId($a_id); }
static ilObject2::_lookupObjIdByImportId (   $a_import_id)
staticfinal

Reimplemented from ilObject.

Definition at line 60 of file class.ilObject2.php.

{ return parent::_lookupObjIdByImportId($a_import_id); }
ilObject2::_lookupOwner (   $a_id)
final

lookup object owner

Parameters
int$a_idobject id

Reimplemented from ilObject.

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

Referenced by ilObjBlog\sendNotification().

{ return parent::_lookupOwner($a_id); }

+ Here is the caller graph for this function:

ilObject2::_lookupOwnerName (   $a_owner_id)
final

lookup owner name for owner id

Reimplemented from ilObject.

Definition at line 63 of file class.ilObject2.php.

{ return parent::_lookupOwnerName($a_owner_id); }
static ilObject2::_lookupTitle (   $a_id)
staticfinal

lookup object title

Parameters
int$a_idobject id

Reimplemented from ilObject.

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

Referenced by ilObjPortfolioGUI\confirmPortfolioDeletion(), ilPortfolioHTMLExport\exportHTMLPages(), ilPortfolioPageTableGUI\fillRow(), ilObjPortfolioGUI\preview(), ilPortfolioPageGUI\renderBlog(), and ilObjBlog\sendNotification().

{ return parent::_lookupTitle($a_id); }

+ Here is the caller graph for this function:

static ilObject2::_lookupType (   $a_id,
  $a_reference = false 
)
staticfinal

lookup object type

Parameters
int$a_idobject id

Reimplemented from ilObject.

Definition at line 204 of file class.ilObject2.php.

{ return parent::_lookupType($a_id,$a_reference); }
static ilObject2::_prepareCloneSelection (   $a_ref_ids,
  $new_type 
)
staticfinal

Definition at line 250 of file class.ilObject2.php.

{ return parent::_prepareCloneSelection($a_ref_ids,$new_type); }
ilObject2::_resetDeletedDate (   $a_ref_id)
final

only called in ilObjectGUI::insertSavedNodes

Reimplemented from ilObject.

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

{ return parent::_resetDeletedDate($a_ref_id); }
ilObject2::_setDeletedDate (   $a_ref_id)
final

only called in ilTree::saveSubTree

Reimplemented from ilObject.

Definition at line 198 of file class.ilObject2.php.

{ return parent::_setDeletedDate($a_ref_id); }
ilObject2::_writeDescription (   $a_obj_id,
  $a_desc 
)
final

write description to db (static)

Parameters
int$a_obj_idobject id
string$a_descdescription public

Reimplemented from ilObject.

Definition at line 202 of file class.ilObject2.php.

{ return parent::_writeDescription($a_obj_id, $a_desc); }
ilObject2::_writeImportId (   $a_obj_id,
  $a_import_id 
)
final

write import id to db (static)

Parameters
int$a_obj_idobject id
string$a_import_idimport id public

Reimplemented from ilObject.

Definition at line 203 of file class.ilObject2.php.

{ return parent::_writeImportId($a_obj_id, $a_import_id); }
ilObject2::_writeTitle (   $a_obj_id,
  $a_title 
)
final

write title to db (static)

Parameters
int$a_obj_idobject id
string$a_titletitle public

Reimplemented from ilObject.

Definition at line 201 of file class.ilObject2.php.

{ return parent::_writeTitle($a_obj_id, $a_title); }
ilObject2::appendCopyInfo (   $a_target_id,
  $a_copy_id 
)
final

Prepend Copy info if object with same name exists in that container.

public

Parameters
intcopy_id

Reimplemented from ilObject.

Definition at line 251 of file class.ilObject2.php.

{ return parent::appendCopyInfo($a_target_id,$a_copy_id); }
ilObject2::beforeCloneObject ( )
protected

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

Referenced by cloneObject().

{
return true;
}

+ Here is the caller graph for this function:

ilObject2::beforeCreate ( )
protected

Definition at line 87 of file class.ilObject2.php.

Referenced by create().

{
return true;
}

+ Here is the caller graph for this function:

ilObject2::beforeCreateMetaData ( )
protected

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

Referenced by createMetaData().

{
return true;
}

+ Here is the caller graph for this function:

ilObject2::beforeDelete ( )
protected

Reimplemented in ilObjFile.

Definition at line 233 of file class.ilObject2.php.

Referenced by delete().

{
return true;
}

+ Here is the caller graph for this function:

ilObject2::beforeMDUpdateListener (   $a_element)
protected

Reimplemented in ilObjFile.

Definition at line 136 of file class.ilObject2.php.

Referenced by MDUpdateListener().

{
return true;
}

+ Here is the caller graph for this function:

ilObject2::beforeUpdate ( )
protected

Reimplemented in ilObjFile.

Definition at line 113 of file class.ilObject2.php.

Referenced by update().

{
return true;
}

+ Here is the caller graph for this function:

ilObject2::beforeUpdateMetaData ( )
protected

Definition at line 182 of file class.ilObject2.php.

Referenced by updateMetaData().

{
return true;
}

+ Here is the caller graph for this function:

ilObject2::cloneDependencies (   $a_target_id,
  $a_copy_id 
)

Clone object dependencies.

This method allows to refresh any ref id references to other objects that are affected in the same copy process. Ask ilCopyWizardOptions for the mappings.

public

Parameters
intref_id of target object
intcopy_id

Reimplemented from ilObject.

Reimplemented in ilObjWorkspaceFolder.

Definition at line 277 of file class.ilObject2.php.

{ return parent::cloneDependencies($a_target_id,$a_copy_id); }
ilObject2::cloneMetaData (   $target_obj)
final

Copy meta data.

public

Parameters
objecttarget object

Reimplemented from ilObject.

Definition at line 252 of file class.ilObject2.php.

Referenced by ilObjFile\doCloneObject().

{ return parent::cloneMetaData($target_obj); }

+ Here is the caller graph for this function:

ilObject2::cloneObject (   $a_target_id,
  $a_copy_id = null,
  $a_omit_tree = false 
)
final

Clone object permissions, put in tree ...

public

Parameters
inttarget id
intcopy id for class.ilCopyWizardOptions()
Returns
object new object

Reimplemented from ilObject.

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

References beforeCloneObject(), and doCloneObject().

{
if($this->beforeCloneObject())
{
$new_obj = parent::cloneObject($a_target_id, $a_copy_id, $a_omit_tree);
if($new_obj)
{
$this->doCloneObject($new_obj, $a_target_id, $a_copy_id);
return $new_obj;
}
}
}

+ Here is the call graph for this function:

ilObject2::countReferences ( )
final

count references of object

public

Returns
integer number of references for this object

Reimplemented from ilObject.

Definition at line 212 of file class.ilObject2.php.

{ return parent::countReferences(); }
ilObject2::create (   $a_clone_mode = false)
final

Definition at line 69 of file class.ilObject2.php.

References ilObject\$id, beforeCreate(), ilObject\create(), and doCreate().

{
if($this->beforeCreate())
{
$id = parent::create();
if($id)
{
$this->doCreate($a_clone_mode);
return $id;
}
}
}

+ Here is the call graph for this function:

ilObject2::createMetaData ( )
final

create meta data entry

Reimplemented from ilObject.

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

References beforeCreateMetaData(), and doCreateMetaData().

Referenced by ilObjFile\createProperties().

{
if($this->beforeCreateMetaData())
{
if(parent::createMetaData())
{
$this->doCreateMetaData();
return true;
}
}
return false;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObject2::createReference ( )
final

creates reference for object

public

Returns
integer reference_id of object

Reimplemented from ilObject.

Definition at line 211 of file class.ilObject2.php.

{ return parent::createReference(); }
ilObject2::createRoleFolder ( )
final

creates a local role folder

public

Parameters
stringrolefolder title
stringrolefolder description
objectparent object where the rolefolder is attached to
Returns
object rolefolder object

Reimplemented from ilObject.

Definition at line 240 of file class.ilObject2.php.

{ return parent::createRoleFolder(); }
ilObject2::delete ( )
final

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!!

public

Returns
boolean true if object was removed completely; false if only a references was removed

Reimplemented from ilObject.

Definition at line 214 of file class.ilObject2.php.

References beforeDelete(), and doDelete().

{
if($this->beforeDelete())
{
if(parent::delete())
{
$this->doDelete();
$this->id = null;
return true;
}
}
return false;
}

+ Here is the call graph for this function:

ilObject2::deleteMetaData ( )
final

delete meta data entry

Reimplemented from ilObject.

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

Referenced by ilObjFile\doDelete().

{ return parent::deleteMetaData(); }

+ Here is the caller graph for this function:

ilObject2::doCloneObject (   $new_obj,
  $a_target_id,
  $a_copy_id = null 
)
protected

Reimplemented in ilObjFile, and ilObjWorkspaceFolder.

Definition at line 267 of file class.ilObject2.php.

Referenced by cloneObject().

{
}

+ Here is the caller graph for this function:

ilObject2::doCreate ( )
protected

Reimplemented in ilVerificationObject, ilObjPortfolio, and ilObjBlog.

Definition at line 82 of file class.ilObject2.php.

Referenced by create().

{
}

+ Here is the caller graph for this function:

ilObject2::doCreateMetaData ( )
protected

Reimplemented in ilObjFile.

Definition at line 154 of file class.ilObject2.php.

Referenced by createMetaData().

{
}

+ Here is the caller graph for this function:

ilObject2::doDelete ( )
protected

Reimplemented in ilObjFile, ilVerificationObject, ilObjPortfolio, and ilObjBlog.

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

Referenced by delete().

{
}

+ Here is the caller graph for this function:

ilObject2::doMDUpdateListener (   $a_element)
protected

Reimplemented in ilObjFile.

Definition at line 131 of file class.ilObject2.php.

Referenced by MDUpdateListener().

{
}

+ Here is the caller graph for this function:

ilObject2::doRead ( )
protected

Reimplemented in ilObjFile, ilVerificationObject, ilObjPortfolio, and ilObjBlog.

Definition at line 40 of file class.ilObject2.php.

Referenced by read().

{
}

+ Here is the caller graph for this function:

ilObject2::doUpdate ( )
protected

Reimplemented in ilObjFile, ilVerificationObject, ilObjPortfolio, and ilObjBlog.

Definition at line 108 of file class.ilObject2.php.

Referenced by update().

{
}

+ Here is the caller graph for this function:

ilObject2::doUpdateMetaData ( )
protected

Reimplemented in ilObjFile.

Definition at line 177 of file class.ilObject2.php.

Referenced by updateMetaData().

{
}

+ Here is the caller graph for this function:

ilObject2::getCreateDate ( )
final

get create date public

Returns
string creation date

Reimplemented from ilObject.

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

{ return parent::getCreateDate(); }
ilObject2::getDescription ( )
final

get object description

public

Returns
string object description

Reimplemented from ilObject.

Definition at line 55 of file class.ilObject2.php.

Referenced by ilObjFile\addNewsNotification().

{ return parent::getDescription(); }

+ Here is the caller graph for this function:

ilObject2::getId ( )
final

get object id public

Returns
integer object id

Reimplemented from ilObject.

Definition at line 45 of file class.ilObject2.php.

Referenced by ilObjFile\__construct(), ilObjFile\addFileVersion(), ilObjFile\addNewsNotification(), ilObjWorkspaceRootFolder\addTranslation(), ilObjFile\beforeMDUpdateListener(), ilObjWorkspaceFolder\cloneDependencies(), ilObjFile\createProperties(), ilObjFile\deleteVersions(), ilObjWorkspaceFolder\doCloneObject(), ilObjFile\doCloneObject(), ilObjFile\doCreateMetaData(), ilObjFile\doDelete(), ilObjFile\doMDUpdateListener(), ilObjFile\doRead(), ilObjFile\doUpdate(), ilObjFile\doUpdateMetaData(), ilObjFile\export(), ilVerificationObject\getFilePath(), ilObjWorkspaceRootFolder\getTranslations(), ilObjFile\getUsages(), ilObjFile\initFileStorage(), ilObjWorkspaceRootFolder\removeTranslations(), and ilObjFile\replaceFile().

{ return parent::getId(); }

+ Here is the caller graph for this function:

ilObject2::getImportId ( )
final

get import id

public

Returns
string import id

Reimplemented from ilObject.

Definition at line 58 of file class.ilObject2.php.

{ return parent::getImportId(); }
ilObject2::getLastUpdateDate ( )
final

get last update date public

Returns
string date of last update

Reimplemented from ilObject.

Definition at line 66 of file class.ilObject2.php.

{ return parent::getLastUpdateDate(); }
ilObject2::getLongDescription ( )
final

get object long description (stored in object_description)

public

Returns
string object description

Reimplemented from ilObject.

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

{ return parent::getLongDescription(); }
ilObject2::getOwner ( )
final

get object owner

public

Returns
integer owner id

Reimplemented from ilObject.

Definition at line 61 of file class.ilObject2.php.

{ return parent::getOwner(); }
ilObject2::getOwnerName ( )
final

Reimplemented from ilObject.

Definition at line 62 of file class.ilObject2.php.

{ return parent::getOwnerName(); }
ilObject2::getPresentationTitle ( )
final

get presentation title Normally same as title Overwritten for sessions

public

Parameters
@return

Reimplemented from ilObject.

Definition at line 51 of file class.ilObject2.php.

{ return parent::getPresentationTitle(); }
ilObject2::getRefId ( )
final

get reference id public

Returns
integer reference id

Reimplemented from ilObject.

Definition at line 48 of file class.ilObject2.php.

Referenced by ilObjWorkspaceFolder\addAdditionalSubItemInformation(), ilObjWorkspaceFolder\cloneDependencies(), and ilObjWorkspaceFolder\downloadFolder().

{ return parent::getRefId(); }

+ Here is the caller graph for this function:

ilObject2::getTitle ( )
final

get object title public

Returns
string object title

Reimplemented from ilObject.

Definition at line 52 of file class.ilObject2.php.

Referenced by ilObjWorkspaceFolder\downloadFolder(), ilObjFile\getFileExtension(), ilVerificationObject\getOfflineFilename(), ilObjFile\isHidden(), ilObjFile\isInline(), and ilObjFile\sendFile().

{ return parent::getTitle(); }

+ Here is the caller graph for this function:

ilObject2::getType ( )
final

get object type public

Returns
string object type

Reimplemented from ilObject.

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

Referenced by ilObjectPlugin\__construct(), ilObjFile\addNewsNotification(), ilObjFile\beforeMDUpdateListener(), ilObjFile\doCreateMetaData(), ilObjFile\doMDUpdateListener(), and ilObjFile\doUpdateMetaData().

{ return parent::getType(); }

+ Here is the caller graph for this function:

ilObject2::getUntranslatedTitle ( )
final

get untranslated object title public

Returns
string object title

Reimplemented from ilObject.

Definition at line 53 of file class.ilObject2.php.

{ return parent::getUntranslatedTitle(); }
ilObject2::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

Returns
array empty array

Reimplemented from ilObject.

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

{ return array(); }
ilObject2::initType ( )
abstractprotected

Reimplemented in ilObjFile, ilObjPortfolio, ilObjBlog, ilObjWorkspaceFolder, ilObjExerciseVerification, ilObjTestVerification, and ilObjWorkspaceRootFolder.

Referenced by ilObjectPlugin\__construct(), and __construct().

+ Here is the caller graph for this function:

ilObject2::isUserRegistered (   $a_user_id = 0)
final

Reimplemented from ilObject.

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

{ return parent::isUserRegistered($a_user_id); }
ilObject2::MDUpdateListener (   $a_element)
final

Meta data update listener.

Important note: Do never call create() or update() method of ilObject here. It would result in an endless loop: update object -> update meta -> update object -> ... Use static _writeTitle() ... methods instead.

Parameters
string$a_element

Reimplemented from ilObject.

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

References beforeMDUpdateListener(), and doMDUpdateListener().

{
if($this->beforeMDUpdateListener($a_element))
{
if(parent::MDUpdateListener($a_element))
{
$this->doMDUpdateListener($a_element);
return true;
}
}
return false;
}

+ Here is the call graph for this function:

ilObject2::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.

TODO: add optional array to pass parameters

public

Parameters
stringevent
integerreference id of object where the event occured
integerreference id of node in the tree which is actually notified
arraypasses optional parameters if required
Returns
boolean

Reimplemented from ilObject.

Reimplemented in ilObjWorkspaceRootFolder.

Definition at line 242 of file class.ilObject2.php.

{ return parent::notify($a_event,$a_ref_id,$a_parent_non_rbac_id,$a_node_id,$a_params); }
ilObject2::putInTree (   $a_parent_ref)
final

maybe this method should be in tree object!?

Todo:
role/rbac stuff

Reimplemented from ilObject.

Definition at line 209 of file class.ilObject2.php.

{ return parent::putInTree($a_parent_ref); }
ilObject2::read (   $a_force_db = false)
final

Read data from db.

Reimplemented from ilObject.

Definition at line 35 of file class.ilObject2.php.

References doRead().

{
parent::read($a_force_db);
$this->doRead();
}

+ Here is the call graph for this function:

ilObject2::requireRegistration ( )
final

Reimplemented from ilObject.

Definition at line 245 of file class.ilObject2.php.

{ return parent::requireRegistration(); }
ilObject2::setDescription (   $a_desc)
final

set object description

public

Parameters
string$a_descobject description

Reimplemented from ilObject.

Definition at line 56 of file class.ilObject2.php.

{ return parent::setDescription($a_desc); }
ilObject2::setId (   $a_id)
final

set object id public

Parameters
integer$a_idobject id

Reimplemented from ilObject.

Definition at line 46 of file class.ilObject2.php.

{ return parent::setId($a_id); }
ilObject2::setImportId (   $a_import_id)
final

set import id

public

Parameters
string$a_import_idimport id

Reimplemented from ilObject.

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

{ return parent::setImportId($a_import_id); }
ilObject2::setObjDataRecord (   $a_record)
final

set object_data record (note: this method should only be called from the ilObjectFactory class)

Parameters
array$a_recordassoc. array from table object_data public
Returns
integer object id

Reimplemented from ilObject.

Definition at line 67 of file class.ilObject2.php.

{ return parent::setObjDataRecord($a_record); }
ilObject2::setOwner (   $a_owner)
final

set object owner

public

Parameters
integer$a_ownerowner id

Reimplemented from ilObject.

Definition at line 64 of file class.ilObject2.php.

{ return parent::setOwner($a_owner); }
ilObject2::setPermissions (   $a_parent_ref)
final

set permissions of object

Parameters
integerreference_id of parent object public

Reimplemented from ilObject.

Definition at line 210 of file class.ilObject2.php.

{ return parent::setPermissions($a_parent_ref); }
ilObject2::setRefId (   $a_id)
final

set reference id public

Parameters
integer$a_idreference id

Reimplemented from ilObject.

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

{ return parent::setRefId($a_id); }
ilObject2::setRegisterMode (   $a_bool)
final

Reimplemented from ilObject.

Definition at line 243 of file class.ilObject2.php.

{ return parent::setRegisterMode($a_bool); }
ilObject2::setTitle (   $a_title)
final

set object title

public

Parameters
string$a_titleobject title

Reimplemented from ilObject.

Definition at line 54 of file class.ilObject2.php.

{ return parent::setTitle($a_title); }
ilObject2::setType (   $a_type)
final

set object type public

Parameters
integer$a_typeobject type

Reimplemented from ilObject.

Definition at line 50 of file class.ilObject2.php.

{ return parent::setType($a_type); }
ilObject2::update ( )
final

update object in db

public

Returns
boolean true on success

Reimplemented from ilObject.

Definition at line 92 of file class.ilObject2.php.

References beforeUpdate(), and doUpdate().

{
if($this->beforeUpdate())
{
if (!parent::update())
{
return false;
}
$this->doUpdate();
return true;
}
return false;
}

+ Here is the call graph for this function:

ilObject2::updateMetaData ( )
final

update meta data entry

Reimplemented from ilObject.

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

References beforeUpdateMetaData(), and doUpdateMetaData().

Referenced by ilObjFile\beforeUpdate().

{
if($this->beforeUpdateMetaData())
{
if(parent::updateMetaData())
{
$this->doUpdateMetaData();
return true;
}
}
return false;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObject2::updateOwner ( )
final

update owner of object in db

public

Returns
boolean true on success

Reimplemented from ilObject.

Definition at line 188 of file class.ilObject2.php.

{ return parent::updateOwner(); }
ilObject2::withReferences ( )
final

determines wehter objects are referenced or not (got ref ids or not)

Reimplemented from ilObject.

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

{ return parent::withReferences(); }
The documentation for this class was generated from the following file: