ilPluginLP Class Reference

Inheritance diagram for ilPluginLP:

Collaboration diagram for ilPluginLP:

Public Member Functions
	getPluginInstance ()
	getDefaultMode ()
	getValidModes ()
	getCurrentMode ()
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 (ilRadioGroupInputGUI $modeRadio)
	shouldFetchIndividualModeFromFormSubmission ()
	fetchIndividualModeFromFormSubmission (ilPropertyFormGUI $form)
	appendModeConfiguration (int $mode, ilRadioOption $modeElement)
	saveModeConfiguration (ilPropertyFormGUI $form, bool &$modeChanged)

Data Fields
const	INACTIVE_PLUGIN = -1

Protected Member Functions
	__construct ($a_obj_id)
	initPlugin ()
Protected Member Functions inherited from ilObjectLP
	__construct (int $obj_id)
	resetCustomLPDataForUserIds (array $user_ids, bool $recursive=true)
	gatherLPUsers ()
	updateParentCollections ()

Static Protected Member Functions
static	isLPMember (array &$res, int $usr_id, array $obj_ids)
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)

Protected Attributes
	$status
Protected Attributes inherited from ilObjectLP
ilTree	$tree
ilDBInterface	$db
ilObjectDefinition	$objectDefinition
int	$obj_id
ilLPCollection	$collection_instance = null
int	$mode = null

Additional Inherited Members
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 Attributes inherited from ilObjectLP
static array	$type_defaults = null

Detailed Description

Definition at line 28 of file class.ilPluginLP.php.

Constructor & Destructor Documentation

__construct()

ilPluginLP::__construct (   $a_obj_id )

protected

Definition at line 34 of file class.ilPluginLP.php.

References ILIAS\GlobalScreen\Provider\__construct(), and initPlugin().

    {
        parent::__construct($a_obj_id);

        $this->initPlugin();
    }

Here is the call graph for this function:

Member Function Documentation

getCurrentMode()

ilPluginLP::getCurrentMode

(

)

Definition at line 74 of file class.ilPluginLP.php.

References ilLPObjSettings\LP_MODE_PLUGIN, and ilLPObjSettings\LP_MODE_UNDEFINED.

                                    : int
    {
        if ($this->status !== null) {
            return ilLPObjSettings::LP_MODE_PLUGIN;
        }
        return ilLPObjSettings::LP_MODE_UNDEFINED;
    }

getDefaultMode()

ilPluginLP::getDefaultMode

(

)

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

References ilLPObjSettings\LP_MODE_UNDEFINED.

                                    : int
    {
        return ilLPObjSettings::LP_MODE_UNDEFINED;
    }

getPluginInstance()

ilPluginLP::getPluginInstance

(

)

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

References $status.

    {
        return $this->status;
    }

getValidModes()

ilPluginLP::getValidModes

(

)

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

References ilLPObjSettings\LP_MODE_PLUGIN, and ilLPObjSettings\LP_MODE_UNDEFINED.

                                   : array
    {
        return array(
            ilLPObjSettings::LP_MODE_UNDEFINED,
            ilLPObjSettings::LP_MODE_PLUGIN
        );
    }

initPlugin()

ilPluginLP::initPlugin ( )

protected

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

References ilObject\_lookupType(), ilObjectFactory\getInstanceByObjId(), and ilRepositoryObjectPluginSlot\isTypePluginWithLP().

Referenced by __construct().

                                   : void
    {
        // active plugin?
        if (ilRepositoryObjectPluginSlot::isTypePluginWithLP(ilObject::_lookupType($this->obj_id))) {
            $obj = ilObjectFactory::getInstanceByObjId($this->obj_id, false); // #12640
            if ($obj instanceof ilLPStatusPluginInterface) {
                $this->status = $obj;
            }
        }
        // inactive plugin?
        elseif (ilRepositoryObjectPluginSlot::isTypePluginWithLP(ilObject::_lookupType($this->obj_id), false)) {
            $this->status = self::INACTIVE_PLUGIN;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isLPMember()

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

staticprotected

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

References $DIC, $location, $type, and ilObject\_lookupType().

                                                                                  : bool
    {
        global $DIC;
        $objDefinition = $DIC['objDefinition'];

        $type = $obj_ids;
        $type = array_shift($type);
        $type = ilObject::_lookupType($type);

        $location = $objDefinition->getLocation($type);
        $class_name = "ilObj" . $objDefinition->getClassName($type);
        include_once $location . "/class." . $class_name . ".php";

        // forward to plugin object
        if (method_exists($class_name, "isLPMember")) {
            return $class_name::isLPMember($res, $usr_id, $obj_ids);
        }

        return false;
    }

Here is the call graph for this function:

Field Documentation

$status

ilPluginLP::$status

protected

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

Referenced by getPluginInstance().

INACTIVE_PLUGIN

const ilPluginLP::INACTIVE_PLUGIN = -1

Definition at line 32 of file class.ilPluginLP.php.

Referenced by ilLPStatusPlugin\_getCompleted(), ilLPStatusPlugin\_getFailed(), ilLPStatusPlugin\_getInProgress(), ilLPStatusPlugin\_getNotAttempted(), ilLPStatusPlugin\determinePercentage(), and ilLPStatusPlugin\determineStatus().

---

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

• Services/Component/classes/class.ilPluginLP.php