ilForumLP Class Reference

Class ilForumLP. More...

Inheritance diagram for ilForumLP:

Collaboration diagram for ilForumLP:

Public Member Functions
	appendModeConfiguration (int $mode)
	saveModeConfiguration (string $selected_group, array $group_data, 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 ()
	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 $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)

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 27 of file class.ilForumLP.php.

Member Function Documentation

appendModeConfiguration()

ilForumLP::appendModeConfiguration

(

int

$mode

)

Returns

array<string, Input> A map of Input elements mapped to a corresponding key

Reimplemented from ilObjectLP.

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

                                                      : array
    {
        global $DIC;
 
        if (ilLPObjSettings::LP_MODE_CONTRIBUTION_TO_DISCUSSION !== $mode) {
            return [];
        }
 
        $ui_factory = $DIC->ui()->factory();
        $refinery = $DIC->refinery();
        $lng = $DIC->language();
 
        $num_postings = $ui_factory->input()->field()->numeric(
            $lng->txt('trac_frm_contribution_num_postings')
        )->withAdditionalTransformation(
            $refinery->in()->series([
                $refinery->int()->isGreaterThanOrEqual(1),
                $refinery->int()->isLessThanOrEqual(99999)
            ])
        )->withRequired(true);
 
        if (is_int(ilForumProperties::getInstance($this->obj_id)->getLpReqNumPostings())) {
            $requiredNumberOfPostings = ilForumProperties::getInstance($this->obj_id)->getLpReqNumPostings();
            $num_postings = $num_postings->withValue($requiredNumberOfPostings);
        }
 
        return ['number_of_postings' => $num_postings];
    }

References $DIC, $lng, ilObjectLP\$mode, ILIAS\UI\examples\Layout\Page\Mail\$refinery, ilForumProperties\getInstance(), and ilLPObjSettings\LP_MODE_CONTRIBUTION_TO_DISCUSSION.

Here is the call graph for this function:

getDefaultMode()

ilForumLP::getDefaultMode

(

)

Reimplemented from ilObjectLP.

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

                                    : int
    {
        return ilLPObjSettings::LP_MODE_DEACTIVATED;
    }

References ilLPObjSettings\LP_MODE_DEACTIVATED.

getDefaultModes()

static ilForumLP::getDefaultModes ( bool  $lp_active )

static

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

Returns

int[]

Reimplemented from ilObjectLP.

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

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

References ilLPObjSettings\LP_MODE_CONTRIBUTION_TO_DISCUSSION, and ilLPObjSettings\LP_MODE_DEACTIVATED.

getModeText()

ilForumLP::getModeText

(

int

$mode

)

Reimplemented from ilObjectLP.

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

                                          : 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;
    }

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

Here is the call graph for this function:

getValidModes()

ilForumLP::getValidModes

(

)

Returns

int[]

Reimplemented from ilObjectLP.

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

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

References ilLPObjSettings\LP_MODE_CONTRIBUTION_TO_DISCUSSION, and ilLPObjSettings\LP_MODE_DEACTIVATED.

saveModeConfiguration()

ilForumLP::saveModeConfiguration	(	string	$selected_group,
		array	$group_data,
		bool &	$modeChanged
	)

Parameters

string	$selected_group	post var of the selected group
	array<string,mixed>	$group_data data of the that group as array, as processed by the KS

Reimplemented from ilObjectLP.

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

     : void {
        $frm_properties = ilForumProperties::getInstance($this->obj_id);
 
        $current_value = $frm_properties->getLpReqNumPostings();
 
        if (is_numeric($group_data['number_of_postings'] ?? null)) {
            $frm_properties->setLpReqNumPostings(
                (int) $group_data['number_of_postings']
            );
        } else {
            $frm_properties->setLpReqNumPostings(null);
        }
        $frm_properties->update();
 
        if ($current_value !== $frm_properties->getLpReqNumPostings()) {
            $modeChanged = true;
        }
    }

---

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

• components/ILIAS/Forum/classes/class.ilForumLP.php