Inheritance diagram for ilSoapGroupAdministration:

Collaboration diagram for ilSoapGroupAdministration:

Public Member Functions
	addGroup (string $sid, int $target_id, string $grp_xml)

	groupExists (string $sid, string $title)

	getGroupsForUser (string $sid, string $parameters)

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

	getMessage ()

	appendMessage (string $a_str)

	setMessageCode (string $a_code)

	getMessageCode ()

	reInitUser ()

	isFault ($object)

	getInstallationInfoXML ()

	getClientInfoXML (string $clientid)

Data Fields
const	MEMBER = 1

const	ADMIN = 2

const	OWNER = 4

Data Fields inherited from ilSoapAdministration
const	NUSOAP = 1

const	PHP5 = 2

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

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

	explodeSid (string $sid)

	setMessage (string $a_str)

	initAuth (string $sid)

	initIlias ()

	initAuthenticationObject ()

	raiseError (string $a_message, $a_code)

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

Protected Attributes inherited from ilSoapAdministration
bool	$soap_check = true

string	$message = ''

string	$message_code = ''

Detailed Description

Definition at line 24 of file class.ilSoapGroupAdministration.php.

Member Function Documentation

◆ addGroup()

ilSoapGroupAdministration::addGroup	(	string	$sid,
		int	$target_id,
		string	$grp_xml
	)

Returns: soap_fault|SoapFault|string|null

Definition at line 33 of file class.ilSoapGroupAdministration.php.

References $DIC, $ref_id, ilGroupXMLParser\$UPDATE, ilObject\_isInTrash(), ilSoapAdministration\checkSession(), ilObjectFactory\getInstanceByRefId(), ilSoapAdministration\getMessage(), ilSoapAdministration\getMessageCode(), ilObjectFactory\getTypeByRefId(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), and ilSoapAdministration\raiseError().

     {
         $this->initAuth($sid);
         $this->initIlias();
 
         if (!$this->checkSession($sid)) {
             return $this->raiseError($this->getMessage(), $this->getMessageCode());
         }
 
         global $DIC;
 
         $rbacsystem = $DIC['rbacsystem'];
 
         if (!$rbacsystem->checkAccess('create', $target_id, 'grp')) {
             return $this->raiseError('Check access failed. No permission to create groups', 'Server');
         }
 
         if (ilObject::_isInTrash($target_id)) {
             return $this->raiseError("Parent with ID $target_id has been deleted.", 'CLIENT_TARGET_DELETED');
         }
 
         $newObj = new ilObjGroup();
         $newObj->setTitle('dummy');
         $newObj->setDescription("");
         $newObj->create();
 
         $xml_parser = new ilGroupXMLParser($newObj, $grp_xml, $target_id);
         $xml_parser->startParsing();
         $new_ref_id = $xml_parser->getObjectRefId();
 
         return $new_ref_id ?: "0";
     }

Here is the call graph for this function:

◆ getGroupsForUser()

ilSoapGroupAdministration::getGroupsForUser	(	string	$sid,
		string	$parameters
	)

Returns: soap_fault|SoapFault|string|null

Definition at line 323 of file class.ilSoapGroupAdministration.php.

References $DIC, $r, $ref_id, ilUtil\__extractRefId(), ilObject\_exists(), ilObject\_getAllReferences(), ilObject\_isInTrash(), ADMIN, ilSoapAdministration\checkObjectAccess(), ilSoapAdministration\checkSession(), ilObjectFactory\getInstanceByObjId(), ilSoapAdministration\getMessage(), ilSoapAdministration\getMessageCode(), ilObjectFactory\getObjectsForOwner(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), ILIAS\Repository\int(), MEMBER, OWNER, ilSoapAdministration\raiseError(), and ROLE_FOLDER_ID.

     {
         $this->initAuth($sid);
         $this->initIlias();
 
         if (!$this->checkSession($sid)) {
             return $this->raiseError($this->getMessage(), $this->getMessageCode());
         }
         global $DIC;
 
         $rbacreview = $DIC['rbacreview'];
         $ilObjDataCache = $DIC['ilObjDataCache'];
         $tree = $DIC['tree'];
 
         $parser = new ilXMLResultSetParser($parameters);
         try {
             $parser->startParsing();
         } catch (ilSaxParserException $exception) {
             return $this->raiseError($exception->getMessage(), "Client");
         }
         $xmlResultSet = $parser->getXMLResultSet();
 
         if (!$xmlResultSet->hasColumn("user_id")) {
             return $this->raiseError("parameter user_id is missing", "Client");
         }
 
         if (!$xmlResultSet->hasColumn("status")) {
             return $this->raiseError("parameter status is missing", "Client");
         }
 
         $user_id = (int) $xmlResultSet->getValue(0, "user_id");
         $status = (int) $xmlResultSet->getValue(0, "status");
 
         $ref_ids = array();
 
         if (ilSoapGroupAdministration::MEMBER == ($status & ilSoapGroupAdministration::MEMBER) ||
             ilSoapGroupAdministration::ADMIN == ($status & ilSoapGroupAdministration::ADMIN)) {
             foreach ($rbacreview->assignedRoles($user_id) as $role_id) {
                 if ($role = ilObjectFactory::getInstanceByObjId($role_id, false)) {
                     #echo $role->getType();
                     if ($role->getType() !== "role") {
                         continue;
                     }
 
                     if ($role->getParent() == ROLE_FOLDER_ID) {
                         continue;
                     }
                     $role_title = $role->getTitle();
 
                     if ($ref_id = ilUtil::__extractRefId($role_title)) {
                         if (!ilObject::_exists($ref_id, true) || ilObject::_isInTrash($ref_id)) {
                             continue;
                         }
 
                         #echo $role_title;
                         if (ilSoapGroupAdministration::MEMBER == ($status & ilSoapGroupAdministration::MEMBER) && strpos(
                             $role_title,
                             "member"
                         ) !== false) {
                             $ref_ids [] = $ref_id;
                         } elseif (ilSoapGroupAdministration::ADMIN == ($status & ilSoapGroupAdministration::ADMIN) && strpos(
                             $role_title,
                             "admin"
                         ) !== false) {
                             $ref_ids [] = $ref_id;
                         }
                     }
                 }
             }
         }
 
         if (($status & ilSoapGroupAdministration::OWNER) == ilSoapGroupAdministration::OWNER) {
             $owned_objects = ilObjectFactory::getObjectsForOwner("grp", $user_id);
             foreach ($owned_objects as $obj_id) {
                 $allrefs = ilObject::_getAllReferences($obj_id);
                 $refs = array();
                 foreach ($allrefs as $r) {
                     if ($tree->isDeleted($r)) {
                         continue;
                     }
                     if ($tree->isInTree($r)) {
                         $refs[] = $r;
                     }
                 }
                 if (count($refs) > 0) {
                     $ref_ids[] = array_pop($refs);
                 }
             }
         }
         $ref_ids = array_unique($ref_ids);
 
         $xmlResultSet = new ilXMLResultSet();
         $xmlResultSet->addColumn("ref_id");
         $xmlResultSet->addColumn("xml");
         $xmlResultSet->addColumn("parent_ref_id");
 
         foreach ($ref_ids as $group_id) {
             $group_obj = $this->checkObjectAccess($group_id, ['grp'], "write", true);
             if ($group_obj instanceof ilObjGroup) {
                 $row = new ilXMLResultSetRow();
                 $row->setValue("ref_id", $group_id);
                 $xmlWriter = new ilGroupXMLWriter($group_obj);
                 $xmlWriter->setAttachUsers(false);
                 $xmlWriter->start();
                 $row->setValue("xml", $xmlWriter->getXML());
                 $row->setValue("parent_ref_id", $tree->getParentId($group_id));
                 $xmlResultSet->addRow($row);
             }
         }
         $xmlResultSetWriter = new ilXMLResultSetWriter($xmlResultSet);
         $xmlResultSetWriter->start();
         return $xmlResultSetWriter->getXML();
     }

Here is the call graph for this function:

◆ groupExists()

ilSoapGroupAdministration::groupExists	(	string	$sid,
		string	$title
	)

Returns: bool|soap_fault|SoapFault|null

Definition at line 110 of file class.ilSoapGroupAdministration.php.

References $DIC, $user_id, ilObject\_getAllReferences(), ilGroupParticipants\_getInstanceByObjId(), ilObject\_isInTrash(), ilObject\_lookupObjId(), ilObject\_lookupType(), ilSoapAdministration\checkSession(), ilObjectFactory\getInstanceByObjId(), ilObjectFactory\getInstanceByRefId(), ilSoapAdministration\getMessage(), ilSoapAdministration\getMessageCode(), ilUtil\groupNameExists(), ilParticipants\IL_GRP_ADMIN, ilParticipants\IL_GRP_MEMBER, ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), and ilSoapAdministration\raiseError().

     {
         $this->initAuth($sid);
         $this->initIlias();
 
         if (!$this->checkSession($sid)) {
             return $this->raiseError($this->getMessage(), $this->getMessageCode());
         }
 
         if (!$title) {
             return $this->raiseError(
                 'No title given. Please choose an title for the group in question.',
                 'Client'
             );
         }
 
         return ilUtil::groupNameExists($title);
     }