ILIAS  release_4-3 Revision
 All Data Structures Namespaces Files Functions Variables Groups Pages
ilObjRemoteCategory Class Reference

Remote category app class. More...

+ Inheritance diagram for ilObjRemoteCategory:
+ Collaboration diagram for ilObjRemoteCategory:

Public Member Functions

 initType ()
- Public Member Functions inherited from ilRemoteObjectBase
 __construct ($a_id=0, $a_call_by_reference=true)
 Constructor.
 beforeCreate ()
 getRealmPlain ()
 Get realm plain.
 setOrganization ($a_organization)
 set organization
 getOrganization ()
 get organization
 getLocalInformation ()
 get local information
 setLocalInformation ($a_info)
 set local information
 getMID ()
 get mid
 setMID ($a_mid)
 set mid
 setRemoteLink ($a_link)
 set remote link
 getRemoteLink ()
 get remote link
 getFullRemoteLink ()
 get full remote link Including ecs generated hash and auth mode
 createAuthResource ($a_plain_realm)
 create authentication resource on ecs server
 doCreate ()
 Create remote object.
 doUpdate ()
 Update remote object.
 doDelete ()
 Delete remote object.
 doRead ()
 read settings
 createFromECSEContent (ilECSSetting $a_server, $a_ecs_content, $a_owner)
 create remote object from ECSContent object
 updateFromECSContent (ilECSSetting $a_server, $a_ecs_content, $a_owner)
 update remote object settings from ecs content
 isLocalObject ()
 Is remote object from same installation?
 handleCreate (ilECSSetting $a_server, $a_econtent_id, array $a_mids)
 Handle creation.
 handleUpdate (ilECSSetting $a_server, $a_econtent_id, array $a_mids)
 Handle update event.
 handleDelete (ilECSSetting $a_server, $a_econtent_id, $a_mid=0)
 Handle delete event.
 getAllResourceIds (ilECSSetting $a_server, $a_sender_only=false)
 Get all available resources.
- 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
 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 ()
 _lookupCreationDate ($a_id)
 Lookup creation date.

Static Public Member Functions

static _lookupMID ($a_obj_id)
static _lookupOrganization ($a_obj_id)
- Static Public Member Functions inherited from ilRemoteObjectBase
static getInstanceByEventType ($a_type)
 Get instance by ilECSEvent(QueueReader) type.
static _lookupOrganization ($a_obj_id, $a_table)
 lookup organization
static _lookupMID ($a_obj_id, $a_table)
 lookup owner mid
- 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 _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.
static getLongDescriptions (array $a_obj_ids)
 Get long description data.
static getAllOwnedRepositoryObjects ($a_user_id)
 Get all ids of objects user owns.

Data Fields

const DB_TABLE_NAME = "rcat_settings"
- Data Fields inherited from ilRemoteObjectBase
const MAIL_SENDER = 6
const OBJECT_OWNER = 6

Protected Member Functions

 getTableName ()
 Get db table name.
 getECSObjectType ()
 Get ECS resource identifier, e.g.
- Protected Member Functions inherited from ilRemoteObjectBase
 doCreateCustomFields (array &$a_fields)
 Add custom fields to db insert.
 doUpdateCustomFields (array &$a_fields)
 Add custom fields to db update.
 doReadCustomFields ($a_row)
 Read custom fields from db row.
 importMetadataFromJson ($a_json, ilECSSetting $a_server, array $a_definition, $a_mapping_mode)
 Add advanced metadata to json (export)
 updateCustomFromECSContent (ilECSSetting $a_server, $ecs_content)
 update remote object settings from ecs content
 sendNewContentNotification ($a_server_id)
 send notifications about new EContent
- Protected Member Functions inherited from ilObject2
 beforeUpdate ()
 doMDUpdateListener ($a_element)
 beforeMDUpdateListener ($a_element)
 doCreateMetaData ()
 beforeCreateMetaData ()
 doUpdateMetaData ()
 beforeUpdateMetaData ()
 beforeDelete ()
 doCloneObject ($new_obj, $a_target_id, $a_copy_id=null)
 beforeCloneObject ()

Additional Inherited Members

- Protected Attributes inherited from ilRemoteObjectBase
 $local_information
 $remote_link
 $organization
 $mid
 $auth_hash = ''
 $realm_plain = ''

Detailed Description

Remote category app class.

Author
Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om
Version
$Id$

Definition at line 15 of file class.ilObjRemoteCategory.php.

Member Function Documentation

static ilObjRemoteCategory::_lookupMID (   $a_obj_id)
static

Definition at line 38 of file class.ilObjRemoteCategory.php.

{
return ilRemoteObjectBase::_lookupMID($a_obj_id, self::DB_TABLE_NAME);
}
static ilObjRemoteCategory::_lookupOrganization (   $a_obj_id)
static

Definition at line 43 of file class.ilObjRemoteCategory.php.

Referenced by ilObjRemoteCategoryListGUI\getProperties().

{
return ilRemoteObjectBase::_lookupOrganization($a_obj_id, self::DB_TABLE_NAME);
}

+ Here is the caller graph for this function:

ilObjRemoteCategory::getECSObjectType ( )
protected

Get ECS resource identifier, e.g.

"/campusconnect/courselinks"

Returns
string

Reimplemented from ilRemoteObjectBase.

Definition at line 29 of file class.ilObjRemoteCategory.php.

{
return "/campusconnect/categories";
}
ilObjRemoteCategory::getTableName ( )
protected

Get db table name.

Returns
string

Reimplemented from ilRemoteObjectBase.

Definition at line 24 of file class.ilObjRemoteCategory.php.

References DB_TABLE_NAME.

{
}
ilObjRemoteCategory::initType ( )

Reimplemented from ilObject2.

Definition at line 19 of file class.ilObjRemoteCategory.php.

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

Field Documentation

const ilObjRemoteCategory::DB_TABLE_NAME = "rcat_settings"

Definition at line 17 of file class.ilObjRemoteCategory.php.

Referenced by getTableName().


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