--- name: "Jifty::Web" section: "3pm" platform: "linux" package: "libjifty-perl" version: "1.10518+dfsg-2" release: "Debian 7 (Wheezy)" platforms: ["linux"] url: "https://new.carta.tech/Jifty::Web" --- # Jifty::Web(3pm) Web framework for a Jifty application ## NAME Jifty::Web - Web framework for a Jifty application ## METHODS *new* Creates a new `"Jifty::Web"` object *mason* Returns a HTML::Mason::Request object *out* Send a string to the browser. *url* Returns the root url of this Jifty application. This is pulled from the configuration file. Takes an optional named path which will form the path part of the resulting URL. *serial* Returns a unique identifier, guaranteed to be unique within the runtime of a particular process (i.e., within the lifetime of Jifty.pm). There's no sort of global uniqueness guarantee, but it should be good enough for generating things like moniker names. ### SESSION MANAGEMENT *setup\_session* Sets up the current `"session"` object (a Jifty::Web::Session tied hash). Aborts if the session is already loaded. *session* Returns the current session's hash. In a regular user environment, it persists, but a request can stop that by handing it a regular hash to use. ### CURRENT USER *current\_user \[USER\]* Getter/setter for the current user; this gets or sets the 'user' key in the session. These are Jifty::Record objects. If a temporary\_current\_user has been set, will return that instead. If the current application has no loaded current user, we get an empty app-specific `"CurrentUser"` object. (This `"ApplicationClass"`::CurrentUser class, a subclass of Jifty::CurrentUser, is autogenerated if it doesn't exist). *temporary\_current\_user \[USER\]* Sets the current request's current\_user to USER if set. This value will \_not\_ be persisted to the session at the end of the request. To restore the original value, set temporary\_current\_user to undef. ### REQUEST *handle\_request \[REQUEST\]* This method sets up a current session, and then processes the given Jifty::Request object. If no request object is given, processes the request object in "request". Each action on the request is vetted in three ways -- first, it must be marked as `"active"` by the Jifty::Request (this is the default). Second, it must be in the set of allowed classes of actions (see "is\_allowed" in Jifty::API). Finally, the action must validate. If it passes all of these criteria, the action is fit to be run. Before they are run, however, the request has a chance to be interrupted and saved away into a continuation, to be resumed at some later point. This is handled by "save\_continuation" in Jifty::Request. If the continuation isn't being saved, then `"handle_request"` goes on to run all of the actions. If all of the actions are successful, it looks to see if the request wished to call any continuations, possibly jumping back and re-running a request that was interrupted in the past. This is handled by "call\_continuation" in Jifty::Request. For more details about continuations, see Jifty::Continuation. *request \[VALUE\]* Gets or sets the current Jifty::Request object. *response \[VALUE\]* Gets or sets the current Jifty::Response object. *form* Returns the current Jifty::Web::Form object, creating one if there isn't one already. *new\_action class =\> CLASS, moniker =\> MONIKER, order =\> ORDER, arguments =\> PARAMHASH* Creates a new action (an instance of a subclass of Jifty::Action). The named arguments passed to this method are passed on to the `"new"` method of the action named in `"CLASS"`. If you pass an odd number of arguments, then the first argument is interpreted as `"class"`. *Arguments* - class `"CLASS"` is qualified, and an instance of that class is created, passing the `"Jifty::Web"` object, the `"MONIKER"`, and any other arguments that `"new_action"` was supplied. - moniker `"MONIKER"` is a unique designator of an action on a page. The moniker is content-free and non-fattening, and may be auto-generated. It is used to tie together arguments that relate to the same action. - order `"ORDER"` defines the order in which the action is run, with lower numerical values running first. - arguments `"ARGUMENTS"` are passed to the "new" in Jifty::Action method. In addition, if the current request (`"$self->request"`) contains an action with a matching moniker, any arguments that are in that requested action but not in the `"PARAMHASH"` list are set. This implements "sticky fields". As a contrast to "add\_action" in Jifty::Web::Form, this does not add the action to the current form -- instead, the first form field to be rendered will automatically register the action in the current form field at that time. *new\_action\_from\_request REQUESTACTION* Given a Jifty::Request::Action, creates a new action using `"new_action"`. *failed\_actions* Returns an array of Jifty::Action objects, one for each Jifty::Request::Action that is marked as failed in the current response. *succeeded\_actions* As "failed\_actions", but for actions that completed successfully; less often used. ### REDIRECTS AND CONTINUATIONS *next\_page \[VALUE\]* Gets or sets the next page for the framework to show. This is normally set during the `"take_action"` method or a Jifty::Action *force\_redirect \[VALUE\]* Gets or sets whether we should force a redirect to `"next_page"`, even if it's already the current page. You might set this, e.g. to force a redirect after a POSTed action. *redirect\_required* Returns true if we need to redirect, now that we've processed all the actions. We need a redirect if either `"next_page"` is different from the current page, or `"force_redirect"` has been set. *webservices\_redirect \[TO\]* Handle redirection inside webservices call. This is meant to be hooked by plugin that knows what to do with it. *redirect \[TO\]* Redirect to the next page. If you pass this method a parameter, it redirects to that URL rather than **next\_page**. It creates a continuation of where you want to be, and then calls it. If you want to redirect to a page with parameters, pass in a Jifty::Web::Form::Clickable object. *caller* Returns the Jifty::Request of our enclosing continuation, or an empty Jifty::Request if we are not in a continuation. ### HTML GENERATION *tangent PARAMHASH* If called in non-void context, creates and renders a Jifty::Web::Form::Clickable with the given *PARAMHASH*, forcing a continuation save. In void context, does a redirect to the URL that the Jifty::Web::Form::Clickable object generates. Both of these versions preserve all state variables by default. *goto PARAMHASH* Does an instant redirect to the url generated by the Jifty::Web::Form::Clickable object generated by the *PARAMHASH*. *link PARAMHASH* Generates and renders a Jifty::Web::Form::Clickable using the given *PARAMHASH*. *return PARAMHASH* If called in non-void context, creates and renders a Jifty::Web::Form::Clickable using the given *PARAMHASH*, additionally defaults to calling the current continuation. Takes an additional argument, `"to"`, which can specify a default path to return to if there is no current continuation. In void context, does a redirect to the URL that the Jifty::Web::Form::Clickable object generates. ### template\_exists PATH Returns true if PATH is a valid template inside your template root. This checks for both Template::Declare and HTML::Mason Templates. Specifically, returns a reference to the handler which can process the template. If PATH is a *reference* to the path, it will update the path to append `"/index.html"` if the path in question doesn't exist, but the index does. ### render\_template PATH Use our templating system to render a template. Searches through "view\_handlers" in Jifty::Handler to find the first handler which provides the given template, and caches the handler for future requests. Catches errors, and redirects to `"/errors/500"`; also shows `"/errors/404"` if the template cannot be found. *render\_messages \[MONIKER\]* Outputs any messages that have been added, in \
and \
tags. Messages are added by calling "message" in Jifty::Result. If a moniker is specified, only messages for that moniker are rendered. *render\_success\_messages \[MONIKER\]* Render success messages for the given moniker, or all of them if no moniker is given. *render\_error\_messages \[MONIKER\]* Render error messages for the given moniker, or all of them if no moniker is given. *\_render\_messages TYPE \[MONIKER\]* Output any messages of the given TYPE (either 'error' or 'message') in a \
tag. If a moniker is given, only renders messages for that action. Internal helper for "render\_success\_messages" and "render\_errors". *query\_string KEY =\> VALUE \[, KEY =\> VALUE \[, ...\]\]* Returns an URL-encoded query string piece representing the arguments passed to it. *escape STRING* HTML-escapes the given string and returns it *escape\_uri STRING* URI-escapes the given string and returns it *navigation* Returns the Jifty::Web::Menu for this web request; one is automatically created if it hasn't been already. *page\_navigation* Returns the Jifty::Web::Menu for this web request; one is automatically created if it hasn't been already. This is useful for separating page-level navigation from app-level navigation. *include\_css* Returns a `""` tag for the compressed CSS *add\_css FILE1, FILE2, ...* Pushes files onto `"Jifty->web->css_files"` *include\_javascript* Returns a `"