ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
ilOrgUnitPathStorage Class Reference

Class ilOrgUnitPathStorage. More...

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

Public Member Functions

 store ()
 
 getConnectorContainerName ()
 @description Return the Name of your Connector Table More...
 
 getRefId ()
 
 setRefId (int $ref_id)
 
 getPath ()
 
 setPath (string $path)
 
 getObjId ()
 
 setObjId (int $obj_id)
 
- Public Member Functions inherited from ActiveRecord
 getArConnector ()
 
 getArFieldList ()
 
 getConnectorContainerName ()
 @description Return the Name of your Connector Table More...
 
 setConnectorContainerName (string $connector_container_name)
 
 getPrimaryFieldValue ()
 
 setPrimaryFieldValue ($value)
 
 __construct (mixed $primary_key=0)
 
 storeObjectToCache ()
 
 asStdClass ()
 
 asArray ()
 
 buildFromArray (array $array)
 
 fixDateField ($field_name, string $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 getAllOrguRefIds ()
 
static getTextRepresentationOfOrgUnits (bool $sort_by_title=true)
 Get ref id path array. More...
 
- 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 ()
 @depracated never use in ILIAS Core, Plugins only More...
 
static preloadObjects ()
 
static additionalParams (array $additional_params)
 
static findOrFail ($primary_key, array $add_constructor_args=[])
 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=[])
 
static where ($where, $operator=null)
 
static innerjoinAR (ActiveRecord $activeRecord, $on_this, string $on_external, array $fields=[' *'], string $operator='=', bool $both_external=false)
 
static innerjoin (string $tablename, $on_this, string $on_external, array $fields=[' *'], string $operator='=', bool $both_external=false)
 
static leftjoin (string $tablename, $on_this, string $on_external, array $fields=[' *'], string $operator='=', bool $both_external=false)
 
static orderBy (string $orderBy, string $orderDirection='ASC')
 
static dateFormat (string $date_format='d.m.Y - H:i:s')
 
static limit (int $start, int $end)
 
static affectedRows ()
 
static count ()
 
static get ()
 
static debug ()
 
static first ()
 
static getCollection ()
 
static last ()
 
static getFirstFromLastQuery ()
 
static connector (arConnector $arConnector)
 
static raw (bool $set_raw=true)
 
static getArray (?string $key=null, string|array|null $values=null)
 
static _toCamelCase (string $str, bool $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
 

Protected Attributes

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

Static Protected Attributes

static array $orgu_names = array()
 

Additional Inherited Members

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

Detailed Description

Member Function Documentation

◆ getAllOrguRefIds()

static ilOrgUnitPathStorage::getAllOrguRefIds ( )
static
Returns
string[]

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

60 : array
61 {
62 $names = self::getAllOrguNames();
63
64 return array_keys($names);
65 }

Referenced by ilCronUpdateOrgUnitPaths\run().

+ Here is the caller graph for this function:

◆ getConnectorContainerName()

ilOrgUnitPathStorage::getConnectorContainerName ( )

@description Return the Name of your Connector Table

Reimplemented from ActiveRecord.

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

203 : string
204 {
205 return self::TABLE_NAME;
206 }

References TABLE_NAME.

◆ getObjId()

ilOrgUnitPathStorage::getObjId ( )

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

228 : int
229 {
230 return $this->obj_id;
231 }

References $obj_id.

◆ getPath()

ilOrgUnitPathStorage::getPath ( )

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

218 : string
219 {
220 return $this->path;
221 }

References $path.

◆ getRefId()

ilOrgUnitPathStorage::getRefId ( )

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

208 : int
209 {
210 return $this->ref_id;
211 }

References $ref_id.

Referenced by store().

+ Here is the caller graph for this function:

◆ getTextRepresentationOfOrgUnits()

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

Get ref id path array.

Parameters
bool$sort_by_title
Returns
array

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

125 : array
126 {
127 if ($sort_by_title) {
128 return ilOrgUnitPathStorage::orderBy('path')->getArray('ref_id', 'path');
129 }
130 return ilOrgUnitPathStorage::getArray('ref_id', 'path');
131 }
static getArray(?string $key=null, string|array|null $values=null)
static orderBy(string $orderBy, string $orderDirection='ASC')

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

Referenced by ilUserSearchOptions\_getSearchableFieldsInfo(), ilMStListCoursesTableGUI\getTextRepresentationOfOrgUnits(), ilMStShowUserCoursesTableGUI\getTextRepresentationOfOrgUnits(), ilParticipantTableGUI\initFilter(), ILIAS\MyStaff\ListCertificates\ilMStListCertificatesTableGUI\initFilter(), ILIAS\MyStaff\ListCompetences\Skills\ilMStListCompetencesSkillsTableGUI\initFilter(), and ILIAS\MyStaff\ListUsers\ilMStListUsersTableGUI\initFilter().

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

◆ setObjId()

ilOrgUnitPathStorage::setObjId ( int  $obj_id)

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

233 : void
234 {
235 $this->obj_id = $obj_id;
236 }

References $obj_id.

◆ setPath()

ilOrgUnitPathStorage::setPath ( string  $path)

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

223 : void
224 {
225 $this->path = $path;
226 }

References $path.

◆ setRefId()

ilOrgUnitPathStorage::setRefId ( int  $ref_id)

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

213 : void
214 {
215 $this->ref_id = $ref_id;
216 }

References $ref_id.

◆ store()

ilOrgUnitPathStorage::store ( )

Reimplemented from ActiveRecord.

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

67 : void
68 {
69 if (self::where(array('ref_id' => $this->getRefId()))->hasSets()) {
70 $this->update();
71 } else {
72 $this->create();
73 }
74 }

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

+ Here is the call graph for this function:

Field Documentation

◆ $obj_id

int ilOrgUnitPathStorage::$obj_id = 0
protected

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

Referenced by getObjId(), and setObjId().

◆ $orgu_names

array ilOrgUnitPathStorage::$orgu_names = array()
staticprotected

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

◆ $path

string ilOrgUnitPathStorage::$path = ''
protected

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

Referenced by getPath(), and setPath().

◆ $ref_id

int ilOrgUnitPathStorage::$ref_id = 0
protected

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

Referenced by getRefId(), and setRefId().

◆ GLUE

const ilOrgUnitPathStorage::GLUE = ' > '

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

◆ GLUE_SIMPLE

const ilOrgUnitPathStorage::GLUE_SIMPLE = ' - '

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

◆ MAX_MIDDLE_PATH_LENGTH

const ilOrgUnitPathStorage::MAX_MIDDLE_PATH_LENGTH = 50

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

◆ ORG_SEPARATOR

const ilOrgUnitPathStorage::ORG_SEPARATOR = ' | '

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

◆ TABLE_NAME

const ilOrgUnitPathStorage::TABLE_NAME = 'orgu_path_storage'

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

Referenced by getConnectorContainerName().


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