Inheritance diagram for ILIAS\OrgUnit\Webservices\SOAP\Base:

Collaboration diagram for ILIAS\OrgUnit\Webservices\SOAP\Base:

Public Member Functions
	__construct ()

	getServiceStyle ()
	Get the service style, e.g. More...

	getServiceUse ()
	Get the service use, e.g. More...

	getServiceNamespace ()
	Get the namespace of the service where this method belongs to. More...

	getInputParams ()
	Get the input parameters. More...

	execute (array $params)
	Execute the business logic for this SOAP method (when a SOAP request hits the endpoint defined by the name). More...

	addError (string $message)

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)

Public Member Functions inherited from ilSoapMethod
	getName ()
	Get the name of the method. More...

	getOutputParams ()
	Get the output parameters in the same format as the input parameters. More...

	getDocumentation ()
	Get the documentation of this method. More...

Data Fields
const	TYPE_INT_ARRAY = 'tns:intArray'

const	TYPE_STRING = 'xsd:string'

const	TYPE_INT = 'xsd:int'

const	TYPE_DOUBLE_ARRAY = 'tns:doubleArray'

const	SID = 'sid'

const	ORGU_REF_ID = 'orgu_ref_id'

const	POSITION_ID = 'position_id'

const	USR_IDS = 'usr_ids'

const	USR_ID = 'usr_id'

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
	initIliasAndCheckSession (string $session_id)
	Use this method at the beginning of your execute() method to check if the provided session ID is valid. More...

	checkParameters (array $params)
	Check that all input parameters are present when executing the soap method. More...

	getAdditionalInputParams ()

	run (array $params)

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
ilOrgUnitPositionDBRepository	$positionRepo

ilOrgUnitUserAssignmentDBRepository	$assignmentRepo

Protected Attributes inherited from ilSoapAdministration
bool	$soap_check = true

string	$message = ''

string	$message_code = ''

Private Member Functions
	init (string $session_id)

Detailed Description

Class Base.

Author: Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 30 of file Base.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\OrgUnit\Webservices\SOAP\Base::__construct ( )

Definition at line 47 of file Base.php.

References $_GET, $dic, ILIAS\GlobalScreen\Provider\__construct(), and ilOrgUnitLocalDIC\dic().

     {
         if (! isset($_GET["wsdl"])) {
             $dic = \ilOrgUnitLocalDIC::dic();
             $this->positionRepo = $dic["repo.Positions"];
             $this->assignmentRepo = $dic["repo.UserAssignments"];
         }
 
         parent::__construct();
     }

Here is the call graph for this function:

Member Function Documentation

◆ addError()

ILIAS\OrgUnit\Webservices\SOAP\Base::addError ( string $message )

Exceptions

Definition at line 143 of file Base.php.

References ilSoapAdministration\raiseError().

Referenced by ILIAS\OrgUnit\Webservices\SOAP\Base\execute(), ILIAS\OrgUnit\Webservices\SOAP\AddUserIdToPositionInOrgUnit\run(), ILIAS\OrgUnit\Webservices\SOAP\PositionTitle\run(), and ILIAS\OrgUnit\Webservices\SOAP\RemoveUserIdFromPositionInOrgUnit\run().

     {
         throw $this->raiseError($message, 'ERROR');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkParameters()

ILIAS\OrgUnit\Webservices\SOAP\Base::checkParameters ( array $params )

protected

Check that all input parameters are present when executing the soap method.

Parameters

array $params

Exceptions

ilSoapPluginException

Definition at line 89 of file Base.php.

References ILIAS\OrgUnit\Webservices\SOAP\Base\getInputParams().

Referenced by ILIAS\OrgUnit\Webservices\SOAP\Base\execute().

                                                      : void
     {
         for ($i = 0, $iMax = count($this->getInputParams()); $i < $iMax; $i++) {
             if (!isset($params[$i])) {
                 $names = implode(', ', array_keys($this->getInputParams()));
                 throw new ilSoapPluginException("Request is missing at least one of the following parameters: $names");
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ execute()

ILIAS\OrgUnit\Webservices\SOAP\Base::execute ( array $params )

Execute the business logic for this SOAP method (when a SOAP request hits the endpoint defined by the name).

Note: This Method must return the data in the format specified by getOutputParams().

Parameters

array $params Key/Value pair of parameters defined by getInputParams()

Returns: mixed

Implements ilSoapMethod.

Definition at line 118 of file Base.php.

References $DIC, ILIAS\OrgUnit\Webservices\SOAP\Base\addError(), ILIAS\OrgUnit\Webservices\SOAP\Base\checkParameters(), ILIAS\OrgUnit\Webservices\SOAP\Base\getAdditionalInputParams(), ilObjOrgUnit\getRootOrgRefId(), ILIAS\OrgUnit\Webservices\SOAP\Base\init(), and ILIAS\OrgUnit\Webservices\SOAP\Base\run().

     {
         $this->checkParameters($params);
         $session_id = (isset($params[0])) ? $params[0] : '';
         $this->init($session_id);
 
         // Check Permissions
         global $DIC;
         if (!$DIC->access()->checkAccess('write', '', \ilObjOrgUnit::getRootOrgRefId())) {
             $this->addError('Permission denied');
         }
 
         $clean_params = array();
         $i = 1;
         foreach ($this->getAdditionalInputParams() as $key => $type) {
             $clean_params[$key] = $params[$i];
             $i++;
         }
 
         return $this->run($clean_params);
     }

Here is the call graph for this function:

◆ getAdditionalInputParams()

ILIAS\OrgUnit\Webservices\SOAP\Base::getAdditionalInputParams ( )

abstractprotected

Referenced by ILIAS\OrgUnit\Webservices\SOAP\Base\execute(), ILIAS\OrgUnit\Webservices\SOAP\Base\getInputParams(), and ILIAS\OrgUnit\Webservices\SOAP\Base\getServiceNamespace().

Here is the caller graph for this function:

◆ getInputParams()

ILIAS\OrgUnit\Webservices\SOAP\Base::getInputParams ( )

Get the input parameters.

Array keys must correspond to parameter names and values must correspond to a valid SOAP data-type

Returns: array

See also: ilNusoapUserAdministrationAdapter::registerMethods() for examples

Implements ilSoapMethod.

Definition at line 106 of file Base.php.

References $params, ILIAS\OrgUnit\Webservices\SOAP\Base\getAdditionalInputParams(), and ILIAS\OrgUnit\Webservices\SOAP\Base\run().

Referenced by ILIAS\OrgUnit\Webservices\SOAP\Base\checkParameters().

                                     : array
     {
         return array_merge(
             array(
                 self::SID => self::TYPE_STRING,
             ),
             $this->getAdditionalInputParams()
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getServiceNamespace()

ILIAS\OrgUnit\Webservices\SOAP\Base::getServiceNamespace ( )

Get the namespace of the service where this method belongs to.

Returns: string

Implements ilSoapMethod.

Definition at line 99 of file Base.php.

References ILIAS\OrgUnit\Webservices\SOAP\Base\getAdditionalInputParams().

                                          : string
     {
         return 'urn:' . ilOrgUnitSOAPServicesPlugin::PLUGIN_NAME;
     }

Here is the call graph for this function:

◆ getServiceStyle()

ILIAS\OrgUnit\Webservices\SOAP\Base::getServiceStyle ( )

Get the service style, e.g.

'rpc'

Returns: string

Implements ilSoapMethod.

Definition at line 58 of file Base.php.

                                      : string
     {
         return 'rpc';
     }

◆ getServiceUse()

ILIAS\OrgUnit\Webservices\SOAP\Base::getServiceUse ( )

Get the service use, e.g.

'encoded'

Returns: string

Implements ilSoapMethod.

Definition at line 63 of file Base.php.

                                    : string
     {
         return 'encoded';
     }

◆ init()

ILIAS\OrgUnit\Webservices\SOAP\Base::init ( string $session_id )

private

Exceptions

ilSoapPluginException

Definition at line 151 of file Base.php.

References ILIAS\OrgUnit\Webservices\SOAP\Base\initIliasAndCheckSession().

Referenced by ILIAS\OrgUnit\Webservices\SOAP\Base\execute().

                                              : void
     {
         $this->initIliasAndCheckSession($session_id); // Throws exception if session is not valid
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initIliasAndCheckSession()

ILIAS\OrgUnit\Webservices\SOAP\Base::initIliasAndCheckSession ( string $session_id )

protected

Use this method at the beginning of your execute() method to check if the provided session ID is valid.

This method wraps around ilSoapAdministration::initAuth() and ilSoapAdministration::initILIAS() which are both required in order to handle the request.

Parameters

string $session_id

Exceptions

ilSoapPluginException

Definition at line 75 of file Base.php.

References ilSoapAdministration\checkSession(), ilSoapAdministration\getMessage(), ilSoapAdministration\initAuth(), and ilSoapAdministration\initIlias().

Referenced by ILIAS\OrgUnit\Webservices\SOAP\Base\init().

                                                                    : void
     {
         $this->initAuth($session_id);
         $this->initIlias();
         if (!$this->checkSession($session_id)) {
             throw new ilSoapPluginException($this->getMessage());
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ run()

ILIAS\OrgUnit\Webservices\SOAP\Base::run ( array $params )

abstractprotected

Referenced by ILIAS\OrgUnit\Webservices\SOAP\Base\execute(), and ILIAS\OrgUnit\Webservices\SOAP\Base\getInputParams().

Here is the caller graph for this function:

Field Documentation

◆ $assignmentRepo

ilOrgUnitUserAssignmentDBRepository ILIAS\OrgUnit\Webservices\SOAP\Base::$assignmentRepo

protected

Definition at line 45 of file Base.php.

◆ $positionRepo

ilOrgUnitPositionDBRepository ILIAS\OrgUnit\Webservices\SOAP\Base::$positionRepo

protected

Definition at line 44 of file Base.php.

◆ ORGU_REF_ID

const ILIAS\OrgUnit\Webservices\SOAP\Base::ORGU_REF_ID = 'orgu_ref_id'

Definition at line 40 of file Base.php.

◆ POSITION_ID

const ILIAS\OrgUnit\Webservices\SOAP\Base::POSITION_ID = 'position_id'

Definition at line 41 of file Base.php.

◆ SID

const ILIAS\OrgUnit\Webservices\SOAP\Base::SID = 'sid'

Definition at line 39 of file Base.php.

◆ TYPE_DOUBLE_ARRAY

const ILIAS\OrgUnit\Webservices\SOAP\Base::TYPE_DOUBLE_ARRAY = 'tns:doubleArray'

Definition at line 38 of file Base.php.

◆ TYPE_INT

const ILIAS\OrgUnit\Webservices\SOAP\Base::TYPE_INT = 'xsd:int'

Definition at line 37 of file Base.php.

◆ TYPE_INT_ARRAY

const ILIAS\OrgUnit\Webservices\SOAP\Base::TYPE_INT_ARRAY = 'tns:intArray'

Definition at line 35 of file Base.php.

Referenced by ILIAS\OrgUnit\Webservices\SOAP\PositionIds\getOutputParams(), ILIAS\OrgUnit\Webservices\SOAP\UserIdsOfPosition\getOutputParams(), and ILIAS\OrgUnit\Webservices\SOAP\UserIdsOfPositionAndOrgUnit\getOutputParams().

◆ TYPE_STRING

const ILIAS\OrgUnit\Webservices\SOAP\Base::TYPE_STRING = 'xsd:string'

Definition at line 36 of file Base.php.

Referenced by ILIAS\OrgUnit\Webservices\SOAP\ImportOrgUnitTree\getAdditionalInputParams(), ILIAS\OrgUnit\Webservices\SOAP\OrgUnitTree\getOutputParams(), and ILIAS\OrgUnit\Webservices\SOAP\PositionTitle\getOutputParams().

◆ USR_ID

const ILIAS\OrgUnit\Webservices\SOAP\Base::USR_ID = 'usr_id'

Definition at line 43 of file Base.php.

◆ USR_IDS

const ILIAS\OrgUnit\Webservices\SOAP\Base::USR_IDS = 'usr_ids'

Definition at line 42 of file Base.php.

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

components/ILIAS/OrgUnit/classes/Webservices/SOAP/Base.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addError()

◆ checkParameters()

◆ execute()

◆ getAdditionalInputParams()

◆ getInputParams()

◆ getServiceNamespace()

◆ getServiceStyle()

◆ getServiceUse()

◆ init()

◆ initIliasAndCheckSession()

◆ run()

Field Documentation

◆ $assignmentRepo

◆ $positionRepo

◆ ORGU_REF_ID

◆ POSITION_ID

◆ SID

◆ TYPE_DOUBLE_ARRAY

◆ TYPE_INT

◆ TYPE_INT_ARRAY

◆ TYPE_STRING

◆ USR_ID

◆ USR_IDS