Open Journal Systems  3.3.0
Symfony\Component\HttpFoundation\RequestStack Class Reference

Public Member Functions

 getCurrentRequest ()
 
 getCurrentRequest ()
 
 getMasterRequest ()
 
 getMasterRequest ()
 
 getParentRequest ()
 
 getParentRequest ()
 
 pop ()
 
 pop ()
 
 push (Request $request)
 
 push (Request $request)
 

Detailed Description

Request stack that controls the lifecycle of requests.

Author
Benjamin Eberlei konta.nosp@m.kt@b.nosp@m.eberl.nosp@m.ei.d.nosp@m.e

Definition at line 19 of file lib/vendor/symfony/http-foundation/RequestStack.php.

Member Function Documentation

◆ getCurrentRequest() [1/2]

Symfony\Component\HttpFoundation\RequestStack::getCurrentRequest ( )
Returns
Request|null

Definition at line 62 of file lib/vendor/symfony/http-foundation/RequestStack.php.

◆ getCurrentRequest() [2/2]

Symfony\Component\HttpFoundation\RequestStack::getCurrentRequest ( )
Returns
Request|null

Definition at line 62 of file vendor/symfony/http-foundation/RequestStack.php.

◆ getMasterRequest() [1/2]

Symfony\Component\HttpFoundation\RequestStack::getMasterRequest ( )

Gets the master Request.

Be warned that making your code aware of the master request might make it un-compatible with other features of your framework like ESI support.

Returns
Request|null

Definition at line 76 of file lib/vendor/symfony/http-foundation/RequestStack.php.

◆ getMasterRequest() [2/2]

Symfony\Component\HttpFoundation\RequestStack::getMasterRequest ( )

Gets the master Request.

Be warned that making your code aware of the master request might make it un-compatible with other features of your framework like ESI support.

Returns
Request|null

Definition at line 76 of file vendor/symfony/http-foundation/RequestStack.php.

◆ getParentRequest() [1/2]

Symfony\Component\HttpFoundation\RequestStack::getParentRequest ( )

Returns the parent request of the current.

Be warned that making your code aware of the parent request might make it un-compatible with other features of your framework like ESI support.

If current Request is the master request, it returns null.

Returns
Request|null

Definition at line 96 of file vendor/symfony/http-foundation/RequestStack.php.

◆ getParentRequest() [2/2]

Symfony\Component\HttpFoundation\RequestStack::getParentRequest ( )

Returns the parent request of the current.

Be warned that making your code aware of the parent request might make it un-compatible with other features of your framework like ESI support.

If current Request is the master request, it returns null.

Returns
Request|null

Definition at line 96 of file lib/vendor/symfony/http-foundation/RequestStack.php.

◆ pop() [1/2]

Symfony\Component\HttpFoundation\RequestStack::pop ( )

Pops the current request from the stack.

This operation lets the current request go out of scope.

This method should generally not be called directly as the stack management should be taken care of by the application itself.

Returns
Request|null

Definition at line 50 of file vendor/symfony/http-foundation/RequestStack.php.

◆ pop() [2/2]

Symfony\Component\HttpFoundation\RequestStack::pop ( )

Pops the current request from the stack.

This operation lets the current request go out of scope.

This method should generally not be called directly as the stack management should be taken care of by the application itself.

Returns
Request|null

Definition at line 50 of file lib/vendor/symfony/http-foundation/RequestStack.php.

◆ push() [1/2]

Symfony\Component\HttpFoundation\RequestStack::push ( Request  $request)

Pushes a Request on the stack.

This method should generally not be called directly as the stack management should be taken care of by the application itself.

Definition at line 35 of file lib/vendor/symfony/http-foundation/RequestStack.php.

◆ push() [2/2]

Symfony\Component\HttpFoundation\RequestStack::push ( Request  $request)

Pushes a Request on the stack.

This method should generally not be called directly as the stack management should be taken care of by the application itself.

Definition at line 35 of file vendor/symfony/http-foundation/RequestStack.php.


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