sfApplicationMapPlugin - 1.0.0

Generates application-module-action map images

You are currently browsing
the website for symfony 1

Visit the Symfony2 website


« Back to the Plugins Home

Signin


Forgot your password?
Create an account

Tools

Stats

advanced search
Information Readme Releases Changelog Contribute
Show source

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:

$ svn co http://svn.symfony-project.com/plugins/sfApplicationMapPlugin/trunk plugins/sfApplicationMapPlugin

from the project root directory or by using the 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 few files under the doc/graph directory:

  • application-map.dot - source graphviz file for all image files

and alternative images of application map:

  • application-map.dot.png : image created by dot command
  • application-map.neato.png : image created by neato command
  • application-map.twopi.png : image created by twopi command
  • application-map.circo.png : image created by circo command
  • application-map.fdp.png : image created by fdp command

All possible GraphViz modes are used so that you can just choose which image is the most readable for you.

Important notes

  • All actions in actions.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

Example dot application map

fdp example

Example fdp application map

Prerequisites

  • You must have GraphViz installed on your system.