ZF2 routing in links not working correctly - php

Question

I'm working on a Zend Framework 2 application for work in which I can't seem to route correctly or know where to route it.
I have an Hostname => webapp.foo-bar.com. We decided to add a Subhost => /app/ to the end and the name of this app is called => app. I have a link on a page which it's route would be say => /graph/page-name. But when I hover over the link which looks like:
FooBar
I'd get webapp.foo-bar.com/graph/page-name as opposed to webapp.foo-bar.com/app/graph/page-name.
My Application config is:
<?php
/**
* Zend Framework (http://framework.zend.com/)
*
* #link http://github.com/zendframework/ZendSkeletonApplication for the canonical source repository
* #copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
* #license http://framework.zend.com/license/new-bsd New BSD License
*/
return array(
'router' => array(
'routes' => array(
'home' => array(
'type' => 'hostname',
'options' => array(
'route' => 'webapp.foo-bar.com/app',
'defaults' => array(
'__NAMESPACE__' => 'Application\Controller',
'controller' => 'Index',
'action' => 'index',
),
),
),
// The following is a route to simplify getting started creating
// new controllers and actions without needing to create a new
// module. Simply drop new controllers in, and you can access them
// using the path /application/:controller/:action
'application' => array(
'type' => 'Literal',
'options' => array(
'route' => '/application',
'defaults' => array(
'__NAMESPACE__' => 'Application\Controller',
'controller' => 'Index',
'action' => 'index',
),
),
'may_terminate' => true,
'child_routes' => array(
'default' => array(
'type' => 'Segment',
'options' => array(
'route' => '/[:controller[/:action]]',
'constraints' => array(
'controller' => '[a-zA-Z][a-zA-Z0-9_-]*',
'action' => '[a-zA-Z][a-zA-Z0-9_-]*',
),
'defaults' => array(
),
),
),
),
),
),
),
'service_manager' => array(
'abstract_factories' => array(
'Zend\Cache\Service\StorageCacheAbstractServiceFactory',
'Zend\Log\LoggerAbstractServiceFactory',
),
'aliases' => array(
'translator' => 'MvcTranslator',
),
),
'translator' => array(
'locale' => 'en_US',
'translation_file_patterns' => array(
array(
'type' => 'gettext',
'base_dir' => __DIR__ . '/../language',
'pattern' => '%s.mo',
),
),
),
'controllers' => array(
'invokables' => array(
'Application\Controller\Index' => 'Application\Controller\IndexController'
),
),
'view_manager' => array(
'display_not_found_reason' => true,
'display_exceptions' => true,
'doctype' => 'HTML5',
'not_found_template' => 'error/404',
'exception_template' => 'error/index',
'template_map' => array(
'layout/layout' => __DIR__ . '/../view/layout/layout.phtml',
'application/index/index' => __DIR__ . '/../view/application/index/index.phtml',
'error/404' => __DIR__ . '/../view/error/404.phtml',
'error/index' => __DIR__ . '/../view/error/index.phtml',
),
'template_path_stack' => array(
__DIR__ . '/../view',
),
),
// Placeholder for console routes
'console' => array(
'router' => array(
'routes' => array(
),
),
),
);
I saw there is an option like:
FooBar
Would this need to be done on every link, or would we be able to do it in the config level?
Thanks!
Update:
I've managed to get the client to go down using the this->url() method and things are looking fine. Links are working even in the jQuery sections. I am having a small issue in relation to a link going to another controller not showing the action in the link.
<a href="<?php echo $this->url('foo-bar', array('action' => 'bar-foo'))?>?year=2015"</a>
Brings back webapp.foo-bar.com/app/foo-bar?year=2015. I want it to return webapp.foo-bar.com/app/foo-bar/bar-foo?year=2015. Is this a configuration in the Controller of foo-bar or can it be done in this-url()?
Thanks a million for all the help given. Really appriciate it!

Answer 1

If both apps share the same domain, then your configuration is invalid. My version of config file is below.
P.S. I created separate module Sample, so it would not interfere with Application config.
use Zend\Router\Http\Literal;
use Zend\Router\Http\Segment;
use \Sample\Controller\IndexController;
use Zend\ServiceManager\Factory\InvokableFactory;
return [
'router' => [
'routes' => [
'v2' => [
'type' => Segment::class,
'options' => [
'route' => '/v2/app',
'defaults' => [
'controller' => IndexController::class,
'action' => 'index',
],
],
'child_routes' => [
'index' => [
'type' => Literal::class,
'options' => [
'route' => '/',
'defaults' => [
'controller' => IndexController::class,
'action' => 'index',
],
],
],
'application' => [
'type' => Segment::class,
'options' => [
'route' => '[/:action]',
'defaults' => [
'controller' => IndexController::class,
'action' => 'index',
],
],
]
],
],
],
],
'controllers' => [
'factories' => [
IndexController::class => InvokableFactory::class,
],
],
'view_manager' => [
'template_path_stack' => [
__DIR__ . '/../view',
],
],
];
This is how you create links to that application:
<?php echo $this->url("v2/application", ['action' => 'page-name']) ?>

Answer 2

In ZF2 a route maps to a specific controller class and its action or method, so they can be of any modules. This route graph/page-name may map to GraphController and its method pageNameAction(), for example. But that can be any other controller and its actions. This depends on your needs.
Now lets come to the type of a route. There are some route plugins in ZF. These can be used to specify a route's type. For example, Hostname specifies domain name and subdomain like subdomain.domain.tld. But you are using domain.tld/v2/app. Hostname type does not allow / in the 'route' => 'subdomain.domain.tld'. So this will not work, in this case.
You can get this type of endpoints (domain.tld/v2/app) without creating any subdomain that you said in your thread. That is why MVC pattern, Framework is more convenient. You can create a lot of endpoints for different purposes(domain.tld/v1/abc domain.tld/v2/mno domain.tld/v3/xyz etc) in your ZF application. They may be mapped to different controllers and actions from different modules.
So you do not need to be dependent on the subdomains as the way you asked.
You also said that you need domain.tld/graph/page-name which actually works as domain.tld/v2/app/graph/page-name. This means you want to hide this part v2/app from the url if I am not wrong. But this is still a challenge.
If you have it graph/page-name used under this v2/app/graph/page-name you may define your route as follows
// Top key of a route
'v2app' => [
'type' => 'Segment',
'options' => [
'route' => '/v2/app',
'defaults' => [
'__NAMESPACE__' => 'Application\Controller',
'controller' => 'Index',
'action' => 'index',
],
],
'may_terminate' => true,
'child_routes' => [
'default' => [
'type' => 'Segment',
'options' => [
'route' => '/',
'defaults' => [
'controller' => 'Application\Controller\Index',
'action' => 'index',
],
],
],
'graph' => [
'type' => 'Segment',
'options' => [
'route' => '[/:controller/:action]',
'defaults' => [
'controller' => 'Application\Controller\Graph',
'action' => 'pageName',
],
],
],
],
],
You can add this to any route section of any module.config.php by correcting the module name, controller name etc. But keep it mind that same configuration for multiple routes would make you unhappy.
Now to output those routes use the following snippet of code
echo $this->url('v2app/graph', [], [], true);
echo $this->url(null, ['controller' => 'graph', 'action' => 'page-name']);
// outputs
// /v2/app/graph/page-name
while v2app is your top route key and graph is the child route of it.
Now you have said about how you should implement links. If you want to show them as menu, you do not have to code like that you said. You can follow this to implement links as menu. But keep it mind providing value (the top key of a route) for the route key while building an array for the navigation.
The following example from above for this route graph/page-name
[
'label' => 'Graph',
// route name not route pattern
'route' => 'graph', // not /graph/page-name
],
Otherwise if you want to show a link in the body of a page you then use $this->url() helper as used above.
Please refer to this DOC for Hostname type.
If we can not help you here please ask this here

Answer 3

Just create a cutomized ViewModel that will contain own url implementation
/**
* #param \Zend\Mvc\MvcEvent $e The MvcEvent instance
* #return void
*/
public function setLayout($e)
{
// Should return your customization
$viewModel = $e->getViewModel();
In that case all your $this->url() will do directly the same trick as:
$this->url('application/default', array('controller' => 'graph', 'action' => 'page-name')
As a partial example to customize render:
$customStrategy = $app->getServiceManager()->get('{Your class name}');
$view->getEventManager()->attach($customStrategy, 1); // 1 - means priority
Inside your class
preg_replace_callback('/<a href=\\"([^\\"]*)\\">(.*)<\\/a>/iU', function ($matches) {
// do whatever you need for each URL
}, $content);
Or it can be used DOM object (but it's relying on your code validity):
$xpath = new \DOMXPath((new \DOMDocument)->loadHTML($content));
foreach ($xpath->query('//a[href]') as $link) {
// ...
}

Answer 4

There is a way around for this purpose. You may try this one. To do that you need to create a custom route plugin and then set that to route pointing to the Graph controller and its target method pageNameAction(), in this case. Please follow the steps below.
Here graph/page-name would work as v2/app/graph/page-name meaning the following link would work as you expect.
FooBar
Please take the custom route plugin from here. Put it under this src/YourModuleName/Route directory using the namespace YourModuleName\Route.
Notice you need to replace 'template_prefix' => 'yourmodulename', with your own module name with all small letters. View templates will be searched for by matching this patten yourmodulename/controller/action-name behind the scene.
'v2app' => [
'type' => 'Segment',
'options' => [
'route' => '[/v2/app]',
'defaults' => [
'controller' => 'YourModuleName\Controller\Index',
'action' => 'index',
],
],
'may_terminate' => true,
'child_routes' => [
'graph' => [
// We call the custom route plugin thus
'type' => 'YourModuleName\Route\AppRoute',
'options' => [
'dir_name' => __DIR__ . '/../view',
'template_prefix' => 'yourmodulename',
'filename_pattern' => '/[a-z0-9_\-]+/',
'defaults' => [
'controller' => 'YourModuleName\Controller\Graph',
'action' => 'pageName',
],
],
],
],
],
Now format the pageNameAction() as the following
public function pageNameAction()
{
// Get path to view template from route params
$pageTemplate = $this->params()->fromRoute('page', null);
// If path is not valid
if($pageTemplate == null) {
$this->getResponse()->setStatusCode(404);
return;
}
$viewModel = new ViewModel();
// Here we set template to be rendered for `v2/app/graph/page-name`
$viewModel->setTemplate($pageTemplate);
return $viewModel;
}
If you need to output link in the view script use this way
echo $this->serverUrl('/graph/page-name');
Hope this would help you!