94 lines
2.4 KiB
YAML
94 lines
2.4 KiB
YAML
|
name: RequestStack
|
||
|
|
class_comment: '# * Request stack that controls the lifecycle of requests.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @author Benjamin Eberlei <kontakt@beberlei.de>'
|
||
|
|
dependencies:
|
||
|
|
- name: SessionNotFoundException
|
||
|
|
type: class
|
||
|
|
source: Symfony\Component\HttpFoundation\Exception\SessionNotFoundException
|
||
|
|
- name: SessionInterface
|
||
|
|
type: class
|
||
|
|
source: Symfony\Component\HttpFoundation\Session\SessionInterface
|
||
|
|
properties: []
|
||
|
|
methods:
|
||
|
|
- name: __construct
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: requests
|
||
|
|
default: '[]'
|
||
|
|
comment: "# * Request stack that controls the lifecycle of requests.\n# *\n# * @author\
|
||
|
|
\ Benjamin Eberlei <kontakt@beberlei.de>\n# */\n# class RequestStack\n# {\n# /**\n\
|
||
|
|
# * @var Request[]\n# */\n# private array $requests = [];\n# \n# /**\n# * @param\
|
||
|
|
\ Request[] $requests"
|
||
|
|
- name: push
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: request
|
||
|
|
comment: '# * 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.'
|
||
|
|
- name: pop
|
||
|
|
visibility: public
|
||
|
|
parameters: []
|
||
|
|
comment: '# * 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.'
|
||
|
|
- name: getCurrentRequest
|
||
|
|
visibility: public
|
||
|
|
parameters: []
|
||
|
|
comment: null
|
||
|
|
- name: getMainRequest
|
||
|
|
visibility: public
|
||
|
|
parameters: []
|
||
|
|
comment: '# * Gets the main request.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * Be warned that making your code aware of the main request
|
||
|
|
|
||
|
|
# * might make it un-compatible with other features of your framework
|
||
|
|
|
||
|
|
# * like ESI support.'
|
||
|
|
- name: getParentRequest
|
||
|
|
visibility: public
|
||
|
|
parameters: []
|
||
|
|
comment: '# * 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 main request, it returns null.'
|
||
|
|
- name: getSession
|
||
|
|
visibility: public
|
||
|
|
parameters: []
|
||
|
|
comment: '# * Gets the current session.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @throws SessionNotFoundException'
|
||
|
|
traits:
|
||
|
|
- Symfony\Component\HttpFoundation\Exception\SessionNotFoundException
|
||
|
|
- Symfony\Component\HttpFoundation\Session\SessionInterface
|
||
|
|
interfaces: []
|