ilTermsOfServiceHelper Class Reference

Class ilTermsOfServiceHelper. More...

Collaboration diagram for ilTermsOfServiceHelper:

Public Member Functions
	__construct (?ilTermsOfServiceDataGatewayFactory $dataGatewayFactory=null, ?ilTermsOfServiceDocumentEvaluation $termsOfServiceEvaluation=null, ?ilTermsOfServiceCriterionTypeFactoryInterface $criterionTypeFactory=null, ?ilObjTermsOfService $tos=null)
	isGloballyEnabled ()
	deleteAcceptanceHistoryByUser (int $userId)
	getCurrentAcceptanceForUser (ilObjUser $user)
	getById (int $id)
	trackAcceptance (ilObjUser $user, ilTermsOfServiceSignableDocument $document)
	resetAcceptance (ilObjUser $user)
	isIncludedUser (ilObjUser $user)
	hasToResignAcceptance (ilObjUser $user, ilLogger $logger)

Static Public Member Functions
static	isEnabled ()

Protected Attributes
ilTermsOfServiceDataGatewayFactory	$dataGatewayFactory
ilTermsOfServiceDocumentEvaluation	$termsOfServiceEvaluation
ilTermsOfServiceCriterionTypeFactoryInterface	$criterionTypeFactory
ilObjTermsOfService	$tos

Private Member Functions
	getEntityFactory ()
	getDataGatewayFactory ()

Detailed Description

Class ilTermsOfServiceHelper.

Author

Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Definition at line 25 of file class.ilTermsOfServiceHelper.php.

Constructor & Destructor Documentation

__construct()

ilTermsOfServiceHelper::__construct	(	?ilTermsOfServiceDataGatewayFactory	$dataGatewayFactory = null,
		?ilTermsOfServiceDocumentEvaluation	$termsOfServiceEvaluation = null,
		?ilTermsOfServiceCriterionTypeFactoryInterface	$criterionTypeFactory = null,
		?ilObjTermsOfService	$tos = null
	)

Definition at line 32 of file class.ilTermsOfServiceHelper.php.

References $criterionTypeFactory, $dataGatewayFactory, $DIC, $termsOfServiceEvaluation, $tos, and ilTermsOfServiceDataGatewayFactory\setDatabaseAdapter().

      {
        global $DIC;

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

        if (null === $termsOfServiceEvaluation) {
            $termsOfServiceEvaluation = $DIC['tos.document.evaluator'];
        }
        $this->termsOfServiceEvaluation = $termsOfServiceEvaluation;

        if (null === $criterionTypeFactory) {
            $criterionTypeFactory = $DIC['tos.criteria.type.factory'];
        }
        $this->criterionTypeFactory = $criterionTypeFactory;

        if (null === $tos) {
            $tos = new ilObjTermsOfService();
        }
        $this->tos = $tos;
    }

Here is the call graph for this function:

Member Function Documentation

deleteAcceptanceHistoryByUser()

ilTermsOfServiceHelper::deleteAcceptanceHistoryByUser

(

int

$userId

)

Parameters

int

$userId

Exceptions

ilTermsOfServiceMissingDatabaseAdapterException

Definition at line 76 of file class.ilTermsOfServiceHelper.php.

References getDataGatewayFactory(), and getEntityFactory().

                                                              : void
    {
        $entity = $this->getEntityFactory()->getByName('ilTermsOfServiceAcceptanceEntity');
        $databaseGateway = $this->getDataGatewayFactory()->getByName('ilTermsOfServiceAcceptanceDatabaseGateway');

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

Here is the call graph for this function:

getById()

ilTermsOfServiceHelper::getById

(

int

$id

)

Parameters

int

$id

Returns

ilTermsOfServiceAcceptanceEntity

Exceptions

ilTermsOfServiceMissingDatabaseAdapterException

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

References getDataGatewayFactory(), and getEntityFactory().

                                    : ilTermsOfServiceAcceptanceEntity
    {
        $entity = $this->getEntityFactory()->getByName('ilTermsOfServiceAcceptanceEntity');
        $databaseGateway = $this->getDataGatewayFactory()->getByName('ilTermsOfServiceAcceptanceDatabaseGateway');

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

Here is the call graph for this function:

getCurrentAcceptanceForUser()

ilTermsOfServiceHelper::getCurrentAcceptanceForUser

(

ilObjUser

$user

)

Parameters

ilObjUser

$user

Returns

ilTermsOfServiceAcceptanceEntity

Exceptions

ilTermsOfServiceMissingDatabaseAdapterException

Definition at line 89 of file class.ilTermsOfServiceHelper.php.

References getDataGatewayFactory(), getEntityFactory(), and ilObject\getId().

Referenced by hasToResignAcceptance().

                                                                : ilTermsOfServiceAcceptanceEntity
    {
        $entity = $this->getEntityFactory()->getByName('ilTermsOfServiceAcceptanceEntity');
        $databaseGateway = $this->getDataGatewayFactory()->getByName('ilTermsOfServiceAcceptanceDatabaseGateway');

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

Here is the call graph for this function:

Here is the caller graph for this function:

getDataGatewayFactory()

ilTermsOfServiceHelper::getDataGatewayFactory ( )

private

Definition at line 222 of file class.ilTermsOfServiceHelper.php.

References $dataGatewayFactory.

Referenced by deleteAcceptanceHistoryByUser(), getById(), getCurrentAcceptanceForUser(), and trackAcceptance().

                                            : ilTermsOfServiceDataGatewayFactory
    {
        return $this->dataGatewayFactory;
    }

Here is the caller graph for this function:

getEntityFactory()

ilTermsOfServiceHelper::getEntityFactory ( )

private

Definition at line 217 of file class.ilTermsOfServiceHelper.php.

Referenced by deleteAcceptanceHistoryByUser(), getById(), getCurrentAcceptanceForUser(), and trackAcceptance().

                                       : ilTermsOfServiceEntityFactory
    {
        return new ilTermsOfServiceEntityFactory();
    }

Here is the caller graph for this function:

hasToResignAcceptance()

ilTermsOfServiceHelper::hasToResignAcceptance	(	ilObjUser	$user,
		ilLogger	$logger
	)

Definition at line 163 of file class.ilTermsOfServiceHelper.php.

References ilLogger\debug(), ilObjUser\getAgreeDate(), getCurrentAcceptanceForUser(), ilObject\getId(), ilObjUser\getLogin(), isGloballyEnabled(), and isIncludedUser().

                                                                            : bool
    {
        $logger->debug(sprintf(
            'Checking reevaluation of Terms of Service for user "%s" (id: %s) ...',
            $user->getLogin(),
            $user->getId()
        ));

        if (!$this->isGloballyEnabled()) {
            $logger->debug('Terms of Service disabled, resigning not required ...');
            return false;
        }

        if (!$this->isIncludedUser($user)) {
            $logger->debug('User is not included for Terms of Service acceptance, resigning not required ...');
            return false;
        }

        if (!$this->tos->shouldReevaluateOnLogin()) {
            $logger->debug('Reevaluation of documents is not enabled, resigning not required ...');
            return false;
        }

        if (!$user->getAgreeDate()) {
            $logger->debug('Terms of Service currently not accepted by user, resigning not required ...');
            return false;
        }

        $evaluator = $this->termsOfServiceEvaluation->withContextUser($user);
        if (!$evaluator->hasDocument()) {
            $logger->debug('No signable Terms of Service document found, resigning not required ...');
            return false;
        }

        $entity = $this->getCurrentAcceptanceForUser($user);
        if (!($entity->getId() > 0)) {
            $logger->debug('No signed Terms of Service document found, resigning not required ...');
            return false;
        }

        $historizedDocument = new ilTermsOfServiceHistorizedDocument(
            $entity,
            new ilTermsOfServiceAcceptanceHistoryCriteriaBag($entity->getSerializedCriteria())
        );

        if ($evaluator->evaluateDocument($historizedDocument)) {
            $logger->debug('Current user values do still match historized criteria, resigning not required ...');
            return false;
        }

        $logger->debug('Current user values do not match historized criteria, resigning required ...');
        return true;
    }

Here is the call graph for this function:

isEnabled()

static ilTermsOfServiceHelper::isEnabled ( )

static

Definition at line 62 of file class.ilTermsOfServiceHelper.php.

Referenced by ilObjUser\_getUsersOnline(), ILIAS\Awareness\User\Collector\collectUsers(), ilObjUser\hasToAcceptTermsOfService(), ilObjUser\hasToAcceptTermsOfServiceInSession(), ilAccountRegistrationGUI\initForm(), ilAccountRegistrationGUI\saveForm(), and ilPersonalProfileGUI\showUserAgreement().

                                      : bool
    {
        return (new self())->tos->getStatus();
    }

Here is the caller graph for this function:

isGloballyEnabled()

ilTermsOfServiceHelper::isGloballyEnabled

(

)

Definition at line 67 of file class.ilTermsOfServiceHelper.php.

Referenced by hasToResignAcceptance().

                                       : bool
    {
        return $this->tos->getStatus();
    }

Here is the caller graph for this function:

isIncludedUser()

ilTermsOfServiceHelper::isIncludedUser

(

ilObjUser

$user

)

Definition at line 145 of file class.ilTermsOfServiceHelper.php.

References ANONYMOUS_USER_ID, ilObject\getId(), ilObjUser\getLogin(), ilObjUser\isAnonymous(), and SYSTEM_USER_ID.

Referenced by hasToResignAcceptance().

                                                   : bool
    {
        $excluded_roles = [];
        if (defined('ANONYMOUS_USER_ID')) {
            $excluded_roles[] = ANONYMOUS_USER_ID;
        }
        if (defined('SYSTEM_USER_ID')) {
            $excluded_roles[] = SYSTEM_USER_ID;
        }

        return (
            'root' !== $user->getLogin() &&
            !in_array($user->getId(), $excluded_roles, true) &&
            !$user->isAnonymous() &&
            $user->getId() > 0
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

resetAcceptance()

ilTermsOfServiceHelper::resetAcceptance

(

ilObjUser

$user

)

Definition at line 139 of file class.ilTermsOfServiceHelper.php.

References ilObjUser\setAgreeDate(), and ilObjUser\update().

                                                    : void
    {
        $user->setAgreeDate(null);
        $user->update();
    }

Here is the call graph for this function:

trackAcceptance()

ilTermsOfServiceHelper::trackAcceptance	(	ilObjUser	$user,
		ilTermsOfServiceSignableDocument	$document
	)

Parameters

ilObjUser	$user
ilTermsOfServiceSignableDocument	$document

Exceptions

ilTermsOfServiceMissingDatabaseAdapterException
ilTermsOfServiceUnexpectedCriteriaBagContentException

Definition at line 116 of file class.ilTermsOfServiceHelper.php.

References ilTermsOfServiceSignableDocument\content(), ilTermsOfServiceSignableDocument\criteria(), getDataGatewayFactory(), getEntityFactory(), ilObject\getId(), ilObjUser\hasToAcceptTermsOfServiceInSession(), ilTermsOfServiceSignableDocument\id(), ilTermsOfServiceSignableDocument\title(), and ilObjUser\writeAccepted().

                                                                                                : void
    {
        $entity = $this->getEntityFactory()->getByName('ilTermsOfServiceAcceptanceEntity');
        $databaseGateway = $this->getDataGatewayFactory()->getByName('ilTermsOfServiceAcceptanceDatabaseGateway');

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

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

        $databaseGateway->trackAcceptance($entity);

        $user->writeAccepted();

        $user->hasToAcceptTermsOfServiceInSession(false);
    }

Here is the call graph for this function:

Field Documentation

$criterionTypeFactory

ilTermsOfServiceCriterionTypeFactoryInterface ilTermsOfServiceHelper::$criterionTypeFactory

protected

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

Referenced by __construct().

$dataGatewayFactory

ilTermsOfServiceDataGatewayFactory ilTermsOfServiceHelper::$dataGatewayFactory

protected

Definition at line 27 of file class.ilTermsOfServiceHelper.php.

Referenced by __construct(), and getDataGatewayFactory().

$termsOfServiceEvaluation

ilTermsOfServiceDocumentEvaluation ilTermsOfServiceHelper::$termsOfServiceEvaluation

protected

Definition at line 28 of file class.ilTermsOfServiceHelper.php.

Referenced by __construct().

$tos

ilObjTermsOfService ilTermsOfServiceHelper::$tos

protected

Definition at line 30 of file class.ilTermsOfServiceHelper.php.

Referenced by __construct().

---

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

• Services/TermsOfService/classes/class.ilTermsOfServiceHelper.php