Returns the return value of the controller
| public getControllerResult ( ) : mixed | ||
| return | mixed | The controller return value |
/**
* @param GetResponseForControllerResultEvent $event
*/
public function onControllerView(GetResponseForControllerResultEvent $event)
{
if (!$event->getControllerResult() instanceof XmlRpcResponse) {
return;
}
$event->setResponse($this->responseGenerator->fromXmlRpcResponse($event->getControllerResult()));
}
/**
* @param GetResponseForControllerResultEvent $event
*/
public function postController(GetResponseForControllerResultEvent $event)
{
if ($this->viewModelService->getViewModel()->getTemplate() === null) {
return;
}
if (is_array($event->getControllerResult())) {
$this->viewModelService->set($event->getControllerResult());
}
if (!$event->hasResponse()) {
$event->setResponse($this->viewModelService->render());
}
}
public function onKernelView(GetResponseForControllerResultEvent $event)
{
$request = $event->getRequest();
if (!$request->attributes->has('_rest') || $event->getControllerResult() instanceof Response) {
return;
}
$config = $this->normalizeConfig($request->attributes->get('_rest', array(), true));
$includes = $request->query->get('include', null);
$data = $event->getControllerResult();
$transformedData = $this->transformResult($config, $data, $includes, $request);
$event->setControllerResult($transformedData);
}
/**
* Perform standard rendering. This event only fires if the previous (REQUEST) event did not generate a response.
*
* @param \Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent $event
*/
public function onKernelView(GetResponseForControllerResultEvent $event)
{
LoggerRegistry::debug('EngineRendererListener performing render() on VIEW event');
$request = $event->getRequest();
$path = explode(':', $request->attributes->get('_route'));
// Set the module attribute.
$request->attributes->set('_module', $path[0]);
// Use either the controller result or the 'natural' name of the view based on the route specifier.
$request->attributes->set('_view', is_null($event->getControllerResult()) ? $path[1] : $event->getControllerResult());
// Let the engine render the response and add instrumentation headers; set back to the event.
$response = $this->getEngine()->renderPage($request);
$event->setResponse($this->getEngine()->instrumentResponse($response));
}
public function onKernelView(GetResponseForControllerResultEvent $event)
{
if (!$this->enabled) {
return;
}
$response = $event->getControllerResult();
if ($response !== null) {
return;
}
$request = $event->getRequest();
$routeName = $request->attributes->get('_route');
if (!($route = $this->routes->get($routeName))) {
return;
}
if (!($args = $route->getOption('_redirect'))) {
return;
}
$uri = isset($args['uri']) ? $args['uri'] : null;
if (isset($args['callable'])) {
$arguments = $this->resolver->getArguments($request, $args['callable']);
$resolved = call_user_func_array($args['callable'], $arguments);
if (null == $uri) {
$uri = $resolved;
} else {
if (null === $this->urlGenerator) {
throw new \InvalidArgumentException("The UrlGeneratorServiceProvider must be registered to use named routes");
}
$uri = $this->urlGenerator->generate($uri, $resolved);
}
}
if (!is_string($uri)) {
throw new \InvalidArgumentException("Could not resolve uri for redirect");
}
$event->setResponse(new RedirectResponse($uri));
}
/**
* @param GetResponseForControllerResultEvent $event
*/
protected function decorateView(GetResponseForControllerResultEvent $event)
{
$params = $event->getRequest()->attributes;
array_walk($this->decorators, function (DecoratorInterface $decorator) use($event, $params) {
$event->setControllerResult($decorator->decorate($params, $event->getControllerResult()));
});
}
/**
* Renders the layout and initializes the content of a new response object
* with the rendered layout.
*
* @param GetResponseForControllerResultEvent $event
*
* @throws LogicException if @Layout annotation is used in incorrect way
*/
public function onKernelView(GetResponseForControllerResultEvent $event)
{
$request = $event->getRequest();
/** @var LayoutAnnotation|null $layoutAnnotation */
$layoutAnnotation = $request->attributes->get('_layout');
if (!$layoutAnnotation) {
return;
}
if ($request->attributes->get('_template')) {
throw new LogicException('The @Template() annotation cannot be used together with the @Layout() annotation.');
}
$parameters = $event->getControllerResult();
if (is_array($parameters)) {
$context = new LayoutContext();
foreach ($parameters as $key => $value) {
$context->set($key, $value);
}
$this->configureContext($context, $layoutAnnotation);
$layout = $this->getLayout($context, $layoutAnnotation);
} elseif ($parameters instanceof ContextInterface) {
$this->configureContext($parameters, $layoutAnnotation);
$layout = $this->getLayout($parameters, $layoutAnnotation);
} elseif ($parameters instanceof Layout) {
if (!$layoutAnnotation->isEmpty()) {
throw new LogicException('The empty @Layout() annotation must be used when ' . 'the controller returns an instance of "Oro\\Component\\Layout\\Layout".');
}
$layout = $parameters;
} else {
return;
}
$response = new Response();
$response->setContent($layout->render());
$event->setResponse($response);
}
/**
* Converts a PSR-7 response to a Symfony response.
*
* @param \Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent $event
* The Event to process.
*/
public function onKernelView(GetResponseForControllerResultEvent $event)
{
$controller_result = $event->getControllerResult();
if ($controller_result instanceof ResponseInterface) {
$event->setResponse($this->httpFoundationFactory->createResponse($controller_result));
}
}
/**
* Persists, updates or delete data return by the controller if applicable.
*
* @param GetResponseForControllerResultEvent $event
*
* @return mixed
*/
public function onKernelView(GetResponseForControllerResultEvent $event)
{
if (!$event->isMasterRequest()) {
return;
}
$request = $event->getRequest();
if (!in_array($request->getMethod(), [Request::METHOD_POST, Request::METHOD_PUT, Request::METHOD_DELETE])) {
return;
}
$resourceType = $request->attributes->get('_resource_type');
if (!$resourceType) {
return;
}
$controllerResult = $event->getControllerResult();
if (null === ($objectManager = $this->getManager($resourceType, $controllerResult))) {
return $controllerResult;
}
switch ($request->getMethod()) {
case Request::METHOD_POST:
$objectManager->persist($controllerResult);
break;
case Request::METHOD_DELETE:
$objectManager->remove($controllerResult);
$event->setControllerResult(null);
break;
}
$objectManager->flush();
}
public function onView(GetResponseForControllerResultEvent $event)
{
$response = $event->getControllerResult();
if (is_string($response)) {
$event->setResponse(new Response($response));
}
}
/**
* Persists, updates or delete data return by the controller if applicable.
*
* @param GetResponseForControllerResultEvent $event
*
* @return mixed
*/
public function onKernelView(GetResponseForControllerResultEvent $event)
{
$request = $event->getRequest();
if ($request->isMethodSafe()) {
return;
}
$resourceClass = $request->attributes->get('_api_resource_class');
if (null === $resourceClass) {
return;
}
$controllerResult = $event->getControllerResult();
if (null === ($objectManager = $this->getManager($resourceClass, $controllerResult))) {
return;
}
switch ($request->getMethod()) {
case Request::METHOD_POST:
$objectManager->persist($controllerResult);
break;
case Request::METHOD_DELETE:
$objectManager->remove($controllerResult);
$event->setControllerResult(null);
break;
}
$objectManager->flush();
}
/**
* In an API context, converts any data to a JSON-LD response.
*
* @param GetResponseForControllerResultEvent $event
*
* @return JsonLdResponse|mixed
*/
public function onKernelView(GetResponseForControllerResultEvent $event)
{
$controllerResult = $event->getControllerResult();
if ($controllerResult instanceof Response) {
return;
}
$request = $event->getRequest();
$format = $request->attributes->get('_api_format');
if (self::FORMAT !== $format) {
return;
}
switch ($request->getMethod()) {
case Request::METHOD_POST:
$status = 201;
break;
case Request::METHOD_DELETE:
$status = 204;
break;
default:
$status = 200;
break;
}
$resourceType = $request->attributes->get('_resource_type');
$response = new JsonLdResponse($resourceType ? $this->normalizer->normalize($controllerResult, self::FORMAT, $resourceType->getNormalizationContext() + ['request_uri' => $request->getRequestUri()]) : $controllerResult, $status);
$event->setResponse($response);
}
public function onKernelView(GetResponseForControllerResultEvent $event)
{
if (!$event->isMasterRequest()) {
return;
}
$request = $event->getRequest();
if ('json' !== $request->getRequestFormat()) {
return;
}
$result = $event->getControllerResult();
if (null === $result) {
$event->setResponse(new JsonResponse(null, 204));
return;
}
if ($result instanceof Response) {
return;
}
$response = new JsonResponse();
if ($request->isMethod('POST')) {
$response->setStatusCode(201);
}
if (!is_scalar($result)) {
$result = $this->getSerializer()->normalize($result, null, ['groups' => $this->options['serialization_default_groups']]);
}
$response->setData($result);
$event->setResponse($response);
}
/**
* @param GetResponseForControllerResultEvent $event The event to handle
*/
public function onKernelView(GetResponseForControllerResultEvent $event)
{
/**
* Anytime we don't find what we're looking for, return and let other
* listeners handle things
*/
$response = $event->getControllerResult();
if (!is_array($response)) {
return;
}
$request = $event->getRequest();
$routeName = $request->attributes->get('_route');
if (!($route = $this->app['routes']->get($routeName))) {
return;
}
if (!($args = $route->getOption('_view'))) {
return;
}
$template = $args['template'];
$callable = $args['callable'];
if ($callable) {
$response = $callable($response, $request);
}
if ($response instanceof Response) {
$event->setResponse($response);
return;
}
if (null !== $template) {
$output = $this->render($template, $response);
$event->setResponse(new Response($output));
}
}
/**
* @param \Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent $e
*/
public function onKernelView(GetResponseForControllerResultEvent $e)
{
$queryset = $e->getControllerResult();
$routeName = $e->getRequest()->attributes->get('_route');
$route = $this->routes->get($routeName);
if (!$route) {
return;
}
$interface = 'SDispatcher\\Common\\PaginatorInterface';
$paginatorClass = $route->getOption(RouteOptions::PAGINATOR_CLASS);
if (!$paginatorClass || !is_subclass_of($paginatorClass, $interface)) {
return;
}
try {
/* @var \SDispatcher\Common\PaginatorInterface $paginator */
$paginator = new $paginatorClass();
if (!$paginator->supports($queryset)) {
return;
}
list($headers, $data) = $paginator->paginate($e->getRequest(), $queryset, 0, $route->getOption(RouteOptions::PAGE_LIMIT), $route->getOption(RouteOptions::PAGINATED_META_CONTAINER_NAME), $route->getOption(RouteOptions::PAGINATED_DATA_CONTAINER_NAME));
} catch (\Exception $ex) {
list($headers, $data) = array(array(), array());
}
$response = new DataResponse($data);
$response->headers->add($headers);
$e->setResponse($response);
}
/**
* Renders the template and initializes a new response object with the
* rendered template content.
*
* @param GetResponseForControllerResultEvent $event
*/
public function onKernelView(GetResponseForControllerResultEvent $event)
{
/* @var Template $template */
$request = $event->getRequest();
$template = $request->attributes->get('_template');
if (null === $template) {
return;
}
$parameters = $event->getControllerResult();
$owner = $template->getOwner();
list($controller, $action) = $owner;
// when the annotation declares no default vars and the action returns
// null, all action method arguments are used as default vars
if (null === $parameters) {
$parameters = $this->resolveDefaultParameters($request, $template, $controller, $action);
}
// attempt to render the actual response
$templating = $this->container->get('templating');
if ($template->isStreamable()) {
$callback = function () use($templating, $template, $parameters) {
return $templating->stream($template->getTemplate(), $parameters);
};
$event->setResponse(new StreamedResponse($callback));
}
// make sure the owner (controller+dependencies) is not cached or stored elsewhere
$template->setOwner(array());
$event->setResponse($templating->renderResponse($template->getTemplate(), $parameters));
}
/**
* In an API context, converts any data to a XML response.
*
* @param GetResponseForControllerResultEvent $event
*
* @return Response|mixed
*/
public function onKernelView(GetResponseForControllerResultEvent $event)
{
$controllerResult = $event->getControllerResult();
if ($controllerResult instanceof Response) {
return $controllerResult;
}
$request = $event->getRequest();
$format = $request->attributes->get('_api_format');
if (self::FORMAT !== $format) {
return $controllerResult;
}
switch ($request->getMethod()) {
case Request::METHOD_POST:
$status = 201;
break;
case Request::METHOD_DELETE:
$status = 204;
break;
default:
$status = 200;
break;
}
$resourceType = $request->attributes->get('_resource_type');
$response = new Response($this->serializer->serialize($controllerResult, self::FORMAT, $resourceType->getNormalizationContext()), $status, ['Content-Type' => 'application/xml']);
$event->setResponse($response);
}
public function onKernelView(GetResponseForControllerResultEvent $event)
{
$request = $event->getRequest();
$templating = $this->templating;
$parameters = $event->getControllerResult();
if (null === $parameters) {
if (!($vars = $request->attributes->get('_template_vars'))) {
if (!($vars = $request->attributes->get('_template_default_vars'))) {
return;
}
}
$parameters = array();
foreach ($vars as $var) {
$parameters[$var] = $request->attributes->get($var);
}
}
$routeParams = $request->attributes->get('_route_params');
// get injected layout entity from annotation and add it to the paramaters
if (isset($routeParams['rootLayout'])) {
$parameters['rootLayout'] = $routeParams['rootLayout'];
}
if (!($template = $request->attributes->get('_template'))) {
return $parameters;
}
// wrap all parameters in params array
$parameters['params'] = $parameters;
if (!$request->attributes->get('_template_streamable')) {
$event->setResponse($templating->renderResponse($template, $parameters));
} else {
$callback = function () use($templating, $template, $parameters) {
return $templating->stream($template, $parameters);
};
$event->setResponse(new StreamedResponse($callback));
}
}
public function onKernelView(GetResponseForControllerResultEvent $event)
{
$response = $event->getControllerResult();
if (null !== ($response = $this->view->render($response))) {
$event->setResponse($response);
}
}
/**
* Renders the template and initializes a new response object with the
* rendered template content.
*
* @param GetResponseForControllerResultEvent $event A GetResponseForControllerResultEvent instance
*/
public function onCoreView(GetResponseForControllerResultEvent $event)
{
$request = $event->getRequest();
$parameters = $event->getControllerResult();
if (null === $parameters) {
if (!$vars = $request->attributes->get('_tal_vars')) {
if (!$vars = $request->attributes->get('_tal_default_vars')) {
return;
}
}
$parameters = array();
foreach ($vars as $var) {
$parameters[$var] = $request->attributes->get($var);
}
}
if (!is_array($parameters)) {
return $parameters;
}
if (!$template = $request->attributes->get('_tal')) {
return $parameters;
}
$event->setResponse(new Response($this->container->get('templating')->render($template, $parameters)));
}
/**
* Handles string responses.
*
* @param GetResponseForControllerResultEvent $event
*/
public function onKernelView(GetResponseForControllerResultEvent $event)
{
$result = $event->getControllerResult();
if (!(null === $result || is_array($result) || $result instanceof Response || is_object($result) && !method_exists($result, '__toString'))) {
$event->setResponse(new Response((string) $result));
}
}
/**
* Transform data from controller to json.
*
* @param GetResponseForControllerResultEvent $event
*/
public function onView(GetResponseForControllerResultEvent $event)
{
$controllerResult = $event->getControllerResult();
$response = new JsonResponse();
$response->setJsonData($this->serializer->serialize($controllerResult, 'json'));
$event->setResponse($response);
}
/**
* Validates data returned by the controller if applicable.
*
* @param GetResponseForControllerResultEvent $event
*
* @throws ValidationException
*/
public function onKernelView(GetResponseForControllerResultEvent $event)
{
$request = $event->getRequest();
try {
$attributes = RequestAttributesExtractor::extractAttributes($request);
} catch (RuntimeException $e) {
return;
}
if ($request->isMethodSafe() || $request->isMethod(Request::METHOD_DELETE)) {
return;
}
$data = $event->getControllerResult();
$resourceMetadata = $this->resourceMetadataFactory->create($attributes['resource_class']);
if (isset($attributes['collection_operation_name'])) {
$validationGroups = $resourceMetadata->getCollectionOperationAttribute($attributes['collection_operation_name'], 'validation_groups');
} else {
$validationGroups = $resourceMetadata->getItemOperationAttribute($attributes['item_operation_name'], 'validation_groups');
}
if (!$validationGroups) {
// Fallback to the resource
$validationGroups = $resourceMetadata->getAttributes()['validation_groups'] ?? null;
}
if (is_callable($validationGroups)) {
$validationGroups = call_user_func_array($validationGroups, [$data]);
}
$violations = $this->validator->validate($data, null, $validationGroups);
if (0 !== count($violations)) {
throw new ValidationException($violations);
}
}
/**
* @param GetResponseForControllerResultEvent $event
*/
public function serializeResponse(GetResponseForControllerResultEvent $event)
{
if ($this->doSerialize) {
$data = $event->getControllerResult();
$apiResponse = new ApiResponse(200, $data);
$data = array_merge($apiResponse->toArray(), $this->data->all());
$data = array_filter($data);
if (!isset($data['data'])) {
$data['data'] = [];
}
$context = new SerializationContext();
$context->setSerializeNull(true);
if (method_exists($context, 'enableMaxDepthChecks')) {
$context->enableMaxDepthChecks();
}
if ($action = $this->getAction($event)) {
$context->setGroups($action->getSerializationGroups());
}
if ($fields = $event->getRequest()->query->get('fields')) {
$context->addExclusionStrategy(new FieldsListExclusionStrategy($fields));
}
$json = $this->serializer->serialize($data, 'json', $context);
$response = new Response($json, 200, ['Content-Type' => 'application/json']);
$event->setResponse($response);
$event->stopPropagation();
}
}
/**
* Dumps the statstable
* @param GetResponseForControllerResultEvent $event
* @throws \RuntimeException
*/
public function onKernelView(GetResponseForControllerResultEvent $event)
{
$configuration = $event->getRequest()->attributes->get('_statstable');
if (!$configuration instanceof Configuration\StatsTableResult) {
return;
}
$types = $this->getTypes();
$format = $configuration->getFormat();
$formatConfiguration = array();
foreach ($types as $type) {
if (in_array($format, $type['formats'])) {
$formatConfiguration = $type;
break;
}
}
if (0 === count($formatConfiguration)) {
throw new \RuntimeException('Invalid format : "' . $format . '" given.');
}
$statsTable = $event->getControllerResult();
if (!$statsTable instanceof \IgraalOSL\StatsTable\StatsTable) {
throw new \RuntimeException('Controller result must be an instance of \\IgraalOSL\\StatsTable\\StatsTable');
}
$response = $event->getResponse();
if (!$response) {
$response = new Response();
}
$event->setResponse($response);
/** @var \IgraalOSB\StatsTable\Dumper\DumperInterface $dumper */
$dumper = new $formatConfiguration['class']();
$stResponse = new StatsTableResponse($statsTable, $dumper);
$response->headers->set('Content-type', $stResponse->headers->get('content-type'));
$response->setContent($stResponse->getContent());
unset($stResponse);
}
public function onKernelView(GetResponseForControllerResultEvent $event)
{
$response = $event->getControllerResult();
if (!$response instanceof Response) {
$event->setResponse(new Response($response));
}
}
/**
* Renders an HtmlPage object to a Response.
*
* @param \Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent $event
* The Event to process.
*/
public function onHtmlPage(GetResponseForControllerResultEvent $event)
{
$page = $event->getControllerResult();
if ($page instanceof HtmlPage) {
// In case renderPage() returns NULL due to an error cast it to a string
// so as to not cause issues with Response. This also allows renderPage
// to return an object implementing __toString(), but that is not
// recommended.
$response = new Response((string) $this->pageRenderer->render($page), $page->getStatusCode());
if ($tags = $page->getCacheTags()) {
$response->headers->set('X-Drupal-Cache-Tags', static::convertCacheTagsToHeader($tags));
}
if ($keys = $page->getCacheKeys()) {
$response->headers->set('cache_keys', serialize($keys));
}
if ($bin = $page->getCacheBin()) {
$response->headers->set('cache_bin', $bin);
}
if ($max_age = $page->getCacheMaxAge()) {
$response->headers->set('cache_max_age', $max_age);
}
// Set the generator in the HTTP header.
list($version) = explode('.', \Drupal::VERSION, 2);
$response->headers->set('X-Generator', 'Drupal ' . $version . ' (http://drupal.org)');
$event->setResponse($response);
}
}
public function onKernelView(GetResponseForControllerResultEvent $event)
{
$hal = $event->getControllerResult();
if ($hal instanceof Hal) {
$event->setResponse(new HalResponse($hal, 200, [], $this->prettyPrint));
}
}
/**
* Renders the template and initializes a new response object with the
* rendered template content.
*
* @param GetResponseForControllerResultEvent $event A GetResponseForControllerResultEvent instance
*/
public function onKernelView(GetResponseForControllerResultEvent $event)
{
$request = $event->getRequest();
$parameters = $event->getControllerResult();
if (null === $parameters) {
if (!($vars = $request->attributes->get('_template_vars'))) {
if (!($vars = $request->attributes->get('_template_default_vars'))) {
return;
}
}
$parameters = array();
foreach ($vars as $var) {
$parameters[$var] = $request->attributes->get($var);
}
}
if (!is_array($parameters)) {
return $parameters;
}
if (!($template = $request->attributes->get('_template'))) {
return $parameters;
}
$templating = $this->container->get('templating');
if (!$request->attributes->get('_template_streamable')) {
$event->setResponse($templating->renderResponse($template, $parameters));
} else {
$callback = function () use($templating, $template, $parameters) {
return $templating->stream($template, $parameters);
};
$event->setResponse(new StreamedResponse($callback));
}
}
public function onKernelView(GetResponseForControllerResultEvent $event)
{
$response = $event->getResponse();
if ($response && $response->headers->get('Content-type') == 'application/json') {
return;
}
$controllerResult = $event->getControllerResult();
$response = new Response();
$response->setStatusCode(200);
$response->headers->add(array('Content-type' => 'application/json'));
list($controllerObject, $controllerMethod) = explode('::', $event->getRequest()->get('_controller'));
$method = new \ReflectionMethod($controllerObject, $controllerMethod);
$annotations = $this->reader->getMethodAnnotations($method);
$full = false;
foreach ($annotations as $annotation) {
if ($annotation instanceof \Hyper\AdsBundle\Api\Json) {
$full = $annotation->full;
}
}
if (is_object($controllerResult)) {
$content = json_encode($this->serializer->toJson($controllerResult, $full));
} elseif (is_array($controllerResult) && !empty($controllerResult) && is_object(current($controllerResult))) {
$content = json_encode($this->serializer->toJsonArray($controllerResult));
} else {
$content = json_encode($controllerResult);
}
$response->setContent($content);
$event->setResponse($response);
}
