Skip to content

Commit 262d490

Browse files
meet-alekseymeet-aleksey
committed
Fixes and improvements.
1 parent 628e8bc commit 262d490

File tree

8 files changed

+81
-33
lines changed

8 files changed

+81
-33
lines changed

‎src/Controller.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ class Controller {
2828
*
2929
* @return void
3030
*/
31-
protected function setViewData($key, $value) {
31+
protected function setData($key, $value) {
3232
$this->viewData[$key] = $value;
3333
}
3434

@@ -39,7 +39,7 @@ protected function setViewData($key, $value) {
3939
*
4040
* @return mixed
4141
*/
42-
protected function getViewData($key) {
42+
protected function getData($key) {
4343
return $this->viewData[$key];
4444
}
4545

‎src/HttpRequestBase.php

Lines changed: 24 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -203,55 +203,65 @@ public function documentRoot() {
203203
* Returns server variables.
204204
*
205205
* @param string|null $key The key to get. Default: null - all variables.
206+
* @param string|null $default The default value if the key is not null, and the value with the specified key was not found. The default value is null.
207+
* @param bool $nullIfEmpty Check the value with the empty() function. If empty() returns true, the function returns $default.
206208
*
207209
* @return array|string
208210
*/
209-
public function server($key = null) {
210-
return InternalHelper::getSingleKeyOrAll($this->serverVariables, $key);
211+
public function server($key = null, $default = null, $nullIfEmpty = false) {
212+
return InternalHelper::getSingleKeyOrAll($this->serverVariables, $key, $default, $nullIfEmpty);
211213
}
212214

213215
/**
214216
* Returns cookies.
215217
*
216218
* @param string|null $key The cookie name to get. Default: null - all cookies.
219+
* @param string|null $default The default value if the key is not null, and the value with the specified key was not found. The default value is null.
220+
* @param bool $nullIfEmpty Check the value with the empty() function. If empty() returns true, the function returns $default.
217221
*
218222
* @return array|string
219223
*/
220-
public function cookies($key = null) {
221-
return InternalHelper::getSingleKeyOrAll($this->cookies, $key);
224+
public function cookies($key = null, $default = null, $nullIfEmpty = false) {
225+
return InternalHelper::getSingleKeyOrAll($this->cookies, $key, $default, $nullIfEmpty);
222226
}
223227

224228
/**
225229
* Returns GET data.
226230
*
227231
* @param string|null $key The key to get. Default: null - all keys.
232+
* @param string|null $default The default value if the key is not null, and the value with the specified key was not found. The default value is null.
233+
* @param bool $nullIfEmpty Check the value with the empty() function. If empty() returns true, the function returns $default.
228234
*
229235
* @return array|mixed
230236
*/
231-
public function get($key = null) {
232-
return InternalHelper::getSingleKeyOrAll($this->get, $key);
237+
public function get($key = null, $default = null, $nullIfEmpty = false) {
238+
return InternalHelper::getSingleKeyOrAll($this->get, $key, $default, $nullIfEmpty);
233239
}
234240

235241
/**
236242
* Returns POST data.
237243
*
238244
* @param string|null $key The key to get. Default: null - all keys.
245+
* @param string|null $default The default value if the key is not null, and the value with the specified key was not found. The default value is null.
246+
* @param bool $nullIfEmpty Check the value with the empty() function. If empty() returns true, the function returns $default.
239247
*
240248
* @return array|mixed
241249
*/
242-
public function post($key = null) {
243-
return InternalHelper::getSingleKeyOrAll($this->post, $key);
250+
public function post($key = null, $default = null, $nullIfEmpty = false) {
251+
return InternalHelper::getSingleKeyOrAll($this->post, $key, $default, $nullIfEmpty);
244252
}
245253

246254
/**
247255
* Returns posted files.
248256
*
249257
* @param string|null $key The key to get. Default: null - all keys.
258+
* @param string|null $default The default value if the key is not null, and the value with the specified key was not found. The default value is null.
259+
* @param bool $nullIfEmpty Check the value with the empty() function. If empty() returns true, the function returns $default.
250260
*
251261
* @return array|mixed
252262
*/
253-
public function files($key = null) {
254-
return InternalHelper::getSingleKeyOrAll($this->files, $key);
263+
public function files($key = null, $default = null, $nullIfEmpty = false) {
264+
return InternalHelper::getSingleKeyOrAll($this->files, $key, $default, $nullIfEmpty);
255265
}
256266

257267
/**
@@ -351,10 +361,12 @@ public function contentType() {
351361
* Returns HTTP headers of the request.
352362
*
353363
* @param string|null $key The key to get. Default: null - all keys.
364+
* @param string|null $default The default value if the key is not null, and the value with the specified key was not found. The default value is null.
365+
* @param bool $nullIfEmpty Check the value with the empty() function. If empty() returns true, the function returns $default.
354366
*
355367
* @return array|string
356368
*/
357-
public function headers($key = null) {
369+
public function headers($key = null, $default = null, $nullIfEmpty = false) {
358370
if ($this->headers === null) {
359371
$result = array();
360372

@@ -370,7 +382,7 @@ public function headers($key = null) {
370382
$this->headers = $result;
371383
}
372384

373-
return InternalHelper::getSingleKeyOrAll($this->headers, $key);
385+
return InternalHelper::getSingleKeyOrAll($this->headers, $key, $default, $nullIfEmpty);
374386
}
375387

376388
}

‎src/InternalHelper.php

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -347,12 +347,19 @@ public static function arrayToObject($array, &$object = null, $type = null) {
347347
*
348348
* @param array $array The array to work.
349349
* @param string|null $key The key to get, or null to get the $array.
350+
* @param string|null $default The default value if the key is not null, and the value with the specified key was not found. The default value is null.
351+
* @param bool $nullIfEmpty Check the value with the empty() function. If empty() returns true, the function returns $default.
350352
*
351353
* @return array|mixed|null
352354
*/
353-
public static function getSingleKeyOrAll($array, $key) {
355+
public static function getSingleKeyOrAll($array, $key, $default = null, $nullIfEmpty = false) {
354356
if ($key !== null) {
355-
return (isset($array[$key])) ? $array[$key] : null;
357+
if ($nullIfEmpty === true) {
358+
return (isset($array[$key])) && !empty($array[$key]) ? $array[$key] : $default;
359+
}
360+
else {
361+
return (isset($array[$key])) ? $array[$key] : $default;
362+
}
356363
}
357364
else {
358365
return $array;

‎src/ValidateAntiForgeryToken.php

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ final class ValidateAntiForgeryToken {
2727
*
2828
* @return void
2929
*/
30-
public static function disable($actionName) {
30+
public static function disable($actionName = null) {
3131
self::set($actionName, false);
3232
}
3333

@@ -38,7 +38,7 @@ public static function disable($actionName) {
3838
*
3939
* @return void
4040
*/
41-
public static function enable($actionName) {
41+
public static function enable($actionName = null) {
4242
self::set($actionName, true);
4343
}
4444

@@ -50,7 +50,9 @@ public static function enable($actionName) {
5050
*
5151
* @return void
5252
*/
53-
public static function set($actionName, $enable) {
53+
public static function set($actionName = null, $enable) {
54+
$actionName = ($actionName === null ? '.' : $actionName);
55+
5456
if ($actionName != '.' && !self::$actionContext->actionNameEquals($actionName)) {
5557
return;
5658
}

‎src/View.php

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,33 @@ public static function getHttpContext() {
3131
return self::$viewContext->getHttpContext();
3232
}
3333

34+
/**
35+
* Gets route of the current request.
36+
*
37+
* @return Route
38+
*/
39+
public static function getRoute() {
40+
return self::$viewContext->getHttpContext()->getRoute();
41+
}
42+
43+
/**
44+
* Gets the HttpRequestBase object for the current request.
45+
*
46+
* @return HttpRequestBase
47+
*/
48+
public static function getRequest() {
49+
return self::$viewContext->getHttpContext()->getRequest();
50+
}
51+
52+
/**
53+
* Gets the HttpResponseBase object for the current request.
54+
*
55+
* @return HttpResponseBase
56+
*/
57+
public static function getResponse() {
58+
return self::$viewContext->getHttpContext()->getResponse();
59+
}
60+
3461
/**
3562
* Sets layout.
3663
*

‎tests/AppBuilderTest.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -169,8 +169,8 @@ public function testMakeView() {
169169
echo ' - OK' . chr(10);
170170
}
171171

172-
public function testSetGetViewData() {
173-
$httpContext = HttpContext::get('/home/setGetViewData')->useDefaultRoute();
172+
public function testSetGetData() {
173+
$httpContext = HttpContext::get('/home/setGetData')->useDefaultRoute();
174174

175175
echo chr(10);
176176
echo 'Request: ' . $httpContext->getRequest()->rawUrl();
@@ -219,12 +219,12 @@ public function testDifferentWaysViewData() {
219219
);
220220

221221
$this->assertContains(
222-
'Hello setViewData!',
222+
'Hello setData!',
223223
$result
224224
);
225225

226226
$this->assertContains(
227-
'Replaced setViewData2!',
227+
'Replaced setData2!',
228228
$result
229229
);
230230

‎tests/mvc/controllers/AccountController.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ public function login($model) {
3131
$modelState = $this->getModelState();
3232

3333
if ($modelState->isValid()) {
34-
$this->setViewData('success', true);
34+
$this->setData('success', true);
3535
return $this->view();
3636
}
3737
}

‎tests/mvc/controllers/HomeController.php

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -49,18 +49,18 @@ public function specifiedView() {
4949
return $this->view('hello', 'Test message passed to the view file "hello.php" from the action method "specifiedView".', '_lite');
5050
}
5151

52-
public function setGetViewData() {
53-
$this->setViewData('key', 'value');
54-
$this->setViewData('message', 'Hello world!');
55-
$this->setViewData('option', true);
56-
$this->setViewData('int', 123);
52+
public function setGetData() {
53+
$this->setData('key', 'value');
54+
$this->setData('message', 'Hello world!');
55+
$this->setData('option', true);
56+
$this->setData('int', 123);
5757

5858
return $this->view('index');
5959
}
6060

6161
public function differentWaysViewData() {
62-
$this->setViewData('setViewData', 'Hello setViewData!');
63-
$this->setViewData('setViewData2', 'Hello setViewData2!');
62+
$this->setData('setData', 'Hello setData!');
63+
$this->setData('setData2', 'Hello setData2!');
6464

6565
$view = new ViewResult();
6666

@@ -69,10 +69,10 @@ public function differentWaysViewData() {
6969

7070
$view->viewData['viewData'] = 'Hello viewData!';
7171
$view->viewData['viewData2'] = 'Hello viewData2!';
72-
$view->viewData['setViewData2'] = 'Replaced setViewData2!';
72+
$view->viewData['setData2'] = 'Replaced setData2!';
7373

7474
// TODO: one common collection of data is needed
75-
$this->setViewData('viewData2', 'This change will be ignored');
75+
$this->setData('viewData2', 'This change will be ignored');
7676

7777
return $view;
7878
}

0 commit comments

Comments
 (0)