Name
CatalystX::Usul::Controller::Root - Root Controller for the application
Version
Describes v0.9.$Rev: 0 $
Synopsis
package YourApp::Controller::Root;
use CatalystX::Usul::Moose;
BEGIN { extends q(CatalystX::Usul::Controller::Root) }Description
Exposes some generic endpoints implemented in the base class
Configuration and Environment
Defines the following attributes
default_namespace-
A simple string which is required. The default namespace
imager_class-
A non empty simple string which defaults to
Imager
Subroutines/Methods
about
Display a simple popup window containing the copyright and license information
access_denied
The auto method redirects unauthorised users to this endpoint
action_closed
The requested endpoint exists but has been deactivated by the administrators
app_closed
Display an information screen explaining that the application has been closed by the administrators. An administrator must authenticate to reopen the application
app_reopen
Action to reopen the application. Does this by setting the global configuration attribute to false
auto
Calls method of same name in parent class
base
Initializes the persistent URI attributes and loads the status messages
begin
Calls method of same name in parent class to stuff the stash with data used by all pages
captcha
Dynamically generates a JPEG image used on the self registration screen to defeat bots.
company
Some text about the company whose application this is.
end
Attempt to render a view
feedback
Display a popup window that lets the user send an email to the site administrators
feedback_send
This private method is the action for the feedback controller
help
Generates a context sensitive help page by calling help_form
imager
Generates transformations of any image under the document root. Calls transform and sets the response object directly
logout
Expires the user object in the session store
quit
Called when collecting profile data using Devel::NYTProf to stop the server. The environment variable MYAPP_QUIT_OK must be set to true for this to work, so don't do that on a production server
redirect_to_default
Redirects to default controller. Matches any uri not matched by another action
render
Call the RenderView action class
select_language
Handles the post request to select the language used. Stores the requested language in the session and the redirects back to the original uri
version
Return the version number of this controller
view_source
View the source code for the current controller. Calls the view_file method in the CatalystX::Usul::Model::FileSystem model to display some source code with syntax highlighting
Diagnostics
Debug can be turned on/off from the tools menu
Dependencies
- CatalystX::Usul::Controller
- CatalystX::Usul::TraitFor::Controller::ModelHelper
- CatalystX::Usul::TraitFor::Controller::PersistentState
- CatalystX::Usul::Moose
Incompatibilities
There are no known incompatibilities in this module
Bugs and Limitations
There are no known bugs in this module. Please report problems to the address below. Patches are welcome
Author
Peter Flanigan, <Support at RoxSoft.co.uk>
License and Copyright
Copyright (c) 2013 Peter Flanigan. All rights reserved
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic
This program is distributed in the hope that it will be useful, but WITHOUT WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE