ilForumLP Class Reference

Class ilForumLP. More...

Inheritance diagram for ilForumLP:

Collaboration diagram for ilForumLP:

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

Static Public Member Functions
static	getDefaultModes (bool $lp_active)
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)

Additional Inherited Members
Protected Member Functions inherited from ilObjectLP
	__construct (int $obj_id)
	resetCustomLPDataForUserIds (array $user_ids, bool $recursive=true)
	gatherLPUsers ()
	updateParentCollections ()
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 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

Class ilForumLP.

Author

Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

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

Member Function Documentation

appendModeConfiguration()

ilForumLP::appendModeConfiguration	(	int	$mode,
		ilRadioOption	$modeElement
	)

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

References $DIC, ilRadioOption\addSubItem(), ilForumProperties\getInstance(), ilLPObjSettings\LP_MODE_CONTRIBUTION_TO_DISCUSSION, and ilRadioOption\setTitle().

                                                                                  : void
    {
        global $DIC;

        if (ilLPObjSettings::LP_MODE_CONTRIBUTION_TO_DISCUSSION === $mode) {
            $num_postings = new ilNumberInputGUI(
                $DIC->language()->txt('trac_frm_contribution_num_postings'),
                'number_of_postings'
            );
            $num_postings->allowDecimals(false);
            $num_postings->setMinValue(1);
            $num_postings->setMaxValue(99999);
            $num_postings->setSize(4);
            $num_postings->setRequired(true);
            if (is_int(ilForumProperties::getInstance($this->obj_id)->getLpReqNumPostings())) {
                $requiredNumberOfPostings = ilForumProperties::getInstance($this->obj_id)->getLpReqNumPostings();
                $num_postings->setValue((string) $requiredNumberOfPostings);
            } else {
                $num_postings->setValue('');
            }
            $modeElement->addSubItem($num_postings);

            // Use the default text presentation of the base class
            $modeElement->setTitle(parent::getModeText($mode));
        }
    }

Here is the call graph for this function:

getDefaultMode()

ilForumLP::getDefaultMode

(

)

Definition at line 88 of file class.ilForumLP.php.

References ilLPObjSettings\LP_MODE_DEACTIVATED.

                                    : int
    {
        return ilLPObjSettings::LP_MODE_DEACTIVATED;
    }

getDefaultModes()

static ilForumLP::getDefaultModes ( bool  $lp_active )

static

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

References ilLPObjSettings\LP_MODE_CONTRIBUTION_TO_DISCUSSION, and ilLPObjSettings\LP_MODE_DEACTIVATED.

                                                           : array
    {
        if ($lp_active) {
            return [
                ilLPObjSettings::LP_MODE_DEACTIVATED,
                ilLPObjSettings::LP_MODE_CONTRIBUTION_TO_DISCUSSION,
            ];
        }

        return [
            ilLPObjSettings::LP_MODE_DEACTIVATED,
        ];
    }

getModeText()

ilForumLP::getModeText

(

int

$mode

)

Definition at line 101 of file class.ilForumLP.php.

References $DIC, ilObjectLP\getCurrentMode(), ilForumProperties\getInstance(), and ilLPObjSettings\LP_MODE_CONTRIBUTION_TO_DISCUSSION.

                                          : string
    {
        global $DIC;

        $text = parent::getModeText($mode);

        if ($mode === ilLPObjSettings::LP_MODE_CONTRIBUTION_TO_DISCUSSION &&
            $mode === $this->getCurrentMode() &&
            is_int(($number_of_postings = ilForumProperties::getInstance($this->obj_id)->getLpReqNumPostings()))) {
            try {
                $text = sprintf(
                    match ($number_of_postings) {
                        1 => $DIC->language()->txt('trac_frm_contribution_num_postings_info_s'),
                        default => $DIC->language()->txt('trac_frm_contribution_num_postings_info_p')
                    },
                    $text,
                    $number_of_postings
                );
            } catch (Throwable) {
            }
        }

        return $text;
    }

Here is the call graph for this function:

getValidModes()

ilForumLP::getValidModes

(

)

Definition at line 93 of file class.ilForumLP.php.

References ilLPObjSettings\LP_MODE_CONTRIBUTION_TO_DISCUSSION, and ilLPObjSettings\LP_MODE_DEACTIVATED.

                                   : array
    {
        return [
            ilLPObjSettings::LP_MODE_DEACTIVATED,
            ilLPObjSettings::LP_MODE_CONTRIBUTION_TO_DISCUSSION,
        ];
    }

saveModeConfiguration()

ilForumLP::saveModeConfiguration	(	ilPropertyFormGUI	$form,
		bool &	$modeChanged
	)

Definition at line 54 of file class.ilForumLP.php.

References ilPropertyFormGUI\getInput(), and ilForumProperties\getInstance().

                                                                                      : void
    {
        $frm_properties = ilForumProperties::getInstance($this->obj_id);

        $current_value = $frm_properties->getLpReqNumPostings();

        if (is_numeric($form->getInput('number_of_postings'))) {
            $frm_properties->setLpReqNumPostings(
                (int) $form->getInput('number_of_postings')
            );
        } else {
            $frm_properties->setLpReqNumPostings(null);
        }
        $frm_properties->update();

        if ($current_value !== $frm_properties->getLpReqNumPostings()) {
            $modeChanged = true;
        }
    }

Here is the call graph for this function:

---

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

• Modules/Forum/classes/class.ilForumLP.php