sfApplicationMapPlugin
1.2.4stable
for sf 1.4sf 1.3 MIT
The sfApplicationMapPlugin provides tasks to generate application-module-action structure images for your entire project using Graphviz. Useful at the designing stage of projects. Very useful to create brief overlook of a project.
Read more about the plugin at symfony developer's blog
Developers
| Name |
Status |
Email |
Tomasz Ducin |
lead |
moc.liamg <<ta>> nicud.zsamot
|
License
Copyright (c) 2009-2010 Tomasz Ducin
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Releases for sf 1.4
| Version |
License |
API |
Released |
|
1.2.4stable
|
MIT |
1.2.4stable
|
13/09/2010 |
|
1.2.3stable
|
MIT |
1.0.0stable
|
16/08/2010 |
|
1.2.2stable
|
MIT |
1.0.0stable
|
22/05/2010 |
|
1.2.1stable
|
MIT |
1.0.0stable
|
07/05/2010 |
|
1.2.0stable
|
MIT |
1.0.0stable
|
02/05/2010 |
|
1.1.1stable
|
MIT |
1.0.0stable
|
01/01/2010 |
|
1.1.0stable
|
MIT |
1.0.0stable
|
21/12/2009 |
Releases for sf 1.3
| Version |
License |
API |
Released |
|
1.2.4stable
|
MIT |
1.2.4stable
|
13/09/2010 |
|
1.2.3stable
|
MIT |
1.0.0stable
|
16/08/2010 |
|
1.2.2stable
|
MIT |
1.0.0stable
|
22/05/2010 |
|
1.2.1stable
|
MIT |
1.0.0stable
|
07/05/2010 |
|
1.2.0stable
|
MIT |
1.0.0stable
|
02/05/2010 |
|
1.1.1stable
|
MIT |
1.0.0stable
|
01/01/2010 |
|
1.1.0stable
|
MIT |
1.0.0stable
|
21/12/2009 |
|
1.0.0stable
|
MIT |
1.0.0stable
|
18/12/2009 |
Releases for sf 1.2
| Version |
License |
API |
Released |
|
1.0.6stable
|
MIT |
1.0.6stable
|
13/09/2010 |
|
1.0.5stable
|
MIT |
1.0.0stable
|
16/08/2010 |
|
1.0.3stable
|
MIT |
1.0.0stable
|
02/05/2010 |
|
1.0.2stable
|
MIT |
1.0.0stable
|
01/01/2010 |
|
1.0.1stable
|
MIT |
1.0.0stable
|
21/12/2009 |
|
1.0.0stable
|
MIT |
1.0.0stable
|
18/12/2009 |
Changelog for release 1.2.4 - 13/09/2010
- support for Windows systems (thanks to Gordon Bazeley)
Other releases
Release 1.2.4 - 13/09/2010
- support for Windows systems (thanks to Gordon Bazeley)
Release 1.2.3 - 16/08/2010
- added separate application graphs (1 graph for entire project + 1 for each application)
Release 1.2.2 - 22/05/2010
- task lib documentaion updated
- more examples of generated maps - for medium-size projects
Release 1.2.1 - 07/05/2010
- fixed bug reported by Kamil Kraśnik (wrong comment included when used non-execute methods)
Release 1.2.0 - 02/05/2010
- distinguish between actions and components
Release 1.1.1 - 01/01/2010
- visual settings configuration added
Release 1.1.0 - 21/12/2009
- created plugin branch for symfony version 1.4
Release 1.0.6 - 13/09/2010
- added support for Windows (thanks to Gordon Bazeley)
Release 1.0.5 - 16/08/2010
- added separate application graphs (1 graph for entire project + 1 for each application)
Release 1.0.3 - 02/05/2010
- distinguish between actions and components
Release 1.0.2 - 01/01/2010
- visual settings configuration added
Release 1.0.1 - 21/12/2009
- README updated - for different symfony branches
Release 1.0.0 - 18/12/2009
sfApplicationMapPlugin
Provides you with a task generating images of appliaction-module-action
structure of the project using the graphviz tool.
Installation
Install the plugin via the subversion repository by executing the following
command from the project root directory:
$ svn co http://svn.symfony-project.com/plugins/sfApplicationMapPlugin/branches/1.4 plugins/sfApplicationMapPlugin
or by using the default symfony plugin install command:
$ ./symfony plugin:install sfApplicationMapPlugin
Usage
After you have created your applications, modules and actions, simply type the
following command:
$ ./symfony project:application-map
which creates the doc/graph directory and few files inside it:
- project.dot, APP_NAME.dot - source graphviz files used for
image files generating, project file defines the entire project, whereas each
APP_NAME stands for name of each application.
and alternative images of application map:
- project.dot.png, APP_NAME.dot.png : images created by dot command
- project.neato.png, APP_NAME.neato.png : images created by neato command
- project.twopi.png, APP_NAME.twopi.png : images created by twopi command
- project.circo.png, APP_NAME.circo.png : images created by circo command
- project.fdp.png, APP_NAME.fdp.png : images created by fdp command
All possible GraphViz modes are used so that you can just choose which image is
the most readable for you.
Configuration
All visual settings of the images can be set in the config/map.ini file of
the plugin. Example settings look like the following:
app_shape = doublecircle
app_style = filled
app_fillcolor = goldenrod2
You can find all properties properly interpreted by GraphViz in its
documentation, such as colors or
shapes.
Important notes
- All actions in actions.class.php or components.class.php must be
documented for the plugin to parse them. Use the default action skeleton
documentation block provided with symfony.
Application map examples
dot example
fdp example
dot example with components
fdp example with components
dot example of medium-size project
click to enlarge
circo example of medium-size project
click to enlarge
fdp backend application map
click to enlarge
circo frontend application map
click to enlarge
Prerequisites
- You must have GraphViz
installed on your system.
Additional
coming soon: support for plugin modules
thanks for all comments, suggestions and bug reports, they help a lot! Feel
free to write me.
