Inheritance diagram for ilTermsOfServiceDocument:

Collaboration diagram for ilTermsOfServiceDocument:

Public Member Functions
	content ()

	title ()

	id ()

	read ()

	buildFromArray (array $array)

	create ()

	update ()

	delete ()

	criteria ()

	attachCriterion (ilTermsOfServiceDocumentCriterionAssignment $criterionAssignment)

	detachCriterion (ilTermsOfServiceDocumentCriterionAssignment $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)

Protected Attributes
int	$id = null

int	$creation_ts = 0

int	$modification_ts = 0

int	$owner_usr_id = 0

int	$last_modified_usr_id = 0

int	$sorting = 0

string	$title = null

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
const	TABLE_NAME = 'tos_documents'

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

Class ilTermsOfServiceDocument.

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

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

Member Function Documentation

◆ attachCriterion()

ilTermsOfServiceDocument::attachCriterion ( ilTermsOfServiceDocumentCriterionAssignment $criterionAssignment )

Parameters

ilTermsOfServiceDocumentCriterionAssignment $criterionAssignment

Exceptions

ilTermsOfServiceDuplicateCriterionAssignmentException

Definition at line 201 of file class.ilTermsOfServiceDocument.php.

References criteria(), ilTermsOfServiceDocumentCriterionAssignment\getCriterionId(), and ilTermsOfServiceDocumentCriterionAssignment\getCriterionValue().

                                                                                                      : void
     {
         foreach ($this->criteria as $currentAssignment) {
             if ($currentAssignment->equals($criterionAssignment)) {
                 throw new ilTermsOfServiceDuplicateCriterionAssignmentException(sprintf(
                     'Cannot attach duplicate criterion with criterion typeIdent %s and value: %s',
                     $criterionAssignment->getCriterionId(),
                     var_export($criterionAssignment->getCriterionValue(), true)
                 ));
             }
         }
 
         $this->criteria[] = $criterionAssignment;
     }

Here is the call graph for this function:

◆ buildFromArray()

ilTermsOfServiceDocument::buildFromArray ( array $array )

Definition at line 129 of file class.ilTermsOfServiceDocument.php.

                                                 : ActiveRecord
     {
         $document = parent::buildFromArray($array);
 
         $this->fetchAllCriterionAssignments();
 
         return $document;
     }

◆ content()

ilTermsOfServiceDocument::content ( )

Implements ilTermsOfServiceSignableDocument.

Definition at line 107 of file class.ilTermsOfServiceDocument.php.

References $text.

                              : string
     {
         return $this->text;
     }

◆ create()

ilTermsOfServiceDocument::create ( )

Definition at line 138 of file class.ilTermsOfServiceDocument.php.

References $criteria, criteria(), and ILIAS\Survey\Mode\getId().

                             : void
     {
         $this->setCreationTs(time());
 
         parent::create();
 
         foreach ($this->criteria as $criterionAssignment) {
             $criterionAssignment->setDocId($this->getId());
             $criterionAssignment->store();
         }
 
         $this->initialPersistedCriteria = $this->criteria;
     }

Here is the call graph for this function:

◆ criteria()

ilTermsOfServiceDocument::criteria ( )

Returns: ilTermsOfServiceEvaluableCriterion[]

Implements ilTermsOfServiceSignableDocument.

Definition at line 192 of file class.ilTermsOfServiceDocument.php.

References $criteria.

Referenced by attachCriterion(), create(), delete(), detachCriterion(), and update().

                               : array
     {
         return $this->criteria;
     }

Here is the caller graph for this function:

◆ delete()

ilTermsOfServiceDocument::delete ( )

Definition at line 181 of file class.ilTermsOfServiceDocument.php.

References criteria().

                             : void
     {
         foreach ($this->initialPersistedCriteria as $criterionAssignment) {
             $criterionAssignment->delete();
         }
 
         $this->initialPersistedCriteria = $this->criteria = [];
 
         parent::delete();
     }

Here is the call graph for this function:

◆ detachCriterion()

ilTermsOfServiceDocument::detachCriterion ( ilTermsOfServiceDocumentCriterionAssignment $criterionAssignment )

Parameters

ilTermsOfServiceDocumentCriterionAssignment $criterionAssignment

Exceptions

OutOfBoundsException

Definition at line 220 of file class.ilTermsOfServiceDocument.php.

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

                                                                                                      : void
     {
         $numCriteriaBeforeRemoval = count($this->criteria);
 
         $this->criteria = array_filter(
             $this->criteria,
             static function (ilTermsOfServiceDocumentCriterionAssignment $currentAssignment) use (
                 $criterionAssignment
             ): bool {
                 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()

ilTermsOfServiceDocument::id ( )

Implements ilTermsOfServiceSignableDocument.

Definition at line 117 of file class.ilTermsOfServiceDocument.php.

References $id.

                         : int
     {
         return $this->id;
     }

◆ read()

ilTermsOfServiceDocument::read ( )

Definition at line 122 of file class.ilTermsOfServiceDocument.php.

                           : void
     {
         parent::read();
 
         $this->fetchAllCriterionAssignments();
     }

◆ returnDbTableName()

static ilTermsOfServiceDocument::returnDbTableName ( )

static

Definition at line 102 of file class.ilTermsOfServiceDocument.php.

                                               : string
     {
         return self::TABLE_NAME;
     }

◆ title()

ilTermsOfServiceDocument::title ( )

Implements ilTermsOfServiceSignableDocument.

Definition at line 112 of file class.ilTermsOfServiceDocument.php.

References $title.

                            : string
     {
         return $this->title;
     }

◆ update()

ilTermsOfServiceDocument::update ( )

Definition at line 152 of file class.ilTermsOfServiceDocument.php.

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

                             : void
     {
         $this->setModificationTs(time());
 
         foreach ($this->criteria as $criterionAssignment) {
             $criterionAssignment->setDocId($this->getId());
             $criterionAssignment->store();
         }
 
         foreach ($this->initialPersistedCriteria as $criterionAssignment) {
             $found = array_filter(
                 $this->criteria,
                 static function (ilTermsOfServiceDocumentCriterionAssignment $criterionToMatch) use (
                     $criterionAssignment
                 ): bool {
                     return $criterionToMatch->getId() === $criterionAssignment->getId();
                 }
             );
 
             if (0 === count($found)) {
                 $criterionAssignment->delete();
             }
         }
 
         $this->initialPersistedCriteria = $this->criteria;
 
         parent::update();
     }