ILIAS  release_7 Revision v7.30-3-g800a261c036
All Data Structures Namespaces Files Functions Variables Modules Pages
ilAccessibilityDocument Class Reference

Class ilAccessibilityDocument. More...

+ Inheritance diagram for ilAccessibilityDocument:
+ Collaboration diagram for ilAccessibilityDocument:

Public Member Functions

 content ()
 
Returns
string
More...
 
 title ()
 
Returns
string
More...
 
 id ()
 
Returns
int
More...
 
 read ()
 
 buildFromArray (array $array)
 
 criteria ()
 
Returns
ilAccessibilityEvaluableCriterion[]
More...
 
 detachCriterion (ilAccessibilityDocumentCriterionAssignment $criterionAssignment)
 
- Public Member Functions inherited from ActiveRecord
 getArConnector ()
 
 getArFieldList ()
 
 getConnectorContainerName ()
 
 setConnectorContainerName ($connector_container_name)
 
 getPrimaryFieldValue ()
 
 setPrimaryFieldValue ($value)
 
 __construct ($primary_key=0, arConnector $connector=null)
 
 storeObjectToCache ()
 
 __getConvertedDateFieldsAsArray ($format=null)
 
 __asCsv ($separator=';', $header=false)
 
 __asArray ()
 
 __asStdClass ()
 
 __asSerializedObject ()
 
 buildFromArray (array $array)
 
 fixDateField ($field_name, $value)
 
 sleep ($field_name)
 
 wakeUp ($field_name, $field_value)
 
 getArrayForDb ()
 
 getArrayForConnector ()
 
 installConnector ()
 
 store ()
 
 save ()
 
 create ()
 
 copy ($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 ($old_name, $new_name)
 
static tableExists ()
 
static fieldExists ($field_name)
 
static removeDBField ($field_name)
 
static updateDB ()
 
static resetDB ()
 
static truncateDB ()
 
static flushDB ()
 
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, $fields=array(' *'), $operator='=', $both_external=false)
 
static innerjoin ($tablename, $on_this, $on_external, $fields=array(' *'), $operator='=', $both_external=false)
 
static leftjoin ($tablename, $on_this, $on_external, $fields=array(' *'), $operator='=', $both_external=false)
 
static orderBy ($orderBy, $orderDirection='ASC')
 
static dateFormat ($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 ($set_raw=true)
 
static getArray ($key=null, $values=null)
 
static _toCamelCase ($str, $capitalise_first_char=false)
 

Data Fields

const TABLE_NAME = 'acc_documents'
 
- Data Fields inherited from ActiveRecord
const ACTIVE_RECORD_VERSION = '2.0.7'
 

Protected Attributes

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

Private Attributes

 $criteriaFetched = false
 

Additional Inherited Members

- Protected Member Functions inherited from ActiveRecord
 serializeToCSV ($field)
 This method is called for every field of your instance if you use __asCsv. More...
 
 installDatabase ()
 
- Static Protected Member Functions inherited from ActiveRecord
static getCalledClass ()
 
static fromCamelCase ($str)
 

Detailed Description

Class ilAccessibilityDocument.

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

Member Function Documentation

◆ buildFromArray()

ilAccessibilityDocument::buildFromArray ( array  $array)

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

References $criteria, ActiveRecord\count(), ActiveRecord\create(), criteria(), and ActiveRecord\update().

137  {
138  $document = parent::buildFromArray($array);
139 
140  $this->fetchAllCriterionAssignments();
141 
142  return $document;
143  }
+ Here is the call graph for this function:

◆ content()

ilAccessibilityDocument::content ( )

Returns
string

Implements ilAccessibilitySignableDocument.

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

References $text.

102  : string
103  {
104  return $this->text;
105  }

◆ criteria()

ilAccessibilityDocument::criteria ( )

Returns
ilAccessibilityEvaluableCriterion[]

Implements ilAccessibilitySignableDocument.

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

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

Referenced by buildFromArray(), and detachCriterion().

213  : array
214  {
215  return $this->criteria;
216  }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ detachCriterion()

ilAccessibilityDocument::detachCriterion ( ilAccessibilityDocumentCriterionAssignment  $criterionAssignment)
Parameters
ilAccessibilityDocumentCriterionAssignment
Exceptions
OutOfBoundsException

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

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

242  : void
243  {
244  $numCriteriaBeforeRemoval = count($this->criteria);
245 
246  $this->criteria = array_filter(
247  $this->criteria,
248  function (ilAccessibilityDocumentCriterionAssignment $currentAssignment) use ($criterionAssignment) {
249  return !$currentAssignment->equals($criterionAssignment);
250  }
251  );
252 
253  $numCriteriaAfterRemoval = count($this->criteria);
254 
255  if ($numCriteriaAfterRemoval === $numCriteriaBeforeRemoval) {
256  throw new OutOfBoundsException(sprintf(
257  "Could not find any criterion with criterion typeIdent %s and value: %s",
258  $criterionAssignment->getCriterionId(),
259  var_export($criterionAssignment->getCriterionValue(), true)
260  ));
261  }
262  }
criteria()
ilAccessibilityEvaluableCriterion[]
+ 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.

118  : int
119  {
120  return (int) $this->id;
121  }

◆ read()

ilAccessibilityDocument::read ( )

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

127  {
128  parent::read();
129 
130  $this->fetchAllCriterionAssignments();
131  }

◆ returnDbTableName()

static ilAccessibilityDocument::returnDbTableName ( )
static

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

95  {
96  return self::TABLE_NAME;
97  }

◆ title()

ilAccessibilityDocument::title ( )

Returns
string

Implements ilAccessibilitySignableDocument.

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

References $title.

110  : string
111  {
112  return $this->title;
113  }

Field Documentation

◆ $creation_ts

ilAccessibilityDocument::$creation_ts = 0
protected

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

◆ $criteria

ilAccessibilityDocument::$criteria = []
protected

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

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

◆ $criteriaFetched

ilAccessibilityDocument::$criteriaFetched = false
private

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

◆ $id

ilAccessibilityDocument::$id
protected

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

Referenced by id().

◆ $initialPersistedCriteria

ilAccessibilityDocument::$initialPersistedCriteria = []
protected

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

◆ $last_modified_usr_id

ilAccessibilityDocument::$last_modified_usr_id = 0
protected

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

◆ $modification_ts

ilAccessibilityDocument::$modification_ts = 0
protected

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

◆ $owner_usr_id

ilAccessibilityDocument::$owner_usr_id = 0
protected

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

◆ $sorting

ilAccessibilityDocument::$sorting = 0
protected

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

◆ $text

ilAccessibilityDocument::$text = ''
protected

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

Referenced by content().

◆ $title

ilAccessibilityDocument::$title = ''
protected

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

Referenced by title().

◆ TABLE_NAME

const ilAccessibilityDocument::TABLE_NAME = 'acc_documents'

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


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