class.ilTermsOfServiceHelper.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2012 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilTermsOfServiceHelper
{
    public static function isEnabled()
    {
        global $DIC;

        return (bool) $DIC['ilSetting']->get('tos_status', 0);
    }

    public static function setStatus($status)
    {
        global $DIC;

        $DIC['ilSetting']->set('tos_status', (int) $status);
    }

    public static function deleteAcceptanceHistoryByUser($usr_id)
    {
        $entity       = self::getEntityFactory()->getByName('ilTermsOfServiceAcceptanceEntity');
        $data_gateway = self::getDataGatewayFactory()->getByName('ilTermsOfServiceAcceptanceDatabaseGateway');
        $entity->setUserId($usr_id);
        $data_gateway->deleteAcceptanceHistoryByUser($entity);
    }

    public static function getCurrentAcceptanceForUser(ilObjUser $user)
    {
        $entity       = self::getEntityFactory()->getByName('ilTermsOfServiceAcceptanceEntity');
        $data_gateway = self::getDataGatewayFactory()->getByName('ilTermsOfServiceAcceptanceDatabaseGateway');
        $entity->setUserId($user->getId());
        return $data_gateway->loadCurrentAcceptanceOfUser($entity);
    }

    public static function getById($id)
    {
        $entity       = self::getEntityFactory()->getByName('ilTermsOfServiceAcceptanceEntity');
        $data_gateway = self::getDataGatewayFactory()->getByName('ilTermsOfServiceAcceptanceDatabaseGateway');
        $entity->setId($id);
        return $data_gateway->loadById($entity);
    }

    public static function trackAcceptance(ilObjUser $user, ilTermsOfServiceSignableDocument $document)
    {
        if (self::isEnabled() && $document->exists()) {
            $entity       = self::getEntityFactory()->getByName('ilTermsOfServiceAcceptanceEntity');
            $data_gateway = self::getDataGatewayFactory()->getByName('ilTermsOfServiceAcceptanceDatabaseGateway');
            $entity->setUserId($user->getId());
            $entity->setTimestamp(time());
            $entity->setIso2LanguageCode($document->getIso2LanguageCode());
            $entity->setSource($document->getSource());
            $entity->setSourceType($document->getSourceType());
            $entity->setText($document->getContent());
            $entity->setHash(md5($document->getContent()));
            $data_gateway->trackAcceptance($entity);

            $user->writeAccepted(); // <- Has to be refactored in future releases

            $user->hasToAcceptTermsOfServiceInSession(false);
        }
    }

    private static function getEntityFactory()
    {
        require_once 'Services/TermsOfService/classes/class.ilTermsOfServiceEntityFactory.php';
        return new ilTermsOfServiceEntityFactory();
    }

    private static function getDataGatewayFactory()
    {
        global $DIC;

        require_once 'Services/TermsOfService/classes/class.ilTermsOfServiceDataGatewayFactory.php';
        $factory = new ilTermsOfServiceDataGatewayFactory();
        $factory->setDatabaseAdapter($DIC['ilDB']);
        return $factory;
    }
}