ILIAS  trunk Revision v13.0_alpha-62-g3b72d83f2e5
Public Member Functions | Static Public Member Functions | Data Fields | Protected Attributes
ilObjectGroupAR 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 ilObjectGroupAR:
+ Collaboration diagram for ilObjectGroupAR:

Public Member Functions

 getId ()
 
 setId (int $id)
 
 getDisplay ()
 
 setDisplay (string $a_val)
 
 getDisplayWithTitleAndToggleableInitially ()
 
 setDisplayWithTitleAndToggleableInitially (string $a_val)
 
 getListPresentation ()
 
 setListPresentation (string $a_val)
 
 getTileSize ()
 
 setTileSize (int $a_val)
 
- 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 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 ()
 @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 DISPLAY = 'display'
 
const DISPLAY_WITHOUT_TITLE = 'without_title'
 
const DISPLAY_WITH_TITLE = 'with_title'
 
const DISPLAY_WITH_TITLE_AND_TOGGLEABLE = 'with_title_and_toggleable'
 
const DISPLAY_WITH_TITLE_AND_TOGGLEABLE_INITIALLY = self::DISPLAY_WITH_TITLE_AND_TOGGLEABLE . '_initially'
 
const DISPLAY_WITH_TITLE_AND_TOGGLEABLE_INITIALLY_CLOSED = self::DISPLAY_WITH_TITLE_AND_TOGGLEABLE_INITIALLY . '_closed'
 
const DISPLAY_WITH_TITLE_AND_TOGGLEABLE_INITIALLY_OPEN = self::DISPLAY_WITH_TITLE_AND_TOGGLEABLE_INITIALLY . '_open'
 

Protected Attributes

int $id
 
string $display = self::DISPLAY_WITH_TITLE
 
string $toggleable_initially = self::DISPLAY_WITH_TITLE_AND_TOGGLEABLE_INITIALLY_OPEN
 
string $list_presentation = ""
 
int $tile_size = 0
 
- Protected Attributes inherited from ActiveRecord
bool $ar_safe_read = true
 
string $connector_container_name = ''
 
bool $is_new = true
 

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

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 Object group active record class

Author
Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Member Function Documentation

◆ getDisplay()

ilObjectGroupAR::getDisplay ( )

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

102 : string
103 {
104 return $this->display ?? self::DISPLAY_WITH_TITLE;
105 }

References DISPLAY_WITH_TITLE.

◆ getDisplayWithTitleAndToggleableInitially()

ilObjectGroupAR::getDisplayWithTitleAndToggleableInitially ( )

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

112 : string
113 {
114 return $this->toggleable_initially ?? self::DISPLAY_WITH_TITLE_AND_TOGGLEABLE_INITIALLY_OPEN;
115 }
ilObjectGroupAR\DISPLAY_WITH_TITLE_AND_TOGGLEABLE_INITIALLY_OPEN
const DISPLAY_WITH_TITLE_AND_TOGGLEABLE_INITIALLY_OPEN
Definition: class.ilObjectGroupAR.php:32

References DISPLAY_WITH_TITLE_AND_TOGGLEABLE_INITIALLY_OPEN.

◆ getId()

ilObjectGroupAR::getId ( )

Definition at line 92 of file class.ilObjectGroupAR.php.

92 : int
93 {
94 return $this->id;
95 }

References $id.

◆ getListPresentation()

ilObjectGroupAR::getListPresentation ( )

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

122 : string
123 {
124 return (string) $this->list_presentation;
125 }

References $list_presentation.

◆ getTileSize()

ilObjectGroupAR::getTileSize ( )

Definition at line 132 of file class.ilObjectGroupAR.php.

132 : int
133 {
134 return (int) $this->tile_size;
135 }

References $tile_size.

◆ returnDbTableName()

static ilObjectGroupAR::returnDbTableName ( )
static
Returns
never
Exceptions

arException

Deprecated:

Reimplemented from ActiveRecord.

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

34 : string
35 {
36 return 'obgr_data';
37 }

◆ setDisplay()

ilObjectGroupAR::setDisplay ( string  $a_val)

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

107 : void
108 {
109 $this->display = $a_val;
110 }

◆ setDisplayWithTitleAndToggleableInitially()

ilObjectGroupAR::setDisplayWithTitleAndToggleableInitially ( string  $a_val)

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

117 : void
118 {
119 $this->toggleable_initially = $a_val;
120 }

◆ setId()

ilObjectGroupAR::setId ( int  $id)

Definition at line 97 of file class.ilObjectGroupAR.php.

97 : void
98 {
99 $this->id = $id;
100 }

References $id.

◆ setListPresentation()

ilObjectGroupAR::setListPresentation ( string  $a_val)

Definition at line 127 of file class.ilObjectGroupAR.php.

127 : void
128 {
129 $this->list_presentation = $a_val;
130 }

◆ setTileSize()

ilObjectGroupAR::setTileSize ( int  $a_val)

Definition at line 137 of file class.ilObjectGroupAR.php.

137 : void
138 {
139 $this->tile_size = $a_val;
140 }

Field Documentation

◆ $display

string ilObjectGroupAR::$display = self::DISPLAY_WITH_TITLE
protected

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

◆ $id

int ilObjectGroupAR::$id
protected

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

Referenced by getId(), and setId().

◆ $list_presentation

string ilObjectGroupAR::$list_presentation = ""
protected

Definition at line 80 of file class.ilObjectGroupAR.php.

Referenced by getListPresentation().

◆ $tile_size

int ilObjectGroupAR::$tile_size = 0
protected

Definition at line 90 of file class.ilObjectGroupAR.php.

Referenced by getTileSize().

◆ $toggleable_initially

string ilObjectGroupAR::$toggleable_initially = self::DISPLAY_WITH_TITLE_AND_TOGGLEABLE_INITIALLY_OPEN
protected

Definition at line 70 of file class.ilObjectGroupAR.php.

◆ DISPLAY

const ilObjectGroupAR::DISPLAY = 'display'

Definition at line 26 of file class.ilObjectGroupAR.php.

Referenced by ilObjObjectGroupGUI\initEditCustomForm().

◆ DISPLAY_WITH_TITLE

const ilObjectGroupAR::DISPLAY_WITH_TITLE = 'with_title'

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

Referenced by getDisplay(), ilObjObjectGroup\getShowTitle(), ilObjObjectGroupGUI\initEditCustomForm(), ILIAS\ObjectGroup\Setup\ilObjectGroupDisplayMigration\mapLegacyValues(), ilObjectGroupDataSet\resolveDisplay(), and ILIAS\ObjectGroup\Setup\ilObjectGroupDBUpdateSteps\step_3().

◆ DISPLAY_WITH_TITLE_AND_TOGGLEABLE

const ilObjectGroupAR::DISPLAY_WITH_TITLE_AND_TOGGLEABLE = 'with_title_and_toggleable'

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

Referenced by ilObjObjectGroup\getBehaviour(), ilObjObjectGroup\getShowTitle(), ilObjObjectGroupGUI\initEditCustomForm(), ILIAS\ObjectGroup\Setup\ilObjectGroupDisplayMigration\mapLegacyValues(), and ilObjectGroupDataSet\resolveDisplay().

◆ DISPLAY_WITH_TITLE_AND_TOGGLEABLE_INITIALLY

const ilObjectGroupAR::DISPLAY_WITH_TITLE_AND_TOGGLEABLE_INITIALLY = self::DISPLAY_WITH_TITLE_AND_TOGGLEABLE . '_initially'

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

Referenced by ilObjObjectGroupGUI\initEditCustomForm().

◆ DISPLAY_WITH_TITLE_AND_TOGGLEABLE_INITIALLY_CLOSED

const ilObjectGroupAR::DISPLAY_WITH_TITLE_AND_TOGGLEABLE_INITIALLY_CLOSED = self::DISPLAY_WITH_TITLE_AND_TOGGLEABLE_INITIALLY . '_closed'

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

Referenced by ilObjObjectGroupGUI\initEditCustomForm(), ILIAS\ObjectGroup\Setup\ilObjectGroupDisplayMigration\mapLegacyValues(), and ilObjectGroupDataSet\resolveBehaviour().

◆ DISPLAY_WITH_TITLE_AND_TOGGLEABLE_INITIALLY_OPEN

const ilObjectGroupAR::DISPLAY_WITH_TITLE_AND_TOGGLEABLE_INITIALLY_OPEN = self::DISPLAY_WITH_TITLE_AND_TOGGLEABLE_INITIALLY . '_open'

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

Referenced by ilObjObjectGroup\getBehaviour(), getDisplayWithTitleAndToggleableInitially(), ilObjObjectGroupGUI\initEditCustomForm(), ILIAS\ObjectGroup\Setup\ilObjectGroupDisplayMigration\mapLegacyValues(), ilObjectGroupDataSet\resolveBehaviour(), and ILIAS\ObjectGroup\Setup\ilObjectGroupDBUpdateSteps\step_3().

◆ DISPLAY_WITHOUT_TITLE

const ilObjectGroupAR::DISPLAY_WITHOUT_TITLE = 'without_title'

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

Referenced by ilObjObjectGroupGUI\initEditCustomForm(), ILIAS\ObjectGroup\Setup\ilObjectGroupDisplayMigration\mapLegacyValues(), and ilObjectGroupDataSet\resolveDisplay().

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