Returns the package key of the specified controller.
| public getControllerPackageKey ( ) : string | ||
| return | string | The package key |
/**
* Creates an URI used for linking to an Controller action.
*
* @param string $actionName Name of the action to be called
* @param array $controllerArguments Additional query parameters. Will be merged with $this->arguments.
* @param string $controllerName Name of the target controller. If not set, current ControllerName is used.
* @param string $packageKey Name of the target package. If not set, current Package is used.
* @param string $subPackageKey Name of the target SubPackage. If not set, current SubPackage is used.
* @return string the rendered URI
* @api
* @see build()
* @throws Exception\MissingActionNameException if $actionName parameter is empty
*/
public function uriFor($actionName, $controllerArguments = [], $controllerName = null, $packageKey = null, $subPackageKey = null)
{
if ($actionName === null || $actionName === '') {
throw new Exception\MissingActionNameException('The URI Builder could not build a URI linking to an action controller because no action name was specified. Please check the stack trace to see which code or template was requesting the link and check the arguments passed to the URI Builder.', 1354629891);
}
$controllerArguments['@action'] = strtolower($actionName);
if ($controllerName !== null) {
$controllerArguments['@controller'] = strtolower($controllerName);
} else {
$controllerArguments['@controller'] = strtolower($this->request->getControllerName());
}
if ($packageKey === null && $subPackageKey === null) {
$subPackageKey = $this->request->getControllerSubpackageKey();
}
if ($packageKey === null) {
$packageKey = $this->request->getControllerPackageKey();
}
$controllerArguments['@package'] = strtolower($packageKey);
if ($subPackageKey !== null) {
$controllerArguments['@subpackage'] = strtolower($subPackageKey);
}
if ($this->format !== null && $this->format !== '') {
$controllerArguments['@format'] = $this->format;
}
$controllerArguments = $this->addNamespaceToArguments($controllerArguments, $this->request);
return $this->build($controllerArguments);
}
/**
* @test
*/
public function setControllerPackageKeyWithLowercasePackageKeyResolvesCorrectly()
{
$mockPackageManager = $this->createMock(PackageManager::class);
$mockPackageManager->expects($this->any())->method('getCaseSensitivePackageKey')->with('acme.testpackage')->will($this->returnValue('Acme.Testpackage'));
$this->inject($this->actionRequest, 'packageManager', $mockPackageManager);
$this->actionRequest->setControllerPackageKey('acme.testpackage');
$this->assertEquals('Acme.Testpackage', $this->actionRequest->getControllerPackageKey());
}
/**
* Redirects the request to another action and / or controller.
*
* 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 throw an exception
* if used with other request types.
*
* @param ActionRequest $request The request to redirect to
* @param integer $delay (optional) The delay in seconds. Default is no delay.
* @param integer $statusCode (optional) The HTTP status code for the redirect. Default is "303 See Other"
* @return void
* @throws StopActionException
* @see forwardToRequest()
* @api
*/
protected function redirectToRequest(ActionRequest $request, $delay = 0, $statusCode = 303)
{
$packageKey = $request->getControllerPackageKey();
$subpackageKey = $request->getControllerSubpackageKey();
if ($subpackageKey !== null) {
$packageKey .= '\\' . $subpackageKey;
}
$this->redirect($request->getControllerActionName(), $request->getControllerName(), $packageKey, $request->getArguments(), $delay, $statusCode, $request->getFormat());
}