class.ilADTFactory.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilADTFactory
{
    public const TYPE_LOCALIZED_TEXT = 'LocalizedText';

    protected static ?ilADTFactory $instance = null;

    public static function getInstance(): ilADTFactory
    {
        if (self::$instance === null) {
            self::$instance = new self();
        }
        return self::$instance;
    }

    public function getValidTypes(): array
    {
        return array(
            "Float",
            "Integer",
            "Location",
            "Text",
            "Boolean",
            "MultiText",
            "Date",
            "DateTime",
            "Enum",
            "MultiEnum",
            "Group",
            'ExternalLink',
            'InternalLink',
            self::TYPE_LOCALIZED_TEXT
        );
    }

    public function isValidType(string $a_type): bool
    {
        return in_array($a_type, $this->getValidTypes());
    }

    public function initTypeClass(string $a_type, string $a_class = null): string
    {
        $class = '';
        if ($this->isValidType($a_type)) {
            $class = "ilADT" . $a_type . $a_class;
            return $class;
        }
        throw new InvalidArgumentException("ilADTFactory unknown type: " . $a_type);
    }

    public function getDefinitionInstanceByType(string $a_type): ilADTDefinition
    {
        $class = $this->initTypeClass($a_type, "Definition");
        return new $class();
    }

    public function getInstanceByDefinition(ilADTDefinition $a_def): ilADT
    {
        if (!method_exists($a_def, "getADTInstance")) {
            $class = $this->initTypeClass($a_def->getType());
            return new $class($a_def);
        } else {
            return $a_def->getADTInstance();
        }
    }

    public function getFormBridgeForInstance(ilADT $a_adt): ilADTFormBridge
    {
        $class = $this->initTypeClass($a_adt->getType(), "FormBridge");
        return new $class($a_adt);
    }

    public function getDBBridgeForInstance(ilADT $a_adt): ilADTDBBridge
    {
        $class = $this->initTypeClass($a_adt->getType(), "DBBridge");
        return new $class($a_adt);
    }

    public function getPresentationBridgeForInstance(ilADT $a_adt): ilADTPresentationBridge
    {
        $class = $this->initTypeClass($a_adt->getType(), "PresentationBridge");
        return new $class($a_adt);
    }

    public function getSearchBridgeForDefinitionInstance(
        ilADTDefinition $a_adt_def,
        bool $a_range = true,
        bool $a_multi = true
    ): ilADTSearchBridge {
        if ($a_range) {
            try {
                $class = $this->initTypeClass($a_adt_def->getType(), "SearchBridgeRange");
                if (class_exists($class)) {
                    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): ilADTActiveRecordBridge
    {
        $class = $this->initTypeClass($a_adt->getType(), "ActiveRecordBridge");
        return new $class($a_adt);
    }


    //
    // active records
    //

    public static function getActiveRecordInstance(ilADTGroupDBBridge $a_properties): ilADTActiveRecord
    {
        return new ilADTActiveRecord($a_properties);
    }

    public static function initActiveRecordByType(): void
    {
    }

    public static function getActiveRecordByTypeInstance(ilADTDBBridge $a_properties): ilADTActiveRecordByType
    {
        self::initActiveRecordByType();
        return new ilADTActiveRecordByType($a_properties);
    }
}