Dashboard
> Proposers
> Home
> Archived
> Controller Subdirectories Proposal - Jeroen Keppens

Log In

Proposers

Controller Subdirectories Proposal - Jeroen Keppens

Added by Jeroen Keppens, last edited by Michael Mayer on May 31, 2007 (view change)

Labels

(None)

Zend Framework: Zend_Controller_Dispatcher Component Proposal

Proposed Component Name	Zend_Controller_Dispatcher
Developer Notes	http://framework.zend.com/wiki/display/ZFDEV/Zend_Controller_Dispatcher
Proposers	zf@keppens.net
Revision	(wiki revision: 9)

Table of Contents

1. Overview
2. References
3. Component Requirements, Constraints, and Acceptance Criteria
4. Dependencies on Other Framework Components
5. Theory of Operation
6. Milestones / Tasks
7. Class Index
8. Use Cases
9. Class Skeletons

1. Overview

In smal projects the current directory structure for controllers is sufficient. For bigger projects however, it might be useful to use subdirectories to group together certain functonalities for clarity reasons.

2. References

3. Component Requirements, Constraints, and Acceptance Criteria

KISS

4. Dependencies on Other Framework Components

5. Theory of Operation

Currently the controller in the url can't have underscores (they are filtered out). This change would keep underscores in place and replace spaces into underscores. The Zend::loadClass has to be adjusted as well so it can use subdirectories when the dirs parameter is not null.

6. Milestones / Tasks

zone: Missing {zone-data:milestones}

7. Class Index

Zend
Zend_Controller_Dispatcher

8. Use Cases

Suppose one of the parts of your website is a Forum, then you could have following urls:

forum_topic/list
forum_topic/add
forum_topic/edit
forum_topic/delete

forum_post/list
forum_post/rate
forum_post/view
forum_post/add
forum_post/edit
forum_post/delete

etc...

This would yield in following files

/application/controllers/Forum/TopicController.php => Class Forum_TopicController
/application/controllers/Forum/PostController.php => Class Forum_PostController

9. Class Skeletons

Zend.php : lijn 84, change:

$file = $class . '.php';

to:

if ($path != $class) {
    $dirs.= DIRECTORY_SEPARATOR.dirname($path);
    $file = basename($path) . '.php';
} else {
    $file = $class . '.php';
}

Zend/Controller/Dispatcher.php: lijn 167, added:

$className = str_replace("_", DIRECTORY_SEPARATOR, $className);

Zend/Controller/Dispatcher.php: lijn 91, change

protected function _formatName($unformatted)
{
    $unformatted = str_replace(array('-', '_', '.'), ' ', strtolower($unformatted));
    $unformatted = preg_replace('[Zend_Db_Adapter_Odbtp_Mssql^a-z0-9 ]', '', $unformatted);
    return str_replace(' ', '', ucwords($unformatted));
}

to:

protected function _formatName($unformatted)
{
    $unformatted = str_replace(array('-', '_', '%20', '.'), ' ', strtolower($unformatted));
    $unformatted = preg_replace('[Zend_Db_Adapter_Odbtp_Mssql^a-z0-9 ]', '', $unformatted);
    return str_replace(' ', '_', ucwords($unformatted));
}

Comments (Hide Comments)

How does this differ from http://framework.zend.com/wiki/x/CwM ?

Posted by Rob Allen at Sep 20, 2006 15:57

This is substantively the same as http://framework.zend.com/wiki/display/ZFPROP/Action+Controller+Directory+Tree+-+Christopher+Thompson, and my comments there apply here as well: a combination of a rewrite rule and a minor modification to Zend_Controller_Dispatcher::_formatName() will solve the issue.

Posted by Matthew Weier O'Phinney at Oct 10, 2006 15:21

Zend Comment

Duplicate of http://framework.zend.com/wiki/display/ZFPROP/Action+Controller+Directory+Tree

Posted by Matthew Weier O'Phinney at Oct 10, 2006 15:51