Router short syntax and multi-word controller names

Question

Router short syntax and multi-word controller names

Tim Robertson Jun '13

Created Jun '13	Last Reply Dec '17	Replies 5	Views 1168	Votes 1

Tim Robertson 2.4k

Jun '13

The short syntax seems to be incompatible with controller classes containing multiple words.

<?php

class ProductCategoryController {
  function indexAction() { ... }
}

$router->add("/products/categories", "ProductCategory::index");
print $router->getControllerName();

getControllerName() returns an all lowercase controller name and the dispatcher looks for a class called ProductcategoryController. Instead of simply lowercasing wouldn't it make more sense to use snake-case. Then transformation can be reversed and the dispatcher can resolve the controller name properly.

1

Phalcon · Answer 1 · 2013-06-06T13:25:30-07:00

Good point and I agree, can you please open a NFR for this on Github? https://github.com/phalcon/cphalcon

Tim Robertson · Answer 2 · 2013-06-06T14:22:08-07:00

Tim Robertson
2.4k

Jun '13

No problamo https://github.com/phalcon/cphalcon/issues/693

Phalcon · Answer 3 · 2013-06-06T14:30:44-07:00

Phalcon
98.9k

Jun '13

Thanks Tim

Stefan Chiriac · Answer 4 · 2015-03-23T03:41:35-07:00

I know this post is old, but this should also be added in docs since is quite important. It took me 2 hours to find how phalcon is handling multi word controllers. Thanks

Karthik261193 · Answer 5 · 2017-12-05T22:05:57-07:00

Hi @Tim Robertson, I am facing the same issue now. If you have an solution could you please suggest me on this? Thank you

Kevin Yarmak · Answer 6 · 2017-12-05T22:32:45-07:00

@Karthik261193 This could be a file naming issue. On Windows, file names are matched in a case insensitive manner. On other systems, it is case sensitive.
Make sure your controller can be found and loaded when using lowercase. If you change the case, git won't detect the change, the suggestion for that is rename it entirely so git can detect the change, then rename back to fix the case. Also note you need the word "Controller" on the end. Even if the Phalcon error doesn't specify "Controller" on the end, it is required.

Tim's issue was fixed back in Phalcon 1.2.0, four and a half years ago, as per his link to issue 693:
https://github.com/phalcon/cphalcon/issues/693

While snake_case, to the best of my understanding, is still used internally by Phalcon, it should be locating your controller with the same casing as you told the router. Just make sure you define the controller with "Controller" on the end, but don't tell the router it has "Controller" on the end.

In other words:

// e.g. /services/router.php
$router->add("/products/categories", "ProductCategory::index"); // no Controller suffix, no Action suffix

// e.g. /Controllers/ProductCategoryController.php
class ProductCategoryController extends \Phalcon\Mvc\Controller
{
    public function indexAction()
    {
        // do stuff
    }
}