ilTermsOfServiceHelper Class Reference

Collaboration diagram for ilTermsOfServiceHelper:

Static Public Member Functions
static	isEnabled ()
static	setStatus ($status)
static	deleteAcceptanceHistoryByUser ($usr_id)
static	getCurrentAcceptanceForUser (ilObjUser $user)
static	getById ($id)
static	trackAcceptance (ilObjUser $user, ilTermsOfServiceSignableDocument $document)

Static Private Member Functions
static	getEntityFactory ()
static	getDataGatewayFactory ()

Detailed Description

Author

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

Version

$Id$

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

Member Function Documentation

deleteAcceptanceHistoryByUser()

static ilTermsOfServiceHelper::deleteAcceptanceHistoryByUser (   $usr_id )

static

Parameters

int

$usr_id

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

Referenced by ilTermsOfServiceAppEventListener\handleEvent().

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

Here is the caller graph for this function:

getById()

static ilTermsOfServiceHelper::getById (   $id )

static

Parameters

integer

$id

Returns

ilTermsOfServiceAcceptanceEntity

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

References $id.

Referenced by ilObjTermsOfServiceGUI\getAcceptedContentAsynch().

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

Here is the caller graph for this function:

getCurrentAcceptanceForUser()

static ilTermsOfServiceHelper::getCurrentAcceptanceForUser ( ilObjUser  $user )

static

Parameters

ilObjUser

$user

Returns

ilTermsOfServiceAcceptanceEntity

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

References ilObject\getId().

Referenced by ilObjUserGUI\handleIgnoredRequiredFields().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getDataGatewayFactory()

static ilTermsOfServiceHelper::getDataGatewayFactory ( )

staticprivate

Returns

ilTermsOfServiceDataGatewayFactory

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

References $DIC, and $factory.

    {
        global $DIC;

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

getEntityFactory()

static ilTermsOfServiceHelper::getEntityFactory ( )

staticprivate

Returns

ilTermsOfServiceEntityFactory

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

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

isEnabled()

static ilTermsOfServiceHelper::isEnabled ( )

static

Returns

bool

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

References $DIC.

Referenced by ilAccountRegistrationGUI\__initForm(), ilObjUser\_getAssociatedUsersOnline(), ilObjUser\_writeHistory(), ilAwarenessUserCollector\collectUsers(), ilObjTermsOfService\getStatus(), ilObjUser\hasToAcceptTermsOfService(), ilObjUser\hasToAcceptTermsOfServiceInSession(), ilAccountRegistrationGUI\saveForm(), and ilStartUpGUI\showRegistrationLinks().

    {
        global $DIC;

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

Here is the caller graph for this function:

setStatus()

static ilTermsOfServiceHelper::setStatus (   $status )

static

Parameters

bool

$status

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

References $DIC.

Referenced by ilObjTermsOfService\saveStatus().

    {
        global $DIC;

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

Here is the caller graph for this function:

trackAcceptance()

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

static

Parameters

ilObjUser	$user
ilTermsOfServiceSignableDocument	$document

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

References ilTermsOfServiceSignableDocument\exists(), ilTermsOfServiceSignableDocument\getContent(), ilObject\getId(), ilTermsOfServiceSignableDocument\getIso2LanguageCode(), ilTermsOfServiceSignableDocument\getSource(), ilTermsOfServiceSignableDocument\getSourceType(), ilObjUser\hasToAcceptTermsOfServiceInSession(), time, and ilObjUser\writeAccepted().

Referenced by ilStartUpGUI\getAcceptance(), and ilAccountRegistrationGUI\saveForm().

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

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

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