ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
Public Member Functions | Data Fields
ILIAS\Container\StandardGUIRequest Class Reference
+ Collaboration diagram for ILIAS\Container\StandardGUIRequest:

Public Member Functions

 __construct (\ILIAS\HTTP\Services $http, \ILIAS\Refinery\Factory $refinery)
 
 getRefId ()
 
 getItemRefId ()
 
 getRedirectSource ()
 
 getNewType ()
 
 getType ()
 
 getBaseClass ()
 
 getSelectedIds ()
 
 getCloneSource ()
 
 getCmdRefId ()
 
 getChildRefId ()
 
 getParentRefId ()
 
 getExpand ()
 
 getBlockAction ()
 
 getBlockId ()
 
 getPreviousSession ()
 
 getNextSession ()
 
 getObjectiveId ()
 
 getNodes ()
 
 getCopyOptions ()
 
 getPositions ()
 
 getTrashIds ()
 
 getAlreadyRenderedRefIds ()
 
 getStartObjIds ()
 
 getCmdClass ()
 

Data Fields

trait BaseGUIRequest
 Base gui request wrapper. More...
 

Detailed Description

Definition at line 25 of file class.StandardGUIRequest.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Container\StandardGUIRequest::__construct ( \ILIAS\HTTP\Services  $http,
\ILIAS\Refinery\Factory  $refinery 
)

Definition at line 29 of file class.StandardGUIRequest.php.

32 {
33 $this->initRequest(
34 $http,
35 $refinery
36 );
37 }
$http
$http
Definition: deliver.php:30
ILIAS\Repository\initRequest
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.
Definition: trait.BaseGUIRequest.php:48

References ILIAS\UI\examples\Layout\Page\Standard\$refinery, and ILIAS\Repository\initRequest().

+ Here is the call graph for this function:

Member Function Documentation

◆ getAlreadyRenderedRefIds()

ILIAS\Container\StandardGUIRequest::getAlreadyRenderedRefIds ( )
Returns
int[]

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

166 : array
167 {
168 $ids = $this->strArray("ids");
169 $ref_ids = array_map(static function (string $i): int {
170 $parts = explode("_", $i);
171 return (int) $parts[2];
172 }, $ids);
173 return $ref_ids;
174 }
$parts
if($clientAssertionType !='urn:ietf:params:oauth:client-assertion-type:jwt-bearer'|| $grantType !='client_credentials') $parts
Definition: ltitoken.php:61

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

+ Here is the call graph for this function:

◆ getBaseClass()

ILIAS\Container\StandardGUIRequest::getBaseClass ( )

Definition at line 64 of file class.StandardGUIRequest.php.

64 : string
65 {
66 return $this->str("baseClass");
67 }

References ILIAS\Repository\str().

+ Here is the call graph for this function:

◆ getBlockAction()

ILIAS\Container\StandardGUIRequest::getBlockAction ( )

Definition at line 105 of file class.StandardGUIRequest.php.

105 : string
106 {
107 return $this->str("act");
108 }

References ILIAS\Repository\str().

+ Here is the call graph for this function:

◆ getBlockId()

ILIAS\Container\StandardGUIRequest::getBlockId ( )

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

110 : string
111 {
112 return $this->str("cont_block_id");
113 }

References ILIAS\Repository\str().

+ Here is the call graph for this function:

◆ getChildRefId()

ILIAS\Container\StandardGUIRequest::getChildRefId ( )

Definition at line 90 of file class.StandardGUIRequest.php.

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

References ILIAS\Repository\int().

+ Here is the call graph for this function:

◆ getCloneSource()

ILIAS\Container\StandardGUIRequest::getCloneSource ( )

Definition at line 80 of file class.StandardGUIRequest.php.

80 : int
81 {
82 return $this->int("clone_source");
83 }

References ILIAS\Repository\int().

+ Here is the call graph for this function:

◆ getCmdClass()

ILIAS\Container\StandardGUIRequest::getCmdClass ( )

Definition at line 182 of file class.StandardGUIRequest.php.

182 : string
183 {
184 return $this->str("cmdClass");
185 }

References ILIAS\Repository\str().

+ Here is the call graph for this function:

◆ getCmdRefId()

ILIAS\Container\StandardGUIRequest::getCmdRefId ( )

Definition at line 85 of file class.StandardGUIRequest.php.

85 : int
86 {
87 return $this->int("cmdrefid");
88 }

References ILIAS\Repository\int().

+ Here is the call graph for this function:

◆ getCopyOptions()

ILIAS\Container\StandardGUIRequest::getCopyOptions ( )

Definition at line 145 of file class.StandardGUIRequest.php.

145 : array
146 {
147 return $this->arrayArray("cp_options");
148 }

References ILIAS\Repository\arrayArray().

+ Here is the call graph for this function:

◆ getExpand()

ILIAS\Container\StandardGUIRequest::getExpand ( )

Definition at line 100 of file class.StandardGUIRequest.php.

100 : int
101 {
102 return $this->int("expand");
103 }

References ILIAS\Repository\int().

+ Here is the call graph for this function:

◆ getItemRefId()

ILIAS\Container\StandardGUIRequest::getItemRefId ( )

Definition at line 44 of file class.StandardGUIRequest.php.

44 : int
45 {
46 return $this->int("item_ref_id");
47 }

References ILIAS\Repository\int().

+ Here is the call graph for this function:

◆ getNewType()

ILIAS\Container\StandardGUIRequest::getNewType ( )

Definition at line 54 of file class.StandardGUIRequest.php.

54 : string
55 {
56 return $this->str("new_type");
57 }

References ILIAS\Repository\str().

+ Here is the call graph for this function:

◆ getNextSession()

ILIAS\Container\StandardGUIRequest::getNextSession ( )

Definition at line 123 of file class.StandardGUIRequest.php.

123 : ?int
124 {
125 if ($this->http->wrapper()->query()->has('crs_next_sess')) {
126 return $this->int("crs_next_sess");
127 }
128 return null;
129 }
ILIAS\FileDelivery\http
static http()
Fetches the global http state from ILIAS.
Definition: HttpServiceAware.php:55

References ILIAS\FileDelivery\http(), and ILIAS\Repository\int().

+ Here is the call graph for this function:

◆ getNodes()

ILIAS\Container\StandardGUIRequest::getNodes ( )
Returns
int[]

Definition at line 137 of file class.StandardGUIRequest.php.

137 : array
138 {
139 if ($this->int("node") > 0) {
140 return [$this->int("node")];
141 }
142 return $this->intArray("nodes");
143 }

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

+ Here is the call graph for this function:

◆ getObjectiveId()

ILIAS\Container\StandardGUIRequest::getObjectiveId ( )

Definition at line 131 of file class.StandardGUIRequest.php.

131 : int
132 {
133 return $this->int("oobj");
134 }

References ILIAS\Repository\int().

+ Here is the call graph for this function:

◆ getParentRefId()

ILIAS\Container\StandardGUIRequest::getParentRefId ( )

Definition at line 95 of file class.StandardGUIRequest.php.

95 : int
96 {
97 return $this->int("parent_ref_id");
98 }

References ILIAS\Repository\int().

+ Here is the call graph for this function:

◆ getPositions()

ILIAS\Container\StandardGUIRequest::getPositions ( )

Definition at line 150 of file class.StandardGUIRequest.php.

150 : array
151 {
152 // note: the position parameter is currently
153 // quite unstructured typewise, array of array|string
154 $body = $this->http->request()->getParsedBody();
155 return $body["position"] ?? [];
156 //return $this->arrayArray("position");
157 }

References ILIAS\FileDelivery\http().

+ Here is the call graph for this function:

◆ getPreviousSession()

ILIAS\Container\StandardGUIRequest::getPreviousSession ( )

Definition at line 115 of file class.StandardGUIRequest.php.

115 : ?int
116 {
117 if ($this->http->wrapper()->query()->has('crs_prev_sess')) {
118 return $this->int("crs_prev_sess");
119 }
120 return null;
121 }

References ILIAS\FileDelivery\http(), and ILIAS\Repository\int().

+ Here is the call graph for this function:

◆ getRedirectSource()

ILIAS\Container\StandardGUIRequest::getRedirectSource ( )

Definition at line 49 of file class.StandardGUIRequest.php.

49 : string
50 {
51 return $this->str("redirectSource");
52 }

References ILIAS\Repository\str().

+ Here is the call graph for this function:

◆ getRefId()

ILIAS\Container\StandardGUIRequest::getRefId ( )

Definition at line 39 of file class.StandardGUIRequest.php.

39 : int
40 {
41 return $this->int("ref_id");
42 }

References ILIAS\Repository\int().

+ Here is the call graph for this function:

◆ getSelectedIds()

ILIAS\Container\StandardGUIRequest::getSelectedIds ( )
Returns
int []

Definition at line 70 of file class.StandardGUIRequest.php.

70 : array
71 {
72 if ($this->int("item_ref_id") > 0) {
73 $ids = [$this->int("item_ref_id")];
74 } else {
75 $ids = $this->intArray("id");
76 }
77 return $ids;
78 }

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

+ Here is the call graph for this function:

◆ getStartObjIds()

ILIAS\Container\StandardGUIRequest::getStartObjIds ( )
Returns
int[]

Definition at line 177 of file class.StandardGUIRequest.php.

177 : array
178 {
179 return $this->intArray("starter");
180 }

References ILIAS\Repository\intArray().

+ Here is the call graph for this function:

◆ getTrashIds()

ILIAS\Container\StandardGUIRequest::getTrashIds ( )
Returns
int[]

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

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

References ILIAS\Repository\intArray().

+ Here is the call graph for this function:

◆ getType()

ILIAS\Container\StandardGUIRequest::getType ( )

Definition at line 59 of file class.StandardGUIRequest.php.

59 : string
60 {
61 return $this->str("type");
62 }

References ILIAS\Repository\str().

+ Here is the call graph for this function:

Field Documentation

◆ BaseGUIRequest

trait ILIAS\Repository::BaseGUIRequest

Base 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 33 of file trait.BaseGUIRequest.php.

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