Settings for members view. More...

Collaboration diagram for ilMemberViewSettings:

Public Member Functions
	getContainer ()

	getCurrentRefId ()

	isActive ()
	Check if member view currently enabled. More...

	isActiveForRefId (int $a_ref_id)
	Check if member view is currently enabled for given ref id. More...

	activate (int $a_ref_id)
	Enable member view for this session and container. More...

	deactivate ()

	toggleActivation (int $a_ref_id, bool $a_activation)
	Toggle activation status. More...

	isEnabled ()
	Check if members view is enabled in the administration. More...

Static Public Member Functions
static	getInstance ()

Data Fields
const	SESSION_MEMBER_VIEW_CONTAINER = 'member_view_container'

Protected Member Functions
	read ()
	Read settings. More...

	findEffectiveRefId ()
	Find effective ref_id for request. More...

Protected Attributes
ilLogger	$logger

RequestInterface	$request

ilCtrl	$ctrl

ilTree	$tree

ilSetting	$settings

Container Service	$container_service

Private Member Functions
	__construct ()

Private Attributes
bool	$active = false

bool	$enabled = false

int	$container = null

array	$container_items = []

int	$current_ref_id = 0

Static Private Attributes
static ilMemberViewSettings	$instance = null

Detailed Description

Settings for members view.

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

◆ __construct()

ilMemberViewSettings::__construct ( )

private

Definition at line 42 of file class.ilMemberViewSettings.php.

References $DIC, ILIAS\Repository\ctrl(), ILIAS\Repository\logger(), read(), and ILIAS\Repository\settings().

     {
         global $DIC;
 
         $this->tree = $DIC->repositoryTree();
         $this->settings = $DIC->settings();
         $this->request = $DIC->http()->request();
         $this->ctrl = $DIC->ctrl();
         $this->logger = $DIC->logger()->cont();
         $this->read();
         $this->container_service = $DIC->container();
     }

Here is the call graph for this function:

Member Function Documentation

◆ activate()

ilMemberViewSettings::activate ( int $a_ref_id )

Enable member view for this session and container.

Definition at line 133 of file class.ilMemberViewSettings.php.

Referenced by toggleActivation().

                                            : void
     {
         $this->active = true;
         $this->setContainer($a_ref_id);
     }

Here is the caller graph for this function:

◆ deactivate()

ilMemberViewSettings::deactivate ( )

Definition at line 139 of file class.ilMemberViewSettings.php.

References ilSession\clear(), and null.

Referenced by read(), and toggleActivation().

                                 : void
     {
         $this->active = false;
         $this->container = null;
         ilSession::clear(self::SESSION_MEMBER_VIEW_CONTAINER);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ findEffectiveRefId()

ilMemberViewSettings::findEffectiveRefId ( )

protected

Find effective ref_id for request.

Definition at line 198 of file class.ilMemberViewSettings.php.

References $ref_id, and ILIAS\Repository\int().

Referenced by read().

                                            : int
     {
         // re-enable asynchronous request due to #41218
         $ref_id = (int) ($this->request->getQueryParams()['ref_id'] ?? 0);
         if ($ref_id) {
             return $this->current_ref_id = $ref_id;
         }
         $target_str = (string) ($this->request->getQueryParams()['target'] ?? '');
         if ($target_str !== '') {
             $target_arr = explode('_', $target_str);
             if (isset($target_arr[1]) && (int) $target_arr[1]) {
                 $this->current_ref_id = (int) $target_arr[1];
             }
         }
         return 0;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getContainer()

ilMemberViewSettings::getContainer ( )

Definition at line 60 of file class.ilMemberViewSettings.php.

References $container.

Referenced by isActive(), isActiveForRefId(), and read().

                                   : ?int
     {
         return $this->container;
     }

Here is the caller graph for this function:

◆ getCurrentRefId()

ilMemberViewSettings::getCurrentRefId ( )

Definition at line 65 of file class.ilMemberViewSettings.php.

References $container, $current_ref_id, ilObjectFactory\getInstanceByRefId(), and ilSession\set().

Referenced by isActive(), and read().

                                      : int
     {
         return $this->current_ref_id;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInstance()

static ilMemberViewSettings::getInstance ( )

static

Definition at line 55 of file class.ilMemberViewSettings.php.

Referenced by ilConditionHandler\_checkAllConditionsOfTarget(), ilObjCourseAccess\_isActivated(), ilInfoScreenGUI\addPreconditionSection(), ilObjGroupGUI\checkAgreement(), ilObjCourseGUI\checkAgreement(), ilAccess\doActivationCheck(), ILIAS\Container\Screen\MemberViewLayoutProvider\getMemberViewModeInfo(), ilRbacSystem\initMemberView(), ilCache\isDisabled(), ilObjectListGUI\parseConditions(), ilObjTestGUI\prepareOutput(), ilMemberViewGUI\showMemberViewSwitch(), and ilIndividualAssessmentAccessHandler\simulateMember().

                                         : ilMemberViewSettings
     {
         return self::$instance ?? (self::$instance = new ilMemberViewSettings());
     }

Here is the caller graph for this function:

◆ isActive()

ilMemberViewSettings::isActive ( )

Check if member view currently enabled.

Definition at line 87 of file class.ilMemberViewSettings.php.

References getContainer(), and getCurrentRefId().

                               : bool
     {
         static $mv_status;
         if (!isset($mv_status)) {
             if (!$this->active) {
                 // Not active
                 return $mv_status = false;
             }
 
             if (!$this->getCurrentRefId()) {
                 // No ref id given => mail, search, personal desktop menu in other tab
                 return $mv_status = false;
             }
 
             if (!in_array($this->getCurrentRefId(), $this->container_items) &&
                 $this->getContainer() !== $this->getCurrentRefId()
             ) {
                 // outside of course
                 return $mv_status = false;
             }
             return $mv_status = true;
         }
 
         return $mv_status;
     }

Here is the call graph for this function:

◆ isActiveForRefId()

ilMemberViewSettings::isActiveForRefId ( int $a_ref_id )

Check if member view is currently enabled for given ref id.

Definition at line 116 of file class.ilMemberViewSettings.php.

References getContainer().

                                                    : bool
     {
         if (!$this->active || !$a_ref_id) {
             return false;
         }
 
         if (
             !in_array($a_ref_id, $this->container_items) &&
             $this->getContainer() !== $a_ref_id) {
             return false;
         }
         return true;
     }

Here is the call graph for this function:

◆ isEnabled()

ilMemberViewSettings::isEnabled ( )

Check if members view is enabled in the administration.

Definition at line 161 of file class.ilMemberViewSettings.php.

References $enabled.

                                : bool
     {
         return $this->enabled;
     }

◆ read()

ilMemberViewSettings::read ( )

protected

Read settings.

Definition at line 169 of file class.ilMemberViewSettings.php.

References deactivate(), findEffectiveRefId(), ilSession\get(), getContainer(), getCurrentRefId(), and ILIAS\Repository\int().

Referenced by __construct().

                              : void
     {
         $current_ref_id = $this->findEffectiveRefId();
 
         // member view is always enabled
         // (2013-06-18, http://www.ilias.de/docu/goto_docu_wiki_1357_Reorganising_Administration.html)
 
         // $this->enabled = $ilSetting->get('preview_learner');
         $this->enabled = true;
 
         if (ilSession::get(self::SESSION_MEMBER_VIEW_CONTAINER)) {
             $this->active = true;
             $this->container = (int) ilSession::get(self::SESSION_MEMBER_VIEW_CONTAINER);
             $this->container_items = $this->tree->getSubTreeIds($this->getContainer());
 
             // deactivate if out of scope
             if (
                 $this->getCurrentRefId() &&
                 !in_array($this->getCurrentRefId(), $this->container_items) &&
                 $this->getCurrentRefId() !== $this->getContainer()
             ) {
                 $this->deactivate();
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toggleActivation()

ilMemberViewSettings::toggleActivation	(	int	$a_ref_id,
		bool	$a_activation
	)

Toggle activation status.

Definition at line 149 of file class.ilMemberViewSettings.php.

References activate(), and deactivate().

                                                                        : void
     {
         if ($a_activation) {
             $this->activate($a_ref_id);
         } else {
             $this->deactivate();
         }
     }