[DocBlock] Add property $request with @var IncomingRequest in BaseController

[samsonasik]

Controller that extends BaseController mostly on http, I think it will be better for IDE detection with mark as @var IncomingRequest for its $request property.

Checklist:

• Securely signed commits

[paulbalandan]

Agreed. My IDE turns red on incomplete interface reliance.

[samsonasik]

@paulbalandan the another solution is probably add & instead of | in the CodeIgniter\Controller's request docblock:

	/*** Instance of the main Request object.
** @var RequestInterface&\CodeIgniter\HTTP\IncomingRequest&\CodeIgniter\HTTP\CLIRequest
*/
protected $request;

that will always work, what do you think?

[paulbalandan]

But I have an experience with phpstan before, using phpstan-strict-rules I think, using the union & in the docblock then passing in a lower type will result in an error. For example here, Property $request expects IncomingRequest, RequestInterface given.

[samsonasik]

Yes, PHPStan seems can't verify & for the following:

@var RequestInterface&\CodeIgniter\HTTP\IncomingRequest&\CodeIgniter\HTTP\CLIRequest

------ ---------------------------------------------------------------- 44 PHPDoc tag @var for property CodeIgniter\Controller::$request contains unresolvable type. 

The mark as IncomingRequest in BaseController seems the possible solution for now.

[MGatner]

This makes me a little uncomfortable with the PSR-7 stuff up in the air, but I think the changes there will require a major version so we could adjust this then anyways. For now I think this will fix a number of other issues for places uses Request and RequestInterface.

[samsonasik]

@MGatner so this PR or the alternative #4282 ?

[MGatner]

I don't really have any IDE experience, and you've taught me everything I know about PHPStan. I trust you two to figure this out. 😊

[paulbalandan]

I'm uncomfortable with a phpstan-ignore-next-line in the phpdoc. Seems like we are suppressing or hiding something. I'd vote for this one instead. And probably we'd do CLIRequest for CommandRunner::$request.

[samsonasik]

@MGatner thank you, I prefer the alternative #4282 but will wait if anyone have another opinion.

[samsonasik]

@paulbalandan Ok, I will merge this 🎉

[MGatner]

Actually, sorry to think about this late, but I think if you run php public/index.php then BaseController::$request will actually be a CLIRequest:

CodeIgniter4/system/CodeIgniter.php

Lines 590 to 595 in 363b090

	if (is_cli() && ENVIRONMENT !== 'testing')
	{
	// @codeCoverageIgnoreStart
	$this->request = Services::clirequest($this->config);
	// @codeCoverageIgnoreEnd
	}

We need to test for this and either update the docblock or revert this change until we can figure this out.

[MGatner]

CodeIgniter4/system/Common.php

Lines 756 to 759 in 69038f6

	functionis_cli(): bool
	{
	return (PHP_SAPI === 'cli' || defined('STDIN'));
	}

[MGatner]

@paulbalandan@samsonasik Please don't let this one slip by

[samsonasik]

probably @var IncomingRequest&CliRequest is the way to go?

[paulbalandan]

probably @var IncomingRequest&CliRequest is the way to go?

Hmm. I think this is the way.

[samsonasik]

@MGatner fixed at #4285

[samsonasik]

Controller that extends BaseController mostly on http, I think it will be better for IDE detection with mark as @var IncomingRequest for its $request property.

Checklist:

• Securely signed commits

[paulbalandan]

Agreed. My IDE turns red on incomplete interface reliance.

[samsonasik]

@paulbalandan the another solution is probably add & instead of | in the CodeIgniter\Controller's request docblock:

	/*** Instance of the main Request object.
** @var RequestInterface&\CodeIgniter\HTTP\IncomingRequest&\CodeIgniter\HTTP\CLIRequest
*/
protected $request;

that will always work, what do you think?

[paulbalandan]

But I have an experience with phpstan before, using phpstan-strict-rules I think, using the union & in the docblock then passing in a lower type will result in an error. For example here, Property $request expects IncomingRequest, RequestInterface given.

[samsonasik]

Yes, PHPStan seems can't verify & for the following:

@var RequestInterface&\CodeIgniter\HTTP\IncomingRequest&\CodeIgniter\HTTP\CLIRequest

------ ---------------------------------------------------------------- 44 PHPDoc tag @var for property CodeIgniter\Controller::$request contains unresolvable type. 

The mark as IncomingRequest in BaseController seems the possible solution for now.

[MGatner]

This makes me a little uncomfortable with the PSR-7 stuff up in the air, but I think the changes there will require a major version so we could adjust this then anyways. For now I think this will fix a number of other issues for places uses Request and RequestInterface.

[samsonasik]

@MGatner so this PR or the alternative #4282 ?

[MGatner]

I don't really have any IDE experience, and you've taught me everything I know about PHPStan. I trust you two to figure this out. 😊

[paulbalandan]

I'm uncomfortable with a phpstan-ignore-next-line in the phpdoc. Seems like we are suppressing or hiding something. I'd vote for this one instead. And probably we'd do CLIRequest for CommandRunner::$request.

[samsonasik]

@MGatner thank you, I prefer the alternative #4282 but will wait if anyone have another opinion.

[samsonasik]

@paulbalandan Ok, I will merge this 🎉

[MGatner]

Actually, sorry to think about this late, but I think if you run php public/index.php then BaseController::$request will actually be a CLIRequest:

CodeIgniter4/system/CodeIgniter.php

Lines 590 to 595 in 363b090

	if (is_cli() && ENVIRONMENT !== 'testing')
	{
	// @codeCoverageIgnoreStart
	$this->request = Services::clirequest($this->config);
	// @codeCoverageIgnoreEnd
	}

We need to test for this and either update the docblock or revert this change until we can figure this out.

[MGatner]

CodeIgniter4/system/Common.php

Lines 756 to 759 in 69038f6

	functionis_cli(): bool
	{
	return (PHP_SAPI === 'cli' || defined('STDIN'));
	}

[MGatner]

@paulbalandan@samsonasik Please don't let this one slip by

[samsonasik]

probably @var IncomingRequest&CliRequest is the way to go?

[paulbalandan]

probably @var IncomingRequest&CliRequest is the way to go?

Hmm. I think this is the way.

[samsonasik]

@MGatner fixed at #4285

[samsonasik]

Controller that extends BaseController mostly on http, I think it will be better for IDE detection with mark as @var IncomingRequest for its $request property.

Checklist:

• Securely signed commits

[paulbalandan]

Agreed. My IDE turns red on incomplete interface reliance.

[samsonasik]

@paulbalandan the another solution is probably add & instead of | in the CodeIgniter\Controller's request docblock:

	/*** Instance of the main Request object.
** @var RequestInterface&\CodeIgniter\HTTP\IncomingRequest&\CodeIgniter\HTTP\CLIRequest
*/
protected $request;

that will always work, what do you think?

[paulbalandan]

But I have an experience with phpstan before, using phpstan-strict-rules I think, using the union & in the docblock then passing in a lower type will result in an error. For example here, Property $request expects IncomingRequest, RequestInterface given.

[samsonasik]

Yes, PHPStan seems can't verify & for the following:

@var RequestInterface&\CodeIgniter\HTTP\IncomingRequest&\CodeIgniter\HTTP\CLIRequest

------ ---------------------------------------------------------------- 44 PHPDoc tag @var for property CodeIgniter\Controller::$request contains unresolvable type. 

The mark as IncomingRequest in BaseController seems the possible solution for now.

[MGatner]

This makes me a little uncomfortable with the PSR-7 stuff up in the air, but I think the changes there will require a major version so we could adjust this then anyways. For now I think this will fix a number of other issues for places uses Request and RequestInterface.

[samsonasik]

@MGatner so this PR or the alternative #4282 ?

[MGatner]

I don't really have any IDE experience, and you've taught me everything I know about PHPStan. I trust you two to figure this out. 😊

[paulbalandan]

I'm uncomfortable with a phpstan-ignore-next-line in the phpdoc. Seems like we are suppressing or hiding something. I'd vote for this one instead. And probably we'd do CLIRequest for CommandRunner::$request.

[samsonasik]

@MGatner thank you, I prefer the alternative #4282 but will wait if anyone have another opinion.

[samsonasik]

@paulbalandan Ok, I will merge this 🎉

[MGatner]

Actually, sorry to think about this late, but I think if you run php public/index.php then BaseController::$request will actually be a CLIRequest:

CodeIgniter4/system/CodeIgniter.php

Lines 590 to 595 in 363b090

	if (is_cli() && ENVIRONMENT !== 'testing')
	{
	// @codeCoverageIgnoreStart
	$this->request = Services::clirequest($this->config);
	// @codeCoverageIgnoreEnd
	}

We need to test for this and either update the docblock or revert this change until we can figure this out.

[MGatner]

CodeIgniter4/system/Common.php

Lines 756 to 759 in 69038f6

	functionis_cli(): bool
	{
	return (PHP_SAPI === 'cli' || defined('STDIN'));
	}

[MGatner]

@paulbalandan@samsonasik Please don't let this one slip by

[samsonasik]

probably @var IncomingRequest&CliRequest is the way to go?

[paulbalandan]

probably @var IncomingRequest&CliRequest is the way to go?

Hmm. I think this is the way.

[samsonasik]

@MGatner fixed at #4285

[samsonasik]

Controller that extends BaseController mostly on http, I think it will be better for IDE detection with mark as @var IncomingRequest for its $request property.

Checklist:

• Securely signed commits

[paulbalandan]

Agreed. My IDE turns red on incomplete interface reliance.

[samsonasik]

@paulbalandan the another solution is probably add & instead of | in the CodeIgniter\Controller's request docblock:

	/*** Instance of the main Request object.
** @var RequestInterface&\CodeIgniter\HTTP\IncomingRequest&\CodeIgniter\HTTP\CLIRequest
*/
protected $request;

that will always work, what do you think?

[paulbalandan]

But I have an experience with phpstan before, using phpstan-strict-rules I think, using the union & in the docblock then passing in a lower type will result in an error. For example here, Property $request expects IncomingRequest, RequestInterface given.

[samsonasik]

Yes, PHPStan seems can't verify & for the following:

@var RequestInterface&\CodeIgniter\HTTP\IncomingRequest&\CodeIgniter\HTTP\CLIRequest

------ ---------------------------------------------------------------- 44 PHPDoc tag @var for property CodeIgniter\Controller::$request contains unresolvable type. 

The mark as IncomingRequest in BaseController seems the possible solution for now.

[MGatner]

This makes me a little uncomfortable with the PSR-7 stuff up in the air, but I think the changes there will require a major version so we could adjust this then anyways. For now I think this will fix a number of other issues for places uses Request and RequestInterface.

[samsonasik]

@MGatner so this PR or the alternative #4282 ?

[MGatner]

I don't really have any IDE experience, and you've taught me everything I know about PHPStan. I trust you two to figure this out. 😊

[paulbalandan]

I'm uncomfortable with a phpstan-ignore-next-line in the phpdoc. Seems like we are suppressing or hiding something. I'd vote for this one instead. And probably we'd do CLIRequest for CommandRunner::$request.

[samsonasik]

@MGatner thank you, I prefer the alternative #4282 but will wait if anyone have another opinion.

[samsonasik]

@paulbalandan Ok, I will merge this 🎉

[MGatner]

Actually, sorry to think about this late, but I think if you run php public/index.php then BaseController::$request will actually be a CLIRequest:

CodeIgniter4/system/CodeIgniter.php

Lines 590 to 595 in 363b090

	if (is_cli() && ENVIRONMENT !== 'testing')
	{
	// @codeCoverageIgnoreStart
	$this->request = Services::clirequest($this->config);
	// @codeCoverageIgnoreEnd
	}

We need to test for this and either update the docblock or revert this change until we can figure this out.

[MGatner]

CodeIgniter4/system/Common.php

Lines 756 to 759 in 69038f6

	functionis_cli(): bool
	{
	return (PHP_SAPI === 'cli' || defined('STDIN'));
	}

[MGatner]

@paulbalandan@samsonasik Please don't let this one slip by

[samsonasik]

probably @var IncomingRequest&CliRequest is the way to go?

[paulbalandan]

probably @var IncomingRequest&CliRequest is the way to go?

Hmm. I think this is the way.

[samsonasik]

@MGatner fixed at #4285

[samsonasik]

Controller that extends BaseController mostly on http, I think it will be better for IDE detection with mark as @var IncomingRequest for its $request property.

Checklist:

• Securely signed commits

[paulbalandan]

Agreed. My IDE turns red on incomplete interface reliance.

[samsonasik]

@paulbalandan the another solution is probably add & instead of | in the CodeIgniter\Controller's request docblock:

	/*** Instance of the main Request object.
** @var RequestInterface&\CodeIgniter\HTTP\IncomingRequest&\CodeIgniter\HTTP\CLIRequest
*/
protected $request;

that will always work, what do you think?

[paulbalandan]

But I have an experience with phpstan before, using phpstan-strict-rules I think, using the union & in the docblock then passing in a lower type will result in an error. For example here, Property $request expects IncomingRequest, RequestInterface given.

[samsonasik]

Yes, PHPStan seems can't verify & for the following:

@var RequestInterface&\CodeIgniter\HTTP\IncomingRequest&\CodeIgniter\HTTP\CLIRequest

------ ---------------------------------------------------------------- 44 PHPDoc tag @var for property CodeIgniter\Controller::$request contains unresolvable type. 

The mark as IncomingRequest in BaseController seems the possible solution for now.

[MGatner]

This makes me a little uncomfortable with the PSR-7 stuff up in the air, but I think the changes there will require a major version so we could adjust this then anyways. For now I think this will fix a number of other issues for places uses Request and RequestInterface.

[samsonasik]

@MGatner so this PR or the alternative #4282 ?

[MGatner]

I don't really have any IDE experience, and you've taught me everything I know about PHPStan. I trust you two to figure this out. 😊

[paulbalandan]

I'm uncomfortable with a phpstan-ignore-next-line in the phpdoc. Seems like we are suppressing or hiding something. I'd vote for this one instead. And probably we'd do CLIRequest for CommandRunner::$request.

[samsonasik]

@MGatner thank you, I prefer the alternative #4282 but will wait if anyone have another opinion.

[samsonasik]

@paulbalandan Ok, I will merge this 🎉

[MGatner]

Actually, sorry to think about this late, but I think if you run php public/index.php then BaseController::$request will actually be a CLIRequest:

CodeIgniter4/system/CodeIgniter.php

Lines 590 to 595 in 363b090

	if (is_cli() && ENVIRONMENT !== 'testing')
	{
	// @codeCoverageIgnoreStart
	$this->request = Services::clirequest($this->config);
	// @codeCoverageIgnoreEnd
	}

We need to test for this and either update the docblock or revert this change until we can figure this out.

[MGatner]

CodeIgniter4/system/Common.php

Lines 756 to 759 in 69038f6

	functionis_cli(): bool
	{
	return (PHP_SAPI === 'cli' || defined('STDIN'));
	}

[MGatner]

@paulbalandan@samsonasik Please don't let this one slip by

[samsonasik]

probably @var IncomingRequest&CliRequest is the way to go?

[paulbalandan]

probably @var IncomingRequest&CliRequest is the way to go?

Hmm. I think this is the way.

[samsonasik]

@MGatner fixed at #4285

[samsonasik]

Controller that extends BaseController mostly on http, I think it will be better for IDE detection with mark as @var IncomingRequest for its $request property.

Checklist:

• Securely signed commits

[paulbalandan]

Agreed. My IDE turns red on incomplete interface reliance.

[samsonasik]

@paulbalandan the another solution is probably add & instead of | in the CodeIgniter\Controller's request docblock:

	/*** Instance of the main Request object.
** @var RequestInterface&\CodeIgniter\HTTP\IncomingRequest&\CodeIgniter\HTTP\CLIRequest
*/
protected $request;

that will always work, what do you think?

[paulbalandan]

But I have an experience with phpstan before, using phpstan-strict-rules I think, using the union & in the docblock then passing in a lower type will result in an error. For example here, Property $request expects IncomingRequest, RequestInterface given.

[samsonasik]

Yes, PHPStan seems can't verify & for the following:

@var RequestInterface&\CodeIgniter\HTTP\IncomingRequest&\CodeIgniter\HTTP\CLIRequest

------ ---------------------------------------------------------------- 44 PHPDoc tag @var for property CodeIgniter\Controller::$request contains unresolvable type. 

The mark as IncomingRequest in BaseController seems the possible solution for now.

[MGatner]

This makes me a little uncomfortable with the PSR-7 stuff up in the air, but I think the changes there will require a major version so we could adjust this then anyways. For now I think this will fix a number of other issues for places uses Request and RequestInterface.

[samsonasik]

@MGatner so this PR or the alternative #4282 ?

[MGatner]

I don't really have any IDE experience, and you've taught me everything I know about PHPStan. I trust you two to figure this out. 😊

[paulbalandan]

I'm uncomfortable with a phpstan-ignore-next-line in the phpdoc. Seems like we are suppressing or hiding something. I'd vote for this one instead. And probably we'd do CLIRequest for CommandRunner::$request.

[samsonasik]

@MGatner thank you, I prefer the alternative #4282 but will wait if anyone have another opinion.

[samsonasik]

@paulbalandan Ok, I will merge this 🎉

[MGatner]

Actually, sorry to think about this late, but I think if you run php public/index.php then BaseController::$request will actually be a CLIRequest:

CodeIgniter4/system/CodeIgniter.php

Lines 590 to 595 in 363b090

	if (is_cli() && ENVIRONMENT !== 'testing')
	{
	// @codeCoverageIgnoreStart
	$this->request = Services::clirequest($this->config);
	// @codeCoverageIgnoreEnd
	}

We need to test for this and either update the docblock or revert this change until we can figure this out.

[MGatner]

CodeIgniter4/system/Common.php

Lines 756 to 759 in 69038f6

	functionis_cli(): bool
	{
	return (PHP_SAPI === 'cli' || defined('STDIN'));
	}

[MGatner]

@paulbalandan@samsonasik Please don't let this one slip by

[samsonasik]

probably @var IncomingRequest&CliRequest is the way to go?

[paulbalandan]

probably @var IncomingRequest&CliRequest is the way to go?

Hmm. I think this is the way.

[samsonasik]

@MGatner fixed at #4285

[samsonasik]

Controller that extends BaseController mostly on http, I think it will be better for IDE detection with mark as @var IncomingRequest for its $request property.

Checklist:

• Securely signed commits

[paulbalandan]

Agreed. My IDE turns red on incomplete interface reliance.

[samsonasik]

@paulbalandan the another solution is probably add & instead of | in the CodeIgniter\Controller's request docblock:

	/*** Instance of the main Request object.
** @var RequestInterface&\CodeIgniter\HTTP\IncomingRequest&\CodeIgniter\HTTP\CLIRequest
*/
protected $request;

that will always work, what do you think?

[paulbalandan]

But I have an experience with phpstan before, using phpstan-strict-rules I think, using the union & in the docblock then passing in a lower type will result in an error. For example here, Property $request expects IncomingRequest, RequestInterface given.

[samsonasik]

Yes, PHPStan seems can't verify & for the following:

@var RequestInterface&\CodeIgniter\HTTP\IncomingRequest&\CodeIgniter\HTTP\CLIRequest

------ ---------------------------------------------------------------- 44 PHPDoc tag @var for property CodeIgniter\Controller::$request contains unresolvable type. 

The mark as IncomingRequest in BaseController seems the possible solution for now.

[MGatner]

This makes me a little uncomfortable with the PSR-7 stuff up in the air, but I think the changes there will require a major version so we could adjust this then anyways. For now I think this will fix a number of other issues for places uses Request and RequestInterface.

[samsonasik]

@MGatner so this PR or the alternative #4282 ?

[MGatner]

I don't really have any IDE experience, and you've taught me everything I know about PHPStan. I trust you two to figure this out. 😊

[paulbalandan]

I'm uncomfortable with a phpstan-ignore-next-line in the phpdoc. Seems like we are suppressing or hiding something. I'd vote for this one instead. And probably we'd do CLIRequest for CommandRunner::$request.

[samsonasik]

@MGatner thank you, I prefer the alternative #4282 but will wait if anyone have another opinion.

[samsonasik]

@paulbalandan Ok, I will merge this 🎉

[MGatner]

Actually, sorry to think about this late, but I think if you run php public/index.php then BaseController::$request will actually be a CLIRequest:

CodeIgniter4/system/CodeIgniter.php

Lines 590 to 595 in 363b090

	if (is_cli() && ENVIRONMENT !== 'testing')
	{
	// @codeCoverageIgnoreStart
	$this->request = Services::clirequest($this->config);
	// @codeCoverageIgnoreEnd
	}

We need to test for this and either update the docblock or revert this change until we can figure this out.

[MGatner]

CodeIgniter4/system/Common.php

Lines 756 to 759 in 69038f6

	functionis_cli(): bool
	{
	return (PHP_SAPI === 'cli' || defined('STDIN'));
	}

[MGatner]

@paulbalandan@samsonasik Please don't let this one slip by

[samsonasik]

probably @var IncomingRequest&CliRequest is the way to go?

[paulbalandan]

probably @var IncomingRequest&CliRequest is the way to go?

Hmm. I think this is the way.

[samsonasik]

@MGatner fixed at #4285

[samsonasik]

Controller that extends BaseController mostly on http, I think it will be better for IDE detection with mark as @var IncomingRequest for its $request property.

Checklist:

• Securely signed commits

[paulbalandan]

Agreed. My IDE turns red on incomplete interface reliance.

[samsonasik]

@paulbalandan the another solution is probably add & instead of | in the CodeIgniter\Controller's request docblock:

	/*** Instance of the main Request object.
** @var RequestInterface&\CodeIgniter\HTTP\IncomingRequest&\CodeIgniter\HTTP\CLIRequest
*/
protected $request;

that will always work, what do you think?

[paulbalandan]

But I have an experience with phpstan before, using phpstan-strict-rules I think, using the union & in the docblock then passing in a lower type will result in an error. For example here, Property $request expects IncomingRequest, RequestInterface given.

[samsonasik]

Yes, PHPStan seems can't verify & for the following:

@var RequestInterface&\CodeIgniter\HTTP\IncomingRequest&\CodeIgniter\HTTP\CLIRequest

------ ---------------------------------------------------------------- 44 PHPDoc tag @var for property CodeIgniter\Controller::$request contains unresolvable type. 

The mark as IncomingRequest in BaseController seems the possible solution for now.

[MGatner]

This makes me a little uncomfortable with the PSR-7 stuff up in the air, but I think the changes there will require a major version so we could adjust this then anyways. For now I think this will fix a number of other issues for places uses Request and RequestInterface.

[samsonasik]

@MGatner so this PR or the alternative #4282 ?

[MGatner]

I don't really have any IDE experience, and you've taught me everything I know about PHPStan. I trust you two to figure this out. 😊

[paulbalandan]

I'm uncomfortable with a phpstan-ignore-next-line in the phpdoc. Seems like we are suppressing or hiding something. I'd vote for this one instead. And probably we'd do CLIRequest for CommandRunner::$request.

[samsonasik]

@MGatner thank you, I prefer the alternative #4282 but will wait if anyone have another opinion.

[samsonasik]

@paulbalandan Ok, I will merge this 🎉

[MGatner]

Actually, sorry to think about this late, but I think if you run php public/index.php then BaseController::$request will actually be a CLIRequest:

CodeIgniter4/system/CodeIgniter.php

Lines 590 to 595 in 363b090

	if (is_cli() && ENVIRONMENT !== 'testing')
	{
	// @codeCoverageIgnoreStart
	$this->request = Services::clirequest($this->config);
	// @codeCoverageIgnoreEnd
	}

We need to test for this and either update the docblock or revert this change until we can figure this out.

[MGatner]

CodeIgniter4/system/Common.php

Lines 756 to 759 in 69038f6

	functionis_cli(): bool
	{
	return (PHP_SAPI === 'cli' || defined('STDIN'));
	}

[MGatner]

@paulbalandan@samsonasik Please don't let this one slip by

[samsonasik]

probably @var IncomingRequest&CliRequest is the way to go?

[paulbalandan]

probably @var IncomingRequest&CliRequest is the way to go?

Hmm. I think this is the way.

[samsonasik]

@MGatner fixed at #4285