class.ilADTFactory.php

Go to the documentation of this file.

<?php
 
require_once "Services/ADT/classes/class.ilADT.php";
require_once "Services/ADT/classes/class.ilADTDefinition.php";
 
class ilADTFactory
{
    public const TYPE_LOCALIZED_TEXT = 'LocalizedText';
 
    protected static $instance; // [ilADTFactory]
    
    protected function __construct()
    {
    }
    
    public static function getInstance()
    {
        if (self::$instance === null) {
            self::$instance = new self;
        }
        return self::$instance;
    }
    
    public function getValidTypes()
    {
        return array(
            "Float", "Integer", "Location", "Text", "Boolean",
            "MultiText", "Date", "DateTime", "Enum", "MultiEnum", "Group",
            'ExternalLink','InternalLink', self::TYPE_LOCALIZED_TEXT
        );
    }
    
    public function isValidType($a_type)
    {
        return in_array((string) $a_type, $this->getValidTypes());
    }
    
    public function initTypeClass($a_type, $a_class = null)
    {
        if ($this->isValidType($a_type)) {
            $class = "ilADT" . $a_type . $a_class;
            $file = "Services/ADT/classes/Types/" . $a_type . "/class." . $class . ".php";
            if (file_exists($file)) {
                require_once $file;
                return $class;
            }
        }
        
        throw new Exception("ilADTFactory unknown type: " . $a_type . ' -> ' . $file);
    }
    
    public function getDefinitionInstanceByType($a_type)
    {
        $class = $this->initTypeClass($a_type, "Definition");
        return new $class();
    }
    
    public function getInstanceByDefinition(ilADTDefinition $a_def)
    {
        if (!method_exists($a_def, "getADTInstance")) {
            $class = $this->initTypeClass($a_def->getType());
            return new $class($a_def);
        } else {
            return $a_def->getADTInstance();
        }
    }
    
    
    //
    // bridges
    //
    
    public function getFormBridgeForInstance(ilADT $a_adt)
    {
        $class = $this->initTypeClass($a_adt->getType(), "FormBridge");
        return new $class($a_adt);
    }
    
    public function getDBBridgeForInstance(ilADT $a_adt)
    {
        $class = $this->initTypeClass($a_adt->getType(), "DBBridge");
        return new $class($a_adt);
    }
    
    public function getPresentationBridgeForInstance(ilADT $a_adt)
    {
        $class = $this->initTypeClass($a_adt->getType(), "PresentationBridge");
        return new $class($a_adt);
    }
    
    public function getSearchBridgeForDefinitionInstance(ilADTDefinition $a_adt_def, $a_range = true, $a_multi = true)
    {
        if ($a_range) {
            try {
                $class = $this->initTypeClass($a_adt_def->getType(), "SearchBridgeRange");
                return new $class($a_adt_def);
            } catch (Exception $e) {
            }
        }
        
        // multi enum search (single) == enum search (multi)
        if (!$a_multi &&
            $a_adt_def->getType() == "MultiEnum") {
            $class = $this->initTypeClass("Enum", "SearchBridgeMulti");
            return new $class($a_adt_def);
        }
        
        if ($a_multi) {
            try {
                if ($a_adt_def->getType() == 'MultiEnum') {
                    $class = $this->initTypeClass('Enum','SearchBridgeMulti');
                    return new $class($a_adt_def);
                }
                $class = $this->initTypeClass($a_adt_def->getType(), "SearchBridgeMulti");
                return new $class($a_adt_def);
            } catch (Exception $e) {
            }
        }
        $class = $this->initTypeClass($a_adt_def->getType(), "SearchBridgeSingle");
        return new $class($a_adt_def);
    }
    
    
    public function getActiveRecordBridgeForInstance(ilADT $a_adt)
    {
        $class = $this->initTypeClass($a_adt->getType(), "ActiveRecordBridge");
        return new $class($a_adt);
    }
    
    
    //
    // active records
    //
    
    public static function getActiveRecordInstance(ilADTGroupDBBridge $a_properties)
    {
        require_once "Services/ADT/classes/ActiveRecord/class.ilADTActiveRecord.php";
        return new ilADTActiveRecord($a_properties);
    }
    
    public static function initActiveRecordByType()
    {
        require_once "Services/ADT/classes/ActiveRecord/class.ilADTActiveRecordByType.php";
    }
    
    public static function getActiveRecordByTypeInstance(ilADTGroupDBBridge $a_properties)
    {
        self::initActiveRecordByType();
        return new ilADTActiveRecordByType($a_properties);
    }
}