ILIAS  release_8 Revision v8.24
ILIAS\Exercise\GUIRequest Class Reference

Exercise gui request wrapper. More...

+ Collaboration diagram for ILIAS\Exercise\GUIRequest:

Public Member Functions

 __construct (\ILIAS\HTTP\Services $http, \ILIAS\Refinery\Factory $refinery, ?array $passed_query_params=null, ?array $passed_post_data=null)
 
 getAssignmentIds ()
 note: shares "id" parameter with team ids More...
 
 getRefId ()
 
 getAssId ()
 
 getAssIds ()
 
 getAssIdGoto ()
 
 getExercise ()
 
 getAssignment ()
 
 getAssType ()
 
 getType ()
 
 getCriteriaType ()
 
 getSelectedAssignments ()
 
 getListedAssignments ()
 
 getMemberId ()
 
 getMemberIds ()
 
 getParticipantId ()
 
 getUserId ()
 
 getUserLogin ()
 
 getSelectedParticipants ()
 
 getListedParticipants ()
 
 getGroupMembers ()
 
 getOldName ()
 
 getNewName ()
 
 getFiles ()
 
 getInstructionFilesToDelete ()
 
 getFile ()
 
 getDone ()
 
 getIdlId ()
 
 getListedIdlIDs ()
 
 getOffset ()
 
 getSortOrder ()
 
 getSortBy ()
 
 getFilterStatus ()
 
 getFilterFeedback ()
 
 getSelectedWspObjId ()
 
 getReviewGiverId ()
 
 getReviewPeerId ()
 
 getReviewCritId ()
 
 getPeerId ()
 
 getCritId ()
 
 getFileHash ()
 
 getCatalogueIds ()
 
 getCatalogueId ()
 
 getCriteriaIds ()
 
 getTeamIds ()
 
 getOrder ()
 
 getPositions ()
 
 getMinCharLimit ()
 
 getLearningComments ()
 
 getMarks ()
 key might be ass_ids or user_ids! More...
 
 getTutorNotices ()
 key might be ass_ids or user_ids! More...
 
 getStatus ()
 key might be ass_ids or user_ids! More...
 
 getComment ()
 
 getRatingValue ()
 
 getSubmittedFileIds ()
 
 getSubmittedFileId ()
 
 getResourceObjectId ()
 
 getBlogId ()
 
 getPortfolioId ()
 
 getBackView ()
 

Protected Member Functions

 getIds ()
 

Detailed Description

Exercise gui request wrapper.

This class processes all request parameters which are not handled by form classes already. POST overwrites GET with the same name. POST/GET parameters may be passed to the class for testing purposes.

Author
Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 30 of file class.GUIRequest.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Exercise\GUIRequest::__construct ( \ILIAS\HTTP\Services  $http,
\ILIAS\Refinery\Factory  $refinery,
?array  $passed_query_params = null,
?array  $passed_post_data = null 
)

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

39 {
40 $this->initRequest(
41 $http,
45 );
46 }
Refinery Factory $refinery
initRequest(HTTP\Services $http, Refinery\Factory $refinery, ?array $passed_query_params=null, ?array $passed_post_data=null)
Query params and post data parameters are used for testing.
$http
Definition: raiseError.php:7

References ILIAS\Repository\$passed_post_data, ILIAS\Repository\$passed_query_params, ILIAS\Repository\$refinery, and ILIAS\Repository\initRequest().

+ Here is the call graph for this function:

Member Function Documentation

◆ getAssId()

ILIAS\Exercise\GUIRequest::getAssId ( )

Definition at line 78 of file class.GUIRequest.php.

78 : int
79 {
80 return $this->int("ass_id");
81 }

References ILIAS\Repository\int().

Referenced by ILIAS\Exercise\GUIRequest\getAssignment().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getAssIdGoto()

ILIAS\Exercise\GUIRequest::getAssIdGoto ( )

Definition at line 91 of file class.GUIRequest.php.

91 : int
92 {
93 return $this->int("ass_id_goto");
94 }

References ILIAS\Repository\int().

+ Here is the call graph for this function:

◆ getAssIds()

ILIAS\Exercise\GUIRequest::getAssIds ( )
Returns
int[]

Definition at line 86 of file class.GUIRequest.php.

86 : array
87 {
88 return $this->intArray("ass");
89 }

References ILIAS\Repository\intArray().

+ Here is the call graph for this function:

◆ getAssignment()

ILIAS\Exercise\GUIRequest::getAssignment ( )
Exceptions

ilExcUnknownAssignmentTypeException

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

111 {
112 if ($this->getAssId() > 0) {
113 return new \ilExAssignment($this->getAssId());
114 }
115 return null;
116 }
Exercise assignment.

References ILIAS\Exercise\GUIRequest\getAssId().

+ Here is the call graph for this function:

◆ getAssignmentIds()

ILIAS\Exercise\GUIRequest::getAssignmentIds ( )

note: shares "id" parameter with team ids

Returns
int[]

Definition at line 68 of file class.GUIRequest.php.

68 : array
69 {
70 return $this->getIds();
71 }

References ILIAS\Exercise\GUIRequest\getIds().

+ Here is the call graph for this function:

◆ getAssType()

ILIAS\Exercise\GUIRequest::getAssType ( )

Definition at line 118 of file class.GUIRequest.php.

118 : string
119 {
120 return $this->str("ass_type");
121 }

References ILIAS\Repository\str().

+ Here is the call graph for this function:

◆ getBackView()

ILIAS\Exercise\GUIRequest::getBackView ( )

Definition at line 494 of file class.GUIRequest.php.

494 : int
495 {
496 return $this->int("vw");
497 }

References ILIAS\Repository\int().

+ Here is the call graph for this function:

◆ getBlogId()

ILIAS\Exercise\GUIRequest::getBlogId ( )

Definition at line 484 of file class.GUIRequest.php.

484 : int
485 {
486 return $this->int("blog_id");
487 }

References ILIAS\Repository\int().

+ Here is the call graph for this function:

◆ getCatalogueId()

ILIAS\Exercise\GUIRequest::getCatalogueId ( )

Definition at line 362 of file class.GUIRequest.php.

362 : int
363 {
364 return $this->int("cat_id");
365 }

References ILIAS\Repository\int().

+ Here is the call graph for this function:

◆ getCatalogueIds()

ILIAS\Exercise\GUIRequest::getCatalogueIds ( )
Returns
int[]

Definition at line 357 of file class.GUIRequest.php.

357 : array
358 {
359 return $this->getIds();
360 }

References ILIAS\Exercise\GUIRequest\getIds().

+ Here is the call graph for this function:

◆ getComment()

ILIAS\Exercise\GUIRequest::getComment ( )

Definition at line 456 of file class.GUIRequest.php.

456 : string
457 {
458 return $this->str("comment");
459 }

References ILIAS\Repository\str().

+ Here is the call graph for this function:

◆ getCriteriaIds()

ILIAS\Exercise\GUIRequest::getCriteriaIds ( )
Returns
int[]

Definition at line 370 of file class.GUIRequest.php.

370 : array
371 {
372 return $this->getIds();
373 }

References ILIAS\Exercise\GUIRequest\getIds().

+ Here is the call graph for this function:

◆ getCriteriaType()

ILIAS\Exercise\GUIRequest::getCriteriaType ( )

Definition at line 130 of file class.GUIRequest.php.

130 : string
131 {
132 return $this->str("type");
133 }

References ILIAS\Repository\str().

+ Here is the call graph for this function:

◆ getCritId()

ILIAS\Exercise\GUIRequest::getCritId ( )

Definition at line 343 of file class.GUIRequest.php.

343 : string
344 {
345 return $this->str("crit_id");
346 }

References ILIAS\Repository\str().

+ Here is the call graph for this function:

◆ getDone()

ILIAS\Exercise\GUIRequest::getDone ( )

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

245 : bool
246 {
247 return (bool) $this->int("dn");
248 }

References ILIAS\Repository\int().

+ Here is the call graph for this function:

◆ getExercise()

ILIAS\Exercise\GUIRequest::getExercise ( )
Exceptions

ilExcUnknownAssignmentTypeException

Definition at line 99 of file class.GUIRequest.php.

100 {
101 if ($this->getRefId() > 0 && \ilObject::_lookupType($this->getRefId(), true) == "exc") {
102 return new \ilObjExercise($this->getRefId());
103 }
104 return null;
105 }
Class ilObjExercise.
static _lookupType(int $id, bool $reference=false)

References ilObject\_lookupType(), and ILIAS\Exercise\GUIRequest\getRefId().

+ Here is the call graph for this function:

◆ getFile()

ILIAS\Exercise\GUIRequest::getFile ( )

Definition at line 235 of file class.GUIRequest.php.

235 : string
236 {
237 return $this->str("file");
238 }

References ILIAS\Repository\str().

+ Here is the call graph for this function:

◆ getFileHash()

ILIAS\Exercise\GUIRequest::getFileHash ( )

Definition at line 349 of file class.GUIRequest.php.

349 : string
350 {
351 return trim($this->str("fuf"));
352 }

References ILIAS\Repository\str().

+ Here is the call graph for this function:

◆ getFiles()

ILIAS\Exercise\GUIRequest::getFiles ( )
Returns
array<int, list<string>>

Definition at line 222 of file class.GUIRequest.php.

222 : array
223 {
224 return $this->arrayArray("file");
225 }

References ILIAS\Repository\arrayArray().

+ Here is the call graph for this function:

◆ getFilterFeedback()

ILIAS\Exercise\GUIRequest::getFilterFeedback ( )

Definition at line 287 of file class.GUIRequest.php.

287 : string
288 {
289 return trim($this->str("filter_feedback"));
290 }

References ILIAS\Repository\str().

+ Here is the call graph for this function:

◆ getFilterStatus()

ILIAS\Exercise\GUIRequest::getFilterStatus ( )

Definition at line 282 of file class.GUIRequest.php.

282 : string
283 {
284 return trim($this->str("filter_status"));
285 }

References ILIAS\Repository\str().

+ Here is the call graph for this function:

◆ getGroupMembers()

ILIAS\Exercise\GUIRequest::getGroupMembers ( )
Returns
int[]

Definition at line 200 of file class.GUIRequest.php.

200 : array
201 {
202 return $this->arrayArray("grpt");
203 }

References ILIAS\Repository\arrayArray().

+ Here is the call graph for this function:

◆ getIdlId()

ILIAS\Exercise\GUIRequest::getIdlId ( )

Definition at line 250 of file class.GUIRequest.php.

250 : string
251 {
252 return $this->str("idlid"); // may be comma separated
253 }

References ILIAS\Repository\str().

+ Here is the call graph for this function:

◆ getIds()

ILIAS\Exercise\GUIRequest::getIds ( )
protected
Returns
int[]

Definition at line 51 of file class.GUIRequest.php.

51 : array
52 {
53 // "id" parameter used in team submission gui
54 if ($this->isArray("id")) {
55 return $this->intArray("id");
56 } else {
57 $team_id = $this->int("id");
58 return ($team_id > 0)
59 ? [$this->int("id")]
60 : [];
61 }
62 }
isArray(string $key)
Check if parameter is an array.

References ILIAS\Repository\int(), ILIAS\Repository\intArray(), and ILIAS\Repository\isArray().

Referenced by ILIAS\Exercise\GUIRequest\getAssignmentIds(), ILIAS\Exercise\GUIRequest\getCatalogueIds(), ILIAS\Exercise\GUIRequest\getCriteriaIds(), and ILIAS\Exercise\GUIRequest\getTeamIds().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getInstructionFilesToDelete()

ILIAS\Exercise\GUIRequest::getInstructionFilesToDelete ( )
Returns
list<string>

Definition at line 230 of file class.GUIRequest.php.

230 : array
231 {
232 return $this->strArray("file");
233 }

References ILIAS\Repository\strArray().

+ Here is the call graph for this function:

◆ getLearningComments()

ILIAS\Exercise\GUIRequest::getLearningComments ( )
Returns
string[]

Definition at line 424 of file class.GUIRequest.php.

424 : array
425 {
426 return $this->strArray("lcomment");
427 }

References ILIAS\Repository\strArray().

+ Here is the call graph for this function:

◆ getListedAssignments()

ILIAS\Exercise\GUIRequest::getListedAssignments ( )
Returns
int[]

Definition at line 146 of file class.GUIRequest.php.

146 : array
147 {
148 return $this->intArray("listed_ass_ids");
149 }

References ILIAS\Repository\intArray().

+ Here is the call graph for this function:

◆ getListedIdlIDs()

ILIAS\Exercise\GUIRequest::getListedIdlIDs ( )
Returns
string[]

Definition at line 258 of file class.GUIRequest.php.

258 : array
259 {
260 return $this->strArray("listed_idl_ids");
261 }

References ILIAS\Repository\strArray().

+ Here is the call graph for this function:

◆ getListedParticipants()

ILIAS\Exercise\GUIRequest::getListedParticipants ( )
Returns
int[]

Definition at line 192 of file class.GUIRequest.php.

192 : array
193 {
194 return $this->intArray("listed_part_ids");
195 }

References ILIAS\Repository\intArray().

+ Here is the call graph for this function:

◆ getMarks()

ILIAS\Exercise\GUIRequest::getMarks ( )

key might be ass_ids or user_ids!

Returns
string[]

Definition at line 433 of file class.GUIRequest.php.

433 : array
434 {
435 return $this->strArray("mark");
436 }

References ILIAS\Repository\strArray().

+ Here is the call graph for this function:

◆ getMemberId()

ILIAS\Exercise\GUIRequest::getMemberId ( )

Definition at line 155 of file class.GUIRequest.php.

155 : int
156 {
157 return $this->int("member_id");
158 }

References ILIAS\Repository\int().

+ Here is the call graph for this function:

◆ getMemberIds()

ILIAS\Exercise\GUIRequest::getMemberIds ( )

Definition at line 160 of file class.GUIRequest.php.

160 : array
161 {
162 return $this->intArray("member_ids");
163 }

References ILIAS\Repository\intArray().

+ Here is the call graph for this function:

◆ getMinCharLimit()

ILIAS\Exercise\GUIRequest::getMinCharLimit ( )

Definition at line 412 of file class.GUIRequest.php.

412 : int
413 {
414 return $this->int("min_char_limit");
415 }

References ILIAS\Repository\int().

+ Here is the call graph for this function:

◆ getNewName()

ILIAS\Exercise\GUIRequest::getNewName ( )

Definition at line 214 of file class.GUIRequest.php.

214 : string
215 {
216 return $this->str("new_name");
217 }

References ILIAS\Repository\str().

+ Here is the call graph for this function:

◆ getOffset()

ILIAS\Exercise\GUIRequest::getOffset ( )

Definition at line 267 of file class.GUIRequest.php.

267 : int
268 {
269 return $this->int("offset");
270 }

References ILIAS\Repository\int().

+ Here is the call graph for this function:

◆ getOldName()

ILIAS\Exercise\GUIRequest::getOldName ( )

Definition at line 209 of file class.GUIRequest.php.

209 : string
210 {
211 return $this->str("old_name");
212 }

References ILIAS\Repository\str().

+ Here is the call graph for this function:

◆ getOrder()

ILIAS\Exercise\GUIRequest::getOrder ( )
Returns
int[]

Definition at line 395 of file class.GUIRequest.php.

395 : array
396 {
397 return $this->intArray("order");
398 }

References ILIAS\Repository\intArray().

+ Here is the call graph for this function:

◆ getParticipantId()

ILIAS\Exercise\GUIRequest::getParticipantId ( )

Definition at line 166 of file class.GUIRequest.php.

166 : int
167 {
168 return $this->int("part_id");
169 }

References ILIAS\Repository\int().

+ Here is the call graph for this function:

◆ getPeerId()

ILIAS\Exercise\GUIRequest::getPeerId ( )

Definition at line 337 of file class.GUIRequest.php.

337 : int
338 {
339 return $this->int("peer_id");
340 }

References ILIAS\Repository\int().

+ Here is the call graph for this function:

◆ getPortfolioId()

ILIAS\Exercise\GUIRequest::getPortfolioId ( )

Definition at line 489 of file class.GUIRequest.php.

489 : int
490 {
491 return $this->int("prtf_id");
492 }

References ILIAS\Repository\int().

+ Here is the call graph for this function:

◆ getPositions()

ILIAS\Exercise\GUIRequest::getPositions ( )
Returns
int[]

Definition at line 403 of file class.GUIRequest.php.

403 : array
404 {
405 return $this->intArray("pos");
406 }

References ILIAS\Repository\intArray().

+ Here is the call graph for this function:

◆ getRatingValue()

ILIAS\Exercise\GUIRequest::getRatingValue ( )

Definition at line 461 of file class.GUIRequest.php.

461 : string
462 {
463 return $this->str("value");
464 }

References ILIAS\Repository\str().

+ Here is the call graph for this function:

◆ getRefId()

ILIAS\Exercise\GUIRequest::getRefId ( )

Definition at line 73 of file class.GUIRequest.php.

73 : int
74 {
75 return $this->int("ref_id");
76 }

References ILIAS\Repository\int().

Referenced by ILIAS\Exercise\GUIRequest\getExercise().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getResourceObjectId()

ILIAS\Exercise\GUIRequest::getResourceObjectId ( )

Definition at line 479 of file class.GUIRequest.php.

479 : int
480 {
481 return $this->int("item");
482 }

References ILIAS\Repository\int().

+ Here is the call graph for this function:

◆ getReviewCritId()

ILIAS\Exercise\GUIRequest::getReviewCritId ( )

Definition at line 326 of file class.GUIRequest.php.

326 : string
327 {
328 $giver_peer_id = $this->str("fu");
329 $parts = explode("__", $giver_peer_id);
330 if (isset($parts[2])) {
331 return (string) $parts[2];
332 }
333 return "";
334 }
if($clientAssertionType !='urn:ietf:params:oauth:client-assertion-type:jwt-bearer'|| $grantType !='client_credentials') $parts
Definition: ltitoken.php:64

References $parts, and ILIAS\Repository\str().

+ Here is the call graph for this function:

◆ getReviewGiverId()

ILIAS\Exercise\GUIRequest::getReviewGiverId ( )

Definition at line 305 of file class.GUIRequest.php.

305 : int
306 {
307 $giver_peer_id = $this->str("fu");
308 $parts = explode("__", $giver_peer_id);
309 if (count($parts) > 1) {
310 return (int) $parts[0];
311 }
312 return 0;
313 }

References $parts, and ILIAS\Repository\str().

+ Here is the call graph for this function:

◆ getReviewPeerId()

ILIAS\Exercise\GUIRequest::getReviewPeerId ( )

Definition at line 315 of file class.GUIRequest.php.

315 : int
316 {
317 $giver_peer_id = $this->str("fu");
318 $parts = explode("__", $giver_peer_id);
319 if (count($parts) > 1) {
320 return (int) $parts[1];
321 }
322
323 return 0;
324 }

References $parts, and ILIAS\Repository\str().

+ Here is the call graph for this function:

◆ getSelectedAssignments()

ILIAS\Exercise\GUIRequest::getSelectedAssignments ( )
Returns
int[]

Definition at line 138 of file class.GUIRequest.php.

138 : array
139 {
140 return $this->intArray("sel_ass_ids");
141 }

References ILIAS\Repository\intArray().

+ Here is the call graph for this function:

◆ getSelectedParticipants()

ILIAS\Exercise\GUIRequest::getSelectedParticipants ( )
Returns
int[]

Definition at line 184 of file class.GUIRequest.php.

184 : array
185 {
186 return $this->intArray("sel_part_ids");
187 }

References ILIAS\Repository\intArray().

+ Here is the call graph for this function:

◆ getSelectedWspObjId()

ILIAS\Exercise\GUIRequest::getSelectedWspObjId ( )

Definition at line 296 of file class.GUIRequest.php.

296 : int
297 {
298 return $this->int("sel_wsp_obj");
299 }

References ILIAS\Repository\int().

+ Here is the call graph for this function:

◆ getSortBy()

ILIAS\Exercise\GUIRequest::getSortBy ( )

Definition at line 277 of file class.GUIRequest.php.

277 : string
278 {
279 return $this->str("sort_by");
280 }

References ILIAS\Repository\str().

+ Here is the call graph for this function:

◆ getSortOrder()

ILIAS\Exercise\GUIRequest::getSortOrder ( )

Definition at line 272 of file class.GUIRequest.php.

272 : string
273 {
274 return $this->str("sort_order");
275 }

References ILIAS\Repository\str().

+ Here is the call graph for this function:

◆ getStatus()

ILIAS\Exercise\GUIRequest::getStatus ( )

key might be ass_ids or user_ids!

Returns
string[]

Definition at line 451 of file class.GUIRequest.php.

451 : array
452 {
453 return $this->strArray("status");
454 }

References ILIAS\Repository\strArray().

+ Here is the call graph for this function:

◆ getSubmittedFileId()

ILIAS\Exercise\GUIRequest::getSubmittedFileId ( )

Definition at line 474 of file class.GUIRequest.php.

474 : int
475 {
476 return $this->int("delivered");
477 }

References ILIAS\Repository\int().

+ Here is the call graph for this function:

◆ getSubmittedFileIds()

ILIAS\Exercise\GUIRequest::getSubmittedFileIds ( )
Returns
int[]

Definition at line 469 of file class.GUIRequest.php.

469 : array
470 {
471 return $this->intArray("delivered");
472 }

References ILIAS\Repository\intArray().

+ Here is the call graph for this function:

◆ getTeamIds()

ILIAS\Exercise\GUIRequest::getTeamIds ( )
Returns
int[]

Definition at line 383 of file class.GUIRequest.php.

383 : array
384 {
385 return $this->getIds();
386 }

References ILIAS\Exercise\GUIRequest\getIds().

+ Here is the call graph for this function:

◆ getTutorNotices()

ILIAS\Exercise\GUIRequest::getTutorNotices ( )

key might be ass_ids or user_ids!

Returns
string[]

Definition at line 442 of file class.GUIRequest.php.

442 : array
443 {
444 return $this->strArray("notice");
445 }

References ILIAS\Repository\strArray().

+ Here is the call graph for this function:

◆ getType()

ILIAS\Exercise\GUIRequest::getType ( )

Definition at line 124 of file class.GUIRequest.php.

124 : int
125 {
126 return $this->int("type");
127 }

References ILIAS\Repository\int().

+ Here is the call graph for this function:

◆ getUserId()

ILIAS\Exercise\GUIRequest::getUserId ( )

Definition at line 171 of file class.GUIRequest.php.

171 : int
172 {
173 return $this->int("user_id");
174 }

References ILIAS\Repository\int().

+ Here is the call graph for this function:

◆ getUserLogin()

ILIAS\Exercise\GUIRequest::getUserLogin ( )

Definition at line 176 of file class.GUIRequest.php.

176 : string
177 {
178 return trim($this->str("user_login"));
179 }

References ILIAS\Repository\str().

+ Here is the call graph for this function:

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