ilGroupLP Class Reference

Inheritance diagram for ilGroupLP:

Collaboration diagram for ilGroupLP:

Public Member Functions
	getDefaultMode ()
	getValidModes ()
	getMembers (bool $a_search=true)
Public Member Functions inherited from ilObjectLP
	resetCaches ()
	isAnonymized ()
	getDefaultMode ()
	getValidModes ()
	getCurrentMode ()
	isActive ()
	getModeText (int $mode)
	getModeInfoText (int $mode)
	getSettingsInfo ()
	getCollectionInstance ()
	getMembers (bool $search=true)
	resetLPDataForCompleteObject (bool $recursive=true)
	resetLPDataForUserIds (array $user_ids, bool $recursive=true)
	handleToTrash ()
	handleDelete ()
	getMailTemplateId ()
	hasIndividualModeOptions ()
	initInvidualModeOptions ()
	Post vars for input groups is taken from array keys. More...
	shouldFetchIndividualModeFromFormSubmission ()
	fetchIndividualModeFromFormSubmission (string $selected_group, array $group_data)
	appendModeConfiguration (int $mode)
	saveModeConfiguration (string $selected_group, array $group_data, bool &$modeChanged)

Static Public Member Functions
static	getDefaultModes (bool $a_lp_active)
	Get available type-specific default modes (no administration needed) More...
Static Public Member Functions inherited from ilObjectLP
static	getInstance (int $obj_id)
static	getTypeClass (string $type)
static	getSupportedObjectTypes ()
static	isSupportedObjectType (string $type)
static	handleMove (int $source_ref_id)
static	getLPMemberships (int $usr_id, array $obj_ids, ?int $parent_ref_id=null, bool $mapped_ref_ids=false)
	Get all objects where given user is member (from LP POV) More...
static	supportsSpentSeconds (string $obj_type)
static	supportsMark (string $obj_type)
static	supportsMatrixView (string $obj_type)
static	getDefaultModes (bool $lp_active)
	Get available type-specific default modes (no administration needed) More...
static	saveTypeDefaults (array $data)
static	getTypeDefault (string $type)

Static Protected Member Functions
static	isLPMember (array &$a_res, int $a_usr_id, array $a_obj_ids)
	Find (lp-relevant) members for given object ids. More...
Static Protected Member Functions inherited from ilObjectLP
static	isLPMember (array &$res, int $usr_id, array $obj_ids)
	Find (lp-relevant) members for given object ids. More...
static	findMembershipsByPath (array &$res, int $usr_id, int $parent_ref_id, array $obj_ids, bool $mapped_ref_ids=false)
	Find (lp-relevant) memberships by path. More...
static	getTypeDefaultFromDB (string $type)

Additional Inherited Members
Protected Member Functions inherited from ilObjectLP
	__construct (int $obj_id)
	resetCustomLPDataForUserIds (array $user_ids, bool $recursive=true)
	gatherLPUsers ()
	updateParentCollections ()
Protected Attributes inherited from ilObjectLP
ilTree	$tree
ilDBInterface	$db
ilObjectDefinition	$objectDefinition
int	$obj_id
ilLPCollection	$collection_instance = null
int	$mode = null
Static Protected Attributes inherited from ilObjectLP
static array	$type_defaults = null

Detailed Description

Definition at line 27 of file class.ilGroupLP.php.

Member Function Documentation

getDefaultMode()

ilGroupLP::getDefaultMode

(

)

Reimplemented from ilObjectLP.

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

                                    : int
    {
        return ilLPObjSettings::LP_MODE_DEACTIVATED;
    }

References ilLPObjSettings\LP_MODE_DEACTIVATED.

getDefaultModes()

static ilGroupLP::getDefaultModes ( bool  $lp_active )

static

Get available type-specific default modes (no administration needed)

Returns

int[]

Reimplemented from ilObjectLP.

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

                                                             : array
    {
        if (!$a_lp_active) {
            return array(
                ilLPObjSettings::LP_MODE_DEACTIVATED
            );
        } else {
            return array(
                ilLPObjSettings::LP_MODE_DEACTIVATED,
                ilLPObjSettings::LP_MODE_MANUAL_BY_TUTOR
            );
        }
    }

References ilLPObjSettings\LP_MODE_DEACTIVATED, and ilLPObjSettings\LP_MODE_MANUAL_BY_TUTOR.

getMembers()

ilGroupLP::getMembers

(

bool

$a_search = true

)

Reimplemented from ilObjectLP.

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

                                                     : array
    {
        $member_obj = ilGroupParticipants::_getInstanceByObjId($this->obj_id);
        return $member_obj->getMembers();
    }

References ilGroupParticipants\_getInstanceByObjId().

Here is the call graph for this function:

getValidModes()

ilGroupLP::getValidModes

(

)

Returns

int[]

Reimplemented from ilObjectLP.

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

                                   : array
    {
        return array(
            ilLPObjSettings::LP_MODE_DEACTIVATED,
            ilLPObjSettings::LP_MODE_MANUAL_BY_TUTOR,
            ilLPObjSettings::LP_MODE_COLLECTION
        );
    }

References ilLPObjSettings\LP_MODE_COLLECTION, ilLPObjSettings\LP_MODE_DEACTIVATED, and ilLPObjSettings\LP_MODE_MANUAL_BY_TUTOR.

isLPMember()

static ilGroupLP::isLPMember ( array &  $res, int  $usr_id, array  $obj_ids  )

staticprotected

Find (lp-relevant) members for given object ids.

Reimplemented from ilObjectLP.

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

                                                                                        : bool
    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        // will only find objects with roles for user!
        // see ilParticipants::_getMembershipByType()
        $query = " SELECT DISTINCT obd.obj_id, obd.type, obd2.title" .
            " FROM rbac_ua ua" .
            " JOIN rbac_fa fa ON (ua.rol_id = fa.rol_id)" .
            " JOIN object_reference obr ON (fa.parent = obr.ref_id)" .
            " JOIN object_data obd ON (obr.obj_id = obd.obj_id)" .
            " JOIN object_data obd2 ON (ua.rol_id = obd2.obj_id)" .
            " WHERE obd.type = " . $ilDB->quote("grp", "text") .
            " AND fa.assign = " . $ilDB->quote("y", "text") .
            " AND ua.usr_id = " . $ilDB->quote($a_usr_id, "integer") .
            " AND " . $ilDB->in("obd.obj_id", $a_obj_ids, false, "integer");
        $set = $ilDB->query($query);
        while ($row = $ilDB->fetchAssoc($set)) {
            $role = $row["title"];
            if (!stristr($role, "il_" . $row["type"] . "_admin_") &&
                !stristr($role, "il_" . $row["type"] . "_tutor_")) {
                $a_res[$row["obj_id"]] = true;
            }
        }
        return true;
    }

References $DIC, and $ilDB.

---

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

• components/ILIAS/Group/classes/class.ilGroupLP.php