TYPO3\CMS\Form\Domain\Finishers\RedirectFinisher Class Reference

Inheritance diagram for TYPO3\CMS\Form\Domain\Finishers\RedirectFinisher:

Protected Member Functions
	executeInternal ()
	redirect (int $pageUid, string $additionalParameters, string $fragment, int $statusCode)
	redirectToUri (string $uri, int $statusCode=303)
	addBaseUriIfNecessary (string $uri)
‪Protected Member Functions inherited from ‪TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher
string array int null	parseOption (string $optionName)
array string	translateFinisherOption ( $subject, FormRuntime $formRuntime, string $optionName, $optionValue, array $translationOptions)
mixed	substituteRuntimeReferences ($needle, FormRuntime $formRuntime)
int string array	resolveRuntimeReference (string $property, FormRuntime $formRuntime)
	getTypoScriptFrontendController ()

Protected Attributes
array	$defaultOptions
‪Protected Attributes inherited from ‪TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher
string	$finisherIdentifier = ''
string	$shortFinisherIdentifier = ''
array	$options = array( )
array	$defaultOptions = array( )
TYPO3 CMS Form Domain Finishers FinisherContext	$finisherContext

Additional Inherited Members
‪Public Member Functions inherited from ‪TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher
	setFinisherIdentifier (string $finisherIdentifier)
	getFinisherIdentifier ()
	setOptions (array $options)
	setOption (string $optionName, $optionValue)
string null	execute (FinisherContext $finisherContext)
	isEnabled ()

Detailed Description

This finisher redirects to another Controller.

Scope: frontend

Definition at line 29 of file RedirectFinisher.php.

Member Function Documentation

addBaseUriIfNecessary()

TYPO3\CMS\Form\Domain\Finishers\RedirectFinisher::addBaseUriIfNecessary ( string  $uri )

protected

Adds the base uri if not already in place.

Parameters

string

$uri

‪The URI

Definition at line 107 of file RedirectFinisher.php.

Referenced by TYPO3\CMS\Form\Domain\Finishers\RedirectFinisher\redirectToUri().

executeInternal()

TYPO3\CMS\Form\Domain\Finishers\RedirectFinisher::executeInternal ( )

protected

Executes this finisher

See also

‪AbstractFinisher::execute()

Reimplemented from TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher.

Definition at line 44 of file RedirectFinisher.php.

References TYPO3\CMS\Redirects\Message\$statusCode, TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher\parseOption(), and TYPO3\CMS\Form\Domain\Finishers\RedirectFinisher\redirect().

redirect()

TYPO3\CMS\Form\Domain\Finishers\RedirectFinisher::redirect ( int  $pageUid, string  $additionalParameters, string  $fragment, int  $statusCode  )

protected

Redirects the request to another page.

Redirect will be sent to the client which then performs another request to the new URI.

NOTE: This method only supports web requests and will thrown an exception if used with other request types.

Parameters

int	$pageUid	‪Target page uid. If NULL, the current page uid is used
string	$additionalParameters
int	$statusCode	‪(optional) The HTTP status code for the redirect. Default is "303 See Other

See also

‪forward()

Definition at line 71 of file RedirectFinisher.php.

References TYPO3\CMS\Redirects\Message\$statusCode, TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher\getTypoScriptFrontendController(), and TYPO3\CMS\Form\Domain\Finishers\RedirectFinisher\redirectToUri().

Referenced by TYPO3\CMS\Form\Domain\Finishers\RedirectFinisher\executeInternal().

redirectToUri()

TYPO3\CMS\Form\Domain\Finishers\RedirectFinisher::redirectToUri ( string  $uri, int  $statusCode = 303  )

protected

Redirects the web request to another uri.

NOTE: This method only supports web requests and will thrown an exception if used with other request types.

Parameters

string	$uri	‪A string representation of a URI
int	$statusCode	‪(optional) The HTTP status code for the redirect. Default is "303 See Other

Exceptions

PropagateResponseException

Definition at line 91 of file RedirectFinisher.php.

References TYPO3\CMS\Redirects\Message\$statusCode, and TYPO3\CMS\Form\Domain\Finishers\RedirectFinisher\addBaseUriIfNecessary().

Referenced by TYPO3\CMS\Form\Domain\Finishers\RedirectFinisher\redirect().

Member Data Documentation

$defaultOptions

array TYPO3\CMS\Form\Domain\Finishers\RedirectFinisher::$defaultOptions

protected

Initial value:

= array( 
        'pageUid' => 1,
        'additionalParameters' => '',
        'statusCode' => 303,
        'fragment' => '',
     )

Definition at line 33 of file RedirectFinisher.php.