ilAwarenessAct Class Reference

High level business class, interface to front ends. More...

Collaboration diagram for ilAwarenessAct:

Public Member Functions
	setRefId ($a_val)
	Set ref id. More...
	getRefId ()
	Get ref id. More...
	getAwarenessData ($a_filter)
	Get awareness data. More...
	getAwarenessUserCounter ()
	Get awareness data. More...
	notifyOnNewOnlineContacts ()
	Send OSD notification on new users. More...

Static Public Member Functions
static	getInstance ($a_user_id)
	Get instance (for a user) More...

Protected Member Functions
	__construct ($a_user_id)
	Constructor. More...

Protected Attributes
	$lng
	$user_id
	$ref_id = 0

Static Protected Attributes
static	$instances = array()
static	$collector

Detailed Description

High level business class, interface to front ends.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

Definition at line 12 of file class.ilAwarenessAct.php.

Constructor & Destructor Documentation

__construct()

ilAwarenessAct::__construct (   $a_user_id )

protected

Constructor.

Parameters

int

$a_user_id

user ud

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

    {
        global $DIC;
 
        $this->lng = $DIC->language();
        $this->user_id = $a_user_id;
    }

References $DIC.

Member Function Documentation

getAwarenessData()

ilAwarenessAct::getAwarenessData

(

$a_filter

)

Get awareness data.

Returns

ilAwarenessData awareness data

Definition at line 77 of file class.ilAwarenessAct.php.

    {
        include_once("./Services/Awareness/classes/class.ilAwarenessData.php");
        $data = ilAwarenessData::getInstance($this->user_id);
        $data->setRefId($this->getRefId());
        $data->setFilter($a_filter);
        return $data->getData();
    }

References $data, ilAwarenessData\getInstance(), and getRefId().

Here is the call graph for this function:

getAwarenessUserCounter()

ilAwarenessAct::getAwarenessUserCounter

(

)

Get awareness data.

Returns

ilAwarenessData awareness data

Definition at line 91 of file class.ilAwarenessAct.php.

    {
        include_once("./Services/Awareness/classes/class.ilAwarenessData.php");
        $data = ilAwarenessData::getInstance($this->user_id);
        $data->setRefId($this->getRefId());
        return $data->getUserCounter();
    }

References $data, ilAwarenessData\getInstance(), and getRefId().

Here is the call graph for this function:

getInstance()

static ilAwarenessAct::getInstance (   $a_user_id )

static

Get instance (for a user)

Parameters

int

$a_user_id

user id

Returns

ilAwarenessAct actor class

Definition at line 63 of file class.ilAwarenessAct.php.

    {
        if (!isset(self::$instances[$a_user_id])) {
            self::$instances[$a_user_id] = new ilAwarenessAct($a_user_id);
        }
 
        return self::$instances[$a_user_id];
    }

Referenced by ilAwarenessGUI\getAwarenessList(), ilAwarenessGUI\getMainMenuHTML(), and ilAwarenessMetaBarProvider\getMetaBarItems().

Here is the caller graph for this function:

getRefId()

ilAwarenessAct::getRefId

(

)

Get ref id.

Returns

int ref id

Definition at line 52 of file class.ilAwarenessAct.php.

    {
        return $this->ref_id;
    }

References $ref_id.

Referenced by getAwarenessData(), getAwarenessUserCounter(), and notifyOnNewOnlineContacts().

Here is the caller graph for this function:

notifyOnNewOnlineContacts()

ilAwarenessAct::notifyOnNewOnlineContacts

(

)

Send OSD notification on new users.

Definition at line 102 of file class.ilAwarenessAct.php.

    {
        $lng = $this->lng;
        $awrn_set = new ilSetting("awrn");
        if (!$awrn_set->get("use_osd", true)) {
            return;
        }
        $ts = ilSession::get("awr_online_user_ts");
 
        $data = ilAwarenessData::getInstance($this->user_id);
        $data->setRefId($this->getRefId());
        $d = $data->getOnlineUserData($ts);
        $new_online_users = array();
        $no_ids = array();
        foreach ($d as $u) {
            $uname = "[" . $u->login . "]";
            if ($u->public_profile) {
                $uname = "<a href='./goto.php?target=usr_" . $u->id . "'>" . $u->lastname . ", " . $u->firstname . " " . $uname . "</a>";
            }
            if (!in_array($u->id, $no_ids)) {
                $new_online_users[] = $uname;
                $no_ids[] = $u->id;
            }
        }
        if (count($new_online_users) == 0) {
            return;
        }
        //var_dump($d); exit;
        $lng->loadLanguageModule('mail');
 
        include_once("./Services/Object/classes/class.ilObjectFactory.php");
        //$recipient = ilObjectFactory::getInstanceByObjId($this->user_id);
        $bodyParams = array(
            'online_user_names' => implode("<br />", $new_online_users)
        );
        //var_dump($bodyParams); exit;
        require_once 'Services/Notifications/classes/class.ilNotificationConfig.php';
        $notification = new ilNotificationConfig('osd_main');
        $notification->setTitleVar('awareness_now_online', $bodyParams, 'awrn');
        $notification->setShortDescriptionVar('awareness_now_online_users', $bodyParams, 'awrn');
        $notification->setLongDescriptionVar('', $bodyParams, '');
        $notification->setAutoDisable(false);
        //$notification->setLink();
        $notification->setIconPath('templates/default/images/icon_usr.svg');
        $notification->setValidForSeconds(ilNotificationConfig::TTL_SHORT);
        $notification->setVisibleForSeconds(ilNotificationConfig::DEFAULT_TTS);
 
        //$notification->setHandlerParam('mail.sender', $sender_id);
 
        ilSession::set("awr_online_user_ts", date("Y-m-d H:i:s", time()));
        
        $notification->notifyByUsers(array($this->user_id));
    }

References $d, $data, $lng, ilNotificationConfig\DEFAULT_TTS, ilSession\get(), ilAwarenessData\getInstance(), getRefId(), ilSession\set(), and ilNotificationConfig\TTL_SHORT.

Here is the call graph for this function:

setRefId()

ilAwarenessAct::setRefId

(

$a_val

)

Set ref id.

Parameters

int

$a_val

ref id

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

    {
        $this->ref_id = $a_val;
    }

Field Documentation

$collector

ilAwarenessAct::$collector

staticprotected

Definition at line 22 of file class.ilAwarenessAct.php.

$instances

ilAwarenessAct::$instances = array()

staticprotected

Definition at line 19 of file class.ilAwarenessAct.php.

$lng

ilAwarenessAct::$lng

protected

Definition at line 17 of file class.ilAwarenessAct.php.

Referenced by notifyOnNewOnlineContacts().

$ref_id

ilAwarenessAct::$ref_id = 0

protected

Definition at line 21 of file class.ilAwarenessAct.php.

Referenced by getRefId().

$user_id

ilAwarenessAct::$user_id

protected

Definition at line 20 of file class.ilAwarenessAct.php.

---

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

• Services/Awareness/classes/class.ilAwarenessAct.php