ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilTermsOfServiceHelper Class Reference
+ Collaboration diagram for ilTermsOfServiceHelper:

Static Public Member Functions

static deleteAcceptanceHistoryByUser ($usr_id)
 
static getCurrentAcceptanceForUser (ilObjUser $user)
 
static getById ($id)
 
static trackAcceptance (ilObjUser $user, ilTermsOfServiceSignableDocument $document)
 

Static Private Member Functions

static getEntityFactory ()
 

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

40 {
41 $entity = self::getEntityFactory()->getByName('ilTermsOfServiceAcceptanceEntity');
42 $data_gateway = self::getDataGatewayFactory()->getByName('ilTermsOfServiceAcceptanceDatabaseGateway');
43 $entity->setUserId($usr_id);
44 $data_gateway->deleteAcceptanceHistoryByUser($entity);
45 }

References getEntityFactory().

Referenced by ilTermsOfServiceAppEventListener\handleEvent().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getById()

static ilTermsOfServiceHelper::getById (   $id)
static
Parameters
integer$id
Returns
ilTermsOfServiceAcceptanceEntity

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

64 {
65 $entity = self::getEntityFactory()->getByName('ilTermsOfServiceAcceptanceEntity');
66 $data_gateway = self::getDataGatewayFactory()->getByName('ilTermsOfServiceAcceptanceDatabaseGateway');
67 $entity->setId($id);
68 return $data_gateway->loadById($entity);
69 }

References getEntityFactory().

Referenced by ilObjTermsOfServiceGUI\getAcceptedContentAsynch().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getCurrentAcceptanceForUser()

static ilTermsOfServiceHelper::getCurrentAcceptanceForUser ( ilObjUser  $user)
static
Parameters
ilObjUser$user
Returns
ilTermsOfServiceAcceptanceEntity

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

52 {
53 $entity = self::getEntityFactory()->getByName('ilTermsOfServiceAcceptanceEntity');
54 $data_gateway = self::getDataGatewayFactory()->getByName('ilTermsOfServiceAcceptanceDatabaseGateway');
55 $entity->setUserId($user->getId());
56 return $data_gateway->loadCurrentAcceptanceOfUser($entity);
57 }
getId()
get object id @access public

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

+ Here is the call graph for this function:

◆ getEntityFactory()

static ilTermsOfServiceHelper::getEntityFactory ( )
staticprivate
Returns
ilTermsOfServiceEntityFactory

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

100 {
101 require_once 'Services/TermsOfService/classes/class.ilTermsOfServiceEntityFactory.php';
103 }

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

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

76 {
77 if(self::isEnabled())
78 {
79 $entity = self::getEntityFactory()->getByName('ilTermsOfServiceAcceptanceEntity');
80 $data_gateway = self::getDataGatewayFactory()->getByName('ilTermsOfServiceAcceptanceDatabaseGateway');
81 $entity->setUserId($user->getId());
82 $entity->setTimestamp(time());
83 $entity->setIso2LanguageCode($document->getIso2LanguageCode());
84 $entity->setSource($document->getSource());
85 $entity->setSourceType($document->getSourceType());
86 $entity->setText($document->getContent());
87 $entity->setHash(md5($document->getContent()));
88 $data_gateway->trackAcceptance($entity);
89
90 $user->writeAccepted(); // <- Has to be refactored in future releases
91
93 }
94 }
writeAccepted()
write accept date of user agreement to db
hasToAcceptTermsOfServiceInSession($status=null)

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

+ Here is the call graph for this function:

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