class.ilObjRemoteGroup.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilObjRemoteGroup extends ilRemoteObjectBase
{
    public const DB_TABLE_NAME = "rgrp_settings";

    public const ACTIVATION_OFFLINE = 1;
    public const ACTIVATION_UNLIMITED = 0;
    public const ACTIVATION_LIMITED = 2;

    protected $availability_type;
    protected $end;
    protected $start;

    public function initType(): void
    {
        $this->type = "rgrp";
    }

    protected function getTableName(): string
    {
        return self::DB_TABLE_NAME;
    }

    protected function getECSObjectType(): string
    {
        return "/campusconnect/groups";
    }

    public function setAvailabilityType($a_type)
    {
        $this->availability_type = $a_type;
    }

    public function getAvailabilityType()
    {
        return $this->availability_type;
    }

    public function setStartingTime($a_time)
    {
        $this->start = $a_time;
    }

    public function getStartingTime()
    {
        return $this->start;
    }

    public function setEndingTime($a_time)
    {
        $this->end = $a_time;
    }

    public function getEndingTime()
    {
        return $this->end;
    }

    public static function _lookupOnline($a_obj_id)
    {
        global $ilDB;

        $query = "SELECT * FROM " . self::DB_TABLE_NAME .
            " WHERE obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " ";
        $res = $ilDB->query($query);
        $row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT);
        switch ($row->availability_type) {
            case self::ACTIVATION_UNLIMITED:
                return true;

            case self::ACTIVATION_OFFLINE:
                return false;

            case self::ACTIVATION_LIMITED:
                return time() > $row->r_start && time < $row->r_end;

            default:
                return false;
        }

        return false;
    }

    protected function doCreateCustomFields(array &$a_fields): void
    {
        $a_fields["availability_type"] = array("integer", 0);
        $a_fields["availability_start"] = array("integer", 0);
        $a_fields["availability_end"] = array("integer", 0);
    }

    protected function doUpdateCustomFields(array &$a_fields): void
    {
        $a_fields["availability_type"] = array("integer", (int) $this->getAvailabilityType());
        $a_fields["availability_start"] = array("integer", (int) $this->getStartingTime());
        $a_fields["availability_end"] = array("integer", (int) $this->getEndingTime());
    }

    protected function doReadCustomFields($a_row): void
    {
        $this->setAvailabilityType($a_row->availability_type);
        $this->setStartingTime($a_row->availability_start);
        $this->setEndingTime($a_row->availability_end);
    }

    protected function updateCustomFromECSContent(ilECSSetting $a_server, $a_ecs_content): void
    {
        // add custom values
        // $this->setAvailabilityType($a_ecs_content->status == 'online' ? self::ACTIVATION_UNLIMITED : self::ACTIVATION_OFFLINE);

        // :TODO: ACTIVATION_LIMITED is currently not supported in ECS yet
    }
}