class.ilTermsOfServiceHelper.php

Go to the documentation of this file.

<?php declare(strict_types=1);
/* Copyright (c) 1998-2018 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilTermsOfServiceHelper
{
    protected $database;

    protected $dataGatewayFactory;

    public function __construct(
        ilDBInterface $database = null,
        ilTermsOfServiceDataGatewayFactory $dataGatewayFactory = null
    ) {
        global $DIC;

        if (null === $database) {
            $database = $DIC->database();
        }
        $this->database = $database;

        if (null === $dataGatewayFactory) {
            $dataGatewayFactory = new ilTermsOfServiceDataGatewayFactory();
            $dataGatewayFactory->setDatabaseAdapter($this->database);
        }
        $this->dataGatewayFactory = $dataGatewayFactory;
    }

    public static function isEnabled() : bool
    {
        global $DIC;

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

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

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

    public function deleteAcceptanceHistoryByUser(int $userId) : void
    {
        $entity = $this->getEntityFactory()->getByName('ilTermsOfServiceAcceptanceEntity');
        $databaseGateway = $this->getDataGatewayFactory()->getByName('ilTermsOfServiceAcceptanceDatabaseGateway');

        $databaseGateway->deleteAcceptanceHistoryByUser($entity->withUserId($userId));
    }

    public function getCurrentAcceptanceForUser(ilObjUser $user) : ilTermsOfServiceAcceptanceEntity
    {
        $entity = $this->getEntityFactory()->getByName('ilTermsOfServiceAcceptanceEntity');
        $databaseGateway = $this->getDataGatewayFactory()->getByName('ilTermsOfServiceAcceptanceDatabaseGateway');

        return $databaseGateway->loadCurrentAcceptanceOfUser($entity->withUserId((int) $user->getId()));
    }

    public function getById(int $id) : ilTermsOfServiceAcceptanceEntity
    {
        $entity = $this->getEntityFactory()->getByName('ilTermsOfServiceAcceptanceEntity');
        $databaseGateway = $this->getDataGatewayFactory()->getByName('ilTermsOfServiceAcceptanceDatabaseGateway');

        return $databaseGateway->loadById($entity->withId($id));
    }

    public function trackAcceptance(ilObjUser $user, ilTermsOfServiceSignableDocument $document) : void
    {
        $entity = $this->getEntityFactory()->getByName('ilTermsOfServiceAcceptanceEntity');
        $databaseGateway = $this->getDataGatewayFactory()->getByName('ilTermsOfServiceAcceptanceDatabaseGateway');

        $entity = $entity
            ->withUserId((int) $user->getId())
            ->withTimestamp(time())
            ->withText((string) $document->content())
            ->withHash(md5($document->content()))
            ->withDocumentId((int) $document->id())
            ->withTitle((string) $document->title());

        $criteriaBag = new ilTermsOfServiceAcceptanceHistoryCriteriaBag($document->criteria());
        $entity = $entity->withSerializedCriteria($criteriaBag->toJson());

        $databaseGateway->trackAcceptance($entity);

        $user->writeAccepted();

        $user->hasToAcceptTermsOfServiceInSession(false);
    }

    private function getEntityFactory() : ilTermsOfServiceEntityFactory
    {
        return new ilTermsOfServiceEntityFactory();
    }

    private function getDataGatewayFactory() : ilTermsOfServiceDataGatewayFactory
    {
        return $this->dataGatewayFactory;
    }
}