phpDocumentor
Back to top  

Redirect controller response.

This indicates that we want to externally redirect the user to another page. Depending on the output type, this may not actually redirect. This may tell the user that we created the resource and give them the URL.

package XenForo_Mvc

 Properties

 

Key-value parameters to pass to the container view.

$containerParams : array
Inherited

inherited_from \XenForo_ControllerResponse_Abstract::$$containerParams
 

$controllerAction

$controllerAction 
Inherited

inherited_from \XenForo_ControllerResponse_Abstract::$$controllerAction
 

$controllerName

$controllerName 
Inherited

inherited_from \XenForo_ControllerResponse_Abstract::$$controllerName
 

$redirectMessage

$redirectMessage 

 

$redirectParams

$redirectParams 

 

$redirectTarget

$redirectTarget 

 

$redirectType

$redirectType 

 

An optional HTTP response code to output

$responseCode : integer
Inherited

inherited_from \XenForo_ControllerResponse_Abstract::$$responseCode
 

$viewName

$viewName 
Inherited

inherited_from \XenForo_ControllerResponse_Abstract::$$viewName

 Constants

 

Use this when no resource has been updated and the redirect target is the canonical version of the target URL.

RESOURCE_CANONICAL : int

For example, this would be used when redirecting the URL /thread/1/new-post to /thread/1/page2#post25.

This should be used when the URL receiving the request may reasonably redirect to different pages at different times (ie, temporary redirect). If this redirect is likely to be permanent, use RESOURCE_CANONICAL_PERMANENT.

 

Use this when no resource has been updated and the redirect target is the canonical version of the target URL.

RESOURCE_CANONICAL_PERMANENT : int

For example, this would be used when redirecting the URL /post/25 to /thread/1#p25.

This should only be used when there is no reasonable expectation that the redirect target for a given request will vary (ie, permanent redirect). Otherwise, use RESOURCE_CANONICAL.

 

Use this only when a resource has been newly created and the redirect target is the URL to the new resource.

RESOURCE_CREATED : int

If the user is being redirected anywhere else, use SUCCESS.

 

Use this only when a resource has been updated and the redirect target is the URL to the resource.

RESOURCE_UPDATED : int

If the user is being redirected anywhere else, use SUCCESS.

 

General purpose redirect for when an action has been successfully carried out.

SUCCESS : int

This might be used when a resource has been created or updated but isn't the redirect target.