ILIAS  release_8 Revision v8.19
All Data Structures Namespaces Files Functions Variables Modules Pages
ilTermsOfServiceLogicalAndDocumentCriteriaEvaluation Class Reference

Interface ilTermsOfServiceLogicalAndDocumentCriteriaEvaluation. More...

+ Inheritance diagram for ilTermsOfServiceLogicalAndDocumentCriteriaEvaluation:
+ Collaboration diagram for ilTermsOfServiceLogicalAndDocumentCriteriaEvaluation:

Public Member Functions

 __construct (ilTermsOfServiceCriterionTypeFactoryInterface $criterionTypeFactory, ilObjUser $user, ilLogger $log)
 
 withContextUser (ilObjUser $user)
 Returns a criteria evaluator like this with the passed context user. More...
 
 evaluate (ilTermsOfServiceSignableDocument $document)
 Evaluates a document for the context given by the concrete implementation. More...
 

Protected Attributes

ilTermsOfServiceCriterionTypeFactoryInterface $criterionTypeFactory
 
ilObjUser $user
 
ilLogger $log
 

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

ilTermsOfServiceLogicalAndDocumentCriteriaEvaluation::__construct ( ilTermsOfServiceCriterionTypeFactoryInterface  $criterionTypeFactory,
ilObjUser  $user,
ilLogger  $log 
)

Member Function Documentation

◆ evaluate()

ilTermsOfServiceLogicalAndDocumentCriteriaEvaluation::evaluate ( ilTermsOfServiceSignableDocument  $document)

Evaluates a document for the context given by the concrete implementation.

Parameters
ilTermsOfServiceSignableDocument$document
Returns
bool

Implements ilTermsOfServiceDocumentCriteriaEvaluation.

Definition at line 49 of file class.ilTermsOfServiceLogicalAndDocumentCriteriaEvaluation.php.

References ilTermsOfServiceSignableDocument\criteria(), ilTermsOfServiceSignableDocument\id(), ilTermsOfServiceSignableDocument\title(), and ILIAS\Repository\user().

49  : bool
50  {
51  $this->log->debug(sprintf(
52  'Evaluating criteria for document "%s" (id: %s) and user "%s" (id: %s)',
53  $document->title(),
54  $document->id(),
55  $this->user->getLogin(),
56  $this->user->getId()
57  ));
58 
59  foreach ($document->criteria() as $criterionAssignment) {
60  $criterionType = $this->criterionTypeFactory->findByTypeIdent($criterionAssignment->getCriterionId(), true);
61 
62  $result = $criterionType->evaluate($this->user, $criterionAssignment->getCriterionValue());
63 
64  $this->log->debug(sprintf(
65  'Criterion of type "%s", configured with %s evaluated: %s',
66  $criterionType->getTypeIdent(),
67  var_export($criterionAssignment->getCriterionValue()->toJson(), true),
68  var_export($result, true)
69  ));
70 
71  if (!$result) {
72  return false;
73  }
74  }
75 
76  return true;
77  }
+ Here is the call graph for this function:

◆ withContextUser()

ilTermsOfServiceLogicalAndDocumentCriteriaEvaluation::withContextUser ( ilObjUser  $user)

Returns a criteria evaluator like this with the passed context user.

Parameters
ilObjUser$user
Returns
ilTermsOfServiceDocumentCriteriaEvaluation

Implements ilTermsOfServiceDocumentCriteriaEvaluation.

Definition at line 41 of file class.ilTermsOfServiceLogicalAndDocumentCriteriaEvaluation.php.

References $user.

42  {
43  $clone = clone $this;
44  $clone->user = $user;
45 
46  return $clone;
47  }

Field Documentation

◆ $criterionTypeFactory

ilTermsOfServiceCriterionTypeFactoryInterface ilTermsOfServiceLogicalAndDocumentCriteriaEvaluation::$criterionTypeFactory
protected

◆ $log

ilLogger ilTermsOfServiceLogicalAndDocumentCriteriaEvaluation::$log
protected

◆ $user

ilObjUser ilTermsOfServiceLogicalAndDocumentCriteriaEvaluation::$user
protected

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