Automatic convention-based routing within a module in Zend Framework 2--possible?

Question

I'm trying to understand all the configuration necessary to get my routing working in Zend Framework 2, and I can't help but wonder if I am making this more complicated than necessary.

I am working on a simple app that will follow a very simple convention:

/:module/:controller/:action

I've already created and wired up my module, "svc" (short for "service)". I then created a second controller, the "ClientsController", and I can't get the routing to pass through my requests to, e.g., /svc/clients/list to ClientsController::listAction().

As I'm wading through hundreds of lines of configuration, in deeply nested arrays, I'm thinking--isn't there some way to just have a default mapping of my URLs to /:module/:controller/:action ?

Thanks for any assistance. I'm going off of the Zend Framework 2 Quick Start, which walked me through creating a new module and then adding a controller to that module. But when I tried to add second controller to that module, I am tripping over the routing.

Update: I didn't catch this the first time through, but apparently this is supposed to be a feature of the Zend Framework Skeleton app. From the quick start guide:

ZendSkeletonApplication ships with a “default route” that will likely get you to this action. That route basically expects “/{module}/{controller}/{action}”, which allows you to specify this: “/zend-user/hello/world”

That's exactly what I want! But I can't get it to work.

It lists an incomplete module.config.php, with a comment at the bottom about putting "other configuration" here. I tried to figure out what that "other configuration" is, and wound up with this:

return array(
    'svc' => array(
        'type'    => 'Literal',
        'options' => array(
            'route'    => '/svc',
            'defaults' => array(
                'controller'    => 'svc\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(
                    ),
                ),
            ),
        ),
    ),
    'controllers' => array(
        'invokables' => array(
            'svc\Controller\Clients' => 'svc\Controller\ClientsController',
        ),
    ),

    'view_manager' => array(
        'template_path_stack' => array(
            'album' => __DIR__ . '/../view',
        ),
    ),
);

JFYI, here is what my controller looks like.

namespace svc\Controller;

use Zend\Mvc\Controller\AbstractActionController;
use Zend\View\Model\ViewModel;

class ClientsController extends AbstractActionController {

    public function indexAction() {
        return new ViewModel();
    }

    public function anotherAction(){

        return new ViewModel();
    }
}

My routes are not working. I get "route not found" when I try to pull up any of my routes.

iirc you forgot to add the default '__NAMESPACE__' => 'svc\Controller' edit: but route not found is weird, what URL are you calling? — Sam
– Sam, Commented May 22, 2013 at 6:31
I added 'NAMESPACE' => 'svc\Controller' and there's no change. I've tried the following URLs: zf-sample.localhost/svc/clients/index, zf-sample.localhost/clients/index, zf-sample.localhost/svc/clients/another, zf-sample.localhost/clients/another. All give "The requested URL could not be matched by routing." — Josh
– Josh, Commented May 22, 2013 at 11:05

Crisp · Accepted Answer · 2013-05-22 13:58:36Z

0

It lists an incomplete module.config.php, with a comment at the bottom about putting "other configuration" here. I tried to figure out what that "other configuration" is, and wound up with this:

If your module.config.php really looks like that then it won't work, routes is an array of routes defined in the router key, your config contains no such spec, try replacing it with this

return array(
    // routes
    'router' => array(
        'routes' => array(
            'svc' => array(
                'type'    => 'Literal',
                'options' => array(
                    'route'    => '/svc',
                    'defaults' => array(
                        'controller'    => 'svc\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(
                                 // add the default namespace for :controllers in this route
                                 '__NAMESPACE__' => 'svc\Controller',
                            ),
                        ),
                    ),
                ),
            ),
        ),
    ),    
    'controllers' => array(
        'invokables' => array(
            'svc\Controller\Clients' => 'svc\Controller\ClientsController',
        ),
    ),

    'view_manager' => array(
        'template_path_stack' => array(
            'album' => __DIR__ . '/../view',
        ),
    ),
);

edited May 22, 2013 at 13:58

answered May 22, 2013 at 12:22

Crisp

11.4k3 gold badges40 silver badges42 bronze badges

Sign up to request clarification or add additional context in comments.

8 Comments

Josh Over a year ago

So I tried that and now I get: "clients(resolves to invalid controller class or alias: clients)". This is at the URL zf-sample.localhost/svc/clients/another. So apparently I need to somehow alias "clients" to my controller class... right? But how do I do that?

Josh Over a year ago

Ok, so I changed this 'controllers' => array( 'invokables' => array( 'svc\Controller\Clients' => 'svc\Controller\ClientsController', ), ), to this: 'controllers' => array( 'invokables' => array( 'clients' => 'svc\Controller\ClientsController', ), ), And that seemed to do the trick. Is that right? Other than that change, I've got exactly what you posted.

Crisp Over a year ago

no, as @Sam pointed out earlier, you'll need to add the __NAMESPACE__ to your route config, see my edit.

Crisp Over a year ago

Yes, that would be another way to do it. Doing it that way, if you ever have another module that also defines a Clients controller in the same manner, one of them will disappear when configs are merged. May not be an issue for your app, but something to keep in mind

Josh Over a year ago

Great, thanks! It's working now. Clarifying question: I see you put child_routes at $returnedArray['router']['routes']['svc']['child_routes']. The Quick Start has child_routes at $returnedArray['svc']['childroutes']. Why the difference? It makes sense to my that child_routes would be a child of routes, so why would the quick start put it as a child of svc (and a sibling of routes)? Here's the quick start link again: framework.zend.com/manual/2.0/en/modules/…

|

Collectives™ on Stack Overflow

Automatic convention-based routing within a module in Zend Framework 2--possible?

1 Answer 1

8 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

8 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related