ilADTBasedObject Class Reference

ADT based-object base class Currently "mixed" with ActiveRecord-pattern, could be splitted. More...

Inheritance diagram for ilADTBasedObject:

Collaboration diagram for ilADTBasedObject:

Public Member Functions
	__construct ()
	Constructor Tries to read record from DB, in accordance to current ILIAS behaviour. More...
	getProperties ()
	Get all properties. More...
	isValid ()
	Validate. More...
	__call ($a_method, $a_value)
	Get property magic method ("get<PropertyName>()") Setters are type-specific and cannot be magic. More...
	read ()
	Read record. More...
	create ()
	Create record (only if valid) More...
	update ()
	Update record (only if valid) More...
	delete ()
	Delete record. More...
	getDBErrors ()
	Get DB errors. More...
	translateDBErrorCodes (array $a_codes)
	Translate DB error codes. More...
	getAllTranslatedErrors (string $delimiter="\)
	Get translated error codes (DB, Validation) More...

Protected Member Functions
	initProperties ()
	Init properties (aka set ADT definition) More...
	parsePrimary (array $a_args)
	Parse incoming primary key. More...
	hasPrimary ()
	Check if currently has primary. More...
	createPrimaryKeyb ()
	Create new primary key, e.g. More...
	initDBBridge (ilADTDBBridge $a_adt_db)
	Init (properties) DB bridge. More...
	initActiveRecordInstance ()
	Init active record helper for current table, primary and properties. More...

Protected Attributes
ilADT	$properties
array	$db_errors = []
ilDBInterface	$db
ilLanguage	$lng

Detailed Description

ADT based-object base class Currently "mixed" with ActiveRecord-pattern, could be splitted.

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

__construct()

ilADTBasedObject::__construct

(

)

Constructor Tries to read record from DB, in accordance to current ILIAS behaviour.

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

References $DIC, initProperties(), ILIAS\Repository\lng(), parsePrimary(), and read().

    {
        global $DIC;
        $this->db = $DIC->database();
        $this->lng = $DIC->language();
        $this->properties = $this->initProperties();

        // :TODO: to keep constructor "open" we COULD use func_get_args()
        $this->parsePrimary(func_get_args());
        $this->read();
    }

Here is the call graph for this function:

Member Function Documentation

__call()

ilADTBasedObject::__call	(		$a_method,
			$a_value
	)

Get property magic method ("get<PropertyName>()") Setters are type-specific and cannot be magic.

Parameters

string	$a_method
mixed	$a_value

Returns

ilADT

Exceptions

Exception

Definition at line 72 of file class.ilADTBasedObject.php.

References $type, createPrimaryKeyb(), hasPrimary(), initDBBridge(), and parsePrimary().

    {
        $type = substr($a_method, 0, 3);
        switch ($type) {
            case "get":
                $parsed = strtolower(preg_replace("/([A-Z])/", " $1", substr($a_method, 3)));
                $parsed = str_replace(" ", "_", trim($parsed));
                if (!$this->properties->hasElement($parsed)) {
                    throw new Exception("ilADTObject unknown property " . $parsed);
                }
                return $this->properties->getElement($parsed);

            default:
                throw new Exception("ilADTObject unknown type: " . $type);
        }
    }

Here is the call graph for this function:

create()

ilADTBasedObject::create

(

)

Create record (only if valid)

Returns

bool

Definition at line 158 of file class.ilADTBasedObject.php.

References Vendor\Package\$e, createPrimaryKeyb(), ilADTDBException\getColumn(), hasPrimary(), initActiveRecordInstance(), isValid(), and update().

Referenced by update().

                            : bool
    {
        if ($this->hasPrimary()) {
            return $this->update();
        }

        if ($this->isValid()) {
            if ($this->createPrimaryKeyb()) {
                try {
                    $rec = $this->initActiveRecordInstance();
                    $rec->create();
                } catch (ilADTDBException $e) {
                    $this->db_errors[$e->getColumn()][] = $e->getCode();
                    return false;
                }
                return true;
            }
        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createPrimaryKeyb()

ilADTBasedObject::createPrimaryKeyb ( )

abstractprotected

Create new primary key, e.g.

sequence

Returns

bool

Referenced by __call(), and create().

Here is the caller graph for this function:

delete()

ilADTBasedObject::delete

(

)

Delete record.

Returns

bool

Definition at line 206 of file class.ilADTBasedObject.php.

References hasPrimary(), and initActiveRecordInstance().

                            : bool
    {
        if ($this->hasPrimary()) {
            $rec = $this->initActiveRecordInstance();
            $rec->delete();
            return true;
        }
        return false;
    }

Here is the call graph for this function:

getAllTranslatedErrors()

ilADTBasedObject::getAllTranslatedErrors

(

string

$delimiter = "\n"

)

Get translated error codes (DB, Validation)

Parameters

string

$delimiter

Returns

string

Definition at line 249 of file class.ilADTBasedObject.php.

References getDBErrors(), getProperties(), and translateDBErrorCodes().

                                                                    : string
    {
        $tmp = array();

        foreach ($this->getProperties()->getValidationErrorsByElements() as $error_code => $element_id) {
            $tmp[] = $element_id . " [validation]: " . $this->getProperties()->translateErrorCode($error_code);
        }

        foreach ($this->getDBErrors() as $element_id => $codes) {
            $tmp[] = $element_id . " [db]: " . implode($delimiter, $this->translateDBErrorCodes($codes));
        }

        if (count($tmp)) {
            return get_class($this) . $delimiter . implode($delimiter, $tmp);
        }
        return '';
    }

Here is the call graph for this function:

getDBErrors()

ilADTBasedObject::getDBErrors

(

)

Get DB errors.

Returns

array

Definition at line 220 of file class.ilADTBasedObject.php.

References $db_errors.

Referenced by getAllTranslatedErrors().

                                 : array
    {
        return $this->db_errors;
    }

Here is the caller graph for this function:

getProperties()

ilADTBasedObject::getProperties

(

)

Get all properties.

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

References $properties.

Referenced by getAllTranslatedErrors().

                                   : ilADT
    {
        return $this->properties;
    }

Here is the caller graph for this function:

hasPrimary()

ilADTBasedObject::hasPrimary ( )

abstractprotected

Check if currently has primary.

Returns

bool

Referenced by __call(), create(), delete(), initActiveRecordInstance(), read(), and update().

Here is the caller graph for this function:

initActiveRecordInstance()

ilADTBasedObject::initActiveRecordInstance ( )

protected

Init active record helper for current table, primary and properties.

Returns

ilADTActiveRecord

PhpParamsInspection

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

References $factory, ilADTFactory\getInstance(), hasPrimary(), and initDBBridge().

Referenced by create(), delete(), read(), and update().

                                                 : ilADTActiveRecord
    {
        if (!$this->hasPrimary()) {
            throw new Exception("ilADTBasedObject no primary");
        }

        $factory = ilADTFactory::getInstance();
        $adt_db = $factory->getDBBridgeForInstance($this->properties);
        $this->initDBBridge($adt_db);

        // use custom error handling
        //FIXME
        //$this->db->exception = "ilADTDBException";

        return $factory->getActiveRecordInstance($adt_db);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initDBBridge()

ilADTBasedObject::initDBBridge ( ilADTDBBridge  $a_adt_db )

abstractprotected

Init (properties) DB bridge.

Parameters

ilADTDBBridge

$a_adt_db

Referenced by __call(), and initActiveRecordInstance().

Here is the caller graph for this function:

initProperties()

ilADTBasedObject::initProperties ( )

abstractprotected

Init properties (aka set ADT definition)

Returns

ilADT

Referenced by __construct().

Here is the caller graph for this function:

isValid()

ilADTBasedObject::isValid

(

)

Validate.

Returns

bool

Definition at line 59 of file class.ilADTBasedObject.php.

Referenced by create(), and update().

                             : bool
    {
        return $this->properties->isValid();
    }

Here is the caller graph for this function:

parsePrimary()

ilADTBasedObject::parsePrimary ( array  $a_args )

abstractprotected

Parse incoming primary key.

Parameters

array

$a_args

See also

__construct()

Referenced by __call(), and __construct().

Here is the caller graph for this function:

read()

ilADTBasedObject::read

(

)

Read record.

Returns

bool

Definition at line 145 of file class.ilADTBasedObject.php.

References hasPrimary(), and initActiveRecordInstance().

Referenced by __construct().

                          : bool
    {
        if ($this->hasPrimary()) {
            $rec = $this->initActiveRecordInstance();
            return $rec->read();
        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

translateDBErrorCodes()

ilADTBasedObject::translateDBErrorCodes

(

array

$a_codes

)

Translate DB error codes.

Parameters

array

$a_codes

Returns

array

Definition at line 230 of file class.ilADTBasedObject.php.

References $res.

Referenced by getAllTranslatedErrors().

                                                         : array
    {
        $res = array();

        foreach ($a_codes as $code) {
            switch ($code) {
                default:
                    $res[] = "Unknown ADT error code " . $code;
                    break;
            }
        }
        return $res;
    }

Here is the caller graph for this function:

update()

ilADTBasedObject::update

(

)

Update record (only if valid)

Returns

bool

Definition at line 183 of file class.ilADTBasedObject.php.

References Vendor\Package\$e, create(), ilADTDBException\getColumn(), hasPrimary(), initActiveRecordInstance(), and isValid().

Referenced by create().

                            : bool
    {
        if (!$this->hasPrimary()) {
            return $this->create();
        }

        if ($this->isValid()) {
            try {
                $rec = $this->initActiveRecordInstance();
                $rec->update();
            } catch (ilADTDBException $e) {
                $this->db_errors[$e->getColumn()][] = $e->getCode();
                return false;
            }
            return true;
        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$db

ilDBInterface ilADTBasedObject::$db

protected

Definition at line 17 of file class.ilADTBasedObject.php.

$db_errors

array ilADTBasedObject::$db_errors = []

protected

Definition at line 15 of file class.ilADTBasedObject.php.

Referenced by getDBErrors().

$lng

ilLanguage ilADTBasedObject::$lng

protected

Definition at line 18 of file class.ilADTBasedObject.php.

$properties

ilADT ilADTBasedObject::$properties

protected

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

Referenced by getProperties().

---

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

• Services/ADT/classes/_Example/class.ilADTBasedObject.php