ilDclFieldProperty Class Reference

Inheritance diagram for ilDclFieldProperty:

Collaboration diagram for ilDclFieldProperty:

Public Member Functions
	__construct (?int $primary_key=0)
	ilDclFieldProperty constructor. More...
	getId ()
	setId (int $id)
	getFieldId ()
	setFieldId (int $field_id)
	getName ()
	setName (string $name)
	getValue ()
	setValue ($value)
	create ()
	update ()
	afterObjectLoad ()
	serializeData ($value)
	Serialize data before storing to db. More...
	deserializeData (string $value)
	Deserialize data before applying to field. More...
Public Member Functions inherited from ActiveRecord
	getArConnector ()
	getArFieldList ()
	getConnectorContainerName ()
	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 ()
	Return the Name of your Database Table 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 ()
	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)

Protected Attributes
int	$id
int	$field_id = 0
string	$name = ""
	$value
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 ()
	Returns an instance of the instatiated calling active record (needs to be done in static methods) : This should be cached somehow More...
static	fromCamelCase (string $str)

Detailed Description

Definition at line 21 of file class.ilDclFieldProperty.php.

Constructor & Destructor Documentation

__construct()

ilDclFieldProperty::__construct

(

?int

$primary_key = 0

)

ilDclFieldProperty constructor.

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

References ILIAS\GlobalScreen\Provider\__construct().

    {
        parent::__construct($primary_key);
    }

Here is the call graph for this function:

Member Function Documentation

afterObjectLoad()

ilDclFieldProperty::afterObjectLoad

(

)

Definition at line 129 of file class.ilDclFieldProperty.php.

References deserializeData().

                                     : void
    {
        $this->value = $this->deserializeData($this->value);
    }

Here is the call graph for this function:

create()

ilDclFieldProperty::create

(

)

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

References serializeData().

                            : void
    {
        $this->value = $this->serializeData($this->value);
        parent::create();
    }

Here is the call graph for this function:

deserializeData()

ilDclFieldProperty::deserializeData

(

string

$value

)

Deserialize data before applying to field.

Returns

string|array

Definition at line 151 of file class.ilDclFieldProperty.php.

References $value.

Referenced by afterObjectLoad().

    {
        $deserialize = json_decode($value, true);
        if (is_array($deserialize)) {
            return $deserialize;
        }

        return $value;
    }

Here is the caller graph for this function:

getFieldId()

ilDclFieldProperty::getFieldId

(

)

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

References $field_id.

                                : int
    {
        return $this->field_id;
    }

getId()

ilDclFieldProperty::getId

(

)

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

References $id.

                           : int
    {
        return $this->id;
    }

getName()

ilDclFieldProperty::getName

(

)

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

References $name.

                             : string
    {
        return $this->name;
    }

getValue()

ilDclFieldProperty::getValue

(

)

Definition at line 104 of file class.ilDclFieldProperty.php.

References $value.

                              : string
    {
        return $this->value;
    }

returnDbTableName()

static ilDclFieldProperty::returnDbTableName ( )

static

Return the Name of your Database Table

Definition at line 69 of file class.ilDclFieldProperty.php.

                                              : string
    {
        return "il_dcl_field_prop";
    }

serializeData()

ilDclFieldProperty::serializeData

(

$value

)

Serialize data before storing to db.

Parameters

int | string | array

$value

Definition at line 138 of file class.ilDclFieldProperty.php.

References $value.

Referenced by create(), and update().

                                         : string
    {
        if (is_array($value)) {
            $value = json_encode($value);
        }

        return (string) $value;
    }

Here is the caller graph for this function:

setFieldId()

ilDclFieldProperty::setFieldId

(

int

$field_id

)

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

References $field_id.

                                             : void
    {
        $this->field_id = $field_id;
    }

setId()

ilDclFieldProperty::setId

(

int

$id

)

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

References $id.

                                  : void
    {
        $this->id = $id;
    }

setName()

ilDclFieldProperty::setName

(

string

$name

)

Definition at line 99 of file class.ilDclFieldProperty.php.

References $name.

                                         : void
    {
        $this->name = $name;
    }

setValue()

ilDclFieldProperty::setValue

(

$value

)

Parameters

string | array | int

$value

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

References $value.

                                    : void
    {
        $this->value = $value;
    }

update()

ilDclFieldProperty::update

(

)

Definition at line 123 of file class.ilDclFieldProperty.php.

References serializeData().

                            : void
    {
        $this->value = $this->serializeData($this->value);
        parent::update();
    }

Here is the call graph for this function:

Field Documentation

$field_id

int ilDclFieldProperty::$field_id = 0

protected

Definition at line 41 of file class.ilDclFieldProperty.php.

Referenced by getFieldId(), and setFieldId().

$id

int ilDclFieldProperty::$id

protected

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

Referenced by getId(), and setId().

$name

string ilDclFieldProperty::$name = ""

protected

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

Referenced by getName(), and setName().

$value

ilDclFieldProperty::$value

protected

Definition at line 56 of file class.ilDclFieldProperty.php.

Referenced by deserializeData(), getValue(), serializeData(), and setValue().

---

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

• components/ILIAS/DataCollection/classes/Fields/Base/class.ilDclFieldProperty.php