Inheritance diagram for ilSoapObjectAdministration:

Collaboration diagram for ilSoapObjectAdministration:

Public Member Functions
	getObjIdByImportId (string $sid, string $import_id)

	getRefIdsByImportId (string $sid, string $import_id)

	getRefIdsByObjId (string $sid, int $obj_id)

	getObjIdsByRefIds (string $sid, array $ref_ids)

	getObjectByReference (string $sid, int $a_ref_id, ?int $user_id=null)

	getObjectsByTitle (string $sid, string $a_title, ?int $user_id=null)

	searchObjects (string $sid, ?array $types, string $key, string $combination, ?int $user_id=null)

	getTreeChilds (string $sid, int $ref_id, ?array $types=null, ?int $user_id=null)

	getXMLTree (string $sid, int $ref_id, ?array $types=null, ?int $user_id=null)

	addReference (string $sid, int $a_source_id, int $a_target_id)

	deleteObject (string $sid, int $reference_id)

	removeFromSystemByImportId (string $sid, string $import_id)

	moveObject (string $sid, int $ref_id, int $target_id)

	copyObject (string $sid, string $copy_settings_xml)

	getPathForRefId (string $sid, int $ref_id)

Public Member Functions inherited from ilSoapAdministration
	__construct (bool $use_nusoap=true)

	getMessage ()

	appendMessage (string $a_str)

	setMessageCode (string $a_code)

	getMessageCode ()

	reInitUser ()

	isFault ($object)

	getInstallationInfoXML ()

	getClientInfoXML (string $clientid)

Private Member Functions
	canAddType (string $type, string $target_type, int $target_id)

	validateReferences (string $a_action, array $a_object_data, int $a_target_id=0)

	updateReferences (array $a_object_data)

	addReferences (ilObject $source, array $a_object_data)

Additional Inherited Members
Data Fields inherited from ilSoapAdministration
const	NUSOAP = 1

const	PHP5 = 2

int	$error_method
	Defines type of error handling (PHP5 \|\| NUSOAP) More...

Protected Member Functions inherited from ilSoapAdministration
	checkSession (string $sid)

	explodeSid (string $sid)

	setMessage (string $a_str)

	initAuth (string $sid)

	initIlias ()

	initAuthenticationObject ()

	raiseError (string $a_message, $a_code)

	checkObjectAccess (int $ref_id, array $expected_type, string $permission, bool $returnObject=false)
	check access for ref id: expected type, permission, return object instance if returnobject is true More...

Protected Attributes inherited from ilSoapAdministration
bool	$soap_check = true

string	$message = ''

string	$message_code = ''

Detailed Description

Definition at line 25 of file class.ilSoapObjectAdministration.php.

Member Function Documentation

◆ addReference()

ilSoapObjectAdministration::addReference	(	string	$sid,
		int	$a_source_id,
		int	$a_target_id
	)

Returns: int|soap_fault|SoapFault|string|null

Definition at line 650 of file class.ilSoapObjectAdministration.php.

    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->checkSession($sid)) {
            return $this->raiseError($this->getMessage(), $this->getMessageCode());
        }
 
        global $DIC;
 
        $objDefinition = $DIC['objDefinition'];
        $rbacsystem = $DIC['rbacsystem'];
        $tree = $DIC['tree'];
 
        if (!$source_obj = ilObjectFactory::getInstanceByRefId($a_source_id, false)) {
            return $this->raiseError(
                'No valid source id given.',
                'Client'
            );
        }
        if (!$target_obj = ilObjectFactory::getInstanceByRefId($a_target_id, false)) {
            return $this->raiseError(
                'No valid target id given.',
                'Client'
            );
        }
 
        if (!$objDefinition->allowLink($source_obj->getType()) and
            $source_obj->getType() !== 'cat' and
            $source_obj->getType() !== 'crs') {
            return $this->raiseError(
                'Linking of object type: ' . $source_obj->getType() . ' is not allowed',
                'Client'
            );
        }
 
        $allowed_subtypes = $target_obj->getPossibleSubObjects();
        $allowed = [];
        foreach ($allowed_subtypes as $row) {
            if ($row['name'] !== 'rolf') {
                $allowed[] = $row['name'];
            }
        }
        if (!in_array($source_obj->getType(), $allowed, true)) {
            return $this->raiseError(
                'Objects of type: ' . $source_obj->getType() . ' are not allowed to be subobjects of type ' .
                $target_obj->getType() . '!',
                'Client'
            );
        }
 
        // Permission checks
        if (!$rbacsystem->checkAccess('create', $target_obj->getRefId(), $source_obj->getType())) {
            return $this->raiseError(
                'No permission to create objects of type ' . $source_obj->getType() . '!',
                'Client'
            );
        }
        if (!$rbacsystem->checkAccess('delete', $source_obj->getRefId())) {
            return $this->raiseError(
                'No permission to link object with id: ' . $source_obj->getRefId() . '!',
                'Client'
            );
        }
 
        if ($source_obj->getType() !== 'cat' and $source_obj->getType() !== 'crs') {
            // check if object already linked to target
            $possibleChilds = $tree->getChildsByType($target_obj->getRefId(), $source_obj->getType());
            foreach ($possibleChilds as $child) {
                if ((int) $child["obj_id"] === $source_obj->getId()) {
                    return $this->raiseError("Object already linked to target.", "Client");
                }
            }
 
            // Finally link it to target position
 
            $new_ref_id = $source_obj->createReference();
            $source_obj->putInTree($target_obj->getRefId());
            $source_obj->setPermissions($target_obj->getRefId());
 
            return $new_ref_id ?: "0";
        }
 
        $new_ref = null;
        switch ($source_obj->getType()) {
            case 'cat':
                $new_ref = new ilObjCategoryReference();
                break;
 
            case 'crs':
                $new_ref = new ilObjCourseReference();
                break;
            case 'grp':
                $new_ref = new ilObjGroupReference();
                break;
        }
        $new_ref->create();
        $new_ref_id = $new_ref->createReference();
 
        $new_ref->putInTree($target_obj->getRefId());
        $new_ref->setPermissions($target_obj->getRefId());
 
        $new_ref->setTargetId($source_obj->getId());
        $new_ref->update();
 
        if (!$new_ref instanceof ilObject) {
            return 0;
        }
 
        return $new_ref_id ?: 0;
    }

References $DIC, ilSoapAdministration\checkSession(), ilObjectFactory\getInstanceByRefId(), ilSoapAdministration\getMessage(), ilSoapAdministration\getMessageCode(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), and ilSoapAdministration\raiseError().

Here is the call graph for this function:

◆ addReferences()

ilSoapObjectAdministration::addReferences	(	ilObject	$source,
		array	$a_object_data
	)

private

Definition at line 1371 of file class.ilSoapObjectAdministration.php.

                                                                          : void
    {
        global $DIC;
 
        $tree = $DIC->repositoryTree();
        $ilLog = $DIC['ilLog'];
 
        if (!isset($a_object_data['references']) || !count($a_object_data['references'])) {
            return;
        }
 
        $original_id = $source->getRefId();
 
        foreach ($a_object_data['references'] as $ref_data) {
            $new_ref_id = $original_id;
            if ($tree->getParentId($original_id) !== (int) $ref_data['parent_id']) {
                // New reference requested => create it
                $new_ref_id = $source->createReference();
                $source->putInTree($ref_data['parent_id']);
                $source->setPermissions($ref_data['parent_id']);
            }
            if (isset($ref_data['time_target']) /* and ($crs_ref_id = $tree->checkForParentType($new_ref_id,'crs')) */) {
                if (!isset($ref_data['time_target']['starting_time'])) {
                    $ref_data['time_target']['starting_time'] = time();
                }
                if (!isset($ref_data['time_target']['ending_time'])) {
                    $ref_data['time_target']['ending_time'] = time();
                }
 
                $items = new ilObjectActivation();
                $items->toggleChangeable($ref_data['time_target']['changeable']);
                $items->setTimingStart($ref_data['time_target']['starting_time']);
                $items->setTimingEnd($ref_data['time_target']['ending_time']);
                $items->toggleVisible($ref_data['time_target']['timing_visibility']);
                $items->setSuggestionStart($ref_data['time_target']['suggestion_start']);
                $items->setSuggestionEnd($ref_data['time_target']['suggestion_end']);
 
                switch ($ref_data['time_target']['timing_type']) {
                    case ilObjectXMLWriter::TIMING_DEACTIVATED:
                        $ilLog->write(__METHOD__ . ilObjectActivation::TIMINGS_DEACTIVATED . ' ' . $ref_data['time_target']['timing_type']);
                        $items->setTimingType(ilObjectActivation::TIMINGS_DEACTIVATED);
                        break;
 
                    case ilObjectXMLWriter::TIMING_TEMPORARILY_AVAILABLE:
                        $ilLog->write(__METHOD__ . ilObjectActivation::TIMINGS_ACTIVATION . ' ' . $ref_data['time_target']['timing_type']);
                        $items->setTimingType(ilObjectActivation::TIMINGS_ACTIVATION);
                        break;
 
                    case ilObjectXMLWriter::TIMING_PRESETTING:
                        $ilLog->write(__METHOD__ . ilObjectActivation::TIMINGS_PRESETTING . ' ' . $ref_data['time_target']['timing_type']);
                        $items->setTimingType(ilObjectActivation::TIMINGS_PRESETTING);
                        break;
                }
                $items->update($new_ref_id);
            }
        }
    }

References $DIC, ilObject\createReference(), ilObject\getRefId(), ilObject\putInTree(), ilObject\setPermissions(), ilObjectXMLWriter\TIMING_DEACTIVATED, ilObjectXMLWriter\TIMING_PRESETTING, ilObjectXMLWriter\TIMING_TEMPORARILY_AVAILABLE, ilObjectActivation\TIMINGS_ACTIVATION, ilObjectActivation\TIMINGS_DEACTIVATED, and ilObjectActivation\TIMINGS_PRESETTING.

Here is the call graph for this function:

◆ canAddType()

ilSoapObjectAdministration::canAddType	(	string	$type,
		string	$target_type,
		int	$target_id
	)

private

Definition at line 1229 of file class.ilSoapObjectAdministration.php.

    {
        // checking for target subtypes. Can we add source to target
        global $DIC;
 
        $objDefinition = $DIC['objDefinition'];
        $rbacsystem = $DIC['rbacsystem'];
 
        $allowed_types = array('root', 'cat', 'grp', 'crs', 'fold');
        if (!in_array($target_type, $allowed_types, true)) {
            return $this->raiseError(
                'No valid target type. Target must be reference id of "course, group, category or folder"',
                'Client'
            );
        }
 
        $allowed_subtypes = $objDefinition->getSubObjects($target_type);
        $allowed = array();
 
        foreach ($allowed_subtypes as $row) {
            if ($row['name'] !== 'rolf') {
                $allowed[] = $row['name'];
            }
        }
 
        if (!in_array($type, $allowed, true)) {
            return $this->raiseError(
                'Objects of type: ' . $type . ' are not allowed to be subobjects of type ' . $target_type . '!',
                'Client'
            );
        }
        if (!$rbacsystem->checkAccess('create', $target_id, $type)) {
            return $this->raiseError('No permission to create objects of type ' . $type . '!', 'Client');
        }
 
        return true;
    }

References $DIC, and ilSoapAdministration\raiseError().

Referenced by copyObject(), moveObject(), and validateReferences().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ copyObject()

ilSoapObjectAdministration::copyObject	(	string	$sid,
		string	$copy_settings_xml
	)

Returns: bool|int|mixed|soap_fault|SoapFault|null

Definition at line 1083 of file class.ilSoapObjectAdministration.php.

    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->checkSession($sid)) {
            return $this->raiseError($this->getMessage(), $this->getMessageCode());
        }
 
        global $DIC;
 
        $rbacreview = $DIC['rbacreview'];
        $objDefinition = $DIC['objDefinition'];
        $rbacsystem = $DIC['rbacsystem'];
        $lng = $DIC['lng'];
        $ilUser = $DIC['ilUser'];
 
        $xml_parser = new ilCopyWizardSettingsXMLParser($copy_settings_xml);
        try {
            $xml_parser->startParsing();
        } catch (ilSaxParserException $se) {
            return $this->raiseError($se->getMessage(), "Client");
        }
 
        // checking copy permissions, objects and create permissions
        if (!$rbacsystem->checkAccess('copy', $xml_parser->getSourceId())) {
            return $this->raiseError(
                "Missing copy permissions for object with reference id " . $xml_parser->getSourceId(),
                'Client'
            );
        }
 
        // checking copy permissions, objects and create permissions
        $source_id = $xml_parser->getSourceId();
        $target_id = $xml_parser->getTargetId();
 
        // does source object exist
        if (!$source_object_type = ilObjectFactory::getTypeByRefId($source_id, false)) {
            return $this->raiseError('No valid source given.', 'Client');
        }
 
        // does target object exist
        if (!$target_object_type = ilObjectFactory::getTypeByRefId($xml_parser->getTargetId(), false)) {
            return $this->raiseError('No valid target given.', 'Client');
        }
 
        $canAddType = $this->canAddType($source_object_type, $target_object_type, $target_id);
        if ($this->isFault($canAddType)) {
            return $canAddType;
        }
 
        // if is container object than clone with sub items
        $options = $xml_parser->getOptions();
        //              print_r($options);
        $source_object = ilObjectFactory::getInstanceByRefId($source_id);
        if ($source_object instanceof ilContainer) {
            // get client id from sid
            $clientid = substr($sid, strpos($sid, "::") + 2);
            $sessionid = str_replace("::" . $clientid, "", $sid);
            // call container clone
            $ret = $source_object->cloneAllObject(
                $sessionid,
                $clientid,
                $source_object_type,
                $target_id,
                $source_id,
                $options,
                true
            );
 
            return $ret['ref_id'];
        }
 
        // create copy wizard settings
        $copy_id = ilCopyWizardOptions::_allocateCopyId();
        $wizard_options = ilCopyWizardOptions::_getInstance($copy_id);
        $wizard_options->saveOwner($ilUser->getId());
        $wizard_options->saveRoot($source_id);
 
        foreach ($options as $source_id => $option) {
            $wizard_options->addEntry($source_id, $option);
        }
        $wizard_options->read();
 
        // call object clone
        $newObject = $source_object->cloneObject($xml_parser->getTargetId(), $copy_id);
        return is_object($newObject) ? $newObject->getRefId() : -1;
    }

References $DIC, $lng, ilCopyWizardOptions\_allocateCopyId(), ilCopyWizardOptions\_getInstance(), canAddType(), ilSoapAdministration\checkSession(), ilObjectFactory\getInstanceByRefId(), ilSoapAdministration\getMessage(), ilSoapAdministration\getMessageCode(), ilObjectFactory\getTypeByRefId(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), ilSoapAdministration\isFault(), and ilSoapAdministration\raiseError().

Here is the call graph for this function:

◆ deleteObject()

ilSoapObjectAdministration::deleteObject	(	string	$sid,
		int	$reference_id
	)

Returns: bool|soap_fault|SoapFault|null

Definition at line 766 of file class.ilSoapObjectAdministration.php.

    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->checkSession($sid)) {
            return $this->raiseError($this->getMessage(), $this->getMessageCode());
        }
 
        global $DIC;
 
        $tree = $DIC->repositoryTree();
        $rbacsystem = $DIC['rbacsystem'];
        $rbacadmin = $DIC['rbacadmin'];
        $user = $DIC->user();
 
        if (!$del_obj = ilObjectFactory::getInstanceByRefId($reference_id, false)) {
            return $this->raiseError(
                'No valid reference id given.',
                'Client'
            );
        }
        if (!$rbacsystem->checkAccess('delete', $del_obj->getRefId())) {
            return $this->raiseError(
                'No permission to delete object with id: ' . $del_obj->getRefId() . '!',
                'Client'
            );
        }
 
        if ($tree->isDeleted($reference_id)) {
            return $this->raiseError('Node already deleted', 'Server');
        }
 
        if ($del_obj->getType() === 'rolf') {
            return $this->raiseError('Delete is not available for role folders.', 'Client');
        }
 
        $subnodes = $tree->getSubTree($tree->getNodeData($reference_id));
        foreach ($subnodes as $subnode) {
            $rbacadmin->revokePermission($subnode["child"]);
        }
        if (!$tree->moveToTrash($reference_id, true, $user->getId())) {
            return $this->raiseError('Node already deleted', 'Client');
        }
        return true;
    }

References $DIC, ilSoapAdministration\checkSession(), ilObjectFactory\getInstanceByRefId(), ilSoapAdministration\getMessage(), ilSoapAdministration\getMessageCode(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), and ilSoapAdministration\raiseError().

Here is the call graph for this function:

◆ getObjectByReference()

ilSoapObjectAdministration::getObjectByReference	(	string	$sid,
		int	$a_ref_id,
		?int	$user_id = `null`
	)

Returns: soap_fault|SoapFault|string|null

Definition at line 154 of file class.ilSoapObjectAdministration.php.

    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->checkSession($sid)) {
            return $this->raiseError($this->getMessage(), $this->getMessageCode());
        }
 
        if (!$tmp_obj = ilObjectFactory::getInstanceByRefId($a_ref_id, false)) {
            return $this->raiseError('Cannot create object instance!', 'Server');
        }
        if (ilObject::_isInTrash($a_ref_id)) {
            return $this->raiseError("Object with ID $a_ref_id has been deleted.", 'Client');
        }
 
        $xml_writer = new ilObjectXMLWriter();
        $xml_writer->enablePermissionCheck(true);
        if (is_int($user_id)) {
            $xml_writer->setUserId($user_id);
            $xml_writer->enableOperations(true);
        }
        $xml_writer->setObjects(array($tmp_obj));
        if ($xml_writer->start()) {
            return $xml_writer->getXML();
        }
        return $this->raiseError('Cannot create object xml !', 'Server');
    }

References $user_id, ilObject\_isInTrash(), ilSoapAdministration\checkSession(), ilObjectFactory\getInstanceByRefId(), ilSoapAdministration\getMessage(), ilSoapAdministration\getMessageCode(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), and ilSoapAdministration\raiseError().

Here is the call graph for this function:

◆ getObjectsByTitle()

ilSoapObjectAdministration::getObjectsByTitle	(	string	$sid,
		string	$a_title,
		?int	$user_id = `null`
	)

Returns: soap_fault|SoapFault|string|null

Definition at line 186 of file class.ilSoapObjectAdministration.php.

    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->checkSession($sid)) {
            return $this->raiseError($this->getMessage(), $this->getMessageCode());
        }
        if ($a_title === '') {
            return $this->raiseError(
                'No valid query string given.',
                'Client'
            );
        }
        $query_parser = new ilQueryParser($a_title);
        $query_parser->setMinWordLength(0);
        $query_parser->setCombination(ilQueryParser::QP_COMBINATION_AND);
        $query_parser->parse();
        if (!$query_parser->validate()) {
            return $this->raiseError(
                $query_parser->getMessage(),
                'Client'
            );
        }
 
        $object_search = new ilLikeObjectSearch($query_parser);
        $object_search->setFields(array('title'));
        $object_search->appendToFilter('role');
        $object_search->appendToFilter('rolt');
        $res = $object_search->performSearch();
        if ($user_id) {
            $res->setUserId($user_id);
        }
 
        $res->filter(ROOT_FOLDER_ID, true);
 
        $objs = array();
        foreach ($res->getUniqueResults() as $entry) {
            if ($entry['type'] === 'role' || $entry['type'] === 'rolt') {
                if ($tmp = ilObjectFactory::getInstanceByObjId($entry['obj_id'], false)) {
                    $objs[] = $tmp;
                }
                continue;
            }
            if ($tmp = ilObjectFactory::getInstanceByRefId($entry['ref_id'], false)) {
                $objs[] = $tmp;
            }
        }
        if (!count($objs)) {
            return '';
        }
 
        $xml_writer = new ilObjectXMLWriter();
        $xml_writer->enablePermissionCheck(true);
        if (is_int($user_id)) {
            $xml_writer->setUserId($user_id);
            $xml_writer->enableOperations(true);
        }
        $xml_writer->setObjects($objs);
        if ($xml_writer->start()) {
            return $xml_writer->getXML();
        }
        return $this->raiseError('Cannot create object xml !', 'Server');
    }

References $res, $user_id, ilSoapAdministration\checkSession(), ilObjectFactory\getInstanceByObjId(), ilObjectFactory\getInstanceByRefId(), ilSoapAdministration\getMessage(), ilSoapAdministration\getMessageCode(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), ilQueryParser\QP_COMBINATION_AND, ilSoapAdministration\raiseError(), and ROOT_FOLDER_ID.

Here is the call graph for this function:

◆ getObjIdByImportId()

ilSoapObjectAdministration::getObjIdByImportId	(	string	$sid,
		string	$import_id
	)

Returns: int|soap_fault|SoapFault|string|null

Definition at line 30 of file class.ilSoapObjectAdministration.php.

    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->checkSession($sid)) {
            return $this->raiseError($this->getMessage(), $this->getMessageCode());
        }
        if (!$import_id) {
            return $this->raiseError(
                'No import id given.',
                'Client'
            );
        }
 
        global $DIC;
 
        $ilLog = $DIC['ilLog'];
        $obj_id = ilObject::_lookupObjIdByImportId($import_id);
        $ilLog->write("SOAP getObjIdByImportId(): import_id = " . $import_id . ' obj_id = ' . $obj_id);
        return $obj_id ?: "0";
    }

References $DIC, ilObject\_lookupObjIdByImportId(), ilSoapAdministration\checkSession(), ilSoapAdministration\getMessage(), ilSoapAdministration\getMessageCode(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), and ilSoapAdministration\raiseError().

Here is the call graph for this function:

◆ getObjIdsByRefIds()

ilSoapObjectAdministration::getObjIdsByRefIds	(	string	$sid,
		array	$ref_ids
	)

Returns: array|soap_fault|SoapFault|null

Definition at line 115 of file class.ilSoapObjectAdministration.php.

    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->checkSession($sid)) {
            return $this->raiseError($this->getMessage(), $this->getMessageCode());
        }
 
        if (!count($ref_ids)) {
            return $this->raiseError('No reference id(s) given.', 'Client');
        }
 
        $obj_ids = [];
        foreach ($ref_ids as $ref_id) {
            $ref_id = trim($ref_id);
            if (!is_numeric($ref_id)) {
                return $this->raiseError('Reference ID has to be numeric. Value: ' . $ref_id, 'Client');
            }
 
            $obj_id = ilObject::_lookupObjectId($ref_id);
            if (!$obj_id) {
                return $this->raiseError('No object found for reference ID. Value: ' . $ref_id, 'Client');
            }
            if (!ilObject::_hasUntrashedReference($obj_id)) {
                return $this->raiseError(
                    'No untrashed reference found for reference ID. Value: ' . $ref_id,
                    'Client'
                );
            }
            $obj_ids[] = $obj_id;
        }
 
        return $obj_ids;
    }

References $ref_id, ilObject\_hasUntrashedReference(), ilObject\_lookupObjectId(), ilSoapAdministration\checkSession(), ilSoapAdministration\getMessage(), ilSoapAdministration\getMessageCode(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), and ilSoapAdministration\raiseError().

Here is the call graph for this function:

◆ getPathForRefId()

ilSoapObjectAdministration::getPathForRefId	(	string	$sid,
		int	$ref_id
	)

Returns: soap_fault|SoapFault|string|null

Definition at line 1175 of file class.ilSoapObjectAdministration.php.

    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->checkSession($sid)) {
            return $this->raiseError($this->getMessage(), $this->getMessageCode());
        }
 
        global $DIC;
 
        $ilAccess = $DIC['ilAccess'];
        $objDefinition = $DIC['objDefinition'];
        $rbacsystem = $DIC['rbacsystem'];
        $lng = $DIC['lng'];
        $ilUser = $DIC['ilUser'];
 
        if (!$rbacsystem->checkAccess('read', $ref_id)) {
            return $this->raiseError("Missing read permissions for object with reference id " . $ref_id, 'Client');
        }
 
        if (ilObject::_isInTrash($ref_id)) {
            return $this->raiseError("Object is in Trash", 'Client');
        }
        global $DIC;
 
        $tree = $DIC['tree'];
        $lng = $DIC['lng'];
        $items = $tree->getPathFull($ref_id);
 
        $xmlResultSet = new ilXMLResultSet();
        $xmlResultSet->addColumn("ref_id");
        $xmlResultSet->addColumn("type");
        $xmlResultSet->addColumn("title");
 
        $writer = new ilXMLResultSetWriter($xmlResultSet);
        foreach ($items as $item) {
            if ((int) $item["ref_id"] === $ref_id) {
                continue;
            }
            if ($item["title"] === "ILIAS" && $item["type"] === "root") {
                $item["title"] = $lng->txt("repository");
            }
 
            $row = new ilXMLResultSetRow();
            $xmlResultSet->addRow($row);
            $row->setValue("ref_id", $item["ref_id"]);
            $row->setValue("type", $item["type"]);
            $row->setValue("title", $item["title"]);
        }
        $writer->start();
        return $writer->getXML();
    }

References $DIC, $lng, $ref_id, ilObject\_isInTrash(), ilSoapAdministration\checkSession(), ilSoapAdministration\getMessage(), ilSoapAdministration\getMessageCode(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), and ilSoapAdministration\raiseError().

Here is the call graph for this function:

◆ getRefIdsByImportId()

ilSoapObjectAdministration::getRefIdsByImportId	(	string	$sid,
		string	$import_id
	)

Returns: array|soap_fault|SoapFault|null

Definition at line 56 of file class.ilSoapObjectAdministration.php.

    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->checkSession($sid)) {
            return $this->raiseError($this->getMessage(), $this->getMessageCode());
        }
        if (!$import_id) {
            return $this->raiseError(
                'No import id given.',
                'Client'
            );
        }
 
        global $DIC;
 
        $tree = $DIC->repositoryTree();
        $obj_id = ilObject::_lookupObjIdByImportId($import_id);
        $ref_ids = ilObject::_getAllReferences($obj_id);
 
        $new_refs = [];
        foreach ($ref_ids as $ref_id) {
            if ($tree->isInTree($ref_id)) {
                $new_refs[] = $ref_id;
            }
        }
        return $new_refs;
    }

References $DIC, $ref_id, ilObject\_getAllReferences(), ilObject\_lookupObjIdByImportId(), ilSoapAdministration\checkSession(), ilSoapAdministration\getMessage(), ilSoapAdministration\getMessageCode(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), and ilSoapAdministration\raiseError().

Here is the call graph for this function:

◆ getRefIdsByObjId()

ilSoapObjectAdministration::getRefIdsByObjId	(	string	$sid,
		int	$obj_id
	)

Returns: array|soap_fault|SoapFault|null

Definition at line 89 of file class.ilSoapObjectAdministration.php.

    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->checkSession($sid)) {
            return $this->raiseError($this->getMessage(), $this->getMessageCode());
        }
        if (!$obj_id) {
            return $this->raiseError(
                'No object id given.',
                'Client'
            );
        }
 
        $ref_ids = ilObject::_getAllReferences($obj_id);
        $new_refs = [];
        foreach ($ref_ids as $ref_id) {
            $new_refs[] = $ref_id;
        }
        return $new_refs;
    }

References $ref_id, ilObject\_getAllReferences(), ilSoapAdministration\checkSession(), ilSoapAdministration\getMessage(), ilSoapAdministration\getMessageCode(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), and ilSoapAdministration\raiseError().

Here is the call graph for this function:

◆ getTreeChilds()

ilSoapObjectAdministration::getTreeChilds	(	string	$sid,
		int	$ref_id,
		?array	$types = `null`,
		?int	$user_id = `null`
	)

Returns: soap_fault|SoapFault|string|null

Definition at line 369 of file class.ilSoapObjectAdministration.php.

    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->checkSession($sid)) {
            return $this->raiseError($this->getMessage(), $this->getMessageCode());
        }
 
        $all = false;
 
        global $DIC;
 
        $tree = $DIC['tree'];
 
        if (!$target_obj = ilObjectFactory::getInstanceByRefId($ref_id, false)) {
            return $this->raiseError(
                'No valid reference id given.',
                'Client'
            );
        }
        if ($ref_id === SYSTEM_FOLDER_ID) {
            return $this->raiseError(
                'No valid reference id given.',
                'Client'
            );
        }
 
        if (!is_array($types) || empty($types)) {
            $all = true;
        }
 
        $objs = array();
 
        foreach ($tree->getChilds($ref_id, 'title') as $child) {
            if ($all || in_array($child['type'], $types, true)) {
                if ($tmp = ilObjectFactory::getInstanceByRefId($child['ref_id'], false)) {
                    $objs[] = $tmp;
                }
            }
        }
 
        $xml_writer = new ilObjectXMLWriter();
        $xml_writer->enablePermissionCheck(true);
        $xml_writer->setObjects($objs);
        $xml_writer->enableOperations(true);
        if (is_int($user_id)) {
            $xml_writer->setUserId($user_id);
        }
 
        if ($xml_writer->start()) {
            return $xml_writer->getXML();
        }
        return $this->raiseError('Cannot create object xml !', 'Server');
    }

References $DIC, $ref_id, $user_id, ilSoapAdministration\checkSession(), ilObjectFactory\getInstanceByRefId(), ilSoapAdministration\getMessage(), ilSoapAdministration\getMessageCode(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), ilSoapAdministration\raiseError(), and SYSTEM_FOLDER_ID.

Here is the call graph for this function:

◆ getXMLTree()

ilSoapObjectAdministration::getXMLTree	(	string	$sid,
		int	$ref_id,
		?array	$types = `null`,
		?int	$user_id = `null`
	)

Returns: soap_fault|SoapFault|string|null

Definition at line 428 of file class.ilSoapObjectAdministration.php.

    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->checkSession($sid)) {
            return $this->raiseError($this->getMessage(), $this->getMessageCode());
        }
 
        global $DIC;
 
        $tree = $DIC['tree'];
        $access = $DIC['ilAccess'];
 
        $nodedata = $tree->getNodeData($ref_id);
        $nodearray = $tree->getSubTree($nodedata);
 
        $all = false;
        if (!is_array($types) || empty($types)) {
            $all = true;
        }
 
        $filter = $types;
 
        global $DIC;
 
        $objDefinition = $DIC['objDefinition'];
        $nodes = [];
        foreach ($nodearray as $node) {
            if (
                !$objDefinition->isAdministrationObject($node['type']) &&
                !$objDefinition->isSystemObject($node['type']) &&
                ($all || !in_array($node['type'], $filter, true)) &&
                $access->checkAccess("read", "", (int) $node['ref_id']) &&
                ($tmp = ilObjectFactory::getInstanceByRefId($node['ref_id'], false))) {
                $nodes[] = $tmp;
            }
        }
 
        $xml_writer = new ilObjectXMLWriter();
        $xml_writer->enablePermissionCheck(true);
        $xml_writer->setObjects($nodes);
        $xml_writer->enableOperations(false);
 
        if (is_int($user_id)) {
            $xml_writer->setUserId($user_id);
        }
 
        if ($xml_writer->start()) {
            return $xml_writer->getXML();
        }
 
        return $this->raiseError('Cannot create object xml !', 'Server');
    }

References $DIC, $ref_id, $user_id, ilSoapAdministration\checkSession(), ilObjectFactory\getInstanceByRefId(), ilSoapAdministration\getMessage(), ilSoapAdministration\getMessageCode(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), and ilSoapAdministration\raiseError().

Here is the call graph for this function:

◆ moveObject()

ilSoapObjectAdministration::moveObject	(	string	$sid,
		int	$ref_id,
		int	$target_id
	)

Returns: bool|soap_fault|SoapFault|null

Definition at line 1016 of file class.ilSoapObjectAdministration.php.

    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->checkSession($sid)) {
            return $this->raiseError($this->getMessage(), $this->getMessageCode());
        }
 
        global $DIC;
 
        $rbacreview = $DIC['rbacreview'];
        $rbacadmin = $DIC['rbacadmin'];
        $objDefinition = $DIC['objDefinition'];
        $rbacsystem = $DIC['rbacsystem'];
        $lng = $DIC['lng'];
        $ilUser = $DIC['ilUser'];
        $tree = $DIC['tree'];
 
        // does source object exist
        if (!$source_object_type = ilObjectFactory::getTypeByRefId($ref_id, false)) {
            return $this->raiseError('No valid source given.', 'Client');
        }
 
        // does target object exist
        if (!$target_object_type = ilObjectFactory::getTypeByRefId($target_id, false)) {
            return $this->raiseError('No valid target given.', 'Client');
        }
 
        // check for trash
        if (ilObject::_isInTrash($ref_id)) {
            return $this->raiseError('Object is trashed.', 'Client');
        }
 
        if (ilObject::_isInTrash($target_id)) {
            return $this->raiseError('Object is trashed.', 'Client');
        }
 
        $canAddType = $this->canAddType($source_object_type, $target_object_type, $target_id);
        if ($this->isFault($canAddType)) {
            return $canAddType;
        }
 
        // check if object already linked to target
        $possibleChilds = $tree->getChildsByType($target_id, $ref_id);
        foreach ($possibleChilds as $child) {
            if ((int) $child["obj_id"] === $ref_id) {
                return $this->raiseError("Object already exists in target.", "Client");
            }
        }
 
        // CHECK IF PASTE OBJECT SHALL BE CHILD OF ITSELF
        if ($tree->isGrandChild($ref_id, $target_id)) {
            return $this->raiseError("Cannot move object into itself.", "Client");
        }
 
        $old_parent = $tree->getParentId($ref_id);
        $tree->moveTree($ref_id, $target_id);
        $rbacadmin->adjustMovedObjectPermissions($ref_id, $old_parent);
 
        ilConditionHandler::_adjustMovedObjectConditions($ref_id);
        return true;
    }

References $DIC, $lng, $ref_id, ilConditionHandler\_adjustMovedObjectConditions(), ilObject\_isInTrash(), canAddType(), ilSoapAdministration\checkSession(), ilSoapAdministration\getMessage(), ilSoapAdministration\getMessageCode(), ilObjectFactory\getTypeByRefId(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), ilSoapAdministration\isFault(), and ilSoapAdministration\raiseError().

Here is the call graph for this function:

◆ removeFromSystemByImportId()

ilSoapObjectAdministration::removeFromSystemByImportId	(	string	$sid,
		string	$import_id
	)

Returns: bool|soap_fault|SoapFault|null

Definition at line 816 of file class.ilSoapObjectAdministration.php.

    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->checkSession($sid)) {
            return $this->raiseError($this->getMessage(), $this->getMessageCode());
        }
        if ($import_id === '') {
            return $this->raiseError(
                'No import id given. Aborting!',
                'Client'
            );
        }
        global $DIC;
 
        $rbacsystem = $DIC['rbacsystem'];
        $tree = $DIC['tree'];
        $ilLog = $DIC['ilLog'];
 
        // get obj_id
        if (!$obj_id = ilObject::_lookupObjIdByImportId($import_id)) {
            return $this->raiseError(
                'No object found with import id: ' . $import_id,
                'Client'
            );
        }
 
        // Check access
        $permission_ok = false;
        foreach ($ref_ids = ilObject::_getAllReferences($obj_id) as $ref_id) {
            if ($rbacsystem->checkAccess('delete', $ref_id)) {
                $permission_ok = true;
                break;
            }
        }
        if (!$permission_ok) {
            return $this->raiseError(
                'No permission to delete the object with import id: ' . $import_id,
                'Server'
            );
        }
 
        // Delete all references (delete permssions and entries in object_reference)
        foreach ($ref_ids as $ref_id) {
            // All subnodes
            $node_data = $tree->getNodeData($ref_id);
            $subtree_nodes = $tree->getSubtree($node_data);
 
            foreach ($subtree_nodes as $node) {
                $ilLog->write('Soap: removeFromSystemByImportId(). Deleting object with title id: ' . $node['title']);
                $tmp_obj = ilObjectFactory::getInstanceByRefId($node['ref_id']);
                if (!is_object($tmp_obj)) {
                    return $this->raiseError(
                        'Cannot create instance of reference id: ' . $node['ref_id'],
                        'Server'
                    );
                }
                $tmp_obj->delete();
            }
            // Finally delete tree
            $tree->deleteTree($node_data);
        }
        return true;
    }

References $DIC, $ref_id, ilObject\_getAllReferences(), ilObject\_lookupObjIdByImportId(), ilSoapAdministration\checkSession(), ilObjectFactory\getInstanceByRefId(), ilSoapAdministration\getMessage(), ilSoapAdministration\getMessageCode(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), and ilSoapAdministration\raiseError().

Here is the call graph for this function:

◆ searchObjects()

ilSoapObjectAdministration::searchObjects	(	string	$sid,
		?array	$types,
		string	$key,
		string	$combination,
		?int	$user_id = `null`
	)

Returns: soap_fault|SoapFault|string|null

Definition at line 254 of file class.ilSoapObjectAdministration.php.

    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->checkSession($sid)) {
            return $this->raiseError($this->getMessage(), $this->getMessageCode());
        }
 
        if ($combination !== 'and' && $combination !== 'or') {
            return $this->raiseError(
                'No valid combination given. Must be "and" or "or".',
                'Client'
            );
        }
 
        $highlighter = null;
        if (ilSearchSettings::getInstance()->enabledLucene()) {
            ilSearchSettings::getInstance()->setMaxHits(25);
 
            $typeFilterQuery = '';
            if (is_array($types)) {
                foreach ($types as $objectType) {
                    if ($typeFilterQuery === '') {
                        $typeFilterQuery .= '+( ';
                    } else {
                        $typeFilterQuery .= 'OR';
                    }
                    $typeFilterQuery .= (' type:' . $objectType . ' ');
                }
                $typeFilterQuery .= ') ';
            }
 
            $query_parser = new ilLuceneQueryParser($typeFilterQuery . $key);
            $query_parser->parse();
 
            $searcher = ilLuceneSearcher::getInstance($query_parser);
            $searcher->search();
 
            $filter = ilLuceneSearchResultFilter::getInstance($user_id);
            $filter->setCandidates($searcher->getResult());
            $filter->filter();
 
            $result_ids = $filter->getResults();
            $objs = array();
            $objs[ROOT_FOLDER_ID] = ilObjectFactory::getInstanceByRefId(ROOT_FOLDER_ID, false);
            foreach ($result_ids as $ref_id => $obj_id) {
                $obj = ilObjectFactory::getInstanceByRefId($ref_id, false);
                if ($obj instanceof ilObject) {
                    $objs[] = $obj;
                }
            }
            $highlighter = new ilLuceneHighlighterResultParser();
            if ($filter->getResultObjIds()) {
                $highlighter = $searcher->highlight($filter->getResultObjIds());
            }
        } else {
 
            $query_parser = new ilQueryParser($key);
            $query_parser->setCombination($combination === 'and' ? ilQueryParser::QP_COMBINATION_AND : ilQueryParser::QP_COMBINATION_OR);
            $query_parser->parse();
            if (!$query_parser->validate()) {
                return $this->raiseError(
                    $query_parser->getMessage(),
                    'Client'
                );
            }
 
            $object_search = new ilLikeObjectSearch($query_parser);
            $object_search->setFilter($types);
            $res = $object_search->performSearch();
            if (is_int($user_id)) {
                $res->setUserId($user_id);
            }
            $res->setMaxHits(100);
            $res->filter(ROOT_FOLDER_ID, $combination === 'and');
            $counter = 0;
            $objs = array();
            foreach ($res->getUniqueResults() as $entry) {
                $obj = ilObjectFactory::getInstanceByRefId($entry['ref_id'], false);
                if ($obj instanceof ilObject) {
                    $objs[] = $obj;
                }
            }
        }
 
        if (!count($objs)) {
            return '';
        }
 
        $xml_writer = new ilObjectXMLWriter();
        if (ilSearchSettings::getInstance()->enabledLucene()) {
            $xml_writer->enableReferences(false);
            $xml_writer->setMode(ilObjectXMLWriter::MODE_SEARCH_RESULT);
            $xml_writer->setHighlighter($highlighter);
        }
 
        $xml_writer->enablePermissionCheck(true);
 
        if ($user_id) {
            $xml_writer->setUserId($user_id);
            $xml_writer->enableOperations(true);
        }
 
        $xml_writer->setObjects($objs);
        if ($xml_writer->start()) {
            return $xml_writer->getXML();
        }
 
        return $this->raiseError('Cannot create object xml !', 'Server');
    }

References $counter, $ref_id, $res, $user_id, ilSoapAdministration\checkSession(), ilSearchSettings\getInstance(), ilLuceneSearcher\getInstance(), ilLuceneSearchResultFilter\getInstance(), ilObjectFactory\getInstanceByRefId(), ilSoapAdministration\getMessage(), ilSoapAdministration\getMessageCode(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), ilObjectXMLWriter\MODE_SEARCH_RESULT, ilQueryParser\QP_COMBINATION_AND, ilQueryParser\QP_COMBINATION_OR, ilSoapAdministration\raiseError(), and ROOT_FOLDER_ID.

Here is the call graph for this function:

◆ updateReferences()

ilSoapObjectAdministration::updateReferences ( array $a_object_data )

private

Definition at line 1327 of file class.ilSoapObjectAdministration.php.

                                                           : void
    {
        global $DIC;
 
        $tree = $DIC['tree'];
        $ilLog = $DIC['ilLog'];
 
        if (!isset($a_object_data['references']) || !count($a_object_data['references'])) {
            return;
        }
 
        foreach ($a_object_data['references'] as $ref_data) {
            if (isset($ref_data['time_target'])) {
                $old = ilObjectActivation::getItem($ref_data['ref_id']);
 
                $items = new ilObjectActivation();
                $items->toggleChangeable($ref_data['time_target']['changeable'] ?? $old['changeable']);
                $items->setTimingStart($ref_data['time_target']['starting_time'] ?? $old['timing_start']);
                $items->setTimingEnd($ref_data['time_target']['ending_time'] ?? $old['timing_end']);
                $items->toggleVisible($ref_data['time_target']['timing_visibility'] ?? $old['visible']);
                $items->setSuggestionStart($ref_data['time_target']['suggestion_start'] ?? $old['suggestion_start']);
                $items->setSuggestionEnd($ref_data['time_target']['suggestion_end'] ?? $old['suggestion_end']);
 
                switch ($ref_data['time_target']['timing_type']) {
                    case ilObjectXMLWriter::TIMING_DEACTIVATED:
                        $ilLog->write(__METHOD__ . ilObjectActivation::TIMINGS_DEACTIVATED . ' ' . $ref_data['time_target']['timing_type']);
                        $items->setTimingType(ilObjectActivation::TIMINGS_DEACTIVATED);
                        break;
 
                    case ilObjectXMLWriter::TIMING_TEMPORARILY_AVAILABLE:
                        $ilLog->write(__METHOD__ . ilObjectActivation::TIMINGS_ACTIVATION . ' ' . $ref_data['time_target']['timing_type']);
                        $items->setTimingType(ilObjectActivation::TIMINGS_ACTIVATION);
                        break;
 
                    case ilObjectXMLWriter::TIMING_PRESETTING:
                        $ilLog->write(__METHOD__ . ilObjectActivation::TIMINGS_PRESETTING . ' ' . $ref_data['time_target']['timing_type']);
                        $items->setTimingType(ilObjectActivation::TIMINGS_PRESETTING);
                        break;
                }
                $items->update($ref_data['ref_id']);
            }
        }
    }

References $DIC, ilObjectActivation\getItem(), ilObjectXMLWriter\TIMING_DEACTIVATED, ilObjectXMLWriter\TIMING_PRESETTING, ilObjectXMLWriter\TIMING_TEMPORARILY_AVAILABLE, ilObjectActivation\TIMINGS_ACTIVATION, ilObjectActivation\TIMINGS_DEACTIVATED, and ilObjectActivation\TIMINGS_PRESETTING.

Here is the call graph for this function:

◆ validateReferences()

ilSoapObjectAdministration::validateReferences	(	string	$a_action,
		array	$a_object_data,
		int	$a_target_id = `0`
	)

private

Definition at line 1267 of file class.ilSoapObjectAdministration.php.

    {
        global $DIC;
 
        $ilAccess = $DIC['ilAccess'];
 
        if (!isset($a_object_data['references']) || !count($a_object_data['references'])) {
            return true;
        }
        if ($a_action === 'create') {
            if (count($a_object_data['references']) > 1 && in_array(
                $a_object_data['type'],
                ['cat', 'crs', 'grp', 'fold'],
                true
            )) {
                return $this->raiseError(
                    "Cannot create references for type " . $a_object_data['type'],
                    'Client'
                );
            }
            if (count($a_object_data['references']) === 1 && $a_target_id != $a_object_data['references'][0]['parent_id']) {
                return $this->raiseError(
                    "Cannot create references for type " . $a_object_data['type'],
                    'Client'
                );
            }
 
            foreach ($a_object_data['references'] as $ref_data) {
                if (!$ref_data['parent_id']) {
                    return $this->raiseError('Element References: No parent Id given!', 'Client');
                }
 
                $target_type = ilObject::_lookupType(ilObject::_lookupObjId($ref_data['parent_id']));
                $can_add_type = $this->canAddType($a_object_data['type'], $target_type, $ref_data['parent_id']);
                if ($this->isFault($can_add_type)) {
                    return $can_add_type;
                }
            }
            return true;
        }
 
        if ($a_action === 'update') {
            foreach ($a_object_data['references'] as $ref_data) {
                if (!$ref_data['ref_id']) {
                    return $this->raiseError('Element References: No reference id given!', 'Client');
                }
                // check permissions
                if (!$ilAccess->checkAccess('write', '', $ref_data['ref_id'])) {
                    return $this->raiseError(
                        'No write permission for object with reference id ' . $ref_data['ref_id'] . '!',
                        'Client'
                    );
                }
                // TODO: check if all references belong to the same object
            }
            return true;
        }
        return true;
    }

References $DIC, ilObject\_lookupObjId(), ilObject\_lookupType(), canAddType(), ilSoapAdministration\isFault(), and ilSoapAdministration\raiseError().

Here is the call graph for this function:

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

components/ILIAS/soap/classes/class.ilSoapObjectAdministration.php

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addReference()

◆ addReferences()

◆ canAddType()

◆ copyObject()

◆ deleteObject()

◆ getObjectByReference()

◆ getObjectsByTitle()

◆ getObjIdByImportId()

◆ getObjIdsByRefIds()

◆ getPathForRefId()

◆ getRefIdsByImportId()

◆ getRefIdsByObjId()

◆ getTreeChilds()

◆ getXMLTree()

◆ moveObject()

◆ removeFromSystemByImportId()

◆ searchObjects()

◆ updateReferences()

◆ validateReferences()