ILIAS
Release_3_10_x_branch Revision 61812
|
Class ilObjGroup. More...
Public Member Functions | |
__construct ($a_id=0, $a_call_by_reference=true) | |
Constructor public. | |
setInformation ($a_information) | |
set information | |
getInformation () | |
get Information | |
setGroupType ($a_type) | |
set group type | |
getGroupType () | |
get group type | |
isGroupTypeModified ($a_old_type) | |
check if group type is modified | |
setRegistrationType ($a_type) | |
set registration type | |
getRegistrationType () | |
get registration type | |
isRegistrationEnabled () | |
is registration enabled | |
enableUnlimitedRegistration ($a_status) | |
enable unlimited registration | |
isRegistrationUnlimited () | |
is registration unlimited | |
setRegistrationStart ($a_start) | |
set registration start | |
getRegistrationStart () | |
get registration start | |
setRegistrationEnd ($a_end) | |
set registration end | |
getRegistrationEnd () | |
get registration end | |
setPassword ($a_pass) | |
set password | |
getPassword () | |
get password | |
enableMembershipLimitation ($a_status) | |
enable max member limitation | |
isMembershipLimited () | |
is max member limited | |
setMaxMembers ($a_max) | |
set max members | |
getMaxMembers () | |
get max members | |
enableWaitingList ($a_status) | |
enable waiting list | |
isWaitingListEnabled () | |
is waiting list enabled | |
setLatitude ($a_latitude) | |
Set Latitude. | |
getLatitude () | |
Get Latitude. | |
setLongitude ($a_longitude) | |
Set Longitude. | |
getLongitude () | |
Get Longitude. | |
setLocationZoom ($a_locationzoom) | |
Set LocationZoom. | |
getLocationZoom () | |
Get LocationZoom. | |
setEnableGroupMap ($a_enablemap) | |
Set Enable Group Map. | |
getEnableGroupMap () | |
Get Enable Group Map. | |
validate () | |
validate group settings | |
create () | |
Create group. | |
update () | |
Update group. | |
delete () | |
delete group and all related data | |
read () | |
Read group. | |
cloneObject ($a_target_id, $a_copy_id=0) | |
Clone group (no member data) | |
cloneDependencies ($a_target_id, $a_copy_id) | |
Clone object dependencies (crs items, preconditions) | |
cloneAutoGeneratedRoles ($new_obj) | |
Clone group admin and member role permissions. | |
join ($a_user_id, $a_mem_role="") | |
join Group, assigns user to role private | |
getDefaultMemberRole () | |
returns object id of created default member role public | |
getDefaultAdminRole () | |
returns object id of created default adminstrator role public | |
addMember ($a_user_id, $a_mem_role) | |
add Member to Group public | |
leaveGroup () | |
is called when a member decides to leave group public | |
leave ($a_user_id) | |
deassign member from group role private | |
getGroupMemberIds () | |
get all group Member ids regardless of role public | |
getGroupMemberData ($a_mem_ids, $active=1) | |
get all group Members regardless of group role. | |
getCountMembers () | |
getGroupAdminIds ($a_grpId="") | |
get Group Admin Id public | |
getDefaultGroupRoles ($a_grp_id="") | |
get default group roles, returns the defaultlike create roles il_grp_member, il_grp_admin public | |
getLocalGroupRoles ($a_translate=false) | |
get ALL local roles of group, also those created and defined afterwards only fetch data once from database. | |
getGrpStatusClosedTemplateId () | |
get group status closed template public | |
getGrpStatusOpenTemplateId () | |
get group status open template public | |
setExpirationDateTime ($a_date) | |
set Expiration Date and Time public | |
getExpiration () | |
Get expiration. | |
getExpirationTimestamp () | |
updateGroupType () | |
Change group type. | |
initGroupStatus ($a_grpStatus=GRP_TYPE_PUBLIC) | |
set group status | |
setGroupStatus ($a_status) | |
Set group status. | |
getGroupStatus () | |
get group status | |
readGroupStatus () | |
get group status, redundant method because public | |
getMemberRoles ($a_user_id) | |
get group member status public | |
getMemberRolesTitle ($a_user_id) | |
get group member status public | |
isAdmin ($a_userId) | |
is Admin public | |
initDefaultRoles () | |
init default roles settings 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 happend, each object may decide how it reacts. | |
exportXML () | |
deleteExportFiles ($a_files) | |
downloadExportFile ($file) | |
_lookupIdByTitle ($a_title) | |
_isMember ($a_user_id, $a_ref_id, $a_field= '') | |
_getMembers ($a_obj_id) | |
getViewMode () | |
get view mode | |
addAdditionalSubItemInformation (&$a_item_data) | |
Add additional information to sub item, e.g. | |
__initFileObject () | |
getMessage () | |
setMessage ($a_message) | |
appendMessage ($a_message) | |
Public Member Functions inherited from ilObject | |
ilObject ($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 object data from db into object | |
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 | |
_lookupObjIdByImportId ($a_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) | |
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) | |
_getAllReferences ($a_id) | |
get all reference ids of object | |
_lookupTitle ($a_id) | |
lookup object title | |
_lookupDescription ($a_id) | |
lookup object description | |
_lookupLastUpdate ($a_id, $a_as_string=false) | |
lookup last update | |
_getLastUpdateOfObjects ($a_objs) | |
Get last update for a set of media objects. | |
_lookupObjId ($a_id) | |
_setDeletedDate ($a_ref_id) | |
only called in ilTree::saveSubTree | |
_resetDeletedDate ($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) | |
_lookupType ($a_id, $a_reference=false) | |
lookup object type | |
_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 | |
createRoleFolder () | |
creates a local role folder | |
setRegisterMode ($a_bool) | |
isUserRegistered ($a_user_id=0) | |
requireRegistration () | |
getXMLZip () | |
getHTMLDirectory () | |
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. | |
Public Member Functions inherited from ilContainer | |
ilContainer ($a_id=0, $a_call_by_reference=true) | |
Constructor public. | |
createContainerDirectory () | |
Create directory for the container. | |
getContainerDirectory () | |
Get the container directory. | |
_getContainerDirectory ($a_id) | |
Get the container directory. | |
getBigIconPath () | |
Get path for big icon. | |
getSmallIconPath () | |
Get path for small icon. | |
getTinyIconPath () | |
Get path for tiny icon. | |
setHiddenFilesFound ($a_hiddenfilesfound) | |
Set Found hidden files (set by getSubItems). | |
getHiddenFilesFound () | |
Get Found hidden files (set by getSubItems). | |
_lookupContainerSetting ($a_id, $a_keyword) | |
Lookup a container setting. | |
_writeContainerSetting ($a_id, $a_keyword, $a_value) | |
_lookupIconPath ($a_id, $a_size="big") | |
lookup icon path | |
saveIcons ($a_big_icon, $a_small_icon, $a_tiny_icon) | |
save container icons | |
removeBigIcon () | |
remove big icon | |
removeSmallIcon () | |
remove small icon | |
removeTinyIcon () | |
remove tiny icon | |
getFirstColumn () | |
Get right column. | |
cloneAllObject ($session_id, $client_id, $new_type, $ref_id, $clone_source, $options, $soap_call=false) | |
clone all objects according to this container | |
getOrderType () | |
Get order type default implementation. | |
setOrderType ($a_value) | |
getSubItems ($a_include_hidden_files=false, $a_include_side_block=false) | |
Get subitems of container. | |
gotItems () | |
Check whether we got any items. | |
getGroupedObjTypes () | |
Get grouped repository object types. | |
enablePageEditing () | |
Check whether page editing is allowed for container. |
Static Public Member Functions | |
_importFromXMLString ($xml, $parent_id) | |
Static used for importing a group from xml string. | |
_importFromFile ($file, $parent_id) | |
Static used for importing an group from xml zip file. | |
_search (&$a_search_obj) | |
STATIC METHOD search for group data. | |
_getLinkToObject ($a_id) | |
STATIC METHOD create a link to the object. | |
Static Public Member Functions inherited from ilObject | |
static | _getIdsForTitle ($title, $type= '') |
_exists ($a_id, $a_reference=false) | |
checks if an object exists in object_data | |
static | _getObjectsByType ($a_obj_type="") |
Get objects by type. | |
static | _prepareCloneSelection ($a_ref_ids, $new_type) |
Prepare copy wizard object selection. | |
static | _getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false) |
Data Fields | |
const | CAL_REG_START = 1 |
const | CAL_REG_END = 2 |
const | ERR_MISSING_TITLE = 'msg_no_title' |
const | ERR_MISSING_GROUP_TYPE = 'grp_missing_grp_type' |
const | ERR_MISSING_PASSWORD = 'grp_missing_password' |
const | ERR_WRONG_MAX_MEMBERS = 'grp_wrong_max_members' |
const | ERR_WRONG_REG_TIME_LIMIT = 'grp_wrong_reg_time_limit' |
$members_obj | |
$file_obj = null | |
Group file object for handling of export files. | |
$m_grpStatus | |
$m_roleMemberId | |
$m_roleAdminId | |
Data Fields inherited from ilObject | |
$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 | |
Data Fields inherited from ilContainer | |
const | VIEW_SESSIONS = 0 |
const | VIEW_OBJECTIVE = 1 |
const | VIEW_TIMING = 2 |
const | VIEW_ARCHIVE = 3 |
const | VIEW_SIMPLE = 4 |
const | VIEW_BY_TYPE = 5 |
const | VIEW_INHERIT = 6 |
const | VIEW_ILINC = 7 |
const | SORT_TITLE = 0 |
const | SORT_MANUAL = 1 |
const | SORT_ACTIVATION = 2 |
Protected Member Functions | |
prepareAppointments ($a_mode= 'create') | |
Prepare calendar appointments. | |
initParticipants () | |
init participants object |
Protected Attributes | |
$information | |
$group_type = null | |
$reg_type = GRP_REGISTRATION_DIRECT | |
$reg_enabled = true | |
$reg_unlimited = true | |
$reg_start = null | |
$reg_end = null | |
$reg_password = '' | |
$reg_membership_limitation = false | |
$reg_max_members = 0 | |
$waiting_list = false | |
$latitude | |
$longitude | |
$location_zoom | |
$enablemap | |
Protected Attributes inherited from ilContainer | |
$order_type = 0 | |
$hiddenfilesfound = false |
Class ilObjGroup.
Definition at line 54 of file class.ilObjGroup.php.
ilObjGroup::__construct | ( | $a_id = 0 , |
|
$a_call_by_reference = true |
|||
) |
Constructor public.
integer | reference_id or object_id |
boolean | treat the id as reference_id (true) or object_id (false) |
Definition at line 105 of file class.ilObjGroup.php.
References ilObject\ilObject(), and ilObject\setRegisterMode().
ilObjGroup::__initFileObject | ( | ) |
Definition at line 1859 of file class.ilObjGroup.php.
References $file_obj.
Referenced by deleteExportFiles(), downloadExportFile(), and exportXML().
|
static |
STATIC METHOD create a link to the object.
int | uniq id |
Definition at line 1713 of file class.ilObjGroup.php.
ilObjGroup::_getMembers | ( | $a_obj_id | ) |
Definition at line 1783 of file class.ilObjGroup.php.
References ilObject\$ref_id, and ilObject\_getAllReferences().
Referenced by ilLPStatusManualByTutor\__getGroupInProgress(), ilLPStatusManual\__getGroupInProgress(), ilLPStatusCollection\_getCompleted(), ilLPStatusCollection\_getFailed(), ilLPStatusCollection\_getInProgress(), ilLPStatusManual\_getNotAttempted(), ilLPStatusCollection\_getNotAttempted(), ilLPStatusManualByTutor\_getNotAttempted(), and _isMember().
|
static |
Static used for importing an group from xml zip file.
xml | file array structure like $_FILE from upload public |
Definition at line 1648 of file class.ilObjGroup.php.
References $file_obj, ilObject\$lng, and _importFromXMLString().
Referenced by ilObjGroupGUI\importFileObject().
|
static |
Static used for importing a group from xml string.
xml | string public |
Definition at line 1632 of file class.ilObjGroup.php.
Referenced by _importFromFile().
ilObjGroup::_isMember | ( | $a_user_id, | |
$a_ref_id, | |||
$a_field = '' |
|||
) |
Definition at line 1733 of file class.ilObjGroup.php.
References $res, _getMembers(), ilObjectFactory\getInstanceByObjId(), and ilUtil\quoteArray().
Referenced by ilObjCourseGrouping\_checkGroupingDependencies().
ilObjGroup::_lookupIdByTitle | ( | $a_title | ) |
Definition at line 1718 of file class.ilObjGroup.php.
References $res, and DB_FETCHMODE_OBJECT.
Referenced by ilMail\getEmailsOfRecipients(), and ilMail\getUserIds().
|
static |
STATIC METHOD search for group data.
This method is called from class.ilSearch This method used by class.ilSearchGUI.php to a link to the results
object | object of search class public |
Definition at line 1674 of file class.ilObjGroup.php.
References $ilBench, $in, $res, and DB_FETCHMODE_OBJECT.
Referenced by ilSearch\performSearch().
ilObjGroup::addAdditionalSubItemInformation | ( | & | $a_item_data | ) |
Add additional information to sub item, e.g.
used in courses for timings information etc.
Reimplemented from ilContainer.
Definition at line 1835 of file class.ilObjGroup.php.
References ilObject\getRefId().
ilObjGroup::addMember | ( | $a_user_id, | |
$a_mem_role | |||
) |
add Member to Group public
integer | user_id |
integer | member role_id of local group_role |
Definition at line 822 of file class.ilObjGroup.php.
References join().
ilObjGroup::appendMessage | ( | $a_message | ) |
Definition at line 1881 of file class.ilObjGroup.php.
References getMessage().
ilObjGroup::cloneAutoGeneratedRoles | ( | $new_obj | ) |
Clone group admin and member role permissions.
public
object | new group object |
Definition at line 743 of file class.ilObjGroup.php.
References $ilLog, getDefaultAdminRole(), getDefaultMemberRole(), and ilObject\getRefId().
Referenced by cloneObject().
ilObjGroup::cloneDependencies | ( | $a_target_id, | |
$a_copy_id | |||
) |
Clone object dependencies (crs items, preconditions)
public
int | target ref id of new course |
int | copy id |
Reimplemented from ilObject.
Definition at line 714 of file class.ilObjGroup.php.
References ilObject\getId(), ilObjectFactory\getInstanceByRefId(), and ilObject\getRefId().
ilObjGroup::cloneObject | ( | $a_target_id, | |
$a_copy_id = 0 |
|||
) |
Clone group (no member data)
public
int | target ref_id |
int | copy id |
Reimplemented from ilObject.
Definition at line 657 of file class.ilObjGroup.php.
References $ilLog, ilGroupParticipants\_getInstanceByObjId(), cloneAutoGeneratedRoles(), ilContainer\getBigIconPath(), getEnableGroupMap(), getGroupType(), ilObject\getId(), getInformation(), getLatitude(), getLocationZoom(), getLongitude(), getMaxMembers(), getPassword(), getRegistrationEnd(), getRegistrationStart(), ilContainer\getSmallIconPath(), ilContainer\getTinyIconPath(), IL_GRP_ADMIN, isMembershipLimited(), isRegistrationUnlimited(), isWaitingListEnabled(), and readGroupStatus().
ilObjGroup::create | ( | ) |
Create group.
Reimplemented from ilObject.
Definition at line 498 of file class.ilObjGroup.php.
References getGroupType(), ilObject\getId(), getInformation(), getRegistrationType(), IL_CAL_DATETIME, isRegistrationUnlimited(), and prepareAppointments().
ilObjGroup::delete | ( | ) |
delete group and all related data
public
Reimplemented from ilObject.
Definition at line 584 of file class.ilObjGroup.php.
References ilParticipants\_deleteAllEntries(), ilObject\getId(), and prepareAppointments().
ilObjGroup::deleteExportFiles | ( | $a_files | ) |
Definition at line 1601 of file class.ilObjGroup.php.
References $file, and __initFileObject().
ilObjGroup::downloadExportFile | ( | $file | ) |
Definition at line 1612 of file class.ilObjGroup.php.
References $file, __initFileObject(), and ilUtil\deliverFile().
ilObjGroup::enableMembershipLimitation | ( | $a_status | ) |
enable max member limitation
public
bool | status |
Definition at line 316 of file class.ilObjGroup.php.
Referenced by read().
ilObjGroup::enableUnlimitedRegistration | ( | $a_status | ) |
enable unlimited registration
public
bool |
Definition at line 224 of file class.ilObjGroup.php.
Referenced by read().
ilObjGroup::enableWaitingList | ( | $a_status | ) |
enable waiting list
public
bool |
Definition at line 361 of file class.ilObjGroup.php.
Referenced by read().
ilObjGroup::exportXML | ( | ) |
Definition at line 1579 of file class.ilObjGroup.php.
References __initFileObject(), and ilObject\getId().
ilObjGroup::getCountMembers | ( | ) |
Definition at line 961 of file class.ilObjGroup.php.
References getGroupMemberIds().
ilObjGroup::getDefaultAdminRole | ( | ) |
returns object id of created default adminstrator role public
Definition at line 809 of file class.ilObjGroup.php.
References getLocalGroupRoles().
Referenced by cloneAutoGeneratedRoles().
ilObjGroup::getDefaultGroupRoles | ( | $a_grp_id = "" | ) |
get default group roles, returns the defaultlike create roles il_grp_member, il_grp_admin public
returns | the obj_ids of group specific roles(il_grp_member,il_grp_admin) |
Definition at line 1001 of file class.ilObjGroup.php.
References ilObject\getRefId().
Referenced by getGroupAdminIds(), isAdmin(), readGroupStatus(), and updateGroupType().
ilObjGroup::getDefaultMemberRole | ( | ) |
returns object id of created default member role public
Definition at line 798 of file class.ilObjGroup.php.
References getLocalGroupRoles().
Referenced by cloneAutoGeneratedRoles().
ilObjGroup::getEnableGroupMap | ( | ) |
Get Enable Group Map.
Definition at line 453 of file class.ilObjGroup.php.
References $enablemap.
Referenced by cloneObject().
ilObjGroup::getExpiration | ( | ) |
Get expiration.
public
Definition at line 1140 of file class.ilObjGroup.php.
References $res, DB_FETCHMODE_ASSOC, and ilObject\getId().
ilObjGroup::getExpirationTimestamp | ( | ) |
Definition at line 1152 of file class.ilObjGroup.php.
References $res, DB_FETCHMODE_ASSOC, and ilObject\getId().
ilObjGroup::getGroupAdminIds | ( | $a_grpId = "" | ) |
get Group Admin Id public
integer | group id |
returns | userids that are assigned to a group administrator! role |
Definition at line 972 of file class.ilObjGroup.php.
References getDefaultGroupRoles(), and ilObject\getRefId().
Referenced by leaveGroup().
ilObjGroup::getGroupMemberData | ( | $a_mem_ids, | |
$active = 1 |
|||
) |
get all group Members regardless of group role.
fetch all users data in one shot to improve performance public
array | of user ids |
Definition at line 931 of file class.ilObjGroup.php.
References $ilBench, DB_FETCHMODE_OBJECT, and ilUtil\quoteArray().
ilObjGroup::getGroupMemberIds | ( | ) |
get all group Member ids regardless of role public
Definition at line 903 of file class.ilObjGroup.php.
References getLocalGroupRoles().
Referenced by getCountMembers(), and leaveGroup().
ilObjGroup::getGroupStatus | ( | ) |
get group status
public
int | group status |
Definition at line 1378 of file class.ilObjGroup.php.
ilObjGroup::getGroupType | ( | ) |
get group type
public
Definition at line 158 of file class.ilObjGroup.php.
References $group_type.
Referenced by cloneObject(), create(), isGroupTypeModified(), update(), updateGroupType(), and validate().
ilObjGroup::getGrpStatusClosedTemplateId | ( | ) |
get group status closed template public
return | obj_id of roletemplate containing permissionsettings for a closed group |
Definition at line 1082 of file class.ilObjGroup.php.
References $res, and DB_FETCHMODE_ASSOC.
Referenced by initGroupStatus(), and updateGroupType().
ilObjGroup::getGrpStatusOpenTemplateId | ( | ) |
get group status open template public
return | obj_id of roletemplate containing permissionsettings for an open group |
Definition at line 1096 of file class.ilObjGroup.php.
References $res, and DB_FETCHMODE_ASSOC.
Referenced by initGroupStatus(), and updateGroupType().
ilObjGroup::getInformation | ( | ) |
get Information
public
@return | string information |
Definition at line 136 of file class.ilObjGroup.php.
References $information.
Referenced by cloneObject(), create(), and update().
ilObjGroup::getLatitude | ( | ) |
Get Latitude.
Definition at line 393 of file class.ilObjGroup.php.
References $latitude.
Referenced by cloneObject().
ilObjGroup::getLocalGroupRoles | ( | $a_translate = false | ) |
get ALL local roles of group, also those created and defined afterwards only fetch data once from database.
info is stored in object variable public
Definition at line 1044 of file class.ilObjGroup.php.
References ilObjRole\_getTranslation(), and ilObject\getRefId().
Referenced by getDefaultAdminRole(), getDefaultMemberRole(), getGroupMemberIds(), getMemberRoles(), and getMemberRolesTitle().
ilObjGroup::getLocationZoom | ( | ) |
Get LocationZoom.
Definition at line 433 of file class.ilObjGroup.php.
Referenced by cloneObject().
ilObjGroup::getLongitude | ( | ) |
Get Longitude.
Definition at line 413 of file class.ilObjGroup.php.
References $longitude.
Referenced by cloneObject().
ilObjGroup::getMaxMembers | ( | ) |
get max members
public
Definition at line 349 of file class.ilObjGroup.php.
References $reg_max_members.
Referenced by cloneObject(), and validate().
ilObjGroup::getMemberRoles | ( | $a_user_id | ) |
get group member status public
integer | user_id |
Definition at line 1420 of file class.ilObjGroup.php.
References $ilBench, and getLocalGroupRoles().
Referenced by leave().
ilObjGroup::getMemberRolesTitle | ( | $a_user_id | ) |
get group member status public
integer | user_id |
Definition at line 1441 of file class.ilObjGroup.php.
References $ilBench, ilObjRole\_getTranslation(), DB_FETCHMODE_ASSOC, getLocalGroupRoles(), and ilUtil\quoteArray().
ilObjGroup::getMessage | ( | ) |
Definition at line 1873 of file class.ilObjGroup.php.
Referenced by appendMessage().
ilObjGroup::getPassword | ( | ) |
get password
public
Definition at line 304 of file class.ilObjGroup.php.
References $reg_password.
Referenced by cloneObject(), and validate().
ilObjGroup::getRegistrationEnd | ( | ) |
get registration end
public
Definition at line 282 of file class.ilObjGroup.php.
References IL_CAL_DATETIME.
Referenced by cloneObject(), prepareAppointments(), and validate().
ilObjGroup::getRegistrationStart | ( | ) |
get registration start
public
Definition at line 258 of file class.ilObjGroup.php.
References IL_CAL_DATETIME.
Referenced by cloneObject(), prepareAppointments(), and validate().
ilObjGroup::getRegistrationType | ( | ) |
get registration type
public
Definition at line 201 of file class.ilObjGroup.php.
References $reg_type.
Referenced by create(), isRegistrationEnabled(), update(), and validate().
ilObjGroup::getViewMode | ( | ) |
get view mode
public
Reimplemented from ilContainer.
Definition at line 1809 of file class.ilObjGroup.php.
References ilObject\_lookupObjId(), ilObjCourse\_lookupViewMode(), ilContainer\VIEW_BY_TYPE, ilContainer\VIEW_SESSIONS, and ilContainer\VIEW_SIMPLE.
ilObjGroup::initDefaultRoles | ( | ) |
init default roles settings public
Reimplemented from ilObject.
Definition at line 1501 of file class.ilObjGroup.php.
References $m_roleAdminId, $m_roleMemberId, ilObject\createRoleFolder(), DB_FETCHMODE_OBJECT, ilObject\getId(), and ilObject\getRefId().
ilObjGroup::initGroupStatus | ( | $a_grpStatus = GRP_TYPE_PUBLIC | ) |
set group status
Grants permissions on the group object for all parent roles. Each permission is granted by computing the intersection of the role template il_grp_status_open/_closed and the permission template of the parent role.
Creates linked roles in the local role folder object for all parent roles and initializes their permission templates. Each permission template is initialized by computing the intersection of the role template il_grp_status_open/_closed and the permission template of the parent role.
public
integer | group status GRP_TYPE_PUBLIC or GRP_TYPE_CLOSED |
Definition at line 1280 of file class.ilObjGroup.php.
References getGrpStatusClosedTemplateId(), getGrpStatusOpenTemplateId(), ilObject\getRefId(), GRP_TYPE_CLOSED, and GRP_TYPE_PUBLIC.
|
protected |
init participants object
protected
Definition at line 1940 of file class.ilObjGroup.php.
References ilGroupParticipants\_getInstanceByObjId(), and ilObject\getId().
Referenced by read().
ilObjGroup::isAdmin | ( | $a_userId | ) |
is Admin public
integer | user_id |
boolean,true | if user is group administrator |
Definition at line 1478 of file class.ilObjGroup.php.
References getDefaultGroupRoles().
Referenced by leaveGroup().
ilObjGroup::isGroupTypeModified | ( | $a_old_type | ) |
check if group type is modified
public
@return |
Definition at line 170 of file class.ilObjGroup.php.
References $group_type, getGroupType(), GRP_TYPE_UNKNOWN, and readGroupStatus().
ilObjGroup::isMembershipLimited | ( | ) |
is max member limited
public
Definition at line 327 of file class.ilObjGroup.php.
References $reg_membership_limitation.
Referenced by cloneObject(), and validate().
ilObjGroup::isRegistrationEnabled | ( | ) |
is registration enabled
public
Definition at line 212 of file class.ilObjGroup.php.
References getRegistrationType(), and GRP_REGISTRATION_DEACTIVATED.
ilObjGroup::isRegistrationUnlimited | ( | ) |
is registration unlimited
public
Definition at line 235 of file class.ilObjGroup.php.
References $reg_unlimited.
Referenced by cloneObject(), create(), prepareAppointments(), and update().
ilObjGroup::isWaitingListEnabled | ( | ) |
is waiting list enabled
public
@return | bool |
Definition at line 373 of file class.ilObjGroup.php.
References $waiting_list.
Referenced by cloneObject().
ilObjGroup::join | ( | $a_user_id, | |
$a_mem_role = "" |
|||
) |
join Group, assigns user to role private
integer | member status = obj_id of local_group_role |
Definition at line 775 of file class.ilObjGroup.php.
Referenced by addMember().
ilObjGroup::leave | ( | $a_user_id | ) |
deassign member from group role private
Definition at line 876 of file class.ilObjGroup.php.
References getMemberRoles().
Referenced by leaveGroup().
ilObjGroup::leaveGroup | ( | ) |
is called when a member decides to leave group public
integer | user-Id |
integer | group-Id |
Definition at line 845 of file class.ilObjGroup.php.
References ilObjUser\dropDesktopItem(), getGroupAdminIds(), getGroupMemberIds(), ilObject\getRefId(), isAdmin(), and leave().
ilObjGroup::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 happend, each object may decide how it reacts.
public
string | event |
integer | reference id of object where the event occured |
array | passes optional parameters if required |
Reimplemented from ilObject.
Definition at line 1563 of file class.ilObjGroup.php.
|
protected |
Prepare calendar appointments.
protected
string | mode UPDATE|CREATE|DELETE |
Definition at line 1897 of file class.ilObjGroup.php.
References ilObject\getLongDescription(), getRegistrationEnd(), getRegistrationStart(), ilObject\getTitle(), IL_CAL_TRANSLATION_SYSTEM, and isRegistrationUnlimited().
Referenced by create(), delete(), and update().
ilObjGroup::read | ( | ) |
Read group.
Reimplemented from ilContainer.
Definition at line 615 of file class.ilObjGroup.php.
References $res, ilContainerSortingSettings\_lookupSortMode(), DB_FETCHMODE_OBJECT, enableMembershipLimitation(), enableUnlimitedRegistration(), enableWaitingList(), ilObject\getId(), IL_CAL_DATETIME, initParticipants(), setEnableGroupMap(), setGroupType(), setInformation(), setLatitude(), setLocationZoom(), setLongitude(), setMaxMembers(), ilContainer\setOrderType(), setPassword(), setRegistrationEnd(), setRegistrationStart(), and setRegistrationType().
ilObjGroup::readGroupStatus | ( | ) |
get group status, redundant method because public
return | group status[0=public|2=closed] |
Definition at line 1388 of file class.ilObjGroup.php.
References getDefaultGroupRoles(), ilObject\getRefId(), GRP_TYPE_CLOSED, and GRP_TYPE_PUBLIC.
Referenced by cloneObject(), and isGroupTypeModified().
ilObjGroup::setEnableGroupMap | ( | $a_enablemap | ) |
Set Enable Group Map.
boolean | $a_enablemap | Enable Group Map |
Definition at line 443 of file class.ilObjGroup.php.
Referenced by read().
ilObjGroup::setExpirationDateTime | ( | $a_date | ) |
set Expiration Date and Time public
date |
Definition at line 1110 of file class.ilObjGroup.php.
References $res, ilObject\getId(), and ilFormat\input2date().
ilObjGroup::setGroupStatus | ( | $a_status | ) |
Set group status.
public
int | group status[0=public|2=closed] |
Definition at line 1366 of file class.ilObjGroup.php.
ilObjGroup::setGroupType | ( | $a_type | ) |
set group type
public
int | type |
Definition at line 147 of file class.ilObjGroup.php.
Referenced by read().
ilObjGroup::setInformation | ( | $a_information | ) |
set information
public
string | information |
Definition at line 124 of file class.ilObjGroup.php.
Referenced by read().
ilObjGroup::setLatitude | ( | $a_latitude | ) |
Set Latitude.
string | $a_latitude | Latitude |
Definition at line 383 of file class.ilObjGroup.php.
Referenced by read().
ilObjGroup::setLocationZoom | ( | $a_locationzoom | ) |
Set LocationZoom.
int | $a_locationzoom | LocationZoom |
Definition at line 423 of file class.ilObjGroup.php.
Referenced by read().
ilObjGroup::setLongitude | ( | $a_longitude | ) |
Set Longitude.
string | $a_longitude | Longitude |
Definition at line 403 of file class.ilObjGroup.php.
Referenced by read().
ilObjGroup::setMaxMembers | ( | $a_max | ) |
set max members
public
int | max members |
Definition at line 338 of file class.ilObjGroup.php.
Referenced by read().
ilObjGroup::setMessage | ( | $a_message | ) |
Definition at line 1877 of file class.ilObjGroup.php.
ilObjGroup::setPassword | ( | $a_pass | ) |
set password
public
string | password |
Definition at line 293 of file class.ilObjGroup.php.
Referenced by read().
ilObjGroup::setRegistrationEnd | ( | $a_end | ) |
set registration end
public
int | unix time |
Definition at line 271 of file class.ilObjGroup.php.
Referenced by read().
ilObjGroup::setRegistrationStart | ( | $a_start | ) |
set registration start
public
object | ilDateTime |
Definition at line 247 of file class.ilObjGroup.php.
Referenced by read().
ilObjGroup::setRegistrationType | ( | $a_type | ) |
set registration type
public
int | registration type |
Definition at line 190 of file class.ilObjGroup.php.
Referenced by read().
ilObjGroup::update | ( | ) |
Update group.
Reimplemented from ilObject.
Definition at line 539 of file class.ilObjGroup.php.
References getGroupType(), ilObject\getId(), getInformation(), getRegistrationType(), IL_CAL_DATETIME, isRegistrationUnlimited(), and prepareAppointments().
ilObjGroup::updateGroupType | ( | ) |
Change group type.
Revokes permissions of all parent non-protected roles and initiates these roles with the according il_grp_(open|closed) template.
public
Definition at line 1174 of file class.ilObjGroup.php.
References getDefaultGroupRoles(), getGroupType(), getGrpStatusClosedTemplateId(), getGrpStatusOpenTemplateId(), ilObject\getRefId(), GRP_TYPE_CLOSED, and GRP_TYPE_PUBLIC.
ilObjGroup::validate | ( | ) |
validate group settings
public
Definition at line 464 of file class.ilObjGroup.php.
References $ilErr, ilDateTime\_before(), getGroupType(), getMaxMembers(), getPassword(), getRegistrationEnd(), getRegistrationStart(), getRegistrationType(), ilObject\getTitle(), GRP_REGISTRATION_PASSWORD, and isMembershipLimited().
|
protected |
Definition at line 83 of file class.ilObjGroup.php.
Referenced by getEnableGroupMap().
ilObjGroup::$file_obj = null |
Group file object for handling of export files.
Definition at line 91 of file class.ilObjGroup.php.
Referenced by __initFileObject(), and _importFromFile().
|
protected |
Definition at line 67 of file class.ilObjGroup.php.
Referenced by getGroupType(), and isGroupTypeModified().
|
protected |
Definition at line 66 of file class.ilObjGroup.php.
Referenced by getInformation().
|
protected |
Definition at line 80 of file class.ilObjGroup.php.
Referenced by getLatitude().
|
protected |
Definition at line 82 of file class.ilObjGroup.php.
|
protected |
Definition at line 81 of file class.ilObjGroup.php.
Referenced by getLongitude().
ilObjGroup::$m_grpStatus |
Definition at line 93 of file class.ilObjGroup.php.
ilObjGroup::$m_roleAdminId |
Definition at line 97 of file class.ilObjGroup.php.
Referenced by initDefaultRoles().
ilObjGroup::$m_roleMemberId |
Definition at line 95 of file class.ilObjGroup.php.
Referenced by initDefaultRoles().
ilObjGroup::$members_obj |
Definition at line 85 of file class.ilObjGroup.php.
|
protected |
Definition at line 69 of file class.ilObjGroup.php.
|
protected |
Definition at line 72 of file class.ilObjGroup.php.
|
protected |
Definition at line 75 of file class.ilObjGroup.php.
Referenced by getMaxMembers().
|
protected |
Definition at line 74 of file class.ilObjGroup.php.
Referenced by isMembershipLimited().
|
protected |
Definition at line 73 of file class.ilObjGroup.php.
Referenced by getPassword().
|
protected |
Definition at line 71 of file class.ilObjGroup.php.
|
protected |
Definition at line 68 of file class.ilObjGroup.php.
Referenced by getRegistrationType().
|
protected |
Definition at line 70 of file class.ilObjGroup.php.
Referenced by isRegistrationUnlimited().
|
protected |
Definition at line 76 of file class.ilObjGroup.php.
Referenced by isWaitingListEnabled().
const ilObjGroup::CAL_REG_END = 2 |
Definition at line 57 of file class.ilObjGroup.php.
const ilObjGroup::CAL_REG_START = 1 |
Definition at line 56 of file class.ilObjGroup.php.
const ilObjGroup::ERR_MISSING_GROUP_TYPE = 'grp_missing_grp_type' |
Definition at line 61 of file class.ilObjGroup.php.
const ilObjGroup::ERR_MISSING_PASSWORD = 'grp_missing_password' |
Definition at line 62 of file class.ilObjGroup.php.
const ilObjGroup::ERR_MISSING_TITLE = 'msg_no_title' |
Definition at line 60 of file class.ilObjGroup.php.
const ilObjGroup::ERR_WRONG_MAX_MEMBERS = 'grp_wrong_max_members' |
Definition at line 63 of file class.ilObjGroup.php.
const ilObjGroup::ERR_WRONG_REG_TIME_LIMIT = 'grp_wrong_reg_time_limit' |
Definition at line 64 of file class.ilObjGroup.php.