ilTermsOfServiceSequentialDocumentEvaluation Class Reference

Interface ilTermsOfServiceSequentialDocumentEvaluation. More...

Inheritance diagram for ilTermsOfServiceSequentialDocumentEvaluation:

Collaboration diagram for ilTermsOfServiceSequentialDocumentEvaluation:

Public Member Functions
	__construct (ilTermsOfServiceDocumentCriteriaEvaluation $evaluation, ilObjUser $user, ilLogger $log, array $possibleDocuments)
	ilTermsOfServiceDocumentLogicalAndCriteriaEvaluation constructor. More...
	document ()
	Returns ilTermsOfServiceSignableDocument Exceptions ilTermsOfServiceNoSignableDocumentFoundException More...
	hasDocument ()
	Returns bool More...

Protected Member Functions
	getMatchingDocuments ()

Protected Attributes
	$evaluation
	$user
	$matchingDocuments = null
	$possibleDocuments = []
	$log

Detailed Description

Interface ilTermsOfServiceSequentialDocumentEvaluation.

Author

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

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

Constructor & Destructor Documentation

__construct()

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

ilTermsOfServiceDocumentLogicalAndCriteriaEvaluation constructor.

Parameters

ilTermsOfServiceDocumentCriteriaEvaluation	$evaluation
ilObjUser	$user
ilLogger	$log
	ilTermsOfServiceSignableDocument[]	$possibleDocuments

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

References $evaluation, $log, $possibleDocuments, $user, and user().

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

Here is the call graph for this function:

Member Function Documentation

document()

ilTermsOfServiceSequentialDocumentEvaluation::document

(

)

Returns

ilTermsOfServiceSignableDocument

Exceptions

ilTermsOfServiceNoSignableDocumentFoundException

Implements ilTermsOfServiceDocumentEvaluation.

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

References $matchingDocuments, getMatchingDocuments(), and user().

                               : 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()
        ));
    }

Here is the call graph for this function:

getMatchingDocuments()

ilTermsOfServiceSequentialDocumentEvaluation::getMatchingDocuments ( )

protected

Returns

ilTermsOfServiceSignableDocument[]

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

References $matchingDocuments, and user().

Referenced by document(), and hasDocument().

                                              : array
    {
        if (null === $this->matchingDocuments) {
            $this->matchingDocuments = [];

            $this->log->debug(sprintf(
                'Evaluating document for user "%s" (id: %s) ...',
                $this->user->getLogin(),
                $this->user->getId()
            ));

            foreach ($this->possibleDocuments as $document) {
                if ($this->evaluation->evaluate($document)) {
                    $this->matchingDocuments[] = $document;
                }
            }

            $this->log->debug(sprintf(
                '%s matching document(s) found',
                count($this->matchingDocuments)
            ));
        }

        return $this->matchingDocuments;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

hasDocument()

ilTermsOfServiceSequentialDocumentEvaluation::hasDocument

(

)

Returns

bool

Implements ilTermsOfServiceDocumentEvaluation.

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

References getMatchingDocuments().

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

Here is the call graph for this function:

Field Documentation

$evaluation

ilTermsOfServiceSequentialDocumentEvaluation::$evaluation

protected

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

Referenced by __construct().

$log

ilTermsOfServiceSequentialDocumentEvaluation::$log

protected

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

Referenced by __construct().

$matchingDocuments

ilTermsOfServiceSequentialDocumentEvaluation::$matchingDocuments = null

protected

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

Referenced by document(), and getMatchingDocuments().

$possibleDocuments

ilTermsOfServiceSequentialDocumentEvaluation::$possibleDocuments = []

protected

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

Referenced by __construct().

$user

ilTermsOfServiceSequentialDocumentEvaluation::$user

protected

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

Referenced by __construct().

---

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

• Services/TermsOfService/classes/Document/class.ilTermsOfServiceSequentialDocumentEvaluation.php