PjaxResponseNegotiator
class PjaxResponseNegotiator (View source)
Handle the X-Pjax header that AJAX responses may provide, returning the fragment, or, in the case of non-AJAX form submissions, redirecting back to the submitter.
X-Pjax ensures that users won't end up seeing the unstyled form HTML in their browser.
If a JS error prevents the Ajax overriding of form submissions from happening.
It also provides better non-JS operation.
Caution: This API is volatile, and might eventually be replaced by a generic action helper system for controllers.
Properties
protected | array | $callbacks | See respond() |
|
protected | HTTPResponse | $response | ||
protected | $fragmentOverride | Overridden fragments (if any). Otherwise uses fragments from the request. |
Methods
Out of the box, the handler "CurrentForm" value, which will return the rendered form.
Set up fragment overriding - will completely replace the incoming fragments.
Details
__construct(array $callbacks = [], HTTPResponse $response = null)
No description
HTTPResponse
getResponse()
No description
setResponse(HTTPResponse $response)
No description
HTTPResponse
respond(HTTPRequest $request, array $extraCallbacks = [])
Out of the box, the handler "CurrentForm" value, which will return the rendered form.
Non-Ajax calls will redirect back.
setCallback(string $fragment, callable $callback)
No description
$this
setFragmentOverride(array $fragments)
Set up fragment overriding - will completely replace the incoming fragments.
array
getFragmentOverride()
No description