CGI::Application::Plugin::DevPopup

CGI::Application::Plugin::DevPopup is a runtime cgiapp info in a popup window.
Download

CGI::Application::Plugin::DevPopup Ranking & Summary

Advertisement

  • Rating:
  • License:
  • Perl Artistic License
  • Price:
  • FREE
  • Publisher Name:
  • Rhesa Rozendaal
  • Publisher web site:
  • http://search.cpan.org/~rhesa/CGI-Application-Plugin-DevPopup-1.00/lib/CGI/Application/Plugin/DevPopup.pm

CGI::Application::Plugin::DevPopup Tags


CGI::Application::Plugin::DevPopup Description

CGI::Application::Plugin::DevPopup is a runtime cgiapp info in a popup window. CGI::Application::Plugin::DevPopup is a runtime cgiapp info in a popup window.SYNOPSISEnd user informationThis module provides a plugin framework for displaying runtime information about your CGI::Application app in a popup window. A sample Timing plugin is provided to show how it works: BEGIN { $ENV{'CAP_DEVPOPUP_EXEC'} = 1; } # turn it on for real use CGI::Application::Plugin::DevPopup; use CGI::Application::Plugin::DevPopup::Timing; The rest of your application follows ...Now whenever you access a runmode, a window pops up over your content, showing information about how long the various stages have taken. Adding other CAP::DevPopup plugins will get you more information. A HTML::Tidy plugin showing you how your document conforms to W3C standards is available: see CGI::Application::Plugin::HtmlTidy.The output consists of a Table of Contents, and a bunch of reports. A rough translation into plain text could look like this: Devpopup report for My::App -> add_timing * Timings - Total runtime: 3.1178 sec. +-----------------------------------------------------------------------+ | Timings | +-----------------------------------------------------------------------+ | Application started at: Thu Sep 22 02:55:35 2005 | | From To Time taken | |-----------------------------------------------------------------------| | init prerun 0.107513 sec. | | prerun before expensive operation 0.000371 sec. | | before expensive operation after expensive operation 3.006688 sec. | | after expensive operation load_tmpl(dp.html) 0.000379 sec. | | load_tmpl(dp.html) postrun 0.002849 sec. | +-----------------------------------------------------------------------+The reports expand and collapse by clicking on the ToC entry or the report header.You can see a (developer) version in action here: http://oss.rhesa.com/cpan/cap-devpopup/example.Developer informationCreating a new plugin for DevPopup is fairly simple. CAP::DevPopup registers a new callback point (named devpopup_report), which it uses to collect output from your plugin. You can add a callback to that point, and return your formatted output from there. The callback has this signature: sub callback($cgiapp_class, $outputref)You pass your output to the devpopup object by calling $cgiapp_class->devpopup->add_report( title => $title, summary => $summary, report => $body, );You are receiving $outputref, because DevPopup wants to be the last one to be called in the postrun callback. If you had wanted to act at postrun time, then please do so with this variable, and not through a callback at postrun.The on switchSince this is primarily a development plugin, and you wouldn't want it to run in your production code, an environment variable named CAP_DEVPOPUP_EXEC has to be set to 1 for this module to function, and it must be present at compile time. This means you should place it in a BEGIN{} block, or use SetEnv or PerlSetEnv (remember to set those before any PerlRequire or PerlModule lines).Absense of the environment variable turns this module into a no-op: while the plugin and its plugins are still loaded, they won't modify your output.Requirements:· Perl Requirements: · Perl


CGI::Application::Plugin::DevPopup Related Software