ilAccessibilitySequentialDocumentEvaluation Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilAccessibilitySequentialDocumentEvaluation:

Collaboration diagram for ilAccessibilitySequentialDocumentEvaluation:

Public Member Functions
	__construct (ilAccessibilityDocumentCriteriaEvaluation $evaluation, ilObjUser $user, ilLogger $log, array $possibleDocuments)
	document ()
	hasDocument ()

Protected Member Functions
	getMatchingDocuments ()

Protected Attributes
ilAccessibilityDocumentCriteriaEvaluation	$evaluation
ilObjUser	$user
array	$matchingDocuments = null
array	$possibleDocuments = []
ilLogger	$log

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Interface ilAccessibilitySequentialDocumentEvaluation

Definition at line 22 of file class.ilAccessibilitySequentialDocumentEvaluation.php.

Constructor & Destructor Documentation

__construct()

ilAccessibilitySequentialDocumentEvaluation::__construct	(	ilAccessibilityDocumentCriteriaEvaluation	$evaluation,
		ilObjUser	$user,
		ilLogger	$log,
		array	$possibleDocuments
	)

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

References $evaluation, $log, $possibleDocuments, $user, and ILIAS\Repository\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()

ilAccessibilitySequentialDocumentEvaluation::document

(

)

Returns

ilAccessibilitySignableDocument

Exceptions

ilAccessibilityNoSignableDocumentFoundException

Implements ilAccessibilityDocumentEvaluation.

Definition at line 73 of file class.ilAccessibilitySequentialDocumentEvaluation.php.

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

                              : ilAccessibilitySignableDocument
    {
        $matchingDocuments = $this->getMatchingDocuments();
        if (count($matchingDocuments) > 0) {
            return $matchingDocuments[0];
        }

        throw new ilAccessibilityNoSignableDocumentFoundException(sprintf(
            'Could not find any accessibility control concept document for the passed user (id: %s|login: %s)',
            $this->user->getId(),
            $this->user->getLogin()
        ));
    }

Here is the call graph for this function:

getMatchingDocuments()

ilAccessibilitySequentialDocumentEvaluation::getMatchingDocuments ( )

protected

Returns

ilAccessibilitySignableDocument[]

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

References $matchingDocuments, null, and ILIAS\Repository\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()

ilAccessibilitySequentialDocumentEvaluation::hasDocument

(

)

Returns

bool

Implements ilAccessibilityDocumentEvaluation.

Definition at line 87 of file class.ilAccessibilitySequentialDocumentEvaluation.php.

References getMatchingDocuments().

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

Here is the call graph for this function:

Field Documentation

$evaluation

ilAccessibilityDocumentCriteriaEvaluation ilAccessibilitySequentialDocumentEvaluation::$evaluation

protected

Definition at line 24 of file class.ilAccessibilitySequentialDocumentEvaluation.php.

Referenced by __construct().

$log

ilLogger ilAccessibilitySequentialDocumentEvaluation::$log

protected

Definition at line 30 of file class.ilAccessibilitySequentialDocumentEvaluation.php.

Referenced by __construct().

$matchingDocuments

array ilAccessibilitySequentialDocumentEvaluation::$matchingDocuments = null

protected

Definition at line 27 of file class.ilAccessibilitySequentialDocumentEvaluation.php.

Referenced by getMatchingDocuments().

$possibleDocuments

array ilAccessibilitySequentialDocumentEvaluation::$possibleDocuments = []

protected

Definition at line 29 of file class.ilAccessibilitySequentialDocumentEvaluation.php.

Referenced by __construct().

$user

ilObjUser ilAccessibilitySequentialDocumentEvaluation::$user

protected

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

Referenced by __construct().

---

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

• components/ILIAS/Accessibility/classes/Document/class.ilAccessibilitySequentialDocumentEvaluation.php