ilAccessibilityDocument 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 ilAccessibilityDocument:

Collaboration diagram for ilAccessibilityDocument:

Public Member Functions
	content ()
	title ()
	id ()
	read ()
	buildFromArray (array $array)
	criteria ()
	detachCriterion (ilAccessibilityDocumentCriterionAssignment $criterionAssignment)
Public Member Functions inherited from ActiveRecord
	getArConnector ()
	getArFieldList ()
	getConnectorContainerName ()
	Return the Name of your Connector Table More...
	setConnectorContainerName (string $connector_container_name)
	getPrimaryFieldValue ()
	setPrimaryFieldValue ($value)
	__construct ($primary_key=0)
	storeObjectToCache ()
	asStdClass ()
	buildFromArray (array $array)
	fixDateField ($field_name, $value)
	sleep ($field_name)
	wakeUp ($field_name, $field_value)
	getArrayForConnector ()
	installConnector ()
	store ()
	save ()
	create ()
	copy (int $new_id=0)
	afterObjectLoad ()
	read ()
	update ()
	delete ()
	__call ($name, $arguments)

Static Public Member Functions
static	returnDbTableName ()
Static Public Member Functions inherited from ActiveRecord
static	returnDbTableName ()
static	installDB ()
static	renameDBField (string $old_name, string $new_name)
static	tableExists ()
static	fieldExists (string $field_name)
static	removeDBField (string $field_name)
static	updateDB ()
static	resetDB ()
static	truncateDB ()
static	flushDB ()
	never use in ILIAS Core, Plugins only More...
static	preloadObjects ()
static	additionalParams (array $additional_params)
static	findOrFail ($primary_key, array $add_constructor_args=array())
	Tries to find the object and throws an Exception if object is not found, instead of returning null. More...
static	findOrGetInstance ($primary_key, array $add_constructor_args=array())
static	where ($where, $operator=null)
static	innerjoinAR (ActiveRecord $ar, $on_this, $on_external, array $fields=array(' *'), string $operator='=', $both_external=false)
static	innerjoin ( $tablename, $on_this, $on_external, array $fields=array(' *'), string $operator='=', bool $both_external=false)
static	leftjoin ( $tablename, $on_this, $on_external, array $fields=array(' *'), string $operator='=', bool $both_external=false)
static	orderBy ($orderBy, string $orderDirection='ASC')
static	dateFormat (string $date_format='d.m.Y - H:i:s')
static	limit ($start, $end)
static	affectedRows ()
static	count ()
static	get ()
static	debug ()
static	first ()
static	getCollection ()
static	last ()
static	getFirstFromLastQuery ()
static	connector (arConnector $connector)
static	raw (bool $set_raw=true)
static	getArray (?string $key=null, $values=null)
static	_toCamelCase (string $str, bool $capitalise_first_char=false)

Data Fields
const	TABLE_NAME = 'acc_documents'

Protected Attributes
int	$id
int	$creation_ts = 0
int	$modification_ts = 0
int	$owner_usr_id = 0
int	$last_modified_usr_id = 0
int	$sorting = 0
string	$title = ''
string	$text = ''
array	$criteria = []
array	$initialPersistedCriteria = []
Protected Attributes inherited from ActiveRecord
bool	$ar_safe_read = true
string	$connector_container_name = ''
bool	$is_new = true

Private Attributes
bool	$criteriaFetched = false

Additional Inherited Members
Protected Member Functions inherited from ActiveRecord
	installDatabase ()
Static Protected Member Functions inherited from ActiveRecord
static	getCalledClass ()
	Returns an instance of the instatiated calling active record (needs to be done in static methods) : This should be cached somehow More...
static	fromCamelCase (string $str)

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 Class ilAccessibilityDocument

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

Member Function Documentation

buildFromArray()

ilAccessibilityDocument::buildFromArray

(

array

$array

)

Definition at line 130 of file class.ilAccessibilityDocument.php.

References $criteria, ActiveRecord\count(), ActiveRecord\create(), criteria(), ILIAS\Survey\Mode\getId(), and ActiveRecord\update().

                                                : \ActiveRecord
    {
        $document = parent::buildFromArray($array);

        $this->fetchAllCriterionAssignments();

        return $document;
    }

Here is the call graph for this function:

content()

ilAccessibilityDocument::content

(

)

Returns

string

Implements ilAccessibilitySignableDocument.

Definition at line 108 of file class.ilAccessibilityDocument.php.

References $text.

                             : string
    {
        return $this->text;
    }

criteria()

ilAccessibilityDocument::criteria

(

)

Returns

ilAccessibilityEvaluableCriterion[]

Implements ilAccessibilitySignableDocument.

Definition at line 195 of file class.ilAccessibilityDocument.php.

References $criteria, ilAccessibilityDocumentCriterionAssignment\getCriterionId(), and ilAccessibilityDocumentCriterionAssignment\getCriterionValue().

Referenced by buildFromArray(), and detachCriterion().

                              : array
    {
        return $this->criteria;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

detachCriterion()

ilAccessibilityDocument::detachCriterion

(

ilAccessibilityDocumentCriterionAssignment

$criterionAssignment

)

Exceptions

OutOfBoundsException

Definition at line 222 of file class.ilAccessibilityDocument.php.

References $criteria, ActiveRecord\count(), criteria(), ilAccessibilityDocumentCriterionAssignment\equals(), ilAccessibilityDocumentCriterionAssignment\getCriterionId(), ilAccessibilityDocumentCriterionAssignment\getCriterionValue(), ILIAS\Survey\Mode\getId(), and ActiveRecord\where().

                                                                                                    : void
    {
        $numCriteriaBeforeRemoval = count($this->criteria);

        $this->criteria = array_filter(
            $this->criteria,
            function (ilAccessibilityDocumentCriterionAssignment $currentAssignment) use ($criterionAssignment) {
                return !$currentAssignment->equals($criterionAssignment);
            }
        );

        $numCriteriaAfterRemoval = count($this->criteria);

        if ($numCriteriaAfterRemoval === $numCriteriaBeforeRemoval) {
            throw new OutOfBoundsException(sprintf(
                "Could not find any criterion with criterion typeIdent %s and value: %s",
                $criterionAssignment->getCriterionId(),
                var_export($criterionAssignment->getCriterionValue(), true)
            ));
        }
    }

Here is the call graph for this function:

id()

ilAccessibilityDocument::id

(

)

Returns

int

Implements ilAccessibilitySignableDocument.

Definition at line 118 of file class.ilAccessibilityDocument.php.

References $id.

                        : int
    {
        return (int) $this->id;
    }

read()

ilAccessibilityDocument::read

(

)

Definition at line 123 of file class.ilAccessibilityDocument.php.

                          : void
    {
        parent::read();

        $this->fetchAllCriterionAssignments();
    }

returnDbTableName()

static ilAccessibilityDocument::returnDbTableName ( )

static

Definition at line 103 of file class.ilAccessibilityDocument.php.

                                              : string
    {
        return self::TABLE_NAME;
    }

title()

ilAccessibilityDocument::title

(

)

Returns

string

Implements ilAccessibilitySignableDocument.

Definition at line 113 of file class.ilAccessibilityDocument.php.

References $title.

                           : string
    {
        return $this->title;
    }

Field Documentation

$creation_ts

int ilAccessibilityDocument::$creation_ts = 0

protected

Definition at line 42 of file class.ilAccessibilityDocument.php.

$criteria

array ilAccessibilityDocument::$criteria = []

protected

Definition at line 94 of file class.ilAccessibilityDocument.php.

Referenced by buildFromArray(), criteria(), and detachCriterion().

$criteriaFetched

bool ilAccessibilityDocument::$criteriaFetched = false

private

Definition at line 101 of file class.ilAccessibilityDocument.php.

$id

int ilAccessibilityDocument::$id

protected

Definition at line 34 of file class.ilAccessibilityDocument.php.

Referenced by id().

$initialPersistedCriteria

array ilAccessibilityDocument::$initialPersistedCriteria = []

protected

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

$last_modified_usr_id

int ilAccessibilityDocument::$last_modified_usr_id = 0

protected

Definition at line 66 of file class.ilAccessibilityDocument.php.

$modification_ts

int ilAccessibilityDocument::$modification_ts = 0

protected

Definition at line 50 of file class.ilAccessibilityDocument.php.

$owner_usr_id

int ilAccessibilityDocument::$owner_usr_id = 0

protected

Definition at line 58 of file class.ilAccessibilityDocument.php.

$sorting

int ilAccessibilityDocument::$sorting = 0

protected

Definition at line 74 of file class.ilAccessibilityDocument.php.

$text

string ilAccessibilityDocument::$text = ''

protected

Definition at line 89 of file class.ilAccessibilityDocument.php.

Referenced by content().

$title

string ilAccessibilityDocument::$title = ''

protected

Definition at line 82 of file class.ilAccessibilityDocument.php.

Referenced by title().

TABLE_NAME

const ilAccessibilityDocument::TABLE_NAME = 'acc_documents'

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

---

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

• Services/Accessibility/classes/Document/class.ilAccessibilityDocument.php