feat: add SiteURIFactory by kenjis · Pull Request #7256 · codeigniter4/CodeIgniter4

kenjis · 2023-02-15T04:50:31Z

~~Needs #7252~~

Description
Supersedes #7239

Add SiteURIFactory to create the current URI object.

To create the current URI object before the Request object creation.
Also, to remove all URI adjustment processing currently performed in the constructor of the Request object.

This PR does not change any existing features yet. The next #7282 changes the behavior.

add SiteURIFactory::createFromGlobals()
add Superglobals

Checklist:

Securely signed commits
Component(s) with PHPDoc blocks, only if necessary or adds value
Unit testing, with >80% coverage
User guide updated
Conforms to style guide

MGatner · 2023-07-09T11:22:52Z

+ private function updateServer(string $key, string $value): void
+ {
+ $_SERVER[$key] = $value;
+ }
+
+ private function updateGetArray(array $array): void
+ {
+ $_GET = $array;
+ }


These make me pretty uneasy. What about an external service dependency that handles Globals, so it can be mocked or replaced? This behavior within a Factory is very counterintuitive.

What do you mean?
Adding another class that handles globals?
private$superglobals; privatefunctionupdateServer(string$key, string$value): void { $this->superglobals->setServer($key, $value); }

Yes, precisely. It could be adapted to anywhere else in the framework we touch globals.

Added class Superglobals.

kenjis · 2023-07-12T01:21:24Z

+
+ // Strip the SCRIPT_NAME path from the URI
+ if (
+ $path !== '' && isset($this->superglobals->server('SCRIPT_NAME')[0])


isset($this->superglobals->server('SCRIPT_NAME')[0])
What is this condition checked?
$_SERVER['SCRIPT_NAME'] is a string.
The condition comes from:
CodeIgniter4/system/HTTP/IncomingRequest.php
Lines 282 to 286 in 6cedbe9
// Strip the SCRIPT_NAME path from the URI
if (
$uri !== '' && isset($_SERVER['SCRIPT_NAME'][0])
&& pathinfo($_SERVER['SCRIPT_NAME'], PATHINFO_EXTENSION) === 'php'
) {
And it came from:
bcit-ci/CodeIgniter@ead327f7

Does that end up being translated as this, because of string array access?
$_SERVER['SCRIPT_NAME'] !== ''

Yes. I assume this is unintended but that's the equivalence.
https://3v4l.org/XC3NO
https://3v4l.org/hqebU

Refactored. fde3216

Because it might be false.

It is difficult to understand.

kenjis · 2023-02-15T04:50:31Z

~~Needs #7252~~

Description
Supersedes #7239

Add SiteURIFactory to create the current URI object.

To create the current URI object before the Request object creation.
Also, to remove all URI adjustment processing currently performed in the constructor of the Request object.

This PR does not change any existing features yet. The next #7282 changes the behavior.

add SiteURIFactory::createFromGlobals()
add Superglobals

Checklist:

Securely signed commits
Component(s) with PHPDoc blocks, only if necessary or adds value
Unit testing, with >80% coverage
User guide updated
Conforms to style guide

MGatner · 2023-07-09T11:22:52Z

+ private function updateServer(string $key, string $value): void
+ {
+ $_SERVER[$key] = $value;
+ }
+
+ private function updateGetArray(array $array): void
+ {
+ $_GET = $array;
+ }


These make me pretty uneasy. What about an external service dependency that handles Globals, so it can be mocked or replaced? This behavior within a Factory is very counterintuitive.

What do you mean?
Adding another class that handles globals?
private$superglobals; privatefunctionupdateServer(string$key, string$value): void { $this->superglobals->setServer($key, $value); }

Yes, precisely. It could be adapted to anywhere else in the framework we touch globals.

Added class Superglobals.

kenjis · 2023-07-12T01:21:24Z

+
+ // Strip the SCRIPT_NAME path from the URI
+ if (
+ $path !== '' && isset($this->superglobals->server('SCRIPT_NAME')[0])


isset($this->superglobals->server('SCRIPT_NAME')[0])
What is this condition checked?
$_SERVER['SCRIPT_NAME'] is a string.
The condition comes from:
CodeIgniter4/system/HTTP/IncomingRequest.php
Lines 282 to 286 in 6cedbe9
// Strip the SCRIPT_NAME path from the URI
if (
$uri !== '' && isset($_SERVER['SCRIPT_NAME'][0])
&& pathinfo($_SERVER['SCRIPT_NAME'], PATHINFO_EXTENSION) === 'php'
) {
And it came from:
bcit-ci/CodeIgniter@ead327f7

Does that end up being translated as this, because of string array access?
$_SERVER['SCRIPT_NAME'] !== ''

Yes. I assume this is unintended but that's the equivalence.
https://3v4l.org/XC3NO
https://3v4l.org/hqebU

Refactored. fde3216

Because it might be false.

It is difficult to understand.

kenjis · 2023-02-15T04:50:31Z

~~Needs #7252~~

Description
Supersedes #7239

Add SiteURIFactory to create the current URI object.

To create the current URI object before the Request object creation.
Also, to remove all URI adjustment processing currently performed in the constructor of the Request object.

This PR does not change any existing features yet. The next #7282 changes the behavior.

add SiteURIFactory::createFromGlobals()
add Superglobals

Checklist:

Securely signed commits
Component(s) with PHPDoc blocks, only if necessary or adds value
Unit testing, with >80% coverage
User guide updated
Conforms to style guide

MGatner · 2023-07-09T11:22:52Z

+ private function updateServer(string $key, string $value): void
+ {
+ $_SERVER[$key] = $value;
+ }
+
+ private function updateGetArray(array $array): void
+ {
+ $_GET = $array;
+ }


These make me pretty uneasy. What about an external service dependency that handles Globals, so it can be mocked or replaced? This behavior within a Factory is very counterintuitive.

What do you mean?
Adding another class that handles globals?
private$superglobals; privatefunctionupdateServer(string$key, string$value): void { $this->superglobals->setServer($key, $value); }

Yes, precisely. It could be adapted to anywhere else in the framework we touch globals.

Added class Superglobals.

kenjis · 2023-07-12T01:21:24Z

+
+ // Strip the SCRIPT_NAME path from the URI
+ if (
+ $path !== '' && isset($this->superglobals->server('SCRIPT_NAME')[0])


isset($this->superglobals->server('SCRIPT_NAME')[0])
What is this condition checked?
$_SERVER['SCRIPT_NAME'] is a string.
The condition comes from:
CodeIgniter4/system/HTTP/IncomingRequest.php
Lines 282 to 286 in 6cedbe9
// Strip the SCRIPT_NAME path from the URI
if (
$uri !== '' && isset($_SERVER['SCRIPT_NAME'][0])
&& pathinfo($_SERVER['SCRIPT_NAME'], PATHINFO_EXTENSION) === 'php'
) {
And it came from:
bcit-ci/CodeIgniter@ead327f7

Does that end up being translated as this, because of string array access?
$_SERVER['SCRIPT_NAME'] !== ''

Yes. I assume this is unintended but that's the equivalence.
https://3v4l.org/XC3NO
https://3v4l.org/hqebU

Refactored. fde3216

Because it might be false.

It is difficult to understand.

kenjis · 2023-02-15T04:50:31Z

~~Needs #7252~~

Description
Supersedes #7239

Add SiteURIFactory to create the current URI object.

To create the current URI object before the Request object creation.
Also, to remove all URI adjustment processing currently performed in the constructor of the Request object.

This PR does not change any existing features yet. The next #7282 changes the behavior.

add SiteURIFactory::createFromGlobals()
add Superglobals

Checklist:

Securely signed commits
Component(s) with PHPDoc blocks, only if necessary or adds value
Unit testing, with >80% coverage
User guide updated
Conforms to style guide

MGatner · 2023-07-09T11:22:52Z

+ private function updateServer(string $key, string $value): void
+ {
+ $_SERVER[$key] = $value;
+ }
+
+ private function updateGetArray(array $array): void
+ {
+ $_GET = $array;
+ }


These make me pretty uneasy. What about an external service dependency that handles Globals, so it can be mocked or replaced? This behavior within a Factory is very counterintuitive.

What do you mean?
Adding another class that handles globals?
private$superglobals; privatefunctionupdateServer(string$key, string$value): void { $this->superglobals->setServer($key, $value); }

Yes, precisely. It could be adapted to anywhere else in the framework we touch globals.

Added class Superglobals.

kenjis · 2023-07-12T01:21:24Z

+
+ // Strip the SCRIPT_NAME path from the URI
+ if (
+ $path !== '' && isset($this->superglobals->server('SCRIPT_NAME')[0])


isset($this->superglobals->server('SCRIPT_NAME')[0])
What is this condition checked?
$_SERVER['SCRIPT_NAME'] is a string.
The condition comes from:
CodeIgniter4/system/HTTP/IncomingRequest.php
Lines 282 to 286 in 6cedbe9
// Strip the SCRIPT_NAME path from the URI
if (
$uri !== '' && isset($_SERVER['SCRIPT_NAME'][0])
&& pathinfo($_SERVER['SCRIPT_NAME'], PATHINFO_EXTENSION) === 'php'
) {
And it came from:
bcit-ci/CodeIgniter@ead327f7

Does that end up being translated as this, because of string array access?
$_SERVER['SCRIPT_NAME'] !== ''

Yes. I assume this is unintended but that's the equivalence.
https://3v4l.org/XC3NO
https://3v4l.org/hqebU

Refactored. fde3216

Because it might be false.

It is difficult to understand.

kenjis · 2023-02-15T04:50:31Z

~~Needs #7252~~

Description
Supersedes #7239

Add SiteURIFactory to create the current URI object.

To create the current URI object before the Request object creation.
Also, to remove all URI adjustment processing currently performed in the constructor of the Request object.

This PR does not change any existing features yet. The next #7282 changes the behavior.

add SiteURIFactory::createFromGlobals()
add Superglobals

Checklist:

Securely signed commits
Component(s) with PHPDoc blocks, only if necessary or adds value
Unit testing, with >80% coverage
User guide updated
Conforms to style guide

MGatner · 2023-07-09T11:22:52Z

+ private function updateServer(string $key, string $value): void
+ {
+ $_SERVER[$key] = $value;
+ }
+
+ private function updateGetArray(array $array): void
+ {
+ $_GET = $array;
+ }


These make me pretty uneasy. What about an external service dependency that handles Globals, so it can be mocked or replaced? This behavior within a Factory is very counterintuitive.

What do you mean?
Adding another class that handles globals?
private$superglobals; privatefunctionupdateServer(string$key, string$value): void { $this->superglobals->setServer($key, $value); }

Yes, precisely. It could be adapted to anywhere else in the framework we touch globals.

Added class Superglobals.

kenjis · 2023-07-12T01:21:24Z

+
+ // Strip the SCRIPT_NAME path from the URI
+ if (
+ $path !== '' && isset($this->superglobals->server('SCRIPT_NAME')[0])


isset($this->superglobals->server('SCRIPT_NAME')[0])
What is this condition checked?
$_SERVER['SCRIPT_NAME'] is a string.
The condition comes from:
CodeIgniter4/system/HTTP/IncomingRequest.php
Lines 282 to 286 in 6cedbe9
// Strip the SCRIPT_NAME path from the URI
if (
$uri !== '' && isset($_SERVER['SCRIPT_NAME'][0])
&& pathinfo($_SERVER['SCRIPT_NAME'], PATHINFO_EXTENSION) === 'php'
) {
And it came from:
bcit-ci/CodeIgniter@ead327f7

Does that end up being translated as this, because of string array access?
$_SERVER['SCRIPT_NAME'] !== ''

Yes. I assume this is unintended but that's the equivalence.
https://3v4l.org/XC3NO
https://3v4l.org/hqebU

Refactored. fde3216

Because it might be false.

It is difficult to understand.

kenjis · 2023-02-15T04:50:31Z

~~Needs #7252~~

Description
Supersedes #7239

Add SiteURIFactory to create the current URI object.

To create the current URI object before the Request object creation.
Also, to remove all URI adjustment processing currently performed in the constructor of the Request object.

This PR does not change any existing features yet. The next #7282 changes the behavior.

add SiteURIFactory::createFromGlobals()
add Superglobals

Checklist:

Securely signed commits
Component(s) with PHPDoc blocks, only if necessary or adds value
Unit testing, with >80% coverage
User guide updated
Conforms to style guide

MGatner · 2023-07-09T11:22:52Z

+ private function updateServer(string $key, string $value): void
+ {
+ $_SERVER[$key] = $value;
+ }
+
+ private function updateGetArray(array $array): void
+ {
+ $_GET = $array;
+ }


These make me pretty uneasy. What about an external service dependency that handles Globals, so it can be mocked or replaced? This behavior within a Factory is very counterintuitive.

What do you mean?
Adding another class that handles globals?
private$superglobals; privatefunctionupdateServer(string$key, string$value): void { $this->superglobals->setServer($key, $value); }

Yes, precisely. It could be adapted to anywhere else in the framework we touch globals.

Added class Superglobals.

kenjis · 2023-07-12T01:21:24Z

+
+ // Strip the SCRIPT_NAME path from the URI
+ if (
+ $path !== '' && isset($this->superglobals->server('SCRIPT_NAME')[0])


isset($this->superglobals->server('SCRIPT_NAME')[0])
What is this condition checked?
$_SERVER['SCRIPT_NAME'] is a string.
The condition comes from:
CodeIgniter4/system/HTTP/IncomingRequest.php
Lines 282 to 286 in 6cedbe9
// Strip the SCRIPT_NAME path from the URI
if (
$uri !== '' && isset($_SERVER['SCRIPT_NAME'][0])
&& pathinfo($_SERVER['SCRIPT_NAME'], PATHINFO_EXTENSION) === 'php'
) {
And it came from:
bcit-ci/CodeIgniter@ead327f7

Does that end up being translated as this, because of string array access?
$_SERVER['SCRIPT_NAME'] !== ''

Yes. I assume this is unintended but that's the equivalence.
https://3v4l.org/XC3NO
https://3v4l.org/hqebU

Refactored. fde3216

Because it might be false.

It is difficult to understand.

kenjis · 2023-02-15T04:50:31Z

~~Needs #7252~~

Description
Supersedes #7239

Add SiteURIFactory to create the current URI object.

To create the current URI object before the Request object creation.
Also, to remove all URI adjustment processing currently performed in the constructor of the Request object.

This PR does not change any existing features yet. The next #7282 changes the behavior.

add SiteURIFactory::createFromGlobals()
add Superglobals

Checklist:

Securely signed commits
Component(s) with PHPDoc blocks, only if necessary or adds value
Unit testing, with >80% coverage
User guide updated
Conforms to style guide

MGatner · 2023-07-09T11:22:52Z

+ private function updateServer(string $key, string $value): void
+ {
+ $_SERVER[$key] = $value;
+ }
+
+ private function updateGetArray(array $array): void
+ {
+ $_GET = $array;
+ }


These make me pretty uneasy. What about an external service dependency that handles Globals, so it can be mocked or replaced? This behavior within a Factory is very counterintuitive.

What do you mean?
Adding another class that handles globals?
private$superglobals; privatefunctionupdateServer(string$key, string$value): void { $this->superglobals->setServer($key, $value); }

Yes, precisely. It could be adapted to anywhere else in the framework we touch globals.

Added class Superglobals.

kenjis · 2023-07-12T01:21:24Z

+
+ // Strip the SCRIPT_NAME path from the URI
+ if (
+ $path !== '' && isset($this->superglobals->server('SCRIPT_NAME')[0])


isset($this->superglobals->server('SCRIPT_NAME')[0])
What is this condition checked?
$_SERVER['SCRIPT_NAME'] is a string.
The condition comes from:
CodeIgniter4/system/HTTP/IncomingRequest.php
Lines 282 to 286 in 6cedbe9
// Strip the SCRIPT_NAME path from the URI
if (
$uri !== '' && isset($_SERVER['SCRIPT_NAME'][0])
&& pathinfo($_SERVER['SCRIPT_NAME'], PATHINFO_EXTENSION) === 'php'
) {
And it came from:
bcit-ci/CodeIgniter@ead327f7

Does that end up being translated as this, because of string array access?
$_SERVER['SCRIPT_NAME'] !== ''

Yes. I assume this is unintended but that's the equivalence.
https://3v4l.org/XC3NO
https://3v4l.org/hqebU

Refactored. fde3216

Because it might be false.

It is difficult to understand.

kenjis · 2023-02-15T04:50:31Z

~~Needs #7252~~

Description
Supersedes #7239

Add SiteURIFactory to create the current URI object.

To create the current URI object before the Request object creation.
Also, to remove all URI adjustment processing currently performed in the constructor of the Request object.

This PR does not change any existing features yet. The next #7282 changes the behavior.

add SiteURIFactory::createFromGlobals()
add Superglobals

Checklist:

Securely signed commits
Component(s) with PHPDoc blocks, only if necessary or adds value
Unit testing, with >80% coverage
User guide updated
Conforms to style guide

MGatner · 2023-07-09T11:22:52Z

+ private function updateServer(string $key, string $value): void
+ {
+ $_SERVER[$key] = $value;
+ }
+
+ private function updateGetArray(array $array): void
+ {
+ $_GET = $array;
+ }


These make me pretty uneasy. What about an external service dependency that handles Globals, so it can be mocked or replaced? This behavior within a Factory is very counterintuitive.

What do you mean?
Adding another class that handles globals?
private$superglobals; privatefunctionupdateServer(string$key, string$value): void { $this->superglobals->setServer($key, $value); }

Yes, precisely. It could be adapted to anywhere else in the framework we touch globals.

Added class Superglobals.

kenjis · 2023-07-12T01:21:24Z

+
+ // Strip the SCRIPT_NAME path from the URI
+ if (
+ $path !== '' && isset($this->superglobals->server('SCRIPT_NAME')[0])


isset($this->superglobals->server('SCRIPT_NAME')[0])
What is this condition checked?
$_SERVER['SCRIPT_NAME'] is a string.
The condition comes from:
CodeIgniter4/system/HTTP/IncomingRequest.php
Lines 282 to 286 in 6cedbe9
// Strip the SCRIPT_NAME path from the URI
if (
$uri !== '' && isset($_SERVER['SCRIPT_NAME'][0])
&& pathinfo($_SERVER['SCRIPT_NAME'], PATHINFO_EXTENSION) === 'php'
) {
And it came from:
bcit-ci/CodeIgniter@ead327f7

Does that end up being translated as this, because of string array access?
$_SERVER['SCRIPT_NAME'] !== ''

Yes. I assume this is unintended but that's the equivalence.
https://3v4l.org/XC3NO
https://3v4l.org/hqebU

Refactored. fde3216

Because it might be false.

It is difficult to understand.

kenjis added enhancement PRs that improve existing functionalities 4.4 labels Feb 15, 2023

kenjis mentioned this pull request Feb 15, 2023
feat: add SiteURI class #7252
Merged
5 tasks

kenjis commented Feb 15, 2023
View reviewed changes

Comment threadsystem/HTTP/SiteURIFactory.php Outdated

kenjis force-pushed the feat-SiteURIFactory branch 2 times, most recently from 77d43a8 to e1d9a9cCompare February 17, 2023 01:21

kenjis marked this pull request as draft February 17, 2023 04:18

kenjis force-pushed the feat-SiteURIFactory branch 6 times, most recently from 157d9cb to d68e8acCompare February 20, 2023 07:48

kenjis mentioned this pull request Feb 20, 2023
rework: URI creation and URL helper #7282
Merged
5 tasks

kenjis force-pushed the feat-SiteURIFactory branch 7 times, most recently from b629857 to b5308b0Compare February 26, 2023 06:51

kenjis force-pushed the feat-SiteURIFactory branch from b5308b0 to 3079cd9Compare March 27, 2023 00:57

kenjis force-pushed the feat-SiteURIFactory branch from 3079cd9 to 63c2b31Compare June 8, 2023 02:15

kenjis force-pushed the feat-SiteURIFactory branch from 63c2b31 to a749f0eCompare June 29, 2023 01:45

kenjis force-pushed the feat-SiteURIFactory branch from a749f0e to 1c1a6abCompare July 9, 2023 08:45

MGatner reviewed Jul 9, 2023
View reviewed changes

kenjis force-pushed the feat-SiteURIFactory branch 2 times, most recently from 239b2cc to 61beca5Compare July 12, 2023 01:15

kenjis commented Jul 12, 2023
View reviewed changes

kenjis marked this pull request as ready for review July 12, 2023 01:38

MGatner requested changes Jul 23, 2023
View reviewed changes

Comment threadsystem/HTTP/SiteURIFactory.php Outdated
Comment threadsystem/Superglobals.php
Comment threadsystem/HTTP/SiteURIFactory.php Outdated

kenjis added 10 commits July 24, 2023 09:00

feat: add SiteURIFactory
6318c23

fix: createFromString() returns URI with invalid hostname
09a96ab

docs: add version to@deprecated
37772e9

refactor: extract class Superglobals and use it
9937a03

test: extract createSiteURIFactory()
8522e99

refactor: change parameter order
be7ca15

feat: allow Superglobals state changes from the constructor
1a95c89

refactore: remove @ that does not make sense, and cast to string
78b0ac6
Because it might be false.

refactor: remove string array access
fde3216
It is difficult to understand.

refactor: make SiteURIFactory final
6b3dd7a

kenjis force-pushed the feat-SiteURIFactory branch from 61beca5 to 6b3dd7aCompare July 24, 2023 00:41

feat: add Superglobals::setGet()
84b4a31

MGatner approved these changes Jul 24, 2023
View reviewed changes

TimexPeachtree approved these changes Jul 24, 2023
View reviewed changes

kenjis merged commit 988906c into codeigniter4:4.4Jul 25, 2023

kenjis deleted the feat-SiteURIFactory branch July 25, 2023 08:13