Inheritance diagram for ilLPStatusContributionToDiscussion:

Collaboration diagram for ilLPStatusContributionToDiscussion:

Public Member Functions
	determineStatus (int $a_obj_id, int $a_usr_id, ?object $a_obj=null)

	getCustomLPSettingsExportXML (int $object_id)

	importCustomLPSettingsExportXML (int $new_object_id, ilImportMapping $a_mapping, SimpleXMLElement $additional_xml_root)

	init (Container $DIC)

	getLPStatusId ()

	getLabel ()

	getInfo ()

Public Member Functions inherited from ilLPStatus
	__construct (int $a_obj_id)

	_updateStatus (int $a_obj_id, int $a_usr_id, ?object $a_obj=null, bool $a_percentage=false, bool $a_force_raise=false)
	New status handling (st: status, nr: accesses, p: percentage, t: time spent, m: mark) Learning progress: More...

	determinePercentage (int $a_obj_id, int $a_usr_id, ?object $a_obj=null)

	determineStatus (int $a_obj_id, int $a_usr_id, ?object $a_obj=null)

	refreshStatus (int $a_obj_id, ?array $a_users=null)
	Refresh status. More...

	init (\ILIAS\DI\Container $DIC)

	getCustomLPSettingsExportXML (int $object_id)

	importCustomLPSettingsExportXML (int $new_object_id, ilImportMapping $a_mapping, SimpleXMLElement $additional_xml_root)

	getLPStatusId ()

	getLabel ()

	getInfo ()

	init (Container $DIC)

	getCustomLPSettingsExportXML (int $object_id)

	importCustomLPSettingsExportXML (int $new_object_id, ilImportMapping $a_mapping, SimpleXMLElement $additional_xml_root)

	getLPStatusId ()

	getLabel ()

	getInfo ()

Static Public Member Functions
static	_getCompleted (int $a_obj_id)

static	_getInProgress (int $a_obj_id)

Static Public Member Functions inherited from ilLPStatus
static	_getCountNotAttempted (int $a_obj_id)

static	_getNotAttempted (int $a_obj_id)

static	_getCountInProgress (int $a_obj_id)

static	_getInProgress (int $a_obj_id)

static	_getCountCompleted (int $a_obj_id)

static	_getCompleted (int $a_obj_id)

static	_getFailed (int $a_obj_id)

static	_getCountFailed (int $a_obj_id)

static	_getStatusInfo (int $a_obj_id)

static	_getTypicalLearningTime (string $type, int $obj_id, int $sub_id=0)

static	checkStatusForObject (int $a_obj_id, ?array $a_users=null)
	This function checks whether the status for a given number of users is dirty and must be recalculated. More...

static	writeStatus (int $a_obj_id, int $a_user_id, int $a_status, int $a_percentage=0, bool $a_force_per=false, ?int &$a_old_status=self::LP_STATUS_NOT_ATTEMPTED_NUM)
	Write status for user and object. More...

static	setInProgressIfNotAttempted (int $a_obj_id, int $a_user_id)
	This function shoudl be clalled for normal "read events". More...

static	setAllDirty ()
	Sets all status to dirty. More...

static	setDirty (int $a_obj_id)
	Sets status of an object to dirty. More...

static	_lookupStatus (int $a_obj_id, int $a_user_id, bool $a_create=true)
	Lookup status. More...

static	_lookupPercentage (int $a_obj_id, int $a_user_id)
	Lookup percentage. More...

static	_hasUserCompleted (int $a_obj_id, int $a_user_id)
	Lookup user object completion. More...

static	_lookupStatusChanged (int $a_obj_id, int $a_user_id)
	Lookup status changed. More...

static	_lookupCompletedForObject (int $a_obj_id, ?array $a_user_ids=null)
	Get completed users for object. More...

static	_lookupFailedForObject (int $a_obj_id, ?array $a_user_ids=null)
	Get failed users for object. More...

static	_lookupInProgressForObject (int $a_obj_id, ?array $a_user_ids=null)
	Get in progress users for object. More...

static	preloadListGUIData (array $a_obj_ids)

static	getListGUIStatus (int $a_obj_id, bool $a_image_only=true)

static	hasListGUIStatus (int $a_obj_id)

Protected Attributes
const string	LNG_TEXT = 'trac_mode_contribution_to_discussion'

const string	LNG_TEXT_INFO = 'trac_mode_contribution_to_discussion_info'

ilLanguage	$lng

Protected Attributes inherited from ilLPStatus
int	$obj_id

ilDBInterface	$db

ilObjectDataCache	$ilObjDataCache

Additional Inherited Members
Data Fields inherited from ilLPStatus
const string	LP_STATUS_NOT_ATTEMPTED = 'trac_no_attempted'

const string	LP_STATUS_IN_PROGRESS = 'trac_in_progress'

const string	LP_STATUS_COMPLETED = 'trac_completed'

const string	LP_STATUS_FAILED = 'trac_failed'

const int	LP_STATUS_NOT_ATTEMPTED_NUM = 0

const int	LP_STATUS_IN_PROGRESS_NUM = 1

const int	LP_STATUS_COMPLETED_NUM = 2

const int	LP_STATUS_FAILED_NUM = 3

const string	LP_STATUS_REGISTERED = 'trac_registered'

const string	LP_STATUS_NOT_REGISTERED = 'trac_not_registered'

const string	LP_ut_lp_markSTATUS_PARTICIPATED = 'trac_participated'

const string	LP_STATUS_NOT_PARTICIPATED = 'trac_not_participated'

Static Public Attributes inherited from ilLPStatus
static array	$list_gui_cache

Static Protected Member Functions inherited from ilLPStatus
static	raiseEvent (int $a_obj_id, int $a_usr_id, int $a_status, int $a_old_status, int $a_percentage)

static	_lookupStatusForObject (int $a_obj_id, int $a_status, ?array $a_user_ids=null)
	Get users with given status for object. More...

static	validateLPForObjects (int $a_user_id, array $a_obj_ids, int $a_parent_ref_id)
	Process given objects for lp-relevance. More...

static	checkLPModesForObjects (array $a_obj_ids, array &$a_coll_obj_ids)
	implements Process lp modes for given objects More...

static	getLPStatusForObjects (int $a_user_id, array $a_obj_ids)
	Get LP status for given objects (and user) More...

Detailed Description

Definition at line 23 of file class.ilLPStatusContributionToDiscussion.php.

Member Function Documentation

◆ _getCompleted()

static ilLPStatusContributionToDiscussion::_getCompleted ( int $a_obj_id )

static

Returns: int[]

Reimplemented from ilLPStatus.

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

                                                       : array
    {
        $userIds = [];
        $frm_properties = ilForumProperties::getInstance($a_obj_id);
        $num_required_postings = $frm_properties->getLpReqNumPostings();
        if (null === $num_required_postings) {
            return $userIds;
        }
        $frm = new ilForum();
        $frm->setForumId($frm_properties->getObjId());
        $statistics = $frm->getUserStatistics(
            $frm_properties->isPostActivationEnabled()
        );
        return array_map(
            static function (array $statisic): int {
                return (int) $statisic['pos_author_id'];
            },
            array_filter(
                $statistics,
                static function (array $statistic) use (
                    $num_required_postings
                ): bool {
                    return (int) $statistic['num_postings'] >= $num_required_postings;
                }
            )
        );
    }

References ilForumProperties\getInstance().

Here is the call graph for this function:

◆ _getInProgress()

static ilLPStatusContributionToDiscussion::_getInProgress ( int $a_obj_id )

static

Reimplemented from ilLPStatus.

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

                                                        : array
    {
        $userIds = [];
        $frm_properties = ilForumProperties::getInstance($a_obj_id);
        $num_required_postings = $frm_properties->getLpReqNumPostings();
        if (null === $num_required_postings) {
            return $userIds;
        }
        $frm = new ilForum();
        $frm->setForumId($frm_properties->getObjId());
        $statistics = $frm->getUserStatistics(
            $frm_properties->isPostActivationEnabled()
        );
        return array_map(
            static function (array $statisic): int {
                return (int) $statisic['pos_author_id'];
            },
            array_filter(
                $statistics,
                static function (array $statistic) use (
                    $num_required_postings
                ): bool {
                    $num_user_postings = (int) $statistic['num_postings'];
                    return $num_user_postings > 0 && $num_user_postings < $num_required_postings;
                }
            )
        );
    }

References ilForumProperties\getInstance(), and ILIAS\Repository\int().

Here is the call graph for this function:

◆ determineStatus()

ilLPStatusContributionToDiscussion::determineStatus	(	int	$a_obj_id,
		int	$a_usr_id,
		?object	$a_obj = `null`
	)

Reimplemented from ilLPStatus.

Definition at line 86 of file class.ilLPStatusContributionToDiscussion.php.

     : int {
        $status = self::LP_STATUS_NOT_ATTEMPTED_NUM;
        $frm_properties = ilForumProperties::getInstance($a_obj_id);
        $num_required_postings = $frm_properties->getLpReqNumPostings();
        if (is_null($num_required_postings)) {
            return $status;
        }
        $frm = new ilForum();
        $frm->setForumId($frm_properties->getObjId());
        $num_postings = $frm->getNumberOfPublishedUserPostings(
            $a_usr_id,
            $frm_properties->isPostActivationEnabled()
        );
        if ($num_postings >= $num_required_postings) {
            $status = self::LP_STATUS_COMPLETED_NUM;
        } elseif ($num_postings > 0) {
            $status = self::LP_STATUS_IN_PROGRESS_NUM;
        }
        return $status;
    }

◆ getCustomLPSettingsExportXML()

ilLPStatusContributionToDiscussion::getCustomLPSettingsExportXML ( int $object_id )

Reimplemented from ilLPStatus.

Definition at line 111 of file class.ilLPStatusContributionToDiscussion.php.

     : SimpleXMLElement {
        $num_postings = ilForumProperties::getInstance($object_id)->getLpReqNumPostings();
        $xml_root = new SimpleXMLElement('<LPStatusContributionToDiscussion></LPStatusContributionToDiscussion>');
        $xml_root->addAttribute('num_postings', (string) $num_postings);
        return $xml_root;
    }

◆ getInfo()

ilLPStatusContributionToDiscussion::getInfo ( )

Reimplemented from ilLPStatus.

Definition at line 146 of file class.ilLPStatusContributionToDiscussion.php.

                             : string
    {
        return $this->lng->txt(self::LNG_TEXT_INFO);
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getLabel()

ilLPStatusContributionToDiscussion::getLabel ( )

Reimplemented from ilLPStatus.

Definition at line 141 of file class.ilLPStatusContributionToDiscussion.php.

                              : string
    {
        return $this->lng->txt(self::LNG_TEXT);
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getLPStatusId()

ilLPStatusContributionToDiscussion::getLPStatusId ( )

Reimplemented from ilLPStatus.

Definition at line 136 of file class.ilLPStatusContributionToDiscussion.php.

                                   : string
    {
        return (string) ilLPObjSettings::LP_MODE_CONTRIBUTION_TO_DISCUSSION;
    }

References ilLPObjSettings\LP_MODE_CONTRIBUTION_TO_DISCUSSION.

◆ importCustomLPSettingsExportXML()

ilLPStatusContributionToDiscussion::importCustomLPSettingsExportXML	(	int	$new_object_id,
		ilImportMapping	$a_mapping,
		SimpleXMLElement	$additional_xml_root
	)

Reimplemented from ilLPStatus.

Definition at line 120 of file class.ilLPStatusContributionToDiscussion.php.

     : void {
        $forum_properties = ilForumProperties::getInstance($new_object_id);
        $forum_properties->setLpReqNumPostings((int) $additional_xml_root->attributes()->num_postings);
        $forum_properties->update();
    }

◆ init()

ilLPStatusContributionToDiscussion::init ( Container $DIC )

Implements ILIAS\Tracking\Status\LPStatusInterface.

Definition at line 130 of file class.ilLPStatusContributionToDiscussion.php.

     : void {
        $this->lng = $DIC->language();
    }

Field Documentation

◆ $lng

ilLanguage ilLPStatusContributionToDiscussion::$lng

protected

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

◆ LNG_TEXT

const string ilLPStatusContributionToDiscussion::LNG_TEXT = 'trac_mode_contribution_to_discussion'

protected

Definition at line 25 of file class.ilLPStatusContributionToDiscussion.php.

◆ LNG_TEXT_INFO

const string ilLPStatusContributionToDiscussion::LNG_TEXT_INFO = 'trac_mode_contribution_to_discussion_info'

protected

Definition at line 26 of file class.ilLPStatusContributionToDiscussion.php.

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

components/ILIAS/Tracking/classes/status/class.ilLPStatusContributionToDiscussion.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _getCompleted()

◆ _getInProgress()

◆ determineStatus()

◆ getCustomLPSettingsExportXML()

◆ getInfo()

◆ getLabel()

◆ getLPStatusId()

◆ importCustomLPSettingsExportXML()

◆ init()

Field Documentation

◆ $lng

◆ LNG_TEXT

◆ LNG_TEXT_INFO