Settings for members view More...

Collaboration diagram for ilMemberViewSettings:

Public Member Functions
	getContainer ()
	Returns $container. More...

	getCurrentRefId ()
	Get current ref_id of request. More...

	setContainer ($container)
	Sets $container. More...

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

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

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

	deactivate ()
	Deactivate member view. More...

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

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

Static Public Member Functions
static	getInstance ()
	Get instance. More...

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

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

Protected Attributes
	$tree

	$settings

Private Member Functions
	__construct ()
	Constructor (singleton) More...

Private Attributes
	$active = false

	$enabled = false

	$container = null

	$container_items = array()

	$current_ref_id = 0

Static Private Attributes
static	$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 29 of file class.ilMemberViewSettings.php.

Constructor & Destructor Documentation

◆ __construct()

ilMemberViewSettings::__construct ( )

private

Constructor (singleton)

Returns

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

References $DIC, read(), and settings().

     {
         global $DIC;
 
         $this->tree = $DIC->repositoryTree();
         $this->settings = $DIC->settings();
         $this->read();
     }

Here is the call graph for this function:

Member Function Documentation

◆ activate()

ilMemberViewSettings::activate ( $a_ref_id )

Enable member view for this session and container.

Returns

Parameters

int $a_ref_id Reference Id of course or group

Exceptions

IllegalArgumentException Thrown if reference id is not a course or group

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

References setContainer().

Referenced by toggleActivation().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deactivate()

ilMemberViewSettings::deactivate ( )

Deactivate member view.

Returns

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

References $_SESSION.

Referenced by toggleActivation().

     {
         $this->active = false;
         $this->container = null;
         unset($_SESSION['member_view_container']);
     }

Here is the caller graph for this function:

◆ findEffectiveRefId()

ilMemberViewSettings::findEffectiveRefId ( )

protected

Find effective ref_id for request.

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

References $_GET, and $target_arr.

Referenced by read().

     {
         if ((int) $_GET['ref_id']) {
             return $this->current_ref_id = (int) $_GET['ref_id'];
         }
         
         $target_arr = explode('_', (string) $_GET['target']);
         if (isset($target_arr[1]) and (int) $target_arr[1]) {
             $this->current_ref_id = (int) $target_arr[1];
         }
     }

Here is the caller graph for this function:

◆ getContainer()

ilMemberViewSettings::getContainer ( )

Returns $container.

See also: ilMemberView::$container

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

References $container.

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

     {
         return $this->container;
     }

Here is the caller graph for this function:

◆ getCurrentRefId()

ilMemberViewSettings::getCurrentRefId ( )

Get current ref_id of request.

Returns: type

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

References $current_ref_id.

Referenced by isActive().

     {
         return $this->current_ref_id;
     }

Here is the caller graph for this function:

◆ getInstance()

static ilMemberViewSettings::getInstance ( )

static

Get instance.

Returns: object ilMemberViewSettings

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

Referenced by LTI\ilMainMenuGUI\__construct(), ilMainMenuGUI\__construct(), ilConditionHandler\_checkAllConditionsOfTarget(), ilObjCourseAccess\_isActivated(), ilInfoScreenGUI\addPreconditionSection(), ilLocatorGUI\addRepositoryItems(), ilObjGroupGUI\checkAgreement(), ilObjCourseGUI\checkAgreement(), ilAccess\doPathCheck(), ilRbacSystem\initMemberView(), ilMainMenuGUI\initMemberView(), ilCache\isDisabled(), ilObjectListGUI\parseConditions(), ilObjCourseGUI\prepareOutput(), ilMemberViewGUI\showMemberViewSwitch(), and ilContainerGUI\showTreeFlatIcon().

     {
         if (self::$instance != null) {
             return self::$instance;
         }
         return self::$instance = new ilMemberViewSettings();
     }

Here is the caller graph for this function:

◆ isActive()

ilMemberViewSettings::isActive ( )

Check if member view currently enabled.

Returns: bool

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

References $tree, getContainer(), and getCurrentRefId().

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

Here is the call graph for this function:

◆ isActiveForRefId()

ilMemberViewSettings::isActiveForRefId ( $a_ref_id )

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

Parameters

int $a_ref_id

Returns: bool

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

References getContainer().

     {
         if (!$this->active || !(int) $a_ref_id) {
             // Not active
             return false;
         }
         
         if (!in_array($a_ref_id, $this->container_items) and
             $this->getContainer() != $a_ref_id) {
             // outside of course
             return false;
         }
         return true;
     }

Here is the call graph for this function:

◆ isEnabled()

ilMemberViewSettings::isEnabled ( )

Check if members view is enabled in the administration.

Returns: bool active

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

References $enabled.

     {
         return (bool) $this->enabled;
     }

◆ read()

ilMemberViewSettings::read ( )

protected

Read settings.

Returns: void

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

References $_SESSION, $ilSetting, $settings, $tree, findEffectiveRefId(), and getContainer().

Referenced by __construct().

     {
         $ilSetting = $this->settings;
         $tree = $this->tree;
         
         $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 (isset($_SESSION['member_view_container'])) {
             $this->active = true;
             $this->container = (int) $_SESSION['member_view_container'];
             $this->container_items = $tree->getSubTreeIds($this->getContainer());
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setContainer()

ilMemberViewSettings::setContainer ( $container )

Sets $container.

Parameters

object $container

See also: ilMemberView::$container

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

References $_SESSION, and $container.

Referenced by activate().

     {
         $this->container = $container;
         $_SESSION['member_view_container'] = $this->container;
         $_SESSION['il_cont_admin_panel'] = false;
     }

Here is the caller graph for this function:

◆ toggleActivation()

ilMemberViewSettings::toggleActivation	(	$a_ref_id,
		$a_activation
	)

Toggle activation status.

Returns

Parameters

int	$a_ref_id
bool	$a_activation

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

References activate(), and deactivate().

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