class.ilObjectFactory.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilObjectFactory
{
    public function ObjectIdExists(int $obj_id): bool
    {
        global $DIC;
        $ilDB = $DIC->database();

        $sql =
            "SELECT obj_id, type, title, description, owner, create_date, last_update, import_id, offline" . PHP_EOL
            . "FROM object_data" . PHP_EOL
            . "WHERE obj_id = " . $ilDB->quote($obj_id, 'integer') . PHP_EOL
        ;

        $result = $ilDB->query($sql);

        return (bool) $result->numRows();
    }

    public static function getObjectsForOwner(string $object_type, int $owner_id): array
    {
        global $DIC;
        $ilDB = $DIC->database();

        $sql =
            "SELECT object_data.obj_id" . PHP_EOL
            . "FROM object_data, object_reference" . PHP_EOL
            . "WHERE object_reference.obj_id = object_data.obj_id" . PHP_EOL
            . "AND object_data.type = " . $ilDB->quote($object_type, 'text') . PHP_EOL
            . "AND object_data.owner = " . $ilDB->quote($owner_id, 'integer') . PHP_EOL
        ;

        $result = $ilDB->query($sql);

        $obj_ids = [];
        while ($row = $result->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
            $obj_ids [] = $row["obj_id"];
        }

        return $obj_ids;
    }

    public static function getInstanceByObjId(?int $obj_id, bool $stop_on_error = true): ?ilObject
    {
        global $DIC;
        $objDefinition = $DIC["objDefinition"];
        $ilDB = $DIC->database();

        // check object id
        if (!isset($obj_id)) {
            $message = "ilObjectFactory::getInstanceByObjId(): No obj_id given!";
            if ($stop_on_error === true) {
                throw new ilObjectNotFoundException($message);
            }
            return null;
        }

        // read object data
        $sql =
            "SELECT obj_id, type, title, description, owner, create_date, last_update, import_id, offline" . PHP_EOL
            . "FROM object_data" . PHP_EOL
            . "WHERE obj_id = " . $ilDB->quote($obj_id, 'integer') . PHP_EOL
        ;
        $result = $ilDB->query($sql);
        // check number of records
        if ($result->numRows() == 0) {
            $message = "ilObjectFactory::getInstanceByObjId(): Object with obj_id: " . $obj_id . " not found!";
            if ($stop_on_error === true) {
                throw new ilObjectNotFoundException($message);
            }
            return null;
        }

        $row = $result->fetchRow(ilDBConstants::FETCHMODE_ASSOC);
        $class_name = "ilObj" . $objDefinition->getClassName($row["type"]);

        // check class
        if ($class_name == "ilObj") {
            $message = "ilObjectFactory::getInstanceByObjId(): Not able to determine object " .
                "class for type" . $row["type"] . ".";
            if ($stop_on_error === true) {
                throw new ilObjectNotFoundException($message);
            }
            return null;
        }

        (new self())->includeClassIfNotExists($class_name, $row["type"], $objDefinition);

        // create instance
        $obj = new $class_name(0, false);    // this avoids reading of data
        $obj->setId($obj_id);
        $obj->read();

        return $obj;
    }

    public static function getInstanceByRefId(int $ref_id, bool $stop_on_error = true): ?ilObject
    {
        global $DIC;
        $objDefinition = $DIC["objDefinition"];
        $ilDB = $DIC->database();

        // check reference id
        if (!isset($ref_id)) {
            if ($stop_on_error === true) {
                $message = "ilObjectFactory::getInstanceByRefId(): No ref_id given!";
                throw new ilObjectNotFoundException($message);
            }
            return null;
        }

        // read object data
        $sql =
            "SELECT object_data.obj_id, object_data.type" . PHP_EOL
            . "FROM object_data, object_reference" . PHP_EOL
            . "WHERE object_reference.obj_id = object_data.obj_id" . PHP_EOL
            . "AND object_reference.ref_id = " . $ilDB->quote($ref_id, 'integer') . PHP_EOL
        ;

        $result = $ilDB->query($sql);

        // check number of records
        if ($result->numRows() == 0) {
            if ($stop_on_error === true) {
                $message = "ilObjectFactory::getInstanceByRefId(): Object with ref_id " . $ref_id . " not found!";
                throw new ilObjectNotFoundException($message);
            }
            return null;
        }

        $row = $result->fetchRow(ilDBConstants::FETCHMODE_ASSOC);
        $class_name = "ilObj" . $objDefinition->getClassName($row["type"]);

        // check class
        if ($class_name == "ilObj") {
            if ($stop_on_error === true) {
                $message = "ilObjectFactory::getInstanceByRefId(): Not able to determine object " .
                    "class for type" . $row["type"] . ".";
                throw new ilObjectNotFoundException($message);
            }
            return null;
        }

        (new self())->includeClassIfNotExists($class_name, $row["type"], $objDefinition);

        // create instance
        $obj = new $class_name(0, false);    // this avoids reading of data
        $obj->setId((int) $row["obj_id"]);
        $obj->setRefId($ref_id);
        $obj->read();
        return $obj;
    }

    public static function getTypeByRefId(int $ref_id, bool $stop_on_error = true): ?string
    {
        global $DIC;
        $ilDB = $DIC->database();

        // check reference id
        if (!isset($ref_id)) {
            if ($stop_on_error === true) {
                $message = "ilObjectFactory::getTypeByRefId(): No ref_id given!";
                throw new ilObjectNotFoundException($message);
            }
            return null;
        }

        // read object data
        $sql =
            "SELECT object_data.obj_id, object_data.type" . PHP_EOL
            . "FROM object_data" . PHP_EOL
            . "LEFT JOIN object_reference ON object_data.obj_id=object_reference.obj_id " . PHP_EOL
            . "WHERE object_reference.ref_id=" . $ilDB->quote($ref_id, 'integer') . PHP_EOL
        ;
        $result = $ilDB->query($sql);

        if ($result->numRows() == 0) {
            if ($stop_on_error === true) {
                $message = "ilObjectFactory::getTypeByRefId(): Object with ref_id " . $ref_id . " not found!";
                throw new ilObjectNotFoundException($message);
            }
            return null;
        }

        $row = $result->fetchRow(ilDBConstants::FETCHMODE_ASSOC);
        return $row["type"];
    }

    public static function getClassByType(string $obj_type): string
    {
        global $DIC;
        $objDefinition = $DIC["objDefinition"];

        $class_name = "ilObj" . $objDefinition->getClassName($obj_type);

        (new self())->includeClassIfNotExists($class_name, $obj_type, $objDefinition);

        return $class_name;
    }

    protected function includeClassIfNotExists(
        string $class_name,
        string $a_obj_type,
        ilObjectDefinition $objDefinition
    ): void {
        if (!class_exists($class_name)) {
            $location = $objDefinition->getLocation($a_obj_type);
            include_once($location . "/class." . $class_name . ".php");
        }
    }
}