ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
ilBiblField 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 ilBiblField:
+ Collaboration diagram for ilBiblField:

Public Member Functions

 getConnectorContainerName ()
 @description Return the Name of your Connector Table More...
 
 getId ()
 
 setId (int $id)
 
 getIdentifier ()
 
 setIdentifier (string $identifier)
 
 getPosition ()
 
 setPosition (int $position)
 
 isStandardField ()
 
 setIsStandardField (bool $is_standard_field)
 
 getDataType ()
 
 setDataType (int $data_type)
 
- 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)
 
- Public Member Functions inherited from ilBiblFieldInterface
 getId ()
 
 setId (int $id)
 
 getIdentifier ()
 
 setIdentifier (string $identifier)
 
 getPosition ()
 
 setPosition (int $position)
 
 isStandardField ()
 
 setIsStandardField (bool $is_standard_field)
 
 getDataType ()
 
 setDataType (int $data_type)
 
 store ()
 

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 TABLE_NAME = 'il_bibl_field'
 
- Data Fields inherited from ilBiblFieldInterface
const DATA_TYPE_RIS = 1
 
const DATA_TYPE_BIBTEX = 2
 

Protected Attributes

int $id = null
 @con_has_field true @con_fieldtype integer @con_length 4 @con_is_notnull true @con_is_primary true @con_is_unique true @con_sequence true More...
 
string $identifier = null
 @con_has_field true @con_fieldtype text @con_length 50 @con_is_notnull true More...
 
int $data_type = 0
 @con_has_field true @con_fieldtype integer @con_length 1 @con_is_notnull true More...
 
int $position = null
 @con_has_field true @con_fieldtype integer @con_length 3 More...
 
bool $is_standard_field = true
 @con_has_field true @con_fieldtype integer @con_length 1 @con_is_notnull true More...
 
- 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 Class ilField

Author
: Benjamin Seglias bs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 23 of file class.ilBiblField.php.

Member Function Documentation

◆ getConnectorContainerName()

ilBiblField::getConnectorContainerName ( )

@description Return the Name of your Connector Table

Reimplemented from ActiveRecord.

Definition at line 33 of file class.ilBiblField.php.

33 : string
34 {
35 return self::TABLE_NAME;
36 }

References TABLE_NAME.

◆ getDataType()

ilBiblField::getDataType ( )

Implements ilBiblFieldInterface.

Definition at line 116 of file class.ilBiblField.php.

116 : int
117 {
118 return $this->data_type;
119 }
int $data_type
@con_has_field true @con_fieldtype integer @con_length 1 @con_is_notnull true

References $data_type.

◆ getId()

ilBiblField::getId ( )

Implements ilBiblFieldInterface.

Definition at line 76 of file class.ilBiblField.php.

76 : ?int
77 {
78 return $this->id;
79 }
int $id
@con_has_field true @con_fieldtype integer @con_length 4 @con_is_notnull true @con_is_primary true @c...

References $id.

Referenced by ilBiblEntryTableGUI\buildFilter().

+ Here is the caller graph for this function:

◆ getIdentifier()

ilBiblField::getIdentifier ( )

Implements ilBiblFieldInterface.

Definition at line 86 of file class.ilBiblField.php.

86 : string
87 {
88 return trim((string) $this->identifier);
89 }

Referenced by ilBiblEntryTableGUI\buildFilter().

+ Here is the caller graph for this function:

◆ getPosition()

ilBiblField::getPosition ( )

Implements ilBiblFieldInterface.

Definition at line 96 of file class.ilBiblField.php.

96 : ?int
97 {
98 return $this->position;
99 }
int $position
@con_has_field true @con_fieldtype integer @con_length 3

References $position.

◆ isStandardField()

ilBiblField::isStandardField ( )

Implements ilBiblFieldInterface.

Definition at line 106 of file class.ilBiblField.php.

106 : bool
107 {
109 }
bool $is_standard_field
@con_has_field true @con_fieldtype integer @con_length 1 @con_is_notnull true

References $is_standard_field.

◆ returnDbTableName()

static ilBiblField::returnDbTableName ( )
static
Returns
never
Exceptions

arException

Deprecated:

Reimplemented from ActiveRecord.

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

27 : string
28 {
29 return self::TABLE_NAME;
30 }

References TABLE_NAME.

◆ setDataType()

ilBiblField::setDataType ( int  $data_type)

Implements ilBiblFieldInterface.

Definition at line 121 of file class.ilBiblField.php.

121 : void
122 {
123 $this->data_type = $data_type;
124 }

References $data_type.

◆ setId()

ilBiblField::setId ( int  $id)

Implements ilBiblFieldInterface.

Definition at line 81 of file class.ilBiblField.php.

81 : void
82 {
83 $this->id = $id;
84 }

References $id.

◆ setIdentifier()

ilBiblField::setIdentifier ( string  $identifier)

Implements ilBiblFieldInterface.

Definition at line 91 of file class.ilBiblField.php.

91 : void
92 {
93 $this->identifier = trim($identifier);
94 }
string $identifier
@con_has_field true @con_fieldtype text @con_length 50 @con_is_notnull true

References $identifier.

◆ setIsStandardField()

ilBiblField::setIsStandardField ( bool  $is_standard_field)

Implements ilBiblFieldInterface.

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

111 : void
112 {
113 $this->is_standard_field = $is_standard_field;
114 }

References $is_standard_field.

◆ setPosition()

ilBiblField::setPosition ( int  $position)

Implements ilBiblFieldInterface.

Definition at line 101 of file class.ilBiblField.php.

101 : void
102 {
103 $this->position = $position;
104 }

References $position.

Field Documentation

◆ $data_type

int ilBiblField::$data_type = 0
protected

@con_has_field true @con_fieldtype integer @con_length 1 @con_is_notnull true

Definition at line 61 of file class.ilBiblField.php.

Referenced by getDataType(), and setDataType().

◆ $id

int ilBiblField::$id = null
protected

@con_has_field true @con_fieldtype integer @con_length 4 @con_is_notnull true @con_is_primary true @con_is_unique true @con_sequence true

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

Referenced by getId(), and setId().

◆ $identifier

string ilBiblField::$identifier = null
protected

@con_has_field true @con_fieldtype text @con_length 50 @con_is_notnull true

Definition at line 54 of file class.ilBiblField.php.

Referenced by setIdentifier().

◆ $is_standard_field

bool ilBiblField::$is_standard_field = true
protected

@con_has_field true @con_fieldtype integer @con_length 1 @con_is_notnull true

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

Referenced by isStandardField(), and setIsStandardField().

◆ $position

int ilBiblField::$position = null
protected

@con_has_field true @con_fieldtype integer @con_length 3

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

Referenced by getPosition(), and setPosition().

◆ TABLE_NAME

const ilBiblField::TABLE_NAME = 'il_bibl_field'

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