Egg::Release - Version of Egg WEB Application Framework.
'Egg' is MVC framework that is influenced from 'Catalyst' and developed.
It consists of a simple module composition. and the residing memory is comparatively few and operates at high speed, too.
Egg::Model::DBI is attached by the standard.
Because Egg::Model::DBI is registered in CPAN, we am separately used properly by the favorite.
Egg::View::Template and Egg::View::Mason is attached by the standard. Egg::View::Template is loaded in default.
Moreover, Egg::View::TT is registered in CPAN, and use it by the favorite separately, please.
It generates it with helper script (Egg::Helper).
Configuration and Dispatch is included in the controller.
Configuration
It is loaded by Egg::Plugin::ConfigLoader in default.
Dispatch
"Egg::Plugin::Dispatch::Standard " is used by the standard. "Egg::Plugin::Dispatch::Fast " that operates at high speed or more can be selected, too.
Either of Egg::Request::Apache::* or Egg::Request::CGI or Egg::Request::FastCGI is loaded judging the environment.
Egg::Response is used fixing.
Moreover, all enhanced features rely on Plugin.
Please refer to the document of the module of the object for details or more for each part.
Egg constructs the application in each project generated with Egg::Helper.
% perl egg_helper.pl Project NewProject
The helper script generates the project file with the following compositions.
The helper script makes the root directory of the project for a suitable place. And, all configuration files are generated to the directory.
Some following scripts concerning the project. It is generated to '/bin'.
[PROJECT_NAME]_helper.pl
Helper script only for project.
[PROJECT_NAME]_tester.pl
Test script only for project. The operational condition of the project can be checked by requesting WEB virtual.
trigger.cgi
Script that becomes trigger when operating as usual CGI. When managing it by this, it moves to an appropriate place and WEB is requested to this script.
dispatch.fcgi
Script used when operating with FastCGI.
The banner image etc. of some Egg are generated to ./htdocs as static contents.
The controller and the configuration for the project are generated to ./lib.
Additionally, the following directories are generated according to the usage.
cache
Empty directory for file cash. Please give the proper permission when you use it.
root
Preservation place of template.
comp
Preservation place of template only for include.
etc
Other configuration file depositories etc.
tmp
Temporary work directory. Please give the proper permission when you use it.
t
Test file depository when project complete set is managed as Perl module.
The controller of the project contains processing importance the application is composed, and the following.
Loading of Egg
Egg is read with use and the plugin and the flag that wants to load it by the argument are passed.
use Egg qw/ -Debug ConfigLoader Encode Upload Tools Dispatch::Standard Debugging Log FormValidator::Simple ErrorDocument DBI::Transaction +MyApp::Plugin /;
Because the method such as 'dispatch' and 'debug' and 'log' that Egg demands is included as for 'Dispatch::*' and 'Debugging' and 'Log', it is necessary to load it.
In addition, please refer to the document of Egg for details.
Initialization of Egg.
The configuration of an appropriate place is loaded by ConfigLoader in default. Please refer to the document of Egg::Plugin::ConfigLoader for details.
However, if it is not a platform where the perpetuity objects such as mod_perl and FastCGI are treated, it always costs the behavior cost in initial operation. To evade this, the configuration is passed directly to 'egg_startup'.
__PACKAGE__->egg_startup({ title => 'project_name', ..... ... . });
Please refer to the document of Egg for a set item of Egg.
Dispatch ‚Ì�Ý’è
The setting for loaded Dispatch is set up by 'dispatch_map'.
__PACKAGE__->dispatch_map( ..... ... . );
Please refer to the document of Egg::Plugin::Dispatch::Standard and Egg::Plugin::Dispatch::Fast for details for the setting method.
Additionally, Egg does a little tricky processing that adds the plugin and oneself to controller's @ISA. Therefore, the method of the addition to the controller is given to priority more than any module included in controller's @ISA.
$e->next::method is used to process it of returning the method of other modules to former processing after override is done as a controller.
sub overwrite_method { my($e)= @_; ....... .... .. $e->next::method; }
It is the main list of the plug-in for Egg. * The one other than the standard are included.
It is a plugin to use ModBlosxom that uses blosxom of a famous Blog system as a module.
Egg::Plugin::Blosxom,
Arbitrary CGI is moved in Egg and the result is output.
Egg::Plugin::CGIrun,
* I think that there is a thing that doesn't operate well according to CGI either.
The use of an arbitrary cash module becomes convenient.
Egg::Plugin::Cache
It appropriately processes it concerning the character set of the output contents.
The following plug-in is loaded and used.
Egg::Plugin::Charset::Charset::UTF8, Egg::Plugin::Charset::EUC_JP, Egg::Plugin::Charset::Shift_JIS,
The configuration of an appropriate place is loaded.
Egg::Plugin::ConfigLoader,
Plugin to use Crypt::CBC.
Egg::Plugin::Crypt::CBC,
It comes to be able to write the code of troublesome DBI simply variously.
Egg::Plugin::DBI::Easy
The processing of Transaction by Egg::Model::DBI is automated.
Egg::Plugin::DBI::Transaction
The processing of Transaction by Egg::Model::DBIC is automated.
Egg::Plugin::DBIC::Transaction
* It is not possible to use it at the same time with 'DBI::Transaction'.
'debug' method demanded by Egg is offered. It is an indispensable plugin.
Egg::Plugin::Debugging
'dispatch' method demanded by Egg is offered. It is an indispensable plugin.
Please load the following either.
Egg::Plugin::Dispatch::Fast, Egg::Plugin::Dispatch::Standard,
It processes it concerning the character-code conversion or union.
Egg::Plugin::Encode.
The contents output when it makes an error of '404 Not Found' and '403 Forbidden', etc. is helped.
Egg::Plugin::ErrorDocument
* It does without relation to the processing when the exception is generated.
The file is rotated and the file before is left.
Egg::Plugin::File::Rotate
Plugin to use 'HTML::FillInForm'.
It is a plugin to receive the data regularized by Filter.
Egg::Plugin::Filter.
Plugin: Egg::Plugin::Filter::Plugin::Japanese::UTF8, Egg::Plugin::Filter::Plugin::Japanese::EUC, Egg::Plugin::Filter::Plugin::Japanese::Shift_JIS,
Plugin to use 'FormValidator::Simple'.
Egg::Plugin::FormValidator::Simple.
Parsing when response header and request header are received by text.
Egg::Plugin::HTTP::HeadParser.
Plugin to use 'LWP::UserAgent'.
Egg::Plugin::LWP.
'log' method demanded by Egg is offered. It is an indispensable plugin.
Egg::Plugin::Log.
Plugin to do Mail Sending.
Egg::Plugin::MailSend.
Plugin to use 'Net::Ping'.
Egg::Plugin::Net::Ping.
It connects with an arbitrary port and a target service situation is checked.
Egg::Plugin::Net::Scan.
The Pod document is output.
Egg::Plugin::Pod::HTML.
Plugin to use 'Prototype'.
Egg::Plugin::Prototype.
An easy HTML source for Redirect is offered and output.
Egg::Plugin::Redirect::Body
The session function is offered.
Egg::Plugin::SessionKit.
It is a plugin that offers a convenient method.
Egg::Plugin::Tools.
Plugin to support file up-loading.
Egg::Plugin::Upload.
Plugin to use 'YAML'.
Egg::Plugin::YAML
Plugin to read resource code file.
Egg::Plugin::rc.
Distribution site.
L<http://egg.bomcity.com/>.
sourcefoge project.
L<http://sourceforge.jp/projects/egg/>.
Masatoshi Mizuno <lushe@cpan.org>
Copyright (C) 2007 by Bee Flag, Corp. <http://egg.bomcity.com/>, All Rights Reserved.
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.6 or, at your option, any later version of Perl 5 you may have available.
2 POD Errors
The following errors were encountered while parsing the POD:
L<> starts or ends with whitespace
Non-ASCII character seen before =encoding in '‚Ì�Ý’è'. Assuming CP1252
To install Egg::Release, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Egg::Release
CPAN shell
perl -MCPAN -e shell install Egg::Release
For more information on module installation, please visit the detailed CPAN module installation guide.