Raphael Manfredi > CGI-MxScreen-0.1.1 > CGI::MxScreen::Action_Env

Download:
CGI-MxScreen-0.1.1.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Source   Latest Release: CGI-MxScreen-0.103

NAME ^

CGI::MxScreen::Action_Env - Action callback error context

SYNOPSIS ^

 # Not meant to be created directly

 sub action {                # an action callback
     my $env = pop @_;       # the Action_Env error context
     my @args = @_;
     return CGI_MX_OK if $env->error_count;
     ...
     return CGI_MX_OK;
 }

DESCRIPTION ^

Instances of this class are used to record failed actions during the processing of button callbacks. They are given as the last parameter of each action callback, and must therefore be retrieved with:

    my $env = pop @_;

This object can be queried for the error_count (to avoid any further action processing if an error was detected, for instance), or for the full error_list, wich tracks a list of

    [$object, $routine, [args]]

Those are the callbacks that were called and which returned an error condition (see CGI::MxScreen::Error for a list of allowed returned values).

This object is also passed as last argument to dynamic error trapping callbacks, so that a proper screen destination can be derived from the errors, if needed.

See CGI::MxScreen::Form::Button for more information on action callback and dynamic error trapping.

AUTHORS ^

Raphael Manfredi <Raphael_Manfredi@pobox.com> and Christophe Dehaudt <Christophe.Dehaudt@teamlog.fr>.

SEE ALSO ^

CGI::MxScreen::Error(3), CGI::MxScreen::Form::Button(3).

syntax highlighting: