Jifty::Result(3pm) User Contributed Perl Documentation Jifty::Result(3pm)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.
perl v5.14.2 2010-09-25 Jifty::Result(3pm)
Check Out this Related Man Page
Jifty::Client(3pm) User Contributed Perl Documentation Jifty::Client(3pm)NAME
Jifty::Client - Subclass of WWW::Mechanize with extra Jifty features
DESCRIPTION
This module is a base for building robots to interact with Jifty applications. It currently contains much overlapping code with
"Jifty::Test::WWW::Mechanize", except that it does not inherit from "Test::WWW::Mechanize".
Expect this code to be refactored in the near future.
METHODS
new
Overrides WWW::Mechanize's "new" to automatically give the bot a cookie jar.
moniker_for ACTION, FIELD1 => VALUE1, FIELD2 => VALUE2
Finds the moniker of the first action of type ACTION whose "constructor" field FIELD1 is VALUE1, and so on.
fill_in_action MONIKER, FIELD1 => VALUE1, FIELD2 => VALUE2, ...
Finds the fields on the current page with the names FIELD1, FIELD2, etc in the MONIKER action, and fills them in. Returns the HTML::Form
object of the form that the action is in, or undef if it can't find all the fields.
action_form MONIKER [ARGUMENTNAMES]
Returns the form (as an HTML::Form object) corresponding to the given moniker (which also contains inputs for the given argumentnames), and
also selects it as the current form. Returns undef if it can't be found.
action_field_value MONIKER, FIELD
Finds the fields on the current page with the names FIELD in the action MONIKER, and returns its value, or undef if it can't be found.
send_action CLASS ARGUMENT => VALUE, [ ... ]
Sends a request to the server via the webservices API, and returns the Jifty::Result of the action. "CLASS" specifies the class of the
action, and all parameters thereafter supply argument keys and values.
The URI of the page is unchanged after this; this is accomplished by using the "back button" after making the webservice request.
fragment_request PATH ARGUMENT => VALUE, [ ... ]
Makes a request for the fragment at PATH, using the webservices API, and returns the string of the result.
field_error_text MONIKER, FIELD
Finds the error span on the current page for the name FIELD in the action MONIKER, and returns the text (tags stripped) from it. (If the
field can't be found, return undef).
uri
WWW::Mechanize has a bug where it returns the wrong value for "uri" after redirect. This fixes that. See
http://rt.cpan.org/NoAuth/Bug.html?id=9059
session
Returns the server-side Jifty::Web::Session object associated with this Mechanize object.
continuation [ID]
Returns the current continuation of the Mechanize object, if any. Or, given an ID, returns the continuation with that ID.
current_user
Returns the Jifty::CurrentUser object or descendant, if any.
SEE ALSO
Jifty::Test::WWW::Mechanize
LICENSE
Jifty is Copyright 2005-2010 Best Practical Solutions, LLC. Jifty is distributed under the same terms as Perl itself.
perl v5.14.2 2011-04-14 Jifty::Client(3pm)