NAME
Egg::Engine - It assists in basic operation of Egg.
METHODS
$e->run
A series of processing is done until the WEB request is received and contents are output.
$e->step1
It is processing of the first stage that is called from $e->run.
$e->prepare
'prepare' method of each plugin is sequentially called.
$e->create_dispatch
It is initial processing of dispatch.
$e->dispatch->_start and $e->dispatch->_run
'_start' method and '_run' method of dispatch are continuously called. However, if $e->finished is ture, these processing is canceled.
$e->step2
It is processing of the second stage that is called from $e->run. However, if $e->finished is true, all processing here is canceled.
$e->action
'action' method of the plugin is called.
$e->view->output
The template is evaluated and contents for the output are generated. However, if $e->response->body has defined it, processing here has already been canceled.
$e->dispatch->_finish
If $e->response->body is undefined, '_finish' method of dispatch is called. The processing of dispatch are the completion of all by this.
$e->step3
They are the last processing most that is called from $e->run.
If $e->response->content_type is first of all undefined in the processing to here, $e->config->{content_type} is set.
$e->finalize
'_finalize' method of each plugin is sequentially called.
$e->output_content
If $e->finished is true, all processing here is canceled.
$e->compress( $e->response->body ) is called before contents are output.
And, contents are output to the client.
$e->encode_entities([STR], [UNSAFE]);
Alias of this method. : escape_html , eHTML
HTML is encoded and the result is returned.
The argument follows HTML::Entities.
$e->decode_entities([STR], [UNSAFE]);
Alias of this method. : unescape_html , ueHTML
HTML is decoded and the result is returned.
The argument follows HTML::Entities.
$e->encode_entities_numeric([STR], [UNSAFE]);
HTML encodes the numerical value.
The argument follows HTML::Entities.
$e->uri_escape([STR], [UNSAFE]);
Alias of this method. : escape_uri , eURI
The result of encoding URI is returned.
The argument follows URI::Escape.
$e->uri_escape_utf8([STR], [UNSAFE]);
When URL is encoded, the UTF-8 character is treated.
The argument follows URI::Escape.
$e->uri_unescape([STR], [UNSAFE]);
Alias of this method. : unescape_uri , ueURI
The result of the URI decipherment is returned.
The argument follows URI::Escape.
$e->create_dispatch
The dispatch object is generated. An overwrite of the controller of this method and customizing for me are also good.
$e->plugin
The plugin is require. However, it is not added to @ISA, and 'setup' method is not called. This merely does require.
$e->default_view([VIEW_NAME]);
It exchanges it for VIEW that does VIEW of default.
If [VIEW_NAME] is unspecification, the name of present default VIEW is returned.
$e->log
The Egg::Debug::Log object is returned.
$e->disp_error([MESSAGE]);
When the error occurs by processing $e->run, it reports on the error on the screen where Egg is yellow.
$e->debug_out([MESSAGE]);
The message of argument is output to STDERR while operating by debug mode. This any method is replaced with the code not done usually.
SEE ALSO
Egg::Release, Egg::Model, Egg::View, Egg::Request, Egg::Response, Egg::D::Stand, Egg::Debug::Base, HTML::Entities, URI::Escape,
AUTHOR
Masatoshi Mizuno, <mizuno@bomcity.com>
COPYRIGHT AND LICENSE
Copyright (C) 2006 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.