class.ilAwarenessUserProvider.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2014 ILIAS open source, Extended GPL, see docs/LICENSE */

abstract class ilAwarenessUserProvider
{
    const MODE_INACTIVE = 0;
    const MODE_ONLINE_ONLY = 1;
    const MODE_INCL_OFFLINE = 2;

    protected $user_id;
    protected $ref_id;
    protected $lng;
    protected $db;
    protected $online_user_filter = false;

    protected $log;

    public function __construct()
    {
        global $DIC;

        $lng = $DIC->language();
        $ilDB = $DIC->database();

        $this->lng = $lng;
        $this->db = $ilDB;
        $this->settings = new ilSetting("awrn");
        $this->log = ilLoggerFactory::getLogger('awrn');
    }
    
    public function setActivationMode($a_val)
    {
        $this->settings->set("up_act_" . $this->getProviderId(), (int) $a_val);
    }

    public function getActivationMode()
    {
        return (int) $this->settings->get("up_act_" . $this->getProviderId());
    }

    public function setUserId($a_val)
    {
        $this->user_id = $a_val;
    }
    
    public function getUserId()
    {
        return $this->user_id;
    }

    public function setRefId($a_val)
    {
        $this->ref_id = $a_val;
    }
    
    public function getRefId()
    {
        return $this->ref_id;
    }
    
    public function setOnlineUserFilter($a_val)
    {
        $this->online_user_filter = $a_val;
    }

    public function getOnlineUserFilter()
    {
        return $this->online_user_filter;
    }

    abstract public function getProviderId();

    abstract public function getTitle();

    abstract public function getInfo();

    abstract public function getInitialUserSet();

    public function collectUsers() : \ilAwarenessUserCollection
    {
        $coll = ilAwarenessUserCollection::getInstance();

        foreach ($this->getInitialUserSet() as $u) {
            $this->addUserToCollection($u, $coll);
        }

        return $coll;
    }

    protected function addUserToCollection($a_user_id, ilAwarenessUserCollection $a_collection)
    {
        $ou = $this->getOnlineUserFilter();
        if ($this->getUserId() != $a_user_id && ($ou === false || in_array($a_user_id, $ou))) {
            $a_collection->addUser($a_user_id);
        }
    }

    public function isHighlighted()
    {
        return false;
    }
}