This is a ADT-based example object. More...

Inheritance diagram for ilADTTest:

Collaboration diagram for ilADTTest:

Data Fields
const	INTERESTS_NONE = 0

const	INTERESTS_LANGUAGES = 1

const	INTERESTS_IT = 2

Protected Member Functions
	initProperties ()
	Init properties (aka set ADT definition) More...

	initDBBridge (ilADTGroupDBBridge $a_adt_db)
	Init (properties) DB bridge. More...

	parsePrimary (array $a_args)
	Parse incoming primary key. More...

	hasPrimary ()
	Check if currently has primary. More...

	createPrimaryKey ()
	Create new primary key, e.g. More...

Protected Member Functions inherited from ilADTBasedObject
	initProperties ()
	Init properties (aka set ADT definition) More...

	parsePrimary (array $a_args)
	Parse incoming primary key. More...

	hasPrimary ()
	Check if currently has primary. More...

	createPrimaryKey ()
	Create new primary key, e.g. More...

	initDBBridge (ilADTGroupDBBridge $a_adt_db)
	Init (properties) DB bridge. More...

	initActiveRecordInstance ()
	Init active record helper for current table, primary and properties. More...

Protected Attributes
	$id

	$properties

Protected Attributes inherited from ilADTBasedObject
	$properties = array()

	$db_errors = array()

Additional Inherited Members
Public Member Functions inherited from ilADTBasedObject
	__construct ()
	Constructor. More...

	getProperties ()
	Get all properties. More...

	isValid ()
	Validate. More...

	__call ($a_method, $a_value)
	Get property magic method ("get<PropertyName>()") 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 ($delimiter="\n")
	Get translated error codes (DB, Validation) More...

Detailed Description

This is a ADT-based example object.

It has all supported ADTs and shows DB sequence-handling

Definition at line 10 of file class.ilADTTest.php.

Member Function Documentation

◆ createPrimaryKey()

ilADTTest::createPrimaryKey ( )

protected

Create new primary key, e.g.

sequence

Returns: bool

Reimplemented from ilADTBasedObject.

Definition at line 114 of file class.ilADTTest.php.

        {
                global $ilDB;
                
                $this->id = $ilDB->nextId("adt_test");
                
                // INSERT is only done if createPrimaryKey() returns TRUE!
                return true;
        }

References $ilDB.

◆ hasPrimary()

ilADTTest::hasPrimary ( )

protected

Check if currently has primary.

Returns: bool

Reimplemented from ilADTBasedObject.

Definition at line 109 of file class.ilADTTest.php.

        {
                return (bool)$this->id;
        }

References $id.

◆ initDBBridge()

ilADTTest::initDBBridge ( ilADTGroupDBBridge $a_adt_db )

protected

Init (properties) DB bridge.

Parameters

ilADTGroupDBBridge $a_adt_db

Reimplemented from ilADTBasedObject.

Definition at line 98 of file class.ilADTTest.php.

        {               
                $a_adt_db->setTable("adt_test");
                $a_adt_db->setPrimary(array("id"=>array("integer", $this->id)));
        }

References ilADTGroupDBBridge\setPrimary(), and ilADTGroupDBBridge\setTable().

Here is the call graph for this function:

◆ initProperties()

ilADTTest::initProperties ( )

protected

Init properties (aka set ADT definition)

Returns: ilADT

Reimplemented from ilADTBasedObject.

Definition at line 22 of file class.ilADTTest.php.

        {
                global $lng;
                                
                // this could be generated from XML or code comments or whatever
                
                include_once "Services/ADT/classes/class.ilADTFactory.php";
                $factory = ilADTFactory::getInstance();
                
                $properties_def = $factory->getDefinitionInstanceByType("Group");
                
                $name = $factory->getDefinitionInstanceByType("Text");
                $name->setMaxLength(255);       
                $properties_def->addElement("name", $name);
                
                $status = $factory->getDefinitionInstanceByType("Boolean");     
                $properties_def->addElement("active", $status);
                                
                // example options from ilLanguage
                $lng->loadLanguageModule("meta");
                $options = array();
                foreach($lng->getInstalledLanguages() as $lang)
                {
                        $options[$lang] = $lng->txt("meta_l_".$lang);
                }
                
                $lang = $factory->getDefinitionInstanceByType("Enum");  
                $lang->setNumeric(false);
                $lang->setOptions($options);
                $properties_def->addElement("lang", $lang);
                
                
                $age = $factory->getDefinitionInstanceByType("Integer");
                $age->setMin(0);                
                $age->setMax(120);              
                $properties_def->addElement("age", $age);
                
                $weight = $factory->getDefinitionInstanceByType("Float");
                $weight->setMin(0);             
                $weight->setMax(500);           
                $properties_def->addElement("weight", $weight);
                
                // null?
                $home = $factory->getDefinitionInstanceByType("Location");      
                $properties_def->addElement("home", $home);             
                
                $tags = $factory->getDefinitionInstanceByType("MultiText");     
                $tags->setMaxLength(255);
                $tags->setMaxSize(5);
                $properties_def->addElement("tags", $tags);
                                                                
                $options = array(
                        self::INTERESTS_NONE => $lng->txt("test_interests_none"),
                        self::INTERESTS_LANGUAGES => $lng->txt("test_interests_languages"),
                        self::INTERESTS_IT => $lng->txt("test_interests_it")
                );
                
                $intr = $factory->getDefinitionInstanceByType("MultiEnum");     
                $intr->setOptions($options);
                $properties_def->addElement("interests", $intr);
                
                $date = $factory->getDefinitionInstanceByType("Date");  
                $properties_def->addElement("entry_date", $date);
                
                $dt = $factory->getDefinitionInstanceByType("DateTime");        
                $properties_def->addElement("last_login", $dt);                         
                
                // convert ADT definitions to proper ADTs
                return $factory->getInstanceByDefinition($properties_def);
        }

References $lang, $lng, $options, and ilADTFactory\getInstance().

Here is the call graph for this function:

◆ parsePrimary()

ilADTTest::parsePrimary ( array $a_args )

protected

Parse incoming primary key.

See also: __construct()

Parameters

array $a_args

Reimplemented from ilADTBasedObject.

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

        {
                $this->id = (int)$a_args[0];
        }

Field Documentation

◆ $id

ilADTTest::$id

protected

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

Referenced by hasPrimary().

◆ $properties

ilADTTest::$properties

protected

Definition at line 13 of file class.ilADTTest.php.

◆ INTERESTS_IT

const ilADTTest::INTERESTS_IT = 2

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

◆ INTERESTS_LANGUAGES

const ilADTTest::INTERESTS_LANGUAGES = 1

Definition at line 16 of file class.ilADTTest.php.

◆ INTERESTS_NONE

const ilADTTest::INTERESTS_NONE = 0

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

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

Services/ADT/classes/_Example/class.ilADTTest.php

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ createPrimaryKey()

◆ hasPrimary()

◆ initDBBridge()

◆ initProperties()

◆ parsePrimary()

Field Documentation

◆ $id

◆ $properties

◆ INTERESTS_IT

◆ INTERESTS_LANGUAGES

◆ INTERESTS_NONE