ilTermsOfServiceHelper Class Reference

Class ilTermsOfServiceHelper. More...

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.

References $database, $dataGatewayFactory, and $DIC.

      {
        global $DIC;

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

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

Member Function Documentation

deleteAcceptanceHistoryByUser()

ilTermsOfServiceHelper::deleteAcceptanceHistoryByUser

(

int

$userId

)

Parameters

int

$userId

Exceptions

ilTermsOfServiceMissingDatabaseAdapterException

Definition at line 63 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 89 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 76 of file class.ilTermsOfServiceHelper.php.

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

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

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

Here is the call graph for this function:

getDataGatewayFactory()

ilTermsOfServiceHelper::getDataGatewayFactory ( )

private

Returns

ilTermsOfServiceDataGatewayFactory

Definition at line 137 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

Returns

ilTermsOfServiceEntityFactory

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

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

                                        : ilTermsOfServiceEntityFactory
    {
        return new ilTermsOfServiceEntityFactory();
    }

Here is the caller graph for this function:

isEnabled()

static ilTermsOfServiceHelper::isEnabled ( )

static

Returns

bool

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

References $DIC.

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

                                       : bool
    {
        global $DIC;

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

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.

References $DIC.

Referenced by ilObjTermsOfService\saveStatus().

                                                   : void
    {
        global $DIC;

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

Here is the caller graph for this function:

trackAcceptance()

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

Parameters

ilObjUser	$user
ilTermsOfServiceSignableDocument	$document

Exceptions

ilTermsOfServiceMissingDatabaseAdapterException
ilTermsOfServiceUnexpectedCriteriaBagContentException

Definition at line 103 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((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);
    }

Here is the call graph for this function:

Field Documentation

$database

ilTermsOfServiceHelper::$database

protected

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

Referenced by __construct().

$dataGatewayFactory

ilTermsOfServiceHelper::$dataGatewayFactory

protected

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

Referenced by __construct(), and getDataGatewayFactory().

---

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

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