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 ()
	getGiverId ()
	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 ()
	getMode ()
	getFromOverview ()
	getZip ()

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.

References ILIAS\Repository\initRequest().

      {
        $this->initRequest(
            $http,
            $refinery,
            $passed_query_params,
            $passed_post_data
        );
    }

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.

References ILIAS\Repository\int().

Referenced by ilExerciseManagementGUI\__construct(), and ILIAS\Exercise\GUIRequest\getAssignment().

                              : int
    {
        return $this->int("ass_id");
    }

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.

References ILIAS\Repository\int().

                                  : int
    {
        return $this->int("ass_id_goto");
    }

Here is the call graph for this function:

getAssIds()

ILIAS\Exercise\GUIRequest::getAssIds

(

)

Returns

int[]

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

References ILIAS\Repository\intArray().

                               : array
    {
        return $this->intArray("ass");
    }

Here is the call graph for this function:

getAssignment()

ILIAS\Exercise\GUIRequest::getAssignment

(

)

Exceptions

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

References ILIAS\Exercise\GUIRequest\getAssId(), and null.

                                   : ?\ilExAssignment
    {
        if ($this->getAssId() > 0) {
            return new \ilExAssignment($this->getAssId());
        }
        return null;
    }

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.

References ILIAS\Exercise\GUIRequest\getIds().

                                      : array
    {
        return $this->getIds();
    }

Here is the call graph for this function:

getAssType()

ILIAS\Exercise\GUIRequest::getAssType

(

)

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

References ILIAS\Repository\str().

                                : string
    {
        return $this->str("ass_type");
    }

Here is the call graph for this function:

getBackView()

ILIAS\Exercise\GUIRequest::getBackView

(

)

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

References ILIAS\Repository\int().

                                 : int
    {
        return $this->int("vw");
    }

Here is the call graph for this function:

getBlogId()

ILIAS\Exercise\GUIRequest::getBlogId

(

)

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

References ILIAS\Repository\int().

                               : int
    {
        return $this->int("blog_id");
    }

Here is the call graph for this function:

getCatalogueId()

ILIAS\Exercise\GUIRequest::getCatalogueId

(

)

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

References ILIAS\Repository\int().

                                    : int
    {
        return $this->int("cat_id");
    }

Here is the call graph for this function:

getCatalogueIds()

ILIAS\Exercise\GUIRequest::getCatalogueIds

(

)

Returns

int[]

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

References ILIAS\Exercise\GUIRequest\getIds().

                                     : array
    {
        return $this->getIds();
    }

Here is the call graph for this function:

getComment()

ILIAS\Exercise\GUIRequest::getComment

(

)

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

References ILIAS\Repository\str().

Referenced by ilExerciseManagementGUI\__construct().

                                : string
    {
        return $this->str("comment");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCriteriaIds()

ILIAS\Exercise\GUIRequest::getCriteriaIds

(

)

Returns

int[]

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

References ILIAS\Exercise\GUIRequest\getIds().

                                    : array
    {
        return $this->getIds();
    }

Here is the call graph for this function:

getCriteriaType()

ILIAS\Exercise\GUIRequest::getCriteriaType

(

)

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

References ILIAS\Repository\str().

                                     : string
    {
        return $this->str("type");
    }

Here is the call graph for this function:

getCritId()

ILIAS\Exercise\GUIRequest::getCritId

(

)

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

References ILIAS\Repository\str().

                               : string
    {
        return $this->str("crit_id");
    }

Here is the call graph for this function:

getDone()

ILIAS\Exercise\GUIRequest::getDone

(

)

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

References ILIAS\Repository\int().

Referenced by ilExerciseManagementGUI\__construct().

                             : bool
    {
        return (bool) $this->int("dn");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getExercise()

ILIAS\Exercise\GUIRequest::getExercise

(

)

Exceptions

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

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

Referenced by ilExerciseManagementGUI\__construct().

                                 : ?\ilObjExercise
    {
        if ($this->getRefId() > 0 && \ilObject::_lookupType($this->getRefId(), true) == "exc") {
            return new \ilObjExercise($this->getRefId());
        }
        return null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFile()

ILIAS\Exercise\GUIRequest::getFile

(

)

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

References ILIAS\Repository\str().

                             : string
    {
        return $this->str("file");
    }

Here is the call graph for this function:

getFileHash()

ILIAS\Exercise\GUIRequest::getFileHash

(

)

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

References ILIAS\Repository\str().

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

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.

References ILIAS\Repository\arrayArray().

Referenced by ilExerciseManagementGUI\__construct().

                              : array
    {
        return $this->arrayArray("file");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFilterFeedback()

ILIAS\Exercise\GUIRequest::getFilterFeedback

(

)

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

References ILIAS\Repository\str().

Referenced by ilExerciseManagementGUI\__construct().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getFilterStatus()

ILIAS\Exercise\GUIRequest::getFilterStatus

(

)

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

References ILIAS\Repository\str().

Referenced by ilExerciseManagementGUI\__construct().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getFromOverview()

ILIAS\Exercise\GUIRequest::getFromOverview

(

)

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

References ILIAS\Repository\int().

                                     : bool
    {
        return (bool) $this->int("from_overview");
    }

Here is the call graph for this function:

getGiverId()

ILIAS\Exercise\GUIRequest::getGiverId

(

)

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

References ILIAS\Repository\int().

                                : int
    {
        return $this->int("giver_id");
    }

Here is the call graph for this function:

getGroupMembers()

ILIAS\Exercise\GUIRequest::getGroupMembers

(

)

Returns

int[]

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

References ILIAS\Repository\arrayArray().

Referenced by ilExerciseManagementGUI\__construct().

                                     : array
    {
        return $this->arrayArray("grpt");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getIdlId()

ILIAS\Exercise\GUIRequest::getIdlId

(

)

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

References ILIAS\Repository\str().

Referenced by ilExerciseManagementGUI\__construct().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getIds()

ILIAS\Exercise\GUIRequest::getIds ( )

protected

Returns

int[]

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

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().

                               : array
    {
        // "id" parameter used in team submission gui
        if ($this->isArray("id")) {
            return $this->intArray("id");
        } else {
            $team_id = $this->int("id");
            return ($team_id > 0)
                ? [$this->int("id")]
                : [];
        }
    }

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.

References ILIAS\Repository\strArray().

                                                 : array
    {
        return $this->strArray("file");
    }

Here is the call graph for this function:

getLearningComments()

ILIAS\Exercise\GUIRequest::getLearningComments

(

)

Returns

string[]

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

References ILIAS\Repository\strArray().

Referenced by ilExerciseManagementGUI\__construct().

                                         : array
    {
        return $this->strArray("lcomment");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getListedAssignments()

ILIAS\Exercise\GUIRequest::getListedAssignments

(

)

Returns

int[]

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

References ILIAS\Repository\intArray().

Referenced by ilExerciseManagementGUI\__construct().

                                          : array
    {
        return $this->intArray("listed_ass_ids");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getListedIdlIDs()

ILIAS\Exercise\GUIRequest::getListedIdlIDs

(

)

Returns

string[]

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

References ILIAS\Repository\strArray().

                                     : array
    {
        return $this->strArray("listed_idl_ids");
    }

Here is the call graph for this function:

getListedParticipants()

ILIAS\Exercise\GUIRequest::getListedParticipants

(

)

Returns

int[]

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

References ILIAS\Repository\intArray().

Referenced by ilExerciseManagementGUI\__construct().

                                           : array
    {
        return $this->intArray("listed_part_ids");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMarks()

ILIAS\Exercise\GUIRequest::getMarks

(

)

key might be ass_ids or user_ids!

Returns

string[]

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

References ILIAS\Repository\strArray().

Referenced by ilExerciseManagementGUI\__construct().

                              : array
    {
        return $this->strArray("mark");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMemberId()

ILIAS\Exercise\GUIRequest::getMemberId

(

)

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

References ILIAS\Repository\int().

Referenced by ilExerciseManagementGUI\__construct().

                                 : int
    {
        return $this->int("member_id");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMemberIds()

ILIAS\Exercise\GUIRequest::getMemberIds

(

)

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

References ILIAS\Repository\intArray().

                                  : array
    {
        return $this->intArray("member_ids");
    }

Here is the call graph for this function:

getMinCharLimit()

ILIAS\Exercise\GUIRequest::getMinCharLimit

(

)

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

References ILIAS\Repository\int().

                                     : int
    {
        return $this->int("min_char_limit");
    }

Here is the call graph for this function:

getMode()

ILIAS\Exercise\GUIRequest::getMode

(

)

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

References ILIAS\Repository\str().

                             : string
    {
        return $this->str("mode");
    }

Here is the call graph for this function:

getNewName()

ILIAS\Exercise\GUIRequest::getNewName

(

)

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

References ILIAS\Repository\str().

                                : string
    {
        return $this->str("new_name");
    }

Here is the call graph for this function:

getOffset()

ILIAS\Exercise\GUIRequest::getOffset

(

)

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

References ILIAS\Repository\int().

                               : int
    {
        return $this->int("offset");
    }

Here is the call graph for this function:

getOldName()

ILIAS\Exercise\GUIRequest::getOldName

(

)

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

References ILIAS\Repository\str().

                                : string
    {
        return $this->str("old_name");
    }

Here is the call graph for this function:

getOrder()

ILIAS\Exercise\GUIRequest::getOrder

(

)

Returns

int[]

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

References ILIAS\Repository\intArray().

                              : array
    {
        return $this->intArray("order");
    }

Here is the call graph for this function:

getParticipantId()

ILIAS\Exercise\GUIRequest::getParticipantId

(

)

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

References ILIAS\Repository\int().

Referenced by ilExerciseManagementGUI\__construct().

                                      : int
    {
        return $this->int("part_id");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPeerId()

ILIAS\Exercise\GUIRequest::getPeerId

(

)

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

References ILIAS\Repository\int().

                               : int
    {
        return $this->int("peer_id");
    }

Here is the call graph for this function:

getPortfolioId()

ILIAS\Exercise\GUIRequest::getPortfolioId

(

)

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

References ILIAS\Repository\int().

                                    : int
    {
        return $this->int("prtf_id");
    }

Here is the call graph for this function:

getPositions()

ILIAS\Exercise\GUIRequest::getPositions

(

)

Returns

int[]

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

References ILIAS\Repository\intArray().

                                  : array
    {
        return $this->intArray("pos");
    }

Here is the call graph for this function:

getRatingValue()

ILIAS\Exercise\GUIRequest::getRatingValue

(

)

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

References ILIAS\Repository\str().

                                    : string
    {
        return $this->str("value");
    }

Here is the call graph for this function:

getRefId()

ILIAS\Exercise\GUIRequest::getRefId

(

)

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

References ILIAS\Repository\int().

Referenced by ilExerciseManagementGUI\__construct(), and ILIAS\Exercise\GUIRequest\getExercise().

                              : int
    {
        return $this->int("ref_id");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getResourceObjectId()

ILIAS\Exercise\GUIRequest::getResourceObjectId

(

)

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

References ILIAS\Repository\int().

                                         : int
    {
        return $this->int("item");
    }

Here is the call graph for this function:

getReviewCritId()

ILIAS\Exercise\GUIRequest::getReviewCritId

(

)

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

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

                                     : string
    {
        $giver_peer_id = $this->str("fu");
        $parts = explode("__", $giver_peer_id);
        if (isset($parts[2])) {
            return (string) $parts[2];
        }
        return "";
    }

Here is the call graph for this function:

getReviewGiverId()

ILIAS\Exercise\GUIRequest::getReviewGiverId

(

)

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

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

                                      : int
    {
        $giver_peer_id = $this->str("fu");
        $parts = explode("__", $giver_peer_id);
        if (count($parts) > 1) {
            return (int) $parts[0];
        }
        return 0;
    }

Here is the call graph for this function:

getReviewPeerId()

ILIAS\Exercise\GUIRequest::getReviewPeerId

(

)

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

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

                                     : int
    {
        $giver_peer_id = $this->str("fu");
        $parts = explode("__", $giver_peer_id);
        if (count($parts) > 1) {
            return (int) $parts[1];
        }

        return 0;
    }

Here is the call graph for this function:

getSelectedAssignments()

ILIAS\Exercise\GUIRequest::getSelectedAssignments

(

)

Returns

int[]

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

References ILIAS\Repository\intArray().

Referenced by ilExerciseManagementGUI\__construct().

                                            : array
    {
        return $this->intArray("sel_ass_ids");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSelectedParticipants()

ILIAS\Exercise\GUIRequest::getSelectedParticipants

(

)

Returns

int[]

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

References ILIAS\Repository\intArray().

Referenced by ilExerciseManagementGUI\__construct().

                                             : array
    {
        return $this->intArray("sel_part_ids");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSelectedWspObjId()

ILIAS\Exercise\GUIRequest::getSelectedWspObjId

(

)

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

References ILIAS\Repository\int().

                                         : int
    {
        return $this->int("sel_wsp_obj");
    }

Here is the call graph for this function:

getSortBy()

ILIAS\Exercise\GUIRequest::getSortBy

(

)

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

References ILIAS\Repository\str().

                               : string
    {
        return $this->str("sort_by");
    }

Here is the call graph for this function:

getSortOrder()

ILIAS\Exercise\GUIRequest::getSortOrder

(

)

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

References ILIAS\Repository\str().

                                  : string
    {
        return $this->str("sort_order");
    }

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 456 of file class.GUIRequest.php.

References ILIAS\Repository\strArray().

Referenced by ilExerciseManagementGUI\__construct().

                               : array
    {
        return $this->strArray("status");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSubmittedFileId()

ILIAS\Exercise\GUIRequest::getSubmittedFileId

(

)

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

References ILIAS\Repository\int().

                                        : int
    {
        return $this->int("delivered");
    }

Here is the call graph for this function:

getSubmittedFileIds()

ILIAS\Exercise\GUIRequest::getSubmittedFileIds

(

)

Returns

int[]

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

References ILIAS\Repository\intArray().

                                         : array
    {
        return $this->intArray("delivered");
    }

Here is the call graph for this function:

getTeamIds()

ILIAS\Exercise\GUIRequest::getTeamIds

(

)

Returns

int[]

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

References ILIAS\Exercise\GUIRequest\getIds().

                                : array
    {
        return $this->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 447 of file class.GUIRequest.php.

References ILIAS\Repository\strArray().

Referenced by ilExerciseManagementGUI\__construct().

                                     : array
    {
        return $this->strArray("notice");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getType()

ILIAS\Exercise\GUIRequest::getType

(

)

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

References ILIAS\Repository\int().

                             : int
    {
        return $this->int("type");
    }

Here is the call graph for this function:

getUserId()

ILIAS\Exercise\GUIRequest::getUserId

(

)

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

References ILIAS\Repository\int().

                               : int
    {
        return $this->int("user_id");
    }

Here is the call graph for this function:

getUserLogin()

ILIAS\Exercise\GUIRequest::getUserLogin

(

)

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

References ILIAS\Repository\str().

Referenced by ilExerciseManagementGUI\__construct().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getZip()

ILIAS\Exercise\GUIRequest::getZip

(

)

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

References ILIAS\Repository\int().

                            : bool
    {
        return (bool) $this->int("zip");
    }

Here is the call graph for this function:

---

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

• components/ILIAS/Exercise/Service/classes/class.GUIRequest.php