Zend 3 - Change template basepath

Question

I am just starting to migrate some of my applications from Zend#1 to Zend#3. All is working fine, but regarding the views I've some trouble understanding the underlying concept.

As the tutorials suggest my project layout is like this:

module
  Application
    view
      application
        index
          main.phtml
          foo.phtml
        baz
          index.phtml

I'm wondering why you need to dublicate the "application" folder inside the view directory - you are already in the directory hirachy of the module. Is there a way to change the search path for the default template resolver so that the module name is omited? Just relying on the viewManager's "template_path_stack" is not working. Do I really need to write a custom resolver here?

Thanks a lot!

PS. Nope, I do not want to use custom template maps here ;-) I want to understand and use the default revolver without template maps, if possible.

score 1 · Answer 1 · answered May 07 '18 at 20:59

Found one possible solution!

In your module's config add this one to the view_manager::

'controller_map' => [
    'Dashboard\Controller\DashboardController' => 'Dashboard'
],

Instead of looking for a template called "Dashboard/view/dashboard/[controller]/[action].phtml" the framework will now look for "Dashboard/view/[controller]/[action].phtml". Basically you are telling Zend to use some kind of shorthand here and strip the array's value from the template resolution (have a look at InjectTemplateListener::mapController())

Anyways... a better solution and explanation is welcome!

jcropp · Accepted Answer · 2018-05-10T22:02:53.870

"Application" is the name of a module in your overall 'application.' At the start, "Application" is the only module, but it is common to add other modules: you might have a module for "Clients" and another module for "Vendors." The hierarchy of the view folders follows the same hierarchy as ModuleName:ControllerName:ActionName, and ZF needs to use the module name in the view folders hierarchy in case you happen to have identical controller and action name pairs in two or more modules. It is likely that a "Clients" module and a "Vendors" module will both have an "index" action. It is less likely that the two would have identical controller names but it's not completely out of the question. If you had a controller named "Contacts" in both a "Clients" module and a "Vendors" module, "contacts/index" isn't enough information to tell ZF which view to use. It needs the module name in the folder hierarchy to distinguish between "clients/contacts/index" and "vendors/contacts/index".

UPDATE

Something to wrap your head around is that ZF3 takes things like router definitions, view folders and who knows what else from all of your different modules and aggregates them into a single structure. In other words,

module
  Application
    view
      application
        add
          add.phtml          
        delete
          delete.phtml          
        edit
          edit.phtml          
        index
          index.phtml          

module
  Clients
    view
      clients
        add-client
          add.phtml          
        delete-client
          delete.phtml          
        edit-client
          edit.phtml          
        client-index
          index.phtml          

module
  Vendors
    view
      vendors
        add-vendor
          add.phtml          
        delete-vendor
          delete.phtml          
        edit-vendor
          edit.phtml          
        vendor-index
          index.phtml

gets recognized somewhat like this:

module
  ....
    view
      application
        add
          add.phtml          
        delete
          delete.phtml          
        edit
          edit.phtml          
        index
          index.phtml          
      clients
        add-client
          add.phtml          
        delete-client
          delete.phtml          
        edit-client
          edit.phtml          
        client-index
          index.phtml          
      vendors
        add-vendor
          add.phtml          
        delete-vendor
          delete.phtml          
        edit-vendor
          edit.phtml          
        vendor-index
          index.phtml

and you could probably put all of your view files into a single module if you wanted to.

Perhaps this helps explain why a folder with the module name is included beneath the "view" folder. The folder with the module name that is above the "view" folder has a storage function. The folders with module names below the "view" folder serve as a means of referencing which modules the view files are associated with in the aggregated definition.

I see - thx a lot! The definition of a "module" was kind of different back in ZF1. Is there an other way of having my code in "submodules" like "module\Website\Admin\Controller\UsersController" and the according view script in "module\Website\Admin\View\users\list.phtml" than doing vodoo with the controller_map or writing myself a resolver? — Sven, May 09 '18 at 20:08
... or "module\Website\Reporting\Controller\FooController" ... or "module\Website\Cms\Controller\FooController" ... or "module\Api\Admin\Controller\FooController" you get the idea ;-) — Sven, May 09 '18 at 20:21
I imagine it's possible to devise a way of organizing your code in a different hierarchy than what ZF3 recommends, but it seems like that would take more time for you to create than the time it takes to create what seems like an extra folder in the view directory. — jcropp, May 10 '18 at 21:25

Zend 3 - Change template basepath

2 Answers2

UPDATE