Collaboration diagram for ilTermsOfServiceHelper:

Public Member Functions
	__construct (\ilDBInterface $database=null, \ilTermsOfServiceDataGatewayFactory $dataGatewayFactory=null)
	ilTermsOfServiceHelper constructor. More...

	deleteAcceptanceHistoryByUser (int $userId)

	getCurrentAcceptanceForUser (\ilObjUser $user)

	getById (int $id)

	trackAcceptance (\ilObjUser $user, \ilTermsOfServiceSignableDocument $document)

Static Public Member Functions
static	isEnabled ()

static	setStatus (bool $status)

Protected Attributes
	$database

	$dataGatewayFactory

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 8 of file class.ilTermsOfServiceHelper.php.

Constructor & Destructor Documentation

◆ __construct()

ilTermsOfServiceHelper::__construct	(	\ilDBInterface	$database = `null`,
		\ilTermsOfServiceDataGatewayFactory	$dataGatewayFactory = `null`
	)

ilTermsOfServiceHelper constructor.

Parameters

\ilDBInterface \| null	$database
\ilTermsOfServiceDataGatewayFactory \| null	$dataGatewayFactory

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

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

References $database, $dataGatewayFactory, and $DIC.

Member Function Documentation

◆ deleteAcceptanceHistoryByUser()

ilTermsOfServiceHelper::deleteAcceptanceHistoryByUser ( int $userId )

Parameters

int $userId

Exceptions

ilTermsOfServiceMissingDatabaseAdapterException

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

    {
        $entity = $this->getEntityFactory()->getByName('ilTermsOfServiceAcceptanceEntity');
        $databaseGateway = $this->getDataGatewayFactory()->getByName('ilTermsOfServiceAcceptanceDatabaseGateway');
 
        $databaseGateway->deleteAcceptanceHistoryByUser($entity->withUserId($userId));
    }

References getDataGatewayFactory(), and getEntityFactory().

Here is the call graph for this function:

◆ getById()

ilTermsOfServiceHelper::getById ( int $id )

Parameters

int $id

Returns: \ilTermsOfServiceAcceptanceEntity

Exceptions

ilTermsOfServiceMissingDatabaseAdapterException

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

                                     : \ilTermsOfServiceAcceptanceEntity
    {
        $entity = $this->getEntityFactory()->getByName('ilTermsOfServiceAcceptanceEntity');
        $databaseGateway = $this->getDataGatewayFactory()->getByName('ilTermsOfServiceAcceptanceDatabaseGateway');
 
        return $databaseGateway->loadById($entity->withId($id));
    }

References $id, getDataGatewayFactory(), and getEntityFactory().

Here is the call graph for this function:

◆ getCurrentAcceptanceForUser()

ilTermsOfServiceHelper::getCurrentAcceptanceForUser ( \ilObjUser $user )

Parameters

\ilObjUser $user

Returns: \ilTermsOfServiceAcceptanceEntity

Exceptions

ilTermsOfServiceMissingDatabaseAdapterException

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

                                                                  : \ilTermsOfServiceAcceptanceEntity
    {
        $entity = $this->getEntityFactory()->getByName('ilTermsOfServiceAcceptanceEntity');
        $databaseGateway = $this->getDataGatewayFactory()->getByName('ilTermsOfServiceAcceptanceDatabaseGateway');
 
        return $databaseGateway->loadCurrentAcceptanceOfUser($entity->withUserId((int) $user->getId()));
    }

References $user, getDataGatewayFactory(), and getEntityFactory().

Here is the call graph for this function:

◆ getDataGatewayFactory()

ilTermsOfServiceHelper::getDataGatewayFactory ( )

private

Returns: \ilTermsOfServiceDataGatewayFactory

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

                                             : \ilTermsOfServiceDataGatewayFactory
    {
        return $this->dataGatewayFactory;
    }

References $dataGatewayFactory.

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

Here is the caller graph for this function:

◆ getEntityFactory()

ilTermsOfServiceHelper::getEntityFactory ( )

private

Returns: \ilTermsOfServiceEntityFactory

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

                                        : \ilTermsOfServiceEntityFactory
    {
        return new \ilTermsOfServiceEntityFactory();
    }

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

Here is the caller graph for this function:

◆ isEnabled()

static ilTermsOfServiceHelper::isEnabled ( )

static

Returns: bool

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

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

References $DIC.

Referenced by ilAccountRegistrationGUI\__initForm(), ilAwarenessUserCollector\collectUsers(), ilObjUser\hasToAcceptTermsOfService(), ilObjUser\hasToAcceptTermsOfServiceInSession(), ilAccountRegistrationGUI\saveForm(), ilStartUpGUI\showTermsOfService(), ilStartUpGUI\showTermsOfServiceLink(), and ilPersonalProfileGUI\showUserAgreement().

Here is the caller graph for this function:

◆ setStatus()

static ilTermsOfServiceHelper::setStatus ( bool $status )

static

Parameters

bool $status

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

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

References $DIC.

Referenced by ilObjTermsOfService\saveStatus().

Here is the caller graph for this function:

◆ trackAcceptance()

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

Parameters

\ilObjUser	$user
\ilTermsOfServiceSignableDocument	$document

Exceptions

ilTermsOfServiceMissingDatabaseAdapterException

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

    {
        $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);
    }