ilSoapObjectAdministration Class Reference

Inheritance diagram for ilSoapObjectAdministration:

Collaboration diagram for ilSoapObjectAdministration:

Public Member Functions
	addDesktopItems ($sid, $user_id, $reference_ids)
	Add desktop items for user. More...
	removeDesktopItems ($sid, $user_id, $reference_ids)
	Remove desktop items for user. More...
	getObjIdByImportId ($sid, $import_id)
	getRefIdsByImportId ($sid, $import_id)
	getRefIdsByObjId ($sid, $obj_id)
	getObjIdsByRefIds ($sid, $ref_ids)
	Returns a array of object ids which match the references id, given by a comma seperated string. More...
	getObjectByReference ($sid, $a_ref_id, $user_id)
	getObjectsByTitle ($sid, $a_title, $user_id)
	searchObjects ($sid, $types, $key, $combination, $user_id)
	getTreeChilds ($sid, $ref_id, $types, $user_id)
	getXMLTree ($sid, $ref_id, $types, $user_id)
	addReference ($sid, $a_source_id, $a_target_id)
	deleteObject ($sid, $reference_id)
	removeFromSystemByImportId ($sid, $import_id)
	moveObject ($sid, $ref_id, $target_id)
	copyObject ($sid, $copy_settings_xml)
	copy object in repository $sid session id $settings_xml contains copy wizard settings following ilias_copy_wizard_settings.dtd More...
	getPathForRefId ($sid, $ref_id)
Public Member Functions inherited from ilSoapAdministration
	__construct ($use_nusoap=true)
	Constructor. More...
	initErrorWriter ()
	Overwrite error handler. More...
	__explodeSid ($sid)
	__setMessage ($a_str)
	__getMessage ()
	__appendMessage ($a_str)
	__setMessageCode ($a_code)
	__getMessageCode ()
	initAuth ($sid)
	Init authentication. More...
	initIlias ()
	__initAuthenticationObject ($a_auth_mode=AUTH_LOCAL)
	__raiseError ($a_message, $a_code)
	getNIC ($sid)
	get client information from current as xml result set More...
	isFault ($object)
	checkObjectAccess ($ref_id, $expected_type, $permission, $returnObject=false)
	check access for ref id: expected type, permission, return object instance if returnobject is true More...
	getInstallationInfoXML ()
	getClientInfoXML ($clientid)

Private Member Functions
	canAddType ($type, $target_type, $target_id)
	validateReferences ($a_action, $a_object_data, $a_target_id=0)
	updateReferences ($a_object_data)
	addReferences ($source, $a_object_data)

Additional Inherited Members
Static Public Member Functions inherited from ilSoapAdministration
static	return_bytes ($val)
	calculate bytes from K,M,G modifiers e.g: 8M = 8 * 1024 * 1024 bytes More...
Data Fields inherited from ilSoapAdministration
	$sauth = null
	$error_method = null
Protected Attributes inherited from ilSoapAdministration
	$soap_check = true

Detailed Description

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

Member Function Documentation

addDesktopItems()

ilSoapObjectAdministration::addDesktopItems	(		$sid,
			$user_id,
			$reference_ids
	)

Add desktop items for user.

Parameters

string	$sid
int	$user_id
	int[]	$reference_ids

Returns

bool

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

References $DIC, ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilObjectFactory\getInstanceByObjId(), ilObjectFactory\getInstanceByRefId(), ilSoapAdministration\initAuth(), and ilSoapAdministration\initIlias().

    {
        return; // abandonded
        $this->initAuth($sid);
        $this->initIlias();

        if (!$this->__checkSession($sid)) {
            return $this->__raiseError($this->__getMessage(), $this->__getMessageCode());
        }

        global $DIC;

        $access = $DIC->rbac()->system();
        $logger = $DIC->logger()->wsrv();

        if (!$access->checkAccess('edit_userassignment', ROLE_FOLDER_ID)) {
            $logger->warning('Missing permission "edit_userassignment".');
            return $this->__raiseError(
                'Missing permission "edit_userassignment".',
                'Client'
            );
        }

        $user = ilObjectFactory::getInstanceByObjId($user_id, false);
        if (!$user instanceof ilObjUser) {
            $logger->warning('Invalid user id given. Cannot instantiate user for id: ' . $user_id);
            return $this->__raiseError(
                'Invalid user id given. Cannot instantiate user for id: ' . $user_id,
                'Client'
            );
        }
        $num_added = 0;
        foreach ($reference_ids as $ref_id) {
            // short "validation" of reference id
            $ref_obj = ilObjectFactory::getInstanceByRefId($ref_id, false);
            if (!$ref_obj instanceof ilObject) {
                $logger->warning('Invalid reference id passed to SOAP::addDesktopItems: ' . $ref_id);
                continue;
            }

            $num_added++;
            /*                  ilObjUser::_addDesktopItem(
                            $user->getId(),
                            $ref_id,
                            ilObject::_lookupType($ref_id,true)
                        );*/
        }
        return $num_added;
    }

Here is the call graph for this function:

addReference()

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

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

References $DIC, ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilObjectFactory\getInstanceByRefId(), ilSoapAdministration\initAuth(), and ilSoapAdministration\initIlias().

    {
        $this->initAuth($sid);
        $this->initIlias();

        if (!$this->__checkSession($sid)) {
            return $this->__raiseError($this->__getMessage(), $this->__getMessageCode());
        }
        if (!is_numeric($a_source_id)) {
            return $this->__raiseError(
                'No source id given.',
                'Client'
            );
        }
        if (!is_numeric($a_target_id)) {
            return $this->__raiseError(
                'No target id given.',
                'Client'
            );
        }

        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();
        foreach ($allowed_subtypes as $row) {
            if ($row['name'] != 'rolf') {
                $allowed[] = $row['name'];
            }
        }
        if (!in_array($source_obj->getType(), $allowed)) {
            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 ($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 ? $new_ref_id : "0";
        } else {
            switch ($source_obj->getType()) {
                case 'cat':
                    include_once('./Modules/CategoryReference/classes/class.ilObjCategoryReference.php');
                    $new_ref = new ilObjCategoryReference();
                    break;
                    
                case 'crs':
                    include_once('./Modules/CourseReference/classes/class.ilObjCourseReference.php');
                    $new_ref = new ilObjCourseReference();
                    break;
                case 'grp':
                    include_once('./Modules/GroupReference/classes/class.ilObjGroupReference.php');
                    $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();
            
            return $new_ref_id ? $new_ref_id : 0;
        }
    }

Here is the call graph for this function:

addReferences()

ilSoapObjectAdministration::addReferences (   $source,   $a_object_data  )

private

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

References $DIC, $ilLog, $source, ilObjectXMLWriter\TIMING_DEACTIVATED, ilObjectXMLWriter\TIMING_PRESETTING, ilObjectXMLWriter\TIMING_TEMPORARILY_AVAILABLE, ilObjectActivation\TIMINGS_ACTIVATION, ilObjectActivation\TIMINGS_DEACTIVATED, and ilObjectActivation\TIMINGS_PRESETTING.

Referenced by getXMLTree().

    {
        global $DIC;

        $tree = $DIC['tree'];
        $ilLog = $DIC['ilLog'];
        
        if (!isset($a_object_data['references']) or !count($a_object_data['references'])) {
            return true;
        }
        
        $original_id = $source->getRefId();
        
        foreach ($a_object_data['references'] as $ref_data) {
            $new_ref_id = $ref_id = $original_id;
            if ($tree->getParentId($original_id) != $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')) */) {
                include_once('./webservice/soap/classes/class.ilObjectXMLWriter.php');
                include_once('./Services/Object/classes/class.ilObjectActivation.php');
                
                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);
            }
        }
    }

Here is the caller graph for this function:

canAddType()

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

private

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

References $DIC, $target_id, $target_type, $type, and ilSoapAdministration\__raiseError().

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

    {
        // 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)) {
            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)) {
            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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

copyObject()

ilSoapObjectAdministration::copyObject	(		$sid,
			$copy_settings_xml
	)

copy object in repository $sid session id $settings_xml contains copy wizard settings following ilias_copy_wizard_settings.dtd

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

References $DIC, $ilUser, $lng, $ret, $target_id, ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilCopyWizardOptions\_allocateCopyId(), ilCopyWizardOptions\_getInstance(), canAddType(), ilObjectFactory\getInstanceByRefId(), ilObjectFactory\getTypeByRefId(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), and ilSoapAdministration\isFault().

    {
        $this->initAuth($sid);
        $this->initIlias();

        if (!$this->__checkSession($sid)) {
            return $this->__raiseError($this->__getMessage(), $this->__getMessageCode());
        }


        include_once './webservice/soap/classes/class.ilSoapUtils.php';
        global $DIC;

        $rbacreview = $DIC['rbacreview'];
        $objDefinition = $DIC['objDefinition'];
        $rbacsystem = $DIC['rbacsystem'];
        $lng = $DIC['lng'];
        $ilUser = $DIC['ilUser'];

        include_once './webservice/soap/classes/class.ilCopyWizardSettingsXMLParser.php';
        $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'];
        } else {
            // 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;
        }
    }

Here is the call graph for this function:

deleteObject()

ilSoapObjectAdministration::deleteObject	(		$sid,
			$reference_id
	)

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

References $DIC, ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilObjectFactory\getInstanceByRefId(), ilSoapAdministration\initAuth(), and ilSoapAdministration\initIlias().

    {
        $this->initAuth($sid);
        $this->initIlias();

        if (!$this->__checkSession($sid)) {
            return $this->__raiseError($this->__getMessage(), $this->__getMessageCode());
        }
        if (!is_numeric($reference_id)) {
            return $this->__raiseError(
                'No reference id given.',
                'Client'
            );
        }
        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'
            );
        }

        // Delete tree
        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;
    }

Here is the call graph for this function:

getObjectByReference()

ilSoapObjectAdministration::getObjectByReference	(		$sid,
			$a_ref_id,
			$user_id
	)

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

References ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilObject\_isInTrash(), ilObjectFactory\getInstanceByRefId(), ilSoapAdministration\initAuth(), and ilSoapAdministration\initIlias().

    {
        $this->initAuth($sid);
        $this->initIlias();

        if (!$this->__checkSession($sid)) {
            return $this->__raiseError($this->__getMessage(), $this->__getMessageCode());
        }
        if (!is_numeric($a_ref_id)) {
            return $this->__raiseError(
                'No valid reference id given. Please choose an existing reference id of an ILIAS object',
                'Client'
            );
        }

        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');
        }

        include_once './webservice/soap/classes/class.ilObjectXMLWriter.php';

        $xml_writer = new ilObjectXMLWriter();
        $xml_writer->enablePermissionCheck(true);
        if ($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');
    }

Here is the call graph for this function:

getObjectsByTitle()

ilSoapObjectAdministration::getObjectsByTitle	(		$sid,
			$a_title,
			$user_id
	)

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

References $res, ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilObjectFactory\getInstanceByObjId(), ilObjectFactory\getInstanceByRefId(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), and QP_COMBINATION_AND.

    {
        $this->initAuth($sid);
        $this->initIlias();

        if (!$this->__checkSession($sid)) {
            return $this->__raiseError($this->__getMessage(), $this->__getMessageCode());
        }
        if (!strlen($a_title)) {
            return $this->__raiseError(
                'No valid query string given.',
                'Client'
            );
        }

        include_once './Services/Search/classes/class.ilQueryParser.php';

        $query_parser = new ilQueryParser($a_title);
        $query_parser->setMinWordLength(0, true);
        $query_parser->setCombination(QP_COMBINATION_AND);
        $query_parser->parse();
        if (!$query_parser->validate()) {
            return $this->__raiseError(
                $query_parser->getMessage(),
                'Client'
            );
        }

        include_once './Services/Search/classes/class.ilObjectSearchFactory.php';

        include_once 'Services/Search/classes/Like/class.ilLikeObjectSearch.php';
        $object_search = new ilLikeObjectSearch($query_parser);

        #$object_search =& ilObjectSearchFactory::_getObjectSearchInstance($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' or $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 '';
        }

        include_once './webservice/soap/classes/class.ilObjectXMLWriter.php';

        $xml_writer = new ilObjectXMLWriter();
        $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');
    }

Here is the call graph for this function:

getObjIdByImportId()

ilSoapObjectAdministration::getObjIdByImportId	(		$sid,
			$import_id
	)

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

References $DIC, $ilLog, ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilObject\_lookupObjIdByImportId(), ilSoapAdministration\initAuth(), and ilSoapAdministration\initIlias().

    {
        $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 ? $obj_id : "0";
    }

Here is the call graph for this function:

getObjIdsByRefIds()

ilSoapObjectAdministration::getObjIdsByRefIds	(		$sid,
			$ref_ids
	)

Returns a array of object ids which match the references id, given by a comma seperated string.

Parameters

string	$sid	Session ID
	array	of int $ref ids as comma separated list

Returns

array of ref ids, same order as object ids there for there might by duplicates

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

References ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilObject\_hasUntrashedReference(), ilObject\_lookupObjectId(), ilSoapAdministration\initAuth(), and ilSoapAdministration\initIlias().

    {
        $this->initAuth($sid);
        $this->initIlias();

        if (!$this->__checkSession($sid)) {
            return $this->__raiseError($this->__getMessage(), $this->__getMessageCode());
        }


        if (!count($ref_ids) || !is_array($ref_ids)) {
            return $this->__raiseError('No reference id(s) given.', 'Client');
        }

        $obj_ids = array();
        if (count($ref_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;
    }

Here is the call graph for this function:

getPathForRefId()

ilSoapObjectAdministration::getPathForRefId	(		$sid,
			$ref_id
	)

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

References $DIC, $ilUser, $lng, ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilObject\_isInTrash(), ilSoapAdministration\initAuth(), and ilSoapAdministration\initIlias().

    {
        $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);
                
        include_once 'webservice/soap/classes/class.ilXMLResultSet.php';
        include_once 'webservice/soap/classes/class.ilXMLResultSetWriter.php';
        include_once 'Modules/Course/classes/class.ilCourseXMLWriter.php';

        $xmlResultSet = new ilXMLResultSet();
        $xmlResultSet->addColumn("ref_id");
        $xmlResultSet->addColumn("type");
        $xmlResultSet->addColumn("title");
        
        $writer = new ilXMLResultSetWriter($xmlResultSet);
        foreach ($items as $item) {
            if ($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();
    }

Here is the call graph for this function:

getRefIdsByImportId()

ilSoapObjectAdministration::getRefIdsByImportId	(		$sid,
			$import_id
	)

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

References $DIC, ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilObject\_getAllReferences(), ilObject\_lookupObjIdByImportId(), ilSoapAdministration\initAuth(), and ilSoapAdministration\initIlias().

    {
        $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['tree'];

        $obj_id = ilObject::_lookupObjIdByImportId($import_id);


        $ref_ids = ilObject::_getAllReferences($obj_id);

        foreach ($ref_ids as $ref_id) {
            // only get non deleted reference ids
            if ($tree->isInTree($ref_id)) {
                $new_refs[] = $ref_id;
            }
        }
        return $new_refs ? $new_refs : array();
    }

Here is the call graph for this function:

getRefIdsByObjId()

ilSoapObjectAdministration::getRefIdsByObjId	(		$sid,
			$obj_id
	)

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

References ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilObject\_getAllReferences(), ilSoapAdministration\initAuth(), and ilSoapAdministration\initIlias().

    {
        $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);
        foreach ($ref_ids as $ref_id) {
            $new_refs[] = $ref_id;
        }
        return $new_refs ? $new_refs : array();
    }

Here is the call graph for this function:

getTreeChilds()

ilSoapObjectAdministration::getTreeChilds	(		$sid,
			$ref_id,
			$types,
			$user_id
	)

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

References $DIC, ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilFMSettings\getInstance(), ilObjectFactory\getInstanceByRefId(), ilSoapAdministration\initAuth(), and ilSoapAdministration\initIlias().

    {
        $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 (intval($ref_id) == SYSTEM_FOLDER_ID) {
            return $this->__raiseError(
                'No valid reference id given.',
                'Client'
            );
        }

        if (!$types) {
            $all = true;
        }

        $objs = array();

        // begin-patch filemanager
        include_once './Services/WebServices/FileManager/classes/class.ilFMSettings.php';
        if (in_array('parent', (array) $types)) {
            $objs[] = $target_obj;
        }
        // end-patch filemanager

        foreach ($tree->getChilds($ref_id, 'title') as $child) {
            if ($all or in_array($child['type'], $types)) {
                if ($tmp = ilObjectFactory::getInstanceByRefId($child['ref_id'], false)) {
                    $objs[] = $tmp;
                }
            }
        }

        include_once './webservice/soap/classes/class.ilObjectXMLWriter.php';

        $xml_writer = new ilObjectXMLWriter();
        // begin-patch filemanager
        if (ilFMSettings::getInstance()->isEnabled()) {
            $xml_writer->enableReferences(false);
        }
        // end-patch filemanager
        $xml_writer->enablePermissionCheck(true);
        $xml_writer->setObjects($objs);
        $xml_writer->enableOperations(true);
        if ($user_id) {
            $xml_writer->setUserId($user_id);
        }

        if ($xml_writer->start()) {
            #$GLOBALS['DIC']['ilLog']->write(__METHOD__.': '.$xml_writer->getXML());
            return $xml_writer->getXML();
        }

        return $this->__raiseError('Cannot create object xml !', 'Server');
    }

Here is the call graph for this function:

getXMLTree()

ilSoapObjectAdministration::getXMLTree	(		$sid,
			$ref_id,
			$types,
			$user_id
	)

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

References $DIC, Vendor\Package\$e, $ilUser, $lng, $location, $res, ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilObject\_exists(), ilObject\_isInTrash(), ilObjUser\_lookupId(), ilObject\_lookupObjIdByImportId(), addReferences(), ilObjectFactory\getInstanceByRefId(), IL_CRS_ADMIN, ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), ilSoapAdministration\isFault(), and validateReferences().

    {
        $this->initAuth($sid);
        $this->initIlias();

        if (!$this->__checkSession($sid)) {
            return $this->__raiseError($this->__getMessage(), $this->__getMessageCode());
        }

        global $DIC;

        $tree = $DIC['tree'];

        $nodedata = $tree->getNodeData($ref_id);
        $nodearray = $tree->getSubTree($nodedata);


        $filter = (array) $types;

        global $DIC;

        $objDefinition = $DIC['objDefinition'];
        foreach ($nodearray as $node) {
            if (!$objDefinition->isAdministrationObject($node['type']) && !$objDefinition->isSystemObject($node['type'])) {
                if (!in_array($node['type'], $filter)) {
                    if ($tmp = ilObjectFactory::getInstanceByRefId($node['ref_id'], false)) {
                        $nodes[] = $tmp;
                    }
                }
            }
        }


        include_once './webservice/soap/classes/class.ilObjectXMLWriter.php';

        $xml_writer = new ilObjectXMLWriter();
        $xml_writer->enablePermissionCheck(true);
        $xml_writer->setObjects($nodes);
        $xml_writer->enableOperations(false);

        if ($user_id) {
            $xml_writer->setUserId($user_id);
        }

        if ($xml_writer->start()) {
            return $xml_writer->getXML();
        }

        return $this->__raiseError('Cannot create object xml !', 'Server');
    }

Here is the call graph for this function:

moveObject()

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

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

References $DIC, $ilUser, $lng, $target_id, ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilConditionHandler\_adjustMovedObjectConditions(), ilObject\_isInTrash(), canAddType(), ilObjectFactory\getTypeByRefId(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), and ilSoapAdministration\isFault().

    {
        $this->initAuth($sid);
        $this->initIlias();

        if (!$this->__checkSession($sid)) {
            return $this->__raiseError($this->__getMessage(), $this->__getMessageCode());
        }

        include_once './webservice/soap/classes/class.ilSoapUtils.php';
        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 ($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);
                
        include_once('./Services/Conditions/classes/class.ilConditionHandler.php');
        ilConditionHandler::_adjustMovedObjectConditions($ref_id);
        return true;
    }

Here is the call graph for this function:

removeDesktopItems()

ilSoapObjectAdministration::removeDesktopItems	(		$sid,
			$user_id,
			$reference_ids
	)

Remove desktop items for user.

Parameters

string	$sid
int	$user_id
	int[]	$reference_ids

Returns

bool

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

References $DIC, ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilObjectFactory\getInstanceByObjId(), ilObjectFactory\getInstanceByRefId(), ilSoapAdministration\initAuth(), and ilSoapAdministration\initIlias().

    {
        return; // abandonded with 6.0
        $this->initAuth($sid);
        $this->initIlias();

        if (!$this->__checkSession($sid)) {
            return $this->__raiseError($this->__getMessage(), $this->__getMessageCode());
        }

        global $DIC;

        $access = $DIC->rbac()->system();
        $logger = $DIC->logger()->wsrv();

        if (!$access->checkAccess('edit_userassignment', ROLE_FOLDER_ID)) {
            $logger->warning('Missing permission "edit_userassignment".');
            return $this->__raiseError(
                'Missing permission "edit_userassignment".',
                'Client'
            );
        }

        $user = ilObjectFactory::getInstanceByObjId($user_id, false);
        if (!$user instanceof ilObjUser) {
            $logger->warning('Invalid user id given. Cannot instantiate user for id: ' . $user_id);
            return $this->__raiseError(
                'Invalid user id given. Cannot instantiate user for id: ' . $user_id,
                'Client'
            );
        }
        $num_removed = 0;
        foreach ($reference_ids as $ref_id) {
            // short "validation" of reference id
            $ref_obj = ilObjectFactory::getInstanceByRefId($ref_id, false);
            if (!$ref_obj instanceof ilObject) {
                $logger->warning('Invalid reference id passed to SOAP::removeDesktopItems: ' . $ref_id);
                continue;
            }

            $num_added++;
            /*
            ilObjUser::_dropDesktopItem(
                $user->getId(),
                $ref_id,
                ilObject::_lookupType($ref_id,true)
            );*/
        }
        return $num_removed;
    }

Here is the call graph for this function:

removeFromSystemByImportId()

ilSoapObjectAdministration::removeFromSystemByImportId	(		$sid,
			$import_id
	)

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

References $DIC, Vendor\Package\$e, $ilLog, $lng, $res, ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilObject\_getAllReferences(), ilObject\_isInTrash(), ilObject\_lookupObjectId(), ilObject\_lookupObjIdByImportId(), ilObjectFactory\getInstanceByObjId(), ilObjectFactory\getInstanceByRefId(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), ilSoapAdministration\isFault(), updateReferences(), and validateReferences().

    {
        $this->initAuth($sid);
        $this->initIlias();

        if (!$this->__checkSession($sid)) {
            return $this->__raiseError($this->__getMessage(), $this->__getMessageCode());
        }
        if (!strlen($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;
    }

Here is the call graph for this function:

searchObjects()

ilSoapObjectAdministration::searchObjects	(		$sid,
			$types,
			$key,
			$combination,
			$user_id
	)

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

References $res, ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilSearchSettings\getInstance(), ilLuceneSearcher\getInstance(), ilLuceneSearchResultFilter\getInstance(), ilObjectFactory\getInstanceByRefId(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), QP_COMBINATION_AND, and QP_COMBINATION_OR.

    {
        $this->initAuth($sid);
        $this->initIlias();

        if (!$this->__checkSession($sid)) {
            return $this->__raiseError($this->__getMessage(), $this->__getMessageCode());
        }
        if (!is_array($types)) {
            return $this->__raiseError(
                'Types must be an array of object types.',
                'Client'
            );
        }
        if ($combination != 'and' and $combination != 'or') {
            return $this->__raiseError(
                'No valid combination given. Must be "and" or "or".',
                'Client'
            );
        }

        // begin-patch fm
        include_once './Services/Search/classes/class.ilSearchSettings.php';
        if (ilSearchSettings::getInstance()->enabledLucene()) {
            ilSearchSettings::getInstance()->setMaxHits(25);

            $typeFilterQuery = '';
            if (is_array($types)) {
                foreach ($types as $objectType) {
                    if (0 === strlen($typeFilterQuery)) {
                        $typeFilterQuery .= '+( ';
                    } else {
                        $typeFilterQuery .= 'OR';
                    }
                    $typeFilterQuery .= (' type:' . (string) $objectType . ' ');
                }
                $typeFilterQuery .= ') ';
            }

            include_once './Services/Search/classes/Lucene/class.ilLuceneQueryParser.php';
            $query_parser = new ilLuceneQueryParser($typeFilterQuery . $key);
            $query_parser->parse();

            include_once './Services/Search/classes/Lucene/class.ilLuceneSearcher.php';
            $searcher = ilLuceneSearcher::getInstance($query_parser);
            $searcher->search();

            include_once './Services/Search/classes/Lucene/class.ilLuceneSearchResultFilter.php';
            include_once './Services/Search/classes/Lucene/class.ilLucenePathFilter.php';
            $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 ((array) $result_ids as $ref_id => $obj_id) {
                $obj = ilObjectFactory::getInstanceByRefId($ref_id, false);
                if ($obj instanceof ilObject) {
                    $objs[] = $obj;
                }
            }
            include_once './Services/Search/classes/Lucene/class.ilLuceneHighlighterResultParser.php';
            $highlighter = new ilLuceneHighlighterResultParser();
            if ($filter->getResultObjIds()) {
                $highlighter = $searcher->highlight($filter->getResultObjIds());
            }
        } else {
            include_once './Services/Search/classes/class.ilQueryParser.php';

            $query_parser = new ilQueryParser($key);
            #$query_parser->setMinWordLength(3);
            $query_parser->setCombination($combination == 'and' ? QP_COMBINATION_AND : QP_COMBINATION_OR);
            $query_parser->parse();
            if (!$query_parser->validate()) {
                return $this->__raiseError(
                    $query_parser->getMessage(),
                    'Client'
                );
            }

            #include_once './Services/Search/classes/class.ilObjectSearchFactory.php';
            #$object_search =& ilObjectSearchFactory::_getObjectSearchInstance($query_parser);

            include_once './Services/Search/classes/Like/class.ilLikeObjectSearch.php';
            $object_search =  new ilLikeObjectSearch($query_parser);

            $object_search->setFilter($types);

            $res =&$object_search->performSearch();
            if ($user_id) {
                $res->setUserId($user_id);
            }
            // begin-patch fm
            $res->setMaxHits(100);
            // begin-patch fm
            $res->filter(ROOT_FOLDER_ID, $combination == 'and' ? true : false);

            $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 '';
        }

        include_once './webservice/soap/classes/class.ilObjectXMLWriter.php';

        $xml_writer = new ilObjectXMLWriter();

        // begin-patch fm
        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()) {
            #$GLOBALS['DIC']['ilLog']->write(__METHOD__.': '.$xml_writer->xmlDumpMem(true));
            return $xml_writer->getXML();
        }

        return $this->__raiseError('Cannot create object xml !', 'Server');
    }

Here is the call graph for this function:

updateReferences()

ilSoapObjectAdministration::updateReferences (   $a_object_data )

private

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

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

Referenced by removeFromSystemByImportId().

    {
        global $DIC;

        $tree = $DIC['tree'];
        $ilLog = $DIC['ilLog'];
        
        if (!isset($a_object_data['references']) or !count($a_object_data['references'])) {
            return true;
        }
        
        foreach ($a_object_data['references'] as $ref_data) {
            if (isset($ref_data['time_target']) /* and ($crs_ref_id = $tree->checkForParentType($ref_data['ref_id'],'crs')) */) {
                include_once('./webservice/soap/classes/class.ilObjectXMLWriter.php');
                include_once('./Services/Object/classes/class.ilObjectActivation.php');
                $old = ilObjectActivation::getItem($ref_data['ref_id']);
                
                $items = new ilObjectActivation();
                $items->toggleChangeable(isset($ref_data['time_target']['changeable']) ? $ref_data['time_target']['changeable'] : $old['changeable']);
                $items->setTimingStart(isset($ref_data['time_target']['starting_time']) ? $ref_data['time_target']['starting_time'] : $old['timing_start']);
                $items->setTimingEnd(isset($ref_data['time_target']['ending_time']) ? $ref_data['time_target']['ending_time'] : $old['timing_end']);
                $items->toggleVisible(isset($ref_data['time_target']['timing_visibility']) ? $ref_data['time_target']['timing_visibility'] : $old['visible']);
                $items->setSuggestionStart(isset($ref_data['time_target']['suggestion_start']) ? $ref_data['time_target']['suggestion_start'] : $old['suggestion_start']);
                $items->setSuggestionEnd(isset($ref_data['time_target']['suggestion_end']) ? $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']);
            }
        }
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

validateReferences()

ilSoapObjectAdministration::validateReferences (   $a_action,   $a_object_data,   $a_target_id = 0  )

private

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

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

Referenced by getXMLTree(), and removeFromSystemByImportId().

    {
        global $DIC;

        $ilAccess = $DIC['ilAccess'];
        
        if (!isset($a_object_data['references']) or !count($a_object_data['references'])) {
            return true;
        }
        if ($a_action == 'create') {
            if (count($a_object_data['references']) > 1) {
                if (in_array($a_object_data['type'], array('cat','crs','grp','fold'))) {
                    return $this->__raiseError(
                        "Cannot create references for type " . $a_object_data['type'],
                        'Client'
                    );
                }
            }
            if (count($a_object_data['references']) == 1) {
                if ($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;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• webservice/soap/classes/class.ilSoapObjectAdministration.php