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 ($a_mode)
	getModeInfoText ($a_mode)
	getSettingsInfo ()
	getCollectionInstance ()
	getMembers ($a_search=true)
	resetLPDataForCompleteObject ($a_recursive=true)
	resetLPDataForUserIds (array $a_user_ids, $a_recursive=true)
	handleToTrash ()
	handleDelete ()
	getMailTemplateId ()

Data Fields
const	INACTIVE_PLUGIN = -1

Protected Member Functions
	__construct ($a_obj_id)
	initPlugin ()
Protected Member Functions inherited from ilObjectLP
	__construct ($a_obj_id)
	resetCustomLPDataForUserIds (array $a_user_ids, $a_recursive=true)
	gatherLPUsers ()
	updateParentCollections ()

Static Protected Member Functions
static	isLPMember (array &$a_res, $a_usr_id, $a_obj_ids)
	Find (lp-relevant) members for given object ids. More...
Static Protected Member Functions inherited from ilObjectLP
static	getTypeClass ($a_type)
static	isLPMember (array &$a_res, $a_usr_id, $a_obj_ids)
	Find (lp-relevant) members for given object ids. More...
static	findMembershipsByPath (array &$a_res, $a_usr_id, $a_parent_ref_id, array $a_obj_ids, $a_mapped_ref_ids=false)
	Find (lp-relevant) memberships by path. More...

Protected Attributes
	$status
Protected Attributes inherited from ilObjectLP
	$obj_id
	$collection_instance
	$mode

Additional Inherited Members
Static Public Member Functions inherited from ilObjectLP
static	getInstance ($a_obj_id)
static	isSupportedObjectType ($a_type)
static	handleMove ($a_source_ref_id)
static	getLPMemberships ($a_usr_id, array $a_obj_ids, $a_parent_ref_id=null, $a_mapped_ref_ids=false)
	Get all objects where given user is member (from LP POV) More...
static	supportsSpentSeconds ($a_obj_type)
static	supportsMark ($a_obj_type)
static	supportsMatrixView ($a_obj_type)

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilPluginLP::__construct (   $a_obj_id )

protected

Reimplemented from ilObjectLP.

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

        {               
                parent::__construct($a_obj_id);
                
                $this->initPlugin();
        }

References initPlugin().

Here is the call graph for this function:

Member Function Documentation

getCurrentMode()

ilPluginLP::getCurrentMode

(

)

Reimplemented from ilObjectLP.

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

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

References ilLPObjSettings\LP_MODE_PLUGIN, and ilLPObjSettings\LP_MODE_UNDEFINED.

getDefaultMode()

ilPluginLP::getDefaultMode

(

)

Reimplemented from ilObjectLP.

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

        {               
                return ilLPObjSettings::LP_MODE_UNDEFINED;
        }

References ilLPObjSettings\LP_MODE_UNDEFINED.

getPluginInstance()

ilPluginLP::getPluginInstance

(

)

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

        {
                return $this->status;
        }       

References $status.

getValidModes()

ilPluginLP::getValidModes

(

)

Reimplemented from ilObjectLP.

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

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

References ilLPObjSettings\LP_MODE_PLUGIN, and ilLPObjSettings\LP_MODE_UNDEFINED.

initPlugin()

ilPluginLP::initPlugin ( )

protected

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

        {                               
                // active plugin?
                include_once 'Services/Repository/classes/class.ilRepositoryObjectPluginSlot.php';      
                if(ilRepositoryObjectPluginSlot::isTypePluginWithLP(ilObject::_lookupType($this->obj_id)))
                {
                        $obj = ilObjectFactory::getInstanceByObjId($this->obj_id, false); // #12640
                        if($obj && $obj instanceof ilLPStatusPluginInterface)
                        {
                                $this->status = $obj;
                        }
                }       
                // inactive plugin?
                else if(ilRepositoryObjectPluginSlot::isTypePluginWithLP(ilObject::_lookupType($this->obj_id), false))
                {
                        $this->status = self::INACTIVE_PLUGIN;
                }                                               
        }

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

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

isLPMember()

static ilPluginLP::isLPMember ( array &  $a_res,   $a_usr_id,   $a_obj_ids  )

staticprotected

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

Parameters

array	$a_res
int	$a_usr_id
array	$a_obj_ids

Reimplemented from ilObjectLP.

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

        {               
                global $objDefinition;
                
                $type = $a_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"))
                {
                        $class_name::isLPMember($a_res, $a_usr_id, $a_obj_ids);
                }
        }

References $location, and ilObject\_lookupType().

Here is the call graph for this function:

Field Documentation

$status

ilPluginLP::$status

protected

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

Referenced by getPluginInstance().

INACTIVE_PLUGIN

const ilPluginLP::INACTIVE_PLUGIN = -1

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

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

---

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

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