-
-
Notifications
You must be signed in to change notification settings - Fork 188
/
RequestInterface.php
67 lines (61 loc) · 1.56 KB
/
RequestInterface.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
<?php
namespace Neos\Flow\Mvc;
/*
* This file is part of the Neos.Flow package.
*
* (c) Contributors of the Neos Project - www.neos.io
*
* This package is Open Source Software. For the full copyright and license
* information, please view the LICENSE file which was distributed with this
* source code.
*/
/**
* Contract for a dispatchable request.
*
* @api
*/
interface RequestInterface
{
/**
* Sets the dispatched flag
*
* @param boolean $flag If this request has been dispatched
* @return void
* @api
*/
public function setDispatched($flag);
/**
* If this request has been dispatched and addressed by the responsible
* controller and the response is ready to be sent.
*
* The dispatcher will try to dispatch the request again if it has not been
* addressed yet.
*
* @return boolean true if this request has been dispatched successfully
* @api
*/
public function isDispatched();
/**
* Returns the object name of the controller which is supposed to process the
* request.
*
* @return string The controller's object name
* @api
*/
public function getControllerObjectName();
/**
* Returns the top level Request: the one just below the HTTP request
*
* @return RequestInterface
* @api
*/
public function getMainRequest();
/**
* Checks if this request is the uppermost ActionRequest, just one below the
* HTTP request.
*
* @return boolean
* @api
*/
public function isMainRequest();
}