ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
ilOrgUnitPathStorage Class Reference

Class ilOrgUnitPathStorage. More...

+ Inheritance diagram for ilOrgUnitPathStorage:
+ Collaboration diagram for ilOrgUnitPathStorage:

Public Member Functions

 store ()
 
 getConnectorContainerName ()
 
 getRefId ()
 
 setRefId ($ref_id)
 
 getPath ()
 
 setPath ($path)
 
 getObjId ()
 
 setObjId ($obj_id)
 
- 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 getAllOrguRefIds ()
 
static getTextRepresentationOfOrgUnits ($sort_by_title=true)
 Get ref id path array. More...
 
- 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 GLUE = ' > '
 
const GLUE_SIMPLE = ' - '
 
const ORG_SEPARATOR = ' | '
 
const TABLE_NAME = 'orgu_path_storage'
 
const MAX_MIDDLE_PATH_LENGTH = 50
 
- Data Fields inherited from ActiveRecord
const ACTIVE_RECORD_VERSION = '2.0.7'
 

Protected Attributes

 $ref_id = 0
 
 $obj_id = 0
 
 $path = ''
 
- Protected Attributes inherited from ActiveRecord
 $ar_safe_read = true
 
 $connector_container_name = ''
 

Static Protected Attributes

static $orgu_names = array()
 

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

Member Function Documentation

◆ getAllOrguRefIds()

static ilOrgUnitPathStorage::getAllOrguRefIds ( )
static
Returns
array

Definition at line 49 of file class.ilOrgUnitPathStorage.php.

50 {
51 $names = self::getAllOrguNames();
52
53 return array_keys($names);
54 }

References $names.

Referenced by ilCronUpdateOrgUnitPaths\run().

+ Here is the caller graph for this function:

◆ getConnectorContainerName()

ilOrgUnitPathStorage::getConnectorContainerName ( )
Returns
string

Reimplemented from ActiveRecord.

Definition at line 244 of file class.ilOrgUnitPathStorage.php.

245 {
246 return self::TABLE_NAME;
247 }

References TABLE_NAME.

◆ getObjId()

ilOrgUnitPathStorage::getObjId ( )
Returns
int

Definition at line 289 of file class.ilOrgUnitPathStorage.php.

References $obj_id.

◆ getPath()

ilOrgUnitPathStorage::getPath ( )
Returns
string

Definition at line 271 of file class.ilOrgUnitPathStorage.php.

References $path.

◆ getRefId()

ilOrgUnitPathStorage::getRefId ( )
Returns
int

Definition at line 253 of file class.ilOrgUnitPathStorage.php.

References $ref_id.

Referenced by store().

+ Here is the caller graph for this function:

◆ getTextRepresentationOfOrgUnits()

static ilOrgUnitPathStorage::getTextRepresentationOfOrgUnits (   $sort_by_title = true)
static

Get ref id path array.

Parameters
bool$sort_by_title
Returns
array

Definition at line 111 of file class.ilOrgUnitPathStorage.php.

112 {
113 if ($sort_by_title) {
114 return ilOrgUnitPathStorage::orderBy('path')->getArray('ref_id', 'path');
115 } else {
116 return ilOrgUnitPathStorage::getArray('ref_id', 'path');
117 }
118 }
static getArray($key=null, $values=null)
static orderBy($orderBy, $orderDirection='ASC')

References ActiveRecord\getArray(), and ActiveRecord\orderBy().

Referenced by ilUserSearchOptions\_getSearchableFieldsInfo(), ilMStListCoursesGUI\getActions(), ilParticipantTableGUI\initFilter(), ilMStListCoursesTableGUI\initFilter(), and ilMStListUsersTableGUI\initFilter().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setObjId()

ilOrgUnitPathStorage::setObjId (   $obj_id)
Parameters
int$obj_id

Definition at line 298 of file class.ilOrgUnitPathStorage.php.

299 {
300 $this->obj_id = $obj_id;
301 }

References $obj_id.

◆ setPath()

ilOrgUnitPathStorage::setPath (   $path)
Parameters
string$path

Definition at line 280 of file class.ilOrgUnitPathStorage.php.

281 {
282 $this->path = $path;
283 }

References $path.

◆ setRefId()

ilOrgUnitPathStorage::setRefId (   $ref_id)
Parameters
int$ref_id

Definition at line 262 of file class.ilOrgUnitPathStorage.php.

263 {
264 $this->ref_id = $ref_id;
265 }

References $ref_id.

◆ store()

ilOrgUnitPathStorage::store ( )

Reimplemented from ActiveRecord.

Definition at line 57 of file class.ilOrgUnitPathStorage.php.

58 {
59 if (self::where(array( 'ref_id' => $this->getRefId() ))->hasSets()) {
60 $this->update();
61 } else {
62 $this->create();
63 }
64 }

References ActiveRecord\create(), getRefId(), and ActiveRecord\update().

+ Here is the call graph for this function:

Field Documentation

◆ $obj_id

ilOrgUnitPathStorage::$obj_id = 0
protected

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

Referenced by getObjId(), and setObjId().

◆ $orgu_names

ilOrgUnitPathStorage::$orgu_names = array()
staticprotected

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

◆ $path

ilOrgUnitPathStorage::$path = ''
protected

Definition at line 39 of file class.ilOrgUnitPathStorage.php.

Referenced by getPath(), and setPath().

◆ $ref_id

ilOrgUnitPathStorage::$ref_id = 0
protected

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

Referenced by getRefId(), and setRefId().

◆ GLUE

const ilOrgUnitPathStorage::GLUE = ' > '

Definition at line 10 of file class.ilOrgUnitPathStorage.php.

◆ GLUE_SIMPLE

const ilOrgUnitPathStorage::GLUE_SIMPLE = ' - '

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

◆ MAX_MIDDLE_PATH_LENGTH

const ilOrgUnitPathStorage::MAX_MIDDLE_PATH_LENGTH = 50

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

◆ ORG_SEPARATOR

const ilOrgUnitPathStorage::ORG_SEPARATOR = ' | '

Definition at line 12 of file class.ilOrgUnitPathStorage.php.

◆ TABLE_NAME

const ilOrgUnitPathStorage::TABLE_NAME = 'orgu_path_storage'

Definition at line 13 of file class.ilOrgUnitPathStorage.php.

Referenced by getConnectorContainerName().


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