ILIAS  Release_3_10_x_branch Revision 61812
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Private Member Functions
ilSoapObjectAdministration Class Reference
+ Inheritance diagram for ilSoapObjectAdministration:
+ Collaboration diagram for ilSoapObjectAdministration:

Public Member Functions

 ilSoapObjectAdministration ()
 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.
 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)
 addObject ($sid, $a_target_id, $a_xml)
 addReference ($sid, $a_source_id, $a_target_id)
 deleteObject ($sid, $reference_id)
 removeFromSystemByImportId ($sid, $import_id)
 updateObjects ($sid, $a_xml)
 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
 getPathForRefId ($sid, $ref_id)
- Public Member Functions inherited from ilSoapAdministration
 ilSoapAdministration ($use_nusoap=true)
 __checkSession ($sid)
 initErrorWriter ()
 Overwrite error handler.
 __explodeSid ($sid)
 __setMessage ($a_str)
 __getMessage ()
 __appendMessage ($a_str)
 __initAuthenticationObject ($a_auth_mode=AUTH_LOCAL)
 __raiseError ($a_message, $a_code)
 getNIC ($sid)
 get client information from current as xml result set
 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
 getInstallationInfoXML ()
 getClientInfoXML ($clientid)

Private Member Functions

 canAddType ($type, $target_type, $target_id)

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
- Data Fields inherited from ilSoapAdministration
 $sauth = null
 $error_method = null

Detailed Description

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

Member Function Documentation

ilSoapObjectAdministration::addObject (   $sid,
  $a_target_id,
  $a_xml 
)

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

References $lng, $location, $ref_id, ilSoapAdministration\__checkSession(), ilSoapAdministration\__raiseError(), ilObject\_exists(), ilObject\_isInTrash(), ilObjUser\_lookupId(), ilObject\_lookupObjIdByImportId(), and ilObjectFactory\getInstanceByRefId().

{
if(!$this->__checkSession($sid))
{
return $this->__raiseError($this->sauth->getMessage(),$this->sauth->getMessageCode());
}
if(!strlen($a_xml))
{
return $this->__raiseError('No valid xml string given.',
'Client');
}
// Include main header
include_once './include/inc.header.php';
global $rbacsystem, $objDefinition,$ilUser, $lng, $ilObjDataCache;
if(!$target_obj =& ilObjectFactory::getInstanceByRefId($a_target_id,false))
{
return $this->__raiseError('No valid target given.',
'Client');
}
if(ilObject::_isInTrash($a_target_id))
{
return $this->__raiseError("Parent with ID $a_target_id has been deleted.", 'Client');
}
$allowed_types = array('root','cat','grp','crs','fold');
if(!in_array($target_obj->getType(),$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_obj->getType());
foreach($allowed_subtypes as $row)
{
if($row['name'] != 'rolf')
{
$allowed[] = $row['name'];
}
}
include_once './webservice/soap/classes/class.ilObjectXMLParser.php';
$xml_parser =& new ilObjectXMLParser($a_xml, true);
try {
$xml_parser->startParsing();
} catch (ilSaxParserException $se){
return $this->__raiseError($se->getMessage(), $se->getCode());
}
foreach($xml_parser->getObjectData() as $object_data)
{
// Check possible subtype
if(!in_array($object_data['type'],$allowed))
{
return $this->__raiseError('Objects of type: '.$object_data['type'].' are not allowed to be subobjects of type '.
$target_obj->getType().'!',
'Client');
}
if(!$rbacsystem->checkAccess('create',$a_target_id,$object_data['type']))
{
return $this->__raiseError('No permission to create objects of type '.$object_data['type'].'!',
'Client');
}
if($object_data['type'] == 'crs')
{
return $this->__raiseError('Cannot create course objects. Use method addCourse() ',
'Client');
}
// It's not possible to add objects with non unique import ids
if(strlen($object_data['import_id']) and ilObject::_lookupObjIdByImportId($object_data['import_id']))
{
return $this->__raiseError('An object with import id '.$object_data['import_id'].' already exists!',
'Server');
}
// call gui object method
$class_name = $objDefinition->getClassName($object_data['type']);
$location = $objDefinition->getLocation($object_data['type']);
$class_constr = "ilObj".$class_name;
require_once($location."/class.ilObj".$class_name.".php");
$newObj = new $class_constr();
if(isset($object_data['owner']) && strlen($object_data['owner']))
{
if((int)$object_data['owner'])
{
if(ilObject::_exists((int)$object_data['owner']) &&
$ilObjDataCache->lookupType((int)$object_data['owner']) == 'usr')
{
$newObj->setOwner((int)$object_data['owner']);
}
}
else
{
$usr_id = ilObjUser::_lookupId(trim($object_data['owner']));
if((int)$usr_id)
{
$newObj->setOwner((int)$usr_id);
}
}
}
$newObj->setType($object_data['type']);
if(strlen($object_data['import_id']))
{
$newObj->setImportId($object_data['import_id']);
}
$newObj->setTitle($object_data['title']);
$newObj->setDescription($object_data['description']);
$newObj->create(); // true for upload
$newObj->createReference();
$newObj->putInTree($a_target_id);
$newObj->setPermissions($a_target_id);
$newObj->initDefaultRoles();
switch($object_data['type'])
{
case 'grp':
// Add member
$newObj->addMember($object_data['owner'] ? $object_data['owner'] : $ilUser->getId(),
$newObj->getDefaultAdminRole());
break;
case 'lm':
case 'dbk':
$newObj->createLMTree();
break;
case 'cat':
$newObj->addTranslation($object_data["title"],$object_data["description"], $lng->getLangKey(), $lng->getLangKey());
break;
}
}
$ref_id = $newObj->getRefId();
return $ref_id ? $ref_id : "0";
}

+ Here is the call graph for this function:

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

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

References ilSoapAdministration\__checkSession(), ilSoapAdministration\__raiseError(), and ilObjectFactory\getInstanceByRefId().

{
if(!$this->__checkSession($sid))
{
return $this->__raiseError($this->sauth->getMessage(),$this->sauth->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');
}
include_once './include/inc.header.php';
global $objDefinition, $rbacsystem, $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 = $objDefinition->getSubObjects($target_obj->getType());
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());
$source_obj->initDefaultRoles();
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;
}
$new_ref->create();
$new_ref_id = $new_ref->createReference();
$new_ref->putInTree($target_obj->getRefId());
$new_ref->setPermissions($target_obj->getRefId());
$new_ref->initDefaultRoles();
$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:

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

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

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

Referenced by copyObject(), and moveObject().

{
// checking for target subtypes. Can we add source to target
global $objDefinition, $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:

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 1072 of file class.ilSoapObjectAdministration.php.

References $lng, $target_id, ilSoapAdministration\__checkSession(), ilSoapAdministration\__raiseError(), ilCopyWizardOptions\_allocateCopyId(), ilCopyWizardOptions\_getInstance(), canAddType(), ilObjectFactory\getInstanceByRefId(), ilObjectFactory\getTypeByRefId(), and ilSoapAdministration\isFault().

{
if(!$this->__checkSession($sid))
{
return $this->__raiseError($this->sauth->getMessage(),$this->sauth->getMessageCode());
}
// Include main header
include_once './include/inc.header.php';
include_once './webservice/soap/classes/class.ilSoapUtils.php';
global $rbacreview, $objDefinition, $rbacsystem, $lng, $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
return $source_object->cloneAllObject($sessionid, $clientid,
$source_object_type,
$target_id,
$source_id,
$options, true);
} 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:

ilSoapObjectAdministration::deleteObject (   $sid,
  $reference_id 
)

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

References ilSoapAdministration\__checkSession(), ilSoapAdministration\__raiseError(), ilObjectFactory\getInstanceByRefId(), and ilUtil\removeItemFromDesktops().

{
global $tree;
if(!$this->__checkSession($sid))
{
return $this->__raiseError($this->sauth->getMessage(),$this->sauth->getMessageCode());
}
if(!is_numeric($reference_id))
{
return $this->__raiseError('No reference id given.',
'Client');
}
include_once './include/inc.header.php';
global $tree, $rbacsystem, $rbacadmin;
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"]);
// remove item from all user desktops
$affected_users = ilUtil::removeItemFromDesktops($subnode["child"]);
}
if(!$tree->saveSubTree($reference_id))
{
return $this->__raiseError('Node already deleted','Client');
}
return true;
}

+ Here is the call graph for this function:

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

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

References ilSoapAdministration\__checkSession(), ilSoapAdministration\__raiseError(), ilObject\_isInTrash(), and ilObjectFactory\getInstanceByRefId().

{
if(!$this->__checkSession($sid))
{
return $this->__raiseError($this->sauth->getMessage(),$this->sauth->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');
}
// Include main header
include_once './include/inc.header.php';
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();
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:

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

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

References $res, ilSoapAdministration\__checkSession(), ilSoapAdministration\__raiseError(), ilObjectFactory\getInstanceByObjId(), and QP_COMBINATION_AND.

{
if(!$this->__checkSession($sid))
{
return $this->__raiseError($this->sauth->getMessage(),$this->sauth->getMessageCode());
}
if(!strlen($a_title))
{
return $this->__raiseError('No valid query string given.',
'Client');
}
// Include main header
include_once './include/inc.header.php';
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)
{
$objs[] = ilObjectFactory::getInstanceByObjId($entry['obj_id'],false);
}
if(!count($objs))
{
return '';
}
include_once './webservice/soap/classes/class.ilObjectXMLWriter.php';
$xml_writer = new ilObjectXMLWriter();
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:

ilSoapObjectAdministration::getObjIdByImportId (   $sid,
  $import_id 
)

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

References $ilLog, ilSoapAdministration\__checkSession(), ilSoapAdministration\__raiseError(), and ilObject\_lookupObjIdByImportId().

{
if(!$this->__checkSession($sid))
{
return $this->__raiseError($this->sauth->getMessage(),$this->sauth->getMessageCode());
}
if(!$import_id)
{
return $this->__raiseError('No import id given.',
'Client');
}
// Include main header
include_once './include/inc.header.php';
global $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:

ilSoapObjectAdministration::getObjIdsByRefIds (   $sid,
  $ref_ids 
)

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

Parameters
string$sidSession ID
arrayof 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 129 of file class.ilSoapObjectAdministration.php.

References $ref_id, ilSoapAdministration\__checkSession(), ilSoapAdministration\__raiseError(), ilObject\_hasUntrashedReference(), and ilObject\_lookupObjectId().

{
if(!$this->__checkSession($sid))
{
return $this->__raiseError($this->sauth->getMessage(),$this->sauth->getMessageCode());
}
// Include main header
include_once './include/inc.header.php';
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:

ilSoapObjectAdministration::getPathForRefId (   $sid,
  $ref_id 
)

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

References $lng, $ref_id, ilSoapAdministration\__checkSession(), ilSoapAdministration\__raiseError(), and ilObject\_isInTrash().

{
if(!$this->__checkSession($sid))
{
return $this->__raiseError($this->sauth->getMessage(),$this->sauth->getMessageCode());
}
// Include main header
include_once './include/inc.header.php';
global $ilAccess, $objDefinition, $rbacsystem, $lng, $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 $tree, $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:

ilSoapObjectAdministration::getRefIdsByImportId (   $sid,
  $import_id 
)

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

References $ref_id, ilSoapAdministration\__checkSession(), ilSoapAdministration\__raiseError(), ilObject\_getAllReferences(), and ilObject\_lookupObjIdByImportId().

{
global $tree;
if(!$this->__checkSession($sid))
{
return $this->__raiseError($this->sauth->getMessage(),$this->sauth->getMessageCode());
}
if(!$import_id)
{
return $this->__raiseError('No import id given.',
'Client');
}
// Include main header
include_once './include/inc.header.php';
global $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:

ilSoapObjectAdministration::getRefIdsByObjId (   $sid,
  $obj_id 
)

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

References $ref_id, ilSoapAdministration\__checkSession(), ilSoapAdministration\__raiseError(), and ilObject\_getAllReferences().

{
if(!$this->__checkSession($sid))
{
return $this->__raiseError($this->sauth->getMessage(),$this->sauth->getMessageCode());
}
if(!$obj_id)
{
return $this->__raiseError('No object id given.',
'Client');
}
// Include main header
include_once './include/inc.header.php';
$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:

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

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

References $ref_id, ilSoapAdministration\__checkSession(), ilSoapAdministration\__raiseError(), and ilObjectFactory\getInstanceByRefId().

{
$all = false;
if(!$this->__checkSession($sid))
{
return $this->__raiseError($this->sauth->getMessage(),$this->sauth->getMessageCode());
}
// Include main header
include_once './include/inc.header.php';
global $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;
}
$filter = is_array($types) ? $types : array();
$objs = array();
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;
}
}
}
/*if(!$objs)
{
return '';
}*/
include_once './webservice/soap/classes/class.ilObjectXMLWriter.php';
$xml_writer = new ilObjectXMLWriter();
$xml_writer->setObjects($objs);
$xml_writer->enableOperations(true);
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:

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

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

References $ref_id, ilSoapAdministration\__checkSession(), ilSoapAdministration\__raiseError(), and ilObjectFactory\getInstanceByRefId().

{
if(!$this->__checkSession($sid))
{
return $this->__raiseError($this->sauth->getMessage(),$this->sauth->getMessageCode());
}
include_once './include/inc.header.php';
global $tree;
$nodedata = $tree->getNodeData($ref_id);
$nodearray = $tree->getSubTree($nodedata);
$filter = is_array($types) ? $types : array("0" => "root","adm","lngf","mail",
"usrf","rolf","taxf","trac","pays",
"auth","chac","objf","recf","assf",
"stys","seas","extt");
foreach($nodearray as $node) {
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->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:

ilSoapObjectAdministration::ilSoapObjectAdministration ( )

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

References ilSoapAdministration\ilSoapAdministration().

{
parent::ilSoapAdministration();
}

+ Here is the call graph for this function:

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

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

References $lng, $ref_id, $target_id, ilSoapAdministration\__checkSession(), ilSoapAdministration\__raiseError(), ilConditionHandler\_adjustMovedObjectConditions(), ilObject\_isInTrash(), canAddType(), ilObjectFactory\getTypeByRefId(), and ilSoapAdministration\isFault().

{
if(!$this->__checkSession($sid))
{
return $this->__raiseError($this->sauth->getMessage(),$this->sauth->getMessageCode());
}
// Include main header
include_once './include/inc.header.php';
include_once './webservice/soap/classes/class.ilSoapUtils.php';
global $rbacreview, $rbacadmin, $objDefinition, $rbacsystem, $lng, $ilUser, $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");
}
// GET COMPLETE NODE_DATA OF ALL SUBTREE NODES
$node_data = $tree->getNodeData($ref_id);
$subtree_nodes = $tree->getSubTree($node_data);
$all_node_data[] = $node_data;
$all_subtree_nodes[] = $subtree_nodes;
// CHECK DELETE PERMISSION OF ALL OBJECTS IN ACTUAL SUBTREE
foreach ($subtree_nodes as $node)
{
if($node['type'] == 'rolf')
{
continue;
}
if (!$rbacsystem->checkAccess('delete',$node["ref_id"]))
{
$no_cut[] = $node["ref_id"];
}
}
// IF THERE IS ANY OBJECT WITH NO PERMISSION TO 'delete'
if (count($no_cut))
{
return $this->__raiseError("Object contains references which you are not allowed to delete.","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('classes/class.ilConditionHandler.php');
ilConditionHandler::_adjustMovedObjectConditions($ref_id);
return true;
}

+ Here is the call graph for this function:

ilSoapObjectAdministration::removeFromSystemByImportId (   $sid,
  $import_id 
)

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

References $ilLog, $ref_id, ilSoapAdministration\__checkSession(), ilSoapAdministration\__raiseError(), ilObject\_getAllReferences(), ilObject\_lookupObjIdByImportId(), and ilObjectFactory\getInstanceByRefId().

{
if(!$this->__checkSession($sid))
{
return $this->__raiseError($this->sauth->getMessage(),$this->sauth->getMessageCode());
}
if(!strlen($import_id))
{
return $this->__raiseError('No import id given. Aborting!',
'Client');
}
include_once './include/inc.header.php';
global $rbacsystem, $tree, $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:

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

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

References $res, ilSoapAdministration\__checkSession(), ilSoapAdministration\__raiseError(), ilObjectFactory\getInstanceByObjId(), QP_COMBINATION_AND, and QP_COMBINATION_OR.

{
if(!$this->__checkSession($sid))
{
return $this->__raiseError($this->sauth->getMessage(),$this->sauth->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');
}
// Include main header
include_once './include/inc.header.php';
include_once './Services/Search/classes/class.ilQueryParser.php';
$query_parser =& new ilQueryParser($key);
$query_parser->setMinWordLength(0,true);
$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);
}
$res->setMaxHits(999999);
$res->filter(ROOT_FOLDER_ID,$combination == 'and' ? true : false);
// Limit to 30 objects
$counter = 0;
$objs = array();
foreach($res->getUniqueResults() as $entry)
{
/*if(++$counter == 30)
{
break;
}*/
$objs[] = ilObjectFactory::getInstanceByObjId($entry['obj_id'],false);
}
if(!count($objs))
{
return '';
}
include_once './webservice/soap/classes/class.ilObjectXMLWriter.php';
$xml_writer = new ilObjectXMLWriter();
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:

ilSoapObjectAdministration::updateObjects (   $sid,
  $a_xml 
)

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

References $lng, $ref_id, ilSoapAdministration\__checkSession(), ilSoapAdministration\__raiseError(), ilObject\_getAllReferences(), ilObject\_isInTrash(), ilObject\_lookupObjectId(), and ilObjectFactory\getInstanceByObjId().

{
if(!$this->__checkSession($sid))
{
return $this->__raiseError($this->sauth->getMessage(),$this->sauth->getMessageCode());
}
if(!strlen($a_xml))
{
return $this->__raiseError('No valid xml string given.',
'Client');
}
// Include main header
include_once './include/inc.header.php';
global $rbacreview, $rbacsystem, $lng;
include_once './webservice/soap/classes/class.ilObjectXMLParser.php';
$xml_parser =& new ilObjectXMLParser($a_xml, true);
try {
$xml_parser->startParsing();
} catch (ilSaxParserException $se){
return $this->__raiseError($se->getMessage(), $se->getCode());
}
// Validate incoming data
$object_datas = $xml_parser->getObjectData();
foreach($object_datas as & $object_data)
{
if(!$object_data["obj_id"])
{
return $this->__raiseError('No obj_id in xml found.', 'Client');
}
elseif ((int) $object_data["obj_id"] == -1 && count($object_data["references"])>0)
{
// object id might be unknown, resolve references instead to determine object id
// all references should point to the same object, so using the first one is ok.
foreach ($object_data["references"] as $refid)
{
if(ilObject::_isInTrash($refid))
{
continue;
}
break;
}
$obj_id_from_refid = ilObject::_lookupObjectId($object_data["references"][0], false);
if (!$obj_id_from_refid)
{
return $this->__raiseError('No obj_id found for reference id '.$object_data["references"][0], 'CLIENT_OBJECT_NOT_FOUND');
} else
{
$tmp_obj = ilObjectFactory::getInstanceByObjId($object_data['obj_id'], false);
$object_data["obj_id"] = $obj_id_from_refid;
}
}
$tmp_obj = ilObjectFactory::getInstanceByObjId($object_data['obj_id'], false);
if ($tmp_obj == null)
{
return $this->__raiseError('No object for id '.$object_data['obj_id'].'!', 'CLIENT_OBJECT_NOT_FOUND');
}
else
{
$object_data["instance"] = $tmp_obj;
}
if($object_data['type'] == 'role')
{
$rolf_ids = $rbacreview->getFoldersAssignedToRole($object_data['obj_id'],true);
$rolf_id = $rolf_ids[0];
if(!$rbacsystem->checkAccess('write',$rolf_id))
{
return $this->__raiseError('No write permission for object with id '.$object_data['obj_id'].'!', 'Client');
}
}
else
{
$permission_ok = false;
foreach(ilObject::_getAllReferences($object_data['obj_id']) as $ref_id)
{
if($rbacsystem->checkAccess('write',$object_data['obj_id']))
{
$permission_ok = true;
break;
}
}
if(!$permission_ok)
{
return $this->__raiseError('No write permission for object with id '.$object_data['obj_id'].'!', 'Client');
}
}
}
// perform update
if (count ($object_datas) > 0)
{
foreach($object_datas as $object_data)
{
$tmp_obj = $object_data["instance"];
$tmp_obj->setTitle($object_data['title']);
$tmp_obj->setDescription($object_data['description']);
switch ($object_data['type']) {
case 'cat':
$tmp_obj->updateTranslation($object_data["title"],$object_data["description"], $lng->getLangKey(), $lng->getLangKey());
break;
}
$tmp_obj->update();
if(strlen($object_data['owner']) && is_numeric($object_data['owner']))
{
$tmp_obj->setOwner($object_data['owner']);
$tmp_obj->updateOwner();
}
}
return true;
}
return false;
}

+ Here is the call graph for this function:

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