Skip to content

Commit e7bce5f

Browse files
authored
Merge pull request #9523 from warcooft/missing-type-return
refactor: fix `missingType.return` errors
2 parents e4ff053 + f57b12a commit e7bce5f

File tree

5 files changed

+72
-164
lines changed

5 files changed

+72
-164
lines changed

Diff for: system/Session/Session.php

+39-2
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,8 @@ public function start()
233233
$this->setSaveHandler();
234234

235235
// Sanitize the cookie, because apparently PHP doesn't do that for userspace handlers
236-
if (isset($_COOKIE[$this->config->cookieName])
236+
if (
237+
isset($_COOKIE[$this->config->cookieName])
237238
&& (! is_string($_COOKIE[$this->config->cookieName]) || preg_match('#\A' . $this->sidRegexp . '\z#', $_COOKIE[$this->config->cookieName]) !== 1)
238239
) {
239240
unset($_COOKIE[$this->config->cookieName]);
@@ -267,6 +268,8 @@ public function start()
267268
* Destroys the current session.
268269
*
269270
* @deprecated Use destroy() instead.
271+
*
272+
* @return void
270273
*/
271274
public function stop()
272275
{
@@ -277,6 +280,8 @@ public function stop()
277280
* Configuration.
278281
*
279282
* Handle input binds and configuration defaults.
283+
*
284+
* @return void
280285
*/
281286
protected function configure()
282287
{
@@ -318,6 +323,8 @@ protected function configure()
318323
*
319324
* To make life easier, we force the PHP defaults. Because PHP9 forces them.
320325
* See https://wiki.php.net/rfc/deprecations_php_8_4#sessionsid_length_and_sessionsid_bits_per_character
326+
*
327+
* @return void
321328
*/
322329
protected function configureSidLength()
323330
{
@@ -342,6 +349,8 @@ protected function configureSidLength()
342349
*
343350
* Clears old "flash" data, marks the new one for deletion and handles
344351
* "temp" data deletion.
352+
*
353+
* @return void
345354
*/
346355
protected function initVars()
347356
{
@@ -370,6 +379,8 @@ protected function initVars()
370379
* Regenerates the session ID.
371380
*
372381
* @param bool $destroy Should old session data be destroyed?
382+
*
383+
* @return void
373384
*/
374385
public function regenerate(bool $destroy = false)
375386
{
@@ -401,6 +412,8 @@ private function removeOldSessionCookie(): void
401412

402413
/**
403414
* Destroys the current session.
415+
*
416+
* @return void
404417
*/
405418
public function destroy()
406419
{
@@ -436,6 +449,8 @@ public function close()
436449
*
437450
* @param array|string $data Property name or associative array of properties
438451
* @param array|bool|float|int|object|string|null $value Property value if single key provided
452+
*
453+
* @return void
439454
*/
440455
public function set($data, $value = null)
441456
{
@@ -510,6 +525,8 @@ public function has(string $key): bool
510525
*
511526
* @param string $key Identifier of the session property we are interested in.
512527
* @param array $data value to be pushed to existing session key.
528+
*
529+
* @return void
513530
*/
514531
public function push(string $key, array $data)
515532
{
@@ -526,6 +543,8 @@ public function push(string $key, array $data)
526543
* of a specific session property to remove.
527544
*
528545
* @param array|string $key Identifier of the session property or properties to remove.
546+
*
547+
* @return void
529548
*/
530549
public function remove($key)
531550
{
@@ -598,6 +617,8 @@ public function __isset(string $key): bool
598617
*
599618
* @param array|string $data Property identifier or associative array of properties
600619
* @param array|bool|float|int|object|string|null $value Property value if $data is a scalar
620+
*
621+
* @return void
601622
*/
602623
public function setFlashdata($data, $value = null)
603624
{
@@ -638,6 +659,8 @@ public function getFlashdata(?string $key = null)
638659
* Keeps a single piece of flash data alive for one more request.
639660
*
640661
* @param array|string $key Property identifier or array of them
662+
*
663+
* @return void
641664
*/
642665
public function keepFlashdata($key)
643666
{
@@ -680,6 +703,8 @@ public function markAsFlashdata($key): bool
680703
* Unmark data in the session as flashdata.
681704
*
682705
* @param array|string $key Property identifier or array of them
706+
*
707+
* @return void
683708
*/
684709
public function unmarkFlashdata($key)
685710
{
@@ -731,6 +756,8 @@ public function getFlashKeys(): array
731756
* @param array|string $data Session data key or associative array of items
732757
* @param array|bool|float|int|object|string|null $value Value to store
733758
* @param int $ttl Time-to-live in seconds
759+
*
760+
* @return void
734761
*/
735762
public function setTempdata($data, $value = null, int $ttl = 300)
736763
{
@@ -750,7 +777,7 @@ public function getTempdata(?string $key = null)
750777
{
751778
if (isset($key)) {
752779
return (isset($_SESSION['__ci_vars'], $_SESSION['__ci_vars'][$key], $_SESSION[$key])
753-
&& is_int($_SESSION['__ci_vars'][$key])) ? $_SESSION[$key] : null;
780+
&& is_int($_SESSION['__ci_vars'][$key])) ? $_SESSION[$key] : null;
754781
}
755782

756783
$tempdata = [];
@@ -770,6 +797,8 @@ public function getTempdata(?string $key = null)
770797
* Removes a single piece of temporary data from the session.
771798
*
772799
* @param string $key Session data key
800+
*
801+
* @return void
773802
*/
774803
public function removeTempdata(string $key)
775804
{
@@ -830,6 +859,8 @@ public function markAsTempdata($key, int $ttl = 300): bool
830859
* lifespan and allowing it to live as long as the session does.
831860
*
832861
* @param array|string $key Property identifier or array of them
862+
*
863+
* @return void
833864
*/
834865
public function unmarkTempdata($key)
835866
{
@@ -875,6 +906,8 @@ public function getTempKeys(): array
875906
/**
876907
* Sets the driver as the session handler in PHP.
877908
* Extracted for easier testing.
909+
*
910+
* @return void
878911
*/
879912
protected function setSaveHandler()
880913
{
@@ -884,6 +917,8 @@ protected function setSaveHandler()
884917
/**
885918
* Starts the session.
886919
* Extracted for testing reasons.
920+
*
921+
* @return void
887922
*/
888923
protected function startSession()
889924
{
@@ -900,6 +935,8 @@ protected function startSession()
900935
* Takes care of setting the cookie on the client side.
901936
*
902937
* @codeCoverageIgnore
938+
*
939+
* @return void
903940
*/
904941
protected function setCookie()
905942
{

Diff for: system/Session/SessionInterface.php

+20
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,15 @@ interface SessionInterface
2222
* Regenerates the session ID.
2323
*
2424
* @param bool $destroy Should old session data be destroyed?
25+
*
26+
* @return void
2527
*/
2628
public function regenerate(bool $destroy = false);
2729

2830
/**
2931
* Destroys the current session.
32+
*
33+
* @return void
3034
*/
3135
public function destroy();
3236

@@ -41,6 +45,8 @@ public function destroy();
4145
*
4246
* @param array|string $data Property name or associative array of properties
4347
* @param array|bool|float|int|object|string|null $value Property value if single key provided
48+
*
49+
* @return void
4450
*/
4551
public function set($data, $value = null);
4652

@@ -74,6 +80,8 @@ public function has(string $key): bool;
7480
* of a specific session property to remove.
7581
*
7682
* @param array|string $key Identifier of the session property or properties to remove.
83+
*
84+
* @return void
7785
*/
7886
public function remove($key);
7987

@@ -88,6 +96,8 @@ public function remove($key);
8896
*
8997
* @param array|string $data Property identifier or associative array of properties
9098
* @param array|string $value Property value if $data is a scalar
99+
*
100+
* @return void
91101
*/
92102
public function setFlashdata($data, $value = null);
93103

@@ -107,6 +117,8 @@ public function getFlashdata(?string $key = null);
107117
* Keeps a single piece of flash data alive for one more request.
108118
*
109119
* @param array|string $key Property identifier or array of them
120+
*
121+
* @return void
110122
*/
111123
public function keepFlashdata($key);
112124

@@ -123,6 +135,8 @@ public function markAsFlashdata($key);
123135
* Unmark data in the session as flashdata.
124136
*
125137
* @param array|string $key Property identifier or array of them
138+
*
139+
* @return void
126140
*/
127141
public function unmarkFlashdata($key);
128142

@@ -140,6 +154,8 @@ public function getFlashKeys(): array;
140154
* @param array|string $data Session data key or associative array of items
141155
* @param array|bool|float|int|object|string|null $value Value to store
142156
* @param int $ttl Time-to-live in seconds
157+
*
158+
* @return void
143159
*/
144160
public function setTempdata($data, $value = null, int $ttl = 300);
145161

@@ -157,6 +173,8 @@ public function getTempdata(?string $key = null);
157173
* Removes a single piece of temporary data from the session.
158174
*
159175
* @param string $key Session data key
176+
*
177+
* @return void
160178
*/
161179
public function removeTempdata(string $key);
162180

@@ -176,6 +194,8 @@ public function markAsTempdata($key, int $ttl = 300);
176194
* lifespan and allowing it to live as long as the session does.
177195
*
178196
* @param array|string $key Property identifier or array of them
197+
*
198+
* @return void
179199
*/
180200
public function unmarkTempdata($key);
181201

Diff for: system/Test/Mock/MockSession.php

+11
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ class MockSession extends Session
3737
/**
3838
* Sets the driver as the session handler in PHP.
3939
* Extracted for easier testing.
40+
*
41+
* @return void
4042
*/
4143
protected function setSaveHandler()
4244
{
@@ -46,6 +48,8 @@ protected function setSaveHandler()
4648
/**
4749
* Starts the session.
4850
* Extracted for testing reasons.
51+
*
52+
* @return void
4953
*/
5054
protected function startSession()
5155
{
@@ -56,6 +60,8 @@ protected function startSession()
5660
/**
5761
* Takes care of setting the cookie on the client side.
5862
* Extracted for testing reasons.
63+
*
64+
* @return void
5965
*/
6066
protected function setCookie()
6167
{
@@ -65,6 +71,11 @@ protected function setCookie()
6571
$this->cookies[] = $this->cookie;
6672
}
6773

74+
/**
75+
* Regenerates the session ID.
76+
*
77+
* @return void
78+
*/
6879
public function regenerate(bool $destroy = false)
6980
{
7081
$this->didRegenerate = true;

Diff for: utils/phpstan-baseline/loader.neon

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# total 3573 errors
1+
# total 3541 errors
22
includes:
33
- argument.type.neon
44
- assign.propertyType.neon

0 commit comments

Comments
 (0)