Interface ilTermsOfServiceSequentialDocumentEvaluation. More...

Inheritance diagram for ilTermsOfServiceSequentialDocumentEvaluation:

Collaboration diagram for ilTermsOfServiceSequentialDocumentEvaluation:

Public Member Functions
	__construct (ilTermsOfServiceDocumentCriteriaEvaluation $evaluation, ilObjUser $user, ilLogger $log, array $possibleDocuments)

	withContextUser (ilObjUser $user)
	Returns an evaluator like this with the passed context user. More...

	evaluateDocument (ilTermsOfServiceSignableDocument $document)
	Evaluates the passed document for the context given in the concrete implementation. More...

	document ()
	Determines a document based on the context of the concrete implementation. More...

	hasDocument ()

	withContextUser (ilObjUser $user)
	Returns an evaluator like this with the passed context user. More...

	document ()
	Determines a document based on the context of the concrete implementation. More...

	hasDocument ()

	evaluateDocument (ilTermsOfServiceSignableDocument $document)
	Evaluates the passed document for the context given in the concrete implementation. More...

Protected Member Functions
	getMatchingDocuments ()

Protected Attributes
ilTermsOfServiceDocumentCriteriaEvaluation	$evaluation

ilObjUser	$user

array	$matchingDocumentsByUser = []

array	$possibleDocuments = []

ilLogger	$log

Detailed Description

Interface ilTermsOfServiceSequentialDocumentEvaluation.

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

Definition at line 25 of file class.ilTermsOfServiceSequentialDocumentEvaluation.php.

Constructor & Destructor Documentation

◆ __construct()

ilTermsOfServiceSequentialDocumentEvaluation::__construct	(	ilTermsOfServiceDocumentCriteriaEvaluation	$evaluation,
		ilObjUser	$user,
		ilLogger	$log,
		array	$possibleDocuments
	)

Definition at line 35 of file class.ilTermsOfServiceSequentialDocumentEvaluation.php.

      {
        $this->evaluation = $evaluation;
        $this->user = $user;
        $this->log = $log;
        $this->possibleDocuments = $possibleDocuments;
    }

References $evaluation, $log, $possibleDocuments, $user, and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ document()

ilTermsOfServiceSequentialDocumentEvaluation::document ( )

Determines a document based on the context of the concrete implementation.

Returns: ilTermsOfServiceSignableDocument

Exceptions

ilTermsOfServiceNoSignableDocumentFoundException

Implements ilTermsOfServiceDocumentEvaluation.

Definition at line 90 of file class.ilTermsOfServiceSequentialDocumentEvaluation.php.

                              : ilTermsOfServiceSignableDocument
    {
        $matchingDocuments = $this->getMatchingDocuments();
        if (count($matchingDocuments) > 0) {
            return $matchingDocuments[0];
        }
 
        throw new ilTermsOfServiceNoSignableDocumentFoundException(sprintf(
            'Could not find any terms of service document for the passed user (id: %s|login: %s)',
            $this->user->getId(),
            $this->user->getLogin()
        ));
    }

References getMatchingDocuments(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ evaluateDocument()

ilTermsOfServiceSequentialDocumentEvaluation::evaluateDocument ( ilTermsOfServiceSignableDocument $document )

Evaluates the passed document for the context given in the concrete implementation.

Parameters

ilTermsOfServiceSignableDocument $document

Returns: bool

Implements ilTermsOfServiceDocumentEvaluation.

Definition at line 85 of file class.ilTermsOfServiceSequentialDocumentEvaluation.php.

                                                                                : bool
    {
        return $this->evaluation->evaluate($document);
    }

Referenced by getMatchingDocuments().

Here is the caller graph for this function:

◆ getMatchingDocuments()

ilTermsOfServiceSequentialDocumentEvaluation::getMatchingDocuments ( )

protected

Returns: ilTermsOfServiceSignableDocument[]

Definition at line 59 of file class.ilTermsOfServiceSequentialDocumentEvaluation.php.

                                             : array
    {
        if (!array_key_exists($this->user->getId(), $this->matchingDocumentsByUser)) {
            $this->matchingDocumentsByUser[$this->user->getId()] = [];
 
            $this->log->debug(sprintf(
                'Evaluating document for user "%s" (id: %s) ...',
                $this->user->getLogin(),
                $this->user->getId()
            ));
 
            foreach ($this->possibleDocuments as $document) {
                if ($this->evaluateDocument($document)) {
                    $this->matchingDocumentsByUser[$this->user->getId()][] = $document;
                }
            }
 
            $this->log->debug(sprintf(
                '%s matching document(s) found',
                count($this->matchingDocumentsByUser[$this->user->getId()])
            ));
        }
 
        return $this->matchingDocumentsByUser[$this->user->getId()];
    }

References evaluateDocument(), and ILIAS\Repository\user().

Referenced by document(), and hasDocument().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasDocument()

ilTermsOfServiceSequentialDocumentEvaluation::hasDocument ( )

Implements ilTermsOfServiceDocumentEvaluation.

Definition at line 104 of file class.ilTermsOfServiceSequentialDocumentEvaluation.php.

                                 : bool
    {
        return count($this->getMatchingDocuments()) > 0;
    }

References getMatchingDocuments().

Here is the call graph for this function:

◆ withContextUser()

ilTermsOfServiceSequentialDocumentEvaluation::withContextUser ( ilObjUser $user )

Returns an evaluator like this with the passed context user.

Parameters

ilObjUser $user

Returns: ilTermsOfServiceDocumentEvaluation

Implements ilTermsOfServiceDocumentEvaluation.

Definition at line 47 of file class.ilTermsOfServiceSequentialDocumentEvaluation.php.

                                                    : ilTermsOfServiceDocumentEvaluation
    {
        $clone = clone $this;
        $clone->user = $user;
        $clone->evaluation = $clone->evaluation->withContextUser($user);
 
        return $clone;
    }