Class ilCmiXapiStatementsDeleteRequest. More...

Collaboration diagram for ilCmiXapiStatementsDeleteRequest:

Public Member Functions
	__construct (int $obj_id, int $type_id, string $activity_id, ?int $usr_id=null, ?string $scope=self::DELETE_SCOPE_FILTERED, ?ilCmiXapiStatementsReportFilter $filter=null)

	deleteData ()

	_lookUpDataCount ($scope=null)

	queryBatch (array $batchId)

Data Fields
const	DELETE_SCOPE_FILTERED = "filtered"

const	DELETE_SCOPE_ALL = "all"

const	DELETE_SCOPE_OWN = "own"

Protected Attributes
string	$scope

ilCmiXapiStatementsReportFilter	$filter

int	$objId

ilCmiXapiLrsType	$lrsType

string	$endpointDefault = ''

string	$endpointFallback = ''

array	$headers

array	$defaultHeaders

ilLogger	$log

Private Member Functions
	getBatchUrl (string $url, string $batchId)

	getDeleteStateUrls ($url)

	buildDeleteAll ()

	buildDeleteFiltered ()

	buildDeleteOwn ()

	buildDeleteStates ()

	checkDeleteState ()

	checkDeleteUsersForObject ()

Private Attributes
GuzzleHttp Client	$client

int	$usrId

string	$activityId

Detailed Description

Class ilCmiXapiStatementsDeleteRequest.

Author: Uwe Kohnle kohnl.nosp@m.e@in.nosp@m.terne.nosp@m.tleh.nosp@m.rer-g.nosp@m.mbh..nosp@m.de; Stefan Schneider

Definition at line 28 of file class.ilCmiXapiStatementsDeleteRequest.php.

Constructor & Destructor Documentation

◆ __construct()

ilCmiXapiStatementsDeleteRequest::__construct	(	int	$obj_id,
		int	$type_id,
		string	$activity_id,
		?int	$usr_id = `null`,
		?string	$scope = `self::DELETE_SCOPE_FILTERED`,
		?ilCmiXapiStatementsReportFilter	$filter = `null`
	)

Definition at line 58 of file class.ilCmiXapiStatementsDeleteRequest.php.

References $DIC, $filter, $headers, $res, $response, $scope, checkDeleteUsersForObject(), ILIAS\UI\examples\Progress\Bar\client(), deleteData(), ILIAS\Repository\filter(), ilLoggerFactory\getLogger(), ILIAS_VERSION_NUMERIC, and queryBatch().

       {
         if ((int)ILIAS_VERSION_NUMERIC < 6) { // only in plugin
             require_once __DIR__ . '/../XapiProxy/vendor/autoload.php';
         }
         $this->objId = $obj_id;
         $this->lrsType = new ilCmiXapiLrsType($type_id);
         $this->activityId = $activity_id;
         $this->usrId = $usr_id;
         $this->scope = $scope;
         $this->filter = $filter;
 
         $this->endpointDefault = $this->lrsType->getLrsEndpoint();
         $this->client = new GuzzleHttp\Client();
         $this->headers = [
             'X-Experience-API-Version' => '1.0.3'
         ];
         $this->defaultHeaders = $this->headers;
         $this->defaultHeaders['Authorization'] = $this->lrsType->getBasicAuth();
 
         $this->log = ilLoggerFactory::getLogger('cmix');
     }

Here is the call graph for this function:

Member Function Documentation

◆ _lookUpDataCount()

ilCmiXapiStatementsDeleteRequest::_lookUpDataCount ( $scope = null )

Definition at line 188 of file class.ilCmiXapiStatementsDeleteRequest.php.

References $DIC, Vendor\Package\$e, Vendor\Package\$f, $response, $scope, $url, ilUtil\appendUrlParameterString(), buildDeleteAll(), buildDeleteFiltered(), buildDeleteOwn(), and ILIAS\UI\examples\Progress\Bar\client().

     {
         global $DIC;
         $pipeline = array();
         if (is_null($scope)) {
             $scope = $this->scope;
         }
         if ($scope === self::DELETE_SCOPE_OWN) {
             $f = $this->buildDeleteOwn();
             if (count($f) == 0) {
                 return 0;
             }
         }
         if ($scope === self::DELETE_SCOPE_FILTERED) {
             $f = $this->buildDeleteFiltered();
         }
         if ($scope === self::DELETE_SCOPE_ALL) {
             $f = $this->buildDeleteAll();
         }
         $pipeline[] = array('$match' => $f);
         $pipeline[] = array('$count' => 'count');
         $pquery = urlencode(json_encode($pipeline));
         $query = "pipeline={$pquery}";
         $purl = $this->lrsType->getLrsEndpointStatementsAggregationLink();
         $url = ilUtil::appendUrlParameterString($purl, $query);
         $request = new GuzzleHttp\Psr7\Request('GET', $url, $this->defaultHeaders);
         try {
             $response = $this->client->sendAsync($request)->wait();
             $cnt = json_decode($response->getBody());
             return (int) $cnt[0]->count;
         } catch(Exception $e) {
             throw new Exception("LRS Connection Problems");
             return 0;
         }
     }

Here is the call graph for this function:

◆ buildDeleteAll()

ilCmiXapiStatementsDeleteRequest::buildDeleteAll ( )

private

Definition at line 266 of file class.ilCmiXapiStatementsDeleteRequest.php.

References $DIC, Vendor\Package\$f, and ilCmiXapiUser\getUsersForObject().

Referenced by _lookUpDataCount(), and deleteData().

                                      : array
     {
         global $DIC;
         $f = array();
 
         $f['statement.object.objectType'] = 'Activity';
         $f['statement.object.id'] = [
             '$regex' => '^' . preg_quote($this->activityId) . ''
         ];
 
         $f['statement.actor.objectType'] = 'Agent';
 
         $f['$or'] = [];
         // foreach (ilXapiCmi5User::getUsersForObjectPlugin($this->getObjId()) as $usr_id) {
         // $f['$or'][] = ['statement.actor.mbox' => "mailto:".ilXapiCmi5User::getUsrIdentPlugin($usr_id,$this->getObjId())];
         foreach (ilCmiXapiUser::getUsersForObject($this->objId) as $cmixUser) {
             $f['$or'][] = ['statement.actor.mbox' => "mailto:{$cmixUser->getUsrIdent()}"];
         }
         if (count($f['$or']) == 0) {
             // Exception Handling!
             return [];
         } else {
             return $f;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildDeleteFiltered()

ilCmiXapiStatementsDeleteRequest::buildDeleteFiltered ( )

private

Definition at line 292 of file class.ilCmiXapiStatementsDeleteRequest.php.

References $DIC, Vendor\Package\$f, ILIAS\Repository\filter(), and ilCmiXapiUser\getUsersForObject().

Referenced by _lookUpDataCount(), and deleteData().

                                           : array
     {
         global $DIC;
         $f = array();
 
         $f['statement.object.objectType'] = 'Activity';
         $f['statement.object.id'] = [
             '$regex' => '^' . preg_quote($this->activityId) . ''
         ];
 
         $f['statement.actor.objectType'] = 'Agent';
         $f['$or'] = [];
         if ($this->filter->getActor()) {
             foreach (ilCmiXapiUser::getUsersForObject($this->objId) as $cmixUser) {
                 if ($cmixUser->getUsrId() == $this->filter->getActor()->getUsrId()) {
                     $f['$or'][] = ['statement.actor.mbox' => "mailto:{$cmixUser->getUsrIdent()}"];
                 }
             }
         } else { // check hasOutcomes Access?
             foreach (ilCmiXapiUser::getUsersForObject($this->objId) as $cmixUser) {
                 $f['$or'][] = ['statement.actor.mbox' => "mailto:{$cmixUser->getUsrIdent()}"];
             }
         }
 
         if ($this->filter->getVerb()) {
             $f['statement.verb.id'] = $this->filter->getVerb();
         }
 
         if ($this->filter->getStartDate() || $this->filter->getEndDate()) {
             $f['statement.timestamp'] = array();
 
             if ($this->filter->getStartDate()) {
                 $f['statement.timestamp']['$gt'] = $this->filter->getStartDate()->toXapiTimestamp();
             }
 
             if ($this->filter->getEndDate()) {
                 $f['statement.timestamp']['$lt'] = $this->filter->getEndDate()->toXapiTimestamp();
             }
         }
 
         if (count($f['$or']) == 0) {
             // Exception Handling!
             return [];
         } else {
             return $f;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildDeleteOwn()

ilCmiXapiStatementsDeleteRequest::buildDeleteOwn ( )

private

Definition at line 340 of file class.ilCmiXapiStatementsDeleteRequest.php.

References $DIC, Vendor\Package\$f, ilCmiXapiUser\getInstancesByObjectIdAndUsrId(), and null.

Referenced by _lookUpDataCount(), and deleteData().

                                      : array
     {
         global $DIC;
         $f = array();
         $f['statement.object.objectType'] = 'Activity';
         $f['statement.object.id'] = [
             '$regex' => '^' . preg_quote($this->activityId) . ''
         ];
         $f['statement.actor.objectType'] = 'Agent';
 
         $usrId = ($this->usrId !== null) ? $this->usrId : $DIC->user()->getId();
         $cmixUsers = ilCmiXapiUser::getInstancesByObjectIdAndUsrId($this->objId, $usrId);
         $f['$or'] = [];
         foreach ($cmixUsers as $cmixUser) {
             $f['$or'][] = ['statement.actor.mbox' => "mailto:{$cmixUser->getUsrIdent()}"];
         }
         if (count($f['$or']) == 0) {
             return [];
         } else {
             return $f;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildDeleteStates()

ilCmiXapiStatementsDeleteRequest::buildDeleteStates ( )

private

Definition at line 363 of file class.ilCmiXapiStatementsDeleteRequest.php.

References $DIC, $usrId, ILIAS\Repository\filter(), ilCmiXapiUser\getUsersForObject(), and null.

Referenced by getDeleteStateUrls().

                                         : array
     {
         global $DIC;
         $ret = array();
         $user = "";
         if ($this->scope === self::DELETE_SCOPE_FILTERED && $this->filter->getActor()) {
             foreach (ilCmiXapiUser::getUsersForObject($this->objId) as $cmixUser) {
                 if ($cmixUser->getUsrId() == $this->filter->getActor()->getUsrId()) {
                     $user = $cmixUser->getUsrIdent();
                     $ret[] = 'activityId=' . urlencode($this->activityId) . '&agent=' . urlencode('{"mbox":"mailto:' . $user . '"}');
                 }
             }
         }
 
         if ($this->scope === self::DELETE_SCOPE_OWN) {
             $usrId = ($this->usrId !== null) ? $this->usrId : $DIC->user()->getId();
             foreach (ilCmiXapiUser::getUsersForObject($this->objId) as $cmixUser) {
                 if ((int) $cmixUser->getUsrId() === $usrId) {
                     $user = $cmixUser->getUsrIdent();
                     $ret[] = 'activityId=' . urlencode($this->activityId) . '&agent=' . urlencode('{"mbox":"mailto:' . $user . '"}');
                 }
             }
         }
 
         if ($this->scope === self::DELETE_SCOPE_ALL) {
             //todo check cmix_del_object
             foreach (ilCmiXapiUser::getUsersForObject($this->objId) as $cmixUser) {
                 $user = $cmixUser->getUsrIdent();
                 $ret[] = 'activityId=' . urlencode($this->activityId) . '&agent=' . urlencode('{"mbox":"mailto:' . $user . '"}');
             }
         }
         return $ret;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkDeleteState()

ilCmiXapiStatementsDeleteRequest::checkDeleteState ( )

private

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

References $DIC, and ILIAS\Repository\filter().

Referenced by checkDeleteUsersForObject(), and deleteData().

                                        : bool
     {
         global $DIC;
         if ($this->scope === self::DELETE_SCOPE_ALL || $this->scope === self::DELETE_SCOPE_OWN) {
             return true;
         }
         if ($this->filter->getActor()) { // ToDo: only in Multicactor Mode?
             if ($this->filter->getVerb() || $this->filter->getStartDate() || $this->filter->getEndDate()) {
                 return false;
             } else {
                 return true;
             }
         }
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkDeleteUsersForObject()

ilCmiXapiStatementsDeleteRequest::checkDeleteUsersForObject ( )

private

Definition at line 413 of file class.ilCmiXapiStatementsDeleteRequest.php.

References $DIC, checkDeleteState(), ilCmiXapiUser\deleteUsersForObject(), ILIAS\Repository\filter(), and null.

Referenced by __construct().

     {
         global $DIC;
         if ($this->scope === self::DELETE_SCOPE_ALL) {
             ilCmiXapiUser::deleteUsersForObject($this->objId);
             //            $model = ilCmiXapiDelModel::init();
             //            $model->deleteXapiObjectEntry($this->objId);
         }
         if ($this->scope === self::DELETE_SCOPE_OWN) {
             $usrId = ($this->usrId !== null) ? [$this->usrId] : [$DIC->user()->getId()];
             ilCmiXapiUser::deleteUsersForObject($this->objId, $usrId);
         }
         if ($this->scope === self::DELETE_SCOPE_FILTERED) {
             if ($this->checkDeleteState() && $this->filter) {
                 $usrId = [$this->filter->getActor()->getUsrId()];
                 ilCmiXapiUser::deleteUsersForObject($this->objId, $usrId);
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteData()

ilCmiXapiStatementsDeleteRequest::deleteData ( )

Definition at line 136 of file class.ilCmiXapiStatementsDeleteRequest.php.

References $DIC, Vendor\Package\$e, Vendor\Package\$f, $r, $response, buildDeleteAll(), buildDeleteFiltered(), buildDeleteOwn(), checkDeleteState(), ILIAS\UI\examples\Progress\Bar\client(), getDeleteStateUrls(), and null.

Referenced by __construct().

                                 : array
     {
         global $DIC;
 
         $deleteState = true;
 
         $f = null;
         if ($this->scope === self::DELETE_SCOPE_FILTERED) {
             $deleteState = $this->checkDeleteState();
             $f = $this->buildDeleteFiltered();
         }
         if ($this->scope === self::DELETE_SCOPE_ALL) {
             $f = $this->buildDeleteAll();
         }
         if ($this->scope === self::DELETE_SCOPE_OWN) {
             $f = $this->buildDeleteOwn();
         }
         if ($f === false) {
             $this->log->debug('error: could not build filter');
             return array();
         }
         $cf = array('filter' => $f);
         $body = json_encode($cf);
         $this->defaultHeaders['Content-Type'] = 'application/json; charset=utf-8';
         $defaultUrl = $this->lrsType->getLrsEndpointDeleteLink();
         $defaultRequest = new GuzzleHttp\Psr7\Request('POST', $defaultUrl, $this->defaultHeaders, $body);
         $promisesStatements = [
             'default' => $this->client->sendAsync($defaultRequest)
         ];
         $promisesStates = array();
         if ($deleteState) {
             $urls = $this->getDeleteStateUrls($this->lrsType->getLrsEndpointStateLink());
             foreach ($urls as $i => $v) {
                 $r = new GuzzleHttp\Psr7\Request('DELETE', $v, $this->defaultHeaders);
                 $promisesStates['default' . $i] = $this->client->sendAsync($r);
             }
         }
         $response = array();
         $response['statements'] = array();
         $response['states'] = array();
 
         try { // maybe everything into one promise?
             $response['statements'] = GuzzleHttp\Promise\Utils::settle($promisesStatements)->wait();
             if ($deleteState && count($promisesStates) > 0) {
                 $response['states'] = GuzzleHttp\Promise\Utils::settle($promisesStates)->wait();
             }
         } catch (Exception $e) {
             $this->log->debug('error:' . $e->getMessage());
         }
         return $response;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getBatchUrl()

ilCmiXapiStatementsDeleteRequest::getBatchUrl	(	string	$url,
		string	$batchId
	)

private

Definition at line 245 of file class.ilCmiXapiStatementsDeleteRequest.php.

References Vendor\Package\$f, and ilUtil\appendUrlParameterString().

Referenced by queryBatch().

                                                               : string
     {
         $f = array();
         $f['_id'] = [
             '$oid' => $batchId
         ];
         $f = urlencode(json_encode($f));
         $f = "filter={$f}";
         return ilUtil::appendUrlParameterString($url, $f);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDeleteStateUrls()

ilCmiXapiStatementsDeleteRequest::getDeleteStateUrls ( $url )

private

Definition at line 256 of file class.ilCmiXapiStatementsDeleteRequest.php.

References $url, ilUtil\appendUrlParameterString(), and buildDeleteStates().

Referenced by deleteData().

                                              : array
     {
         $ret = array();
         $states = $this->buildDeleteStates();
         foreach($states as $i => $v) {
             $ret[] = ilUtil::appendUrlParameterString($url, $v);
         }
         return $ret;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ queryBatch()

ilCmiXapiStatementsDeleteRequest::queryBatch ( array $batchId )

Parameters

string $batchId

Returns: array

Definition at line 228 of file class.ilCmiXapiStatementsDeleteRequest.php.

References $DIC, Vendor\Package\$e, $response, ILIAS\UI\examples\Progress\Bar\client(), and getBatchUrl().

Referenced by __construct().

                                               : array
     {
         global $DIC;
         $defaultUrl = $this->getBatchUrl($this->lrsType->getLrsEndpointBatchLink(), $batchId[0]);
         $defaultRequest = new GuzzleHttp\Psr7\Request('GET', $defaultUrl, $this->defaultHeaders);
         $promises = [
             'default' => $this->client->sendAsync($defaultRequest)
         ];
         $response = [];
         try {
             $response = GuzzleHttp\Promise\Utils::settle($promises)->wait();
         } catch (Exception $e) {
             $this->log->debug('error:' . $e->getMessage());
         }
         return $response;
     }