NAME¶
Jifty::Result - Outcome of running a Jifty::Action
DESCRIPTION¶
"Jifty::Result" encapsulates the outcome of running a Jifty::Action.
Results are also stored on the framework's Jifty::Response object.
new¶
Construct a new action result. This is done automatically when the action is
created, and can be accessed via the "result" in Jifty::Action.
failure [BOOL]¶
Gets or sets if the action succeeded or failed.
success [BOOL]¶
Gets or sets if the action succeeded or failed -- this is an alternate interface
from "failure" but has the same effect.
action_class [MESSAGE]¶
Returns the class for the action that this result came from.
message [MESSAGE]¶
Gets or sets the action's response message. This is an informational textual
description of the outcome of the action.
error [ERROR]¶
Gets or sets the action's error response. This is an informational textual
description of what went wrong with the action, overall. This also
automatically sets the result to be a "failure".
field_error FIELD [ERROR] [OPTIONS]¶
Gets or sets the error string for a specific field on the action. This also
automatically sets the result to be a failure. "OPTIONS" is an
optional set of key-value pairs; the only currently supported option is
"force", which sets the "ajax_force_validate" for this
field.
field_errors¶
Returns a hash which maps argument name to error.
field_warning FIELD [WARNING] [OPTIONS]¶
Gets or sets the warning string for a specific field on the action.
"OPTIONS" is an optional set of key-value pairs; the only currently
supported option is "force", which sets the
"ajax_force_validate" for this field.
field_warnings¶
Returns a hash which maps argument name to warning.
ajax_force_validate FIELD [VALUE]¶
Gets or sets the flag which determines if warnings and errors are set using ajax
validation, even if the field is empty. By default, validation warnings and
errors are
not shown for empty fields, as yelling to users about
mandatory fields they've not gotten to yet is poor form. You can use this
method to force ajax errors to show even on empty fields.
field_canonicalization_note FIELD [NOTE]¶
Gets or sets a canonicalization note for a specific field on the action.
field_canonicalization_notes¶
Returns a hash which maps argument name to canonicalization notes.
content [KEY [, VALUE]]¶
Gets or sets the content "KEY". This is used when actions need to
return values. If not "KEY" is passed, it returns an anonymous hash
of all of the "KEY" and "VALUE" pairs.
as_hash¶
This returns the results as a hash to be given directly to the end user (usually
via REST or webservices). The difference between
"$result->as_hash" and %$result is that the latter will expand
everything as deeply as possible. The former won't inflate
"refers_to" columns, among other things.