ilSoapWebLinkAdministration Class Reference

Soap methods for adminstrating web links. More...

Inheritance diagram for ilSoapWebLinkAdministration:

Collaboration diagram for ilSoapWebLinkAdministration:

Public Member Functions
	__construct ()
	readWebLink (string $sid, int $request_ref_id)
	createWebLink (string $sid, int $target_id, string $weblink_xml)
	updateWebLink (string $sid, int $request_ref_id, string $weblink_xml)
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)

Additional Inherited Members
Data Fields inherited from ilSoapAdministration
const	NUSOAP = 1
const	PHP5 = 2
int	$error_method
	Defines type of error handling (PHP5 || NUSOAP) More...
Protected Member Functions inherited from ilSoapAdministration
	checkSession (string $sid)
	explodeSid (string $sid)
	setMessage (string $a_str)
	initAuth (string $sid)
	initIlias ()
	initAuthenticationObject ()
	raiseError (string $a_message, $a_code)
	checkObjectAccess (int $ref_id, array $expected_type, string $permission, bool $returnObject=false)
	check access for ref id: expected type, permission, return object instance if returnobject is true More...
Protected Attributes inherited from ilSoapAdministration
bool	$soap_check = true
string	$message = ''
string	$message_code = ''

Detailed Description

Soap methods for adminstrating web links.

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

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

Constructor & Destructor Documentation

__construct()

ilSoapWebLinkAdministration::__construct

(

)

Definition at line 26 of file class.ilSoapWebLinkAdministration.php.

    {
        parent::__construct();
    }

References ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

createWebLink()

ilSoapWebLinkAdministration::createWebLink	(	string	$sid,
		int	$target_id,
		string	$weblink_xml
	)

Returns

int|soap_fault|SoapFault|null

Definition at line 102 of file class.ilSoapWebLinkAdministration.php.

    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->checkSession($sid)) {
            return $this->raiseError($this->getMessage(), $this->getMessageCode());
        }
        global $DIC;
 
        $rbacsystem = $DIC['rbacsystem'];
        $tree = $DIC['tree'];
        $ilLog = $DIC['ilLog'];
 
        if (!$target_obj = ilObjectFactory::getInstanceByRefId($target_id, false)) {
            return $this->raiseError('No valid target given.', 'Client');
        }
 
        if (ilObject::_isInTrash($target_id)) {
            return $this->raiseError("Parent with ID $target_id has been deleted.", 'CLIENT_OBJECT_DELETED');
        }
 
        // Check access
        // TODO: read from object definition
        $allowed_types = array('cat', 'grp', 'crs', 'fold', 'root');
        if (!in_array($target_obj->getType(), $allowed_types)) {
            return $this->raiseError(
                'No valid target type. Target must be reference id of "course, group, root, category or folder"',
                'Client'
            );
        }
 
        if (!$rbacsystem->checkAccess('create', $target_id, "webr")) {
            return $this->raiseError('No permission to create weblink in target  ' . $target_id . '!', 'Client');
        }
 
        // create object, put it into the tree and use the parser to update the settings
        $webl = new ilObjLinkResource();
        $webl->setTitle('XML Import');
        $webl->create();
        $webl->createReference();
        $webl->putInTree($target_id);
        $webl->setPermissions($target_id);
 
        try {
            $parser = new ilWebLinkXmlParser($webl, $weblink_xml);
            $parser->setMode(ilWebLinkXmlParser::MODE_CREATE);
            $parser->start();
        } catch (ilSaxParserException | ilWebLinkXmlParserException $e) {
            return $this->raiseError($e->getMessage(), 'Client');
        }
 
        // Check if required
        return $webl->getRefId();
    }

References $DIC, Vendor\Package\$e, ilObject\_isInTrash(), ilSoapAdministration\checkSession(), ilObjectFactory\getInstanceByRefId(), ilSoapAdministration\getMessage(), ilSoapAdministration\getMessageCode(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), ilWebLinkXmlParser\MODE_CREATE, and ilSoapAdministration\raiseError().

Here is the call graph for this function:

readWebLink()

ilSoapWebLinkAdministration::readWebLink	(	string	$sid,
		int	$request_ref_id
	)

Returns

soap_fault|SoapFault|string|null

Definition at line 34 of file class.ilSoapWebLinkAdministration.php.

    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->checkSession($sid)) {
            return $this->raiseError($this->getMessage(), $this->getMessageCode());
        }
        if (!$request_ref_id) {
            return $this->raiseError(
                'No ref id given. Aborting!',
                'Client'
            );
        }
        global $DIC;
 
        $rbacsystem = $DIC['rbacsystem'];
        $tree = $DIC['tree'];
        $ilLog = $DIC['ilLog'];
 
        // get obj_id
        if (!$obj_id = ilObject::_lookupObjectId($request_ref_id)) {
            return $this->raiseError(
                'No weblink found for id: ' . $request_ref_id,
                'Client'
            );
        }
 
        if (ilObject::_isInTrash($request_ref_id)) {
            return $this->raiseError("Parent with ID $request_ref_id has been deleted.", 'Client');
        }
 
        // Check access
        $permission_ok = false;
        $write_permission_ok = false;
        $ref_ids = ilObject::_getAllReferences($obj_id);
        foreach ($ref_ids as $ref_id) {
            if ($rbacsystem->checkAccess('edit', $ref_id)) {
                $write_permission_ok = true;
                break;
            }
            if ($rbacsystem->checkAccess('read', $ref_id)) {
                $permission_ok = true;
                break;
            }
        }
 
        if (!$permission_ok && !$write_permission_ok) {
            return $this->raiseError(
                'No permission to edit the object with id: ' . $request_ref_id,
                'Server'
            );
        }
 
        try {
            $writer = new ilWebLinkXmlWriter(true);
            $writer->setObjId($obj_id);
            $writer->write();
 
            return $writer->xmlDumpMem(true);
        } catch (UnexpectedValueException $e) {
            return $this->raiseError($e->getMessage(), 'Client');
        }
    }

References $DIC, Vendor\Package\$e, $ref_id, ilObject\_getAllReferences(), ilObject\_isInTrash(), ilObject\_lookupObjectId(), ilSoapAdministration\checkSession(), ilSoapAdministration\getMessage(), ilSoapAdministration\getMessageCode(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), and ilSoapAdministration\raiseError().

Here is the call graph for this function:

updateWebLink()

ilSoapWebLinkAdministration::updateWebLink	(	string	$sid,
		int	$request_ref_id,
		string	$weblink_xml
	)

Returns

bool|soap_fault|SoapFault|null

@noinspection PhpParamsInspection

Definition at line 161 of file class.ilSoapWebLinkAdministration.php.

    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->checkSession($sid)) {
            return $this->raiseError($this->getMessage(), $this->getMessageCode());
        }
        global $DIC;
 
        $rbacsystem = $DIC['rbacsystem'];
        $tree = $DIC['tree'];
        $ilLog = $DIC['ilLog'];
 
        if (ilObject::_isInTrash($request_ref_id)) {
            return $this->raiseError(
                'Cannot perform update since weblink has been deleted.',
                'CLIENT_OBJECT_DELETED'
            );
        }
        // get obj_id
        if (!$obj_id = ilObject::_lookupObjectId($request_ref_id)) {
            return $this->raiseError(
                'No weblink found for id: ' . $request_ref_id,
                'CLIENT_OBJECT_NOT_FOUND'
            );
        }
 
        // Check access
        $permission_ok = false;
        foreach ($ref_ids = ilObject::_getAllReferences($obj_id) as $ref_id) {
            if ($rbacsystem->checkAccess('edit', $ref_id)) {
                $permission_ok = true;
                break;
            }
        }
 
        if (!$permission_ok) {
            return $this->raiseError(
                'No permission to edit the weblink with id: ' . $request_ref_id,
                'Server'
            );
        }
 
        $webl = ilObjectFactory::getInstanceByObjId($obj_id, false);
        if (!$webl instanceof ilObjLinkResource) {
            return $this->raiseError(
                'Wrong obj id or type for weblink with id ' . $request_ref_id,
                'Client'
            );
        }
 
        try {
            $parser = new ilWebLinkXmlParser($webl, $weblink_xml);
            $parser->setMode(ilWebLinkXmlParser::MODE_UPDATE);
            $parser->start();
        } catch (ilSaxParserException | ilWebLinkXmlParserException $e) {
            return $this->raiseError($e->getMessage(), 'Client');
        }
 
        // Check if required
        return true;
    }

References $DIC, Vendor\Package\$e, $ref_id, ilObject\_getAllReferences(), ilObject\_isInTrash(), ilObject\_lookupObjectId(), ilSoapAdministration\checkSession(), ilObjectFactory\getInstanceByObjId(), ilSoapAdministration\getMessage(), ilSoapAdministration\getMessageCode(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), ilWebLinkXmlParser\MODE_UPDATE, and ilSoapAdministration\raiseError().

Here is the call graph for this function:

---

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

• components/ILIAS/soap/classes/class.ilSoapWebLinkAdministration.php