ILIAS\Awareness\AdminManager Class Reference

Administrate awareness tool. More...

Collaboration diagram for ILIAS\Awareness\AdminManager:

Public Member Functions
	__construct (int $ref_id, InternalDataService $data_service, InternalDomainService $domain_service)
	getAllUserProviders ()
	setActivationMode (string $provider_id, int $a_val)
	Activate provider. More...
	getActivationMode (string $provider_id)
	isProviderActivated (string $provider_id)
	includesProviderOfflineUsers (string $provider_id)
	getModeOptions ()

Protected Attributes
const	MODE_INACTIVE = 0
const	MODE_ONLINE_ONLY = 1
const	MODE_INCL_OFFLINE = 2
ilLanguage	$lng
InternalDomainService	$domain_service
InternalDataService	$data_service
ilSetting	$settings
int	$user_id
int	$ref_id = 0

Detailed Description

Administrate awareness tool.

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 28 of file class.AdminManager.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Awareness\AdminManager::__construct	(	int	$ref_id,
		InternalDataService	$data_service,
		InternalDomainService	$domain_service
	)

Definition at line 41 of file class.AdminManager.php.

References ILIAS\Awareness\AdminManager\$data_service, ILIAS\Awareness\AdminManager\$domain_service, ILIAS\Awareness\AdminManager\$ref_id, ILIAS\Awareness\InternalDomainService\awarenessSettings(), ILIAS\Repository\lng(), and ILIAS\Repository\settings().

      {
        $this->ref_id = $ref_id;
        $this->settings = $domain_service->awarenessSettings();
        $this->domain_service = $domain_service;
        $this->lng = $domain_service->lng();
        $this->data_service = $data_service;
    }

Here is the call graph for this function:

Member Function Documentation

getActivationMode()

ILIAS\Awareness\AdminManager::getActivationMode

(

string

$provider_id

)

Definition at line 69 of file class.AdminManager.php.

References ILIAS\Repository\settings().

Referenced by ILIAS\Awareness\AdminManager\includesProviderOfflineUsers(), and ILIAS\Awareness\AdminManager\isProviderActivated().

                                                          : int
    {
        return (int) $this->settings->get("up_act_" . $provider_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAllUserProviders()

ILIAS\Awareness\AdminManager::getAllUserProviders

(

)

Returns

User[]

Definition at line 56 of file class.AdminManager.php.

                                         : array
    {
        return $this->domain_service->userProvider()->getAllProviders();
    }

getModeOptions()

ILIAS\Awareness\AdminManager::getModeOptions

(

)

Returns

array<int,string>

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

References ILIAS\Repository\lng().

                                    : array
    {
        $options = array(
            self::MODE_INACTIVE => $this->lng->txt("awrn_inactive"),
            self::MODE_ONLINE_ONLY => $this->lng->txt("awrn_online_only"),
            self::MODE_INCL_OFFLINE => $this->lng->txt("awrn_incl_offline")
        );

        return $options;
    }

Here is the call graph for this function:

includesProviderOfflineUsers()

ILIAS\Awareness\AdminManager::includesProviderOfflineUsers

(

string

$provider_id

)

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

References ILIAS\Awareness\AdminManager\getActivationMode().

                                                                     : bool
    {
        return ($this->getActivationMode($provider_id) == self::MODE_INCL_OFFLINE);
    }

Here is the call graph for this function:

isProviderActivated()

ILIAS\Awareness\AdminManager::isProviderActivated

(

string

$provider_id

)

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

References ILIAS\Awareness\AdminManager\getActivationMode().

                                                            : bool
    {
        return ($this->getActivationMode($provider_id) != self::MODE_INACTIVE);
    }

Here is the call graph for this function:

setActivationMode()

ILIAS\Awareness\AdminManager::setActivationMode	(	string	$provider_id,
		int	$a_val
	)

Activate provider.

Definition at line 64 of file class.AdminManager.php.

References ILIAS\Repository\settings().

                                                                      : void
    {
        $this->settings->set("up_act_" . $provider_id, (string) $a_val);
    }

Here is the call graph for this function:

Field Documentation

$data_service

InternalDataService ILIAS\Awareness\AdminManager::$data_service

protected

Definition at line 36 of file class.AdminManager.php.

Referenced by ILIAS\Awareness\AdminManager\__construct().

$domain_service

InternalDomainService ILIAS\Awareness\AdminManager::$domain_service

protected

Definition at line 35 of file class.AdminManager.php.

Referenced by ILIAS\Awareness\AdminManager\__construct().

$lng

ilLanguage ILIAS\Awareness\AdminManager::$lng

protected

Definition at line 34 of file class.AdminManager.php.

$ref_id

int ILIAS\Awareness\AdminManager::$ref_id = 0

protected

Definition at line 39 of file class.AdminManager.php.

Referenced by ILIAS\Awareness\AdminManager\__construct().

$settings

ilSetting ILIAS\Awareness\AdminManager::$settings

protected

Definition at line 37 of file class.AdminManager.php.

$user_id

int ILIAS\Awareness\AdminManager::$user_id

protected

Definition at line 38 of file class.AdminManager.php.

MODE_INACTIVE

const ILIAS\Awareness\AdminManager::MODE_INACTIVE = 0

protected

Definition at line 30 of file class.AdminManager.php.

MODE_INCL_OFFLINE

const ILIAS\Awareness\AdminManager::MODE_INCL_OFFLINE = 2

protected

Definition at line 32 of file class.AdminManager.php.

MODE_ONLINE_ONLY

const ILIAS\Awareness\AdminManager::MODE_ONLINE_ONLY = 1

protected

Definition at line 31 of file class.AdminManager.php.

---

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

• components/ILIAS/Awareness/classes/class.AdminManager.php