CatalystX::Usul::Controller::Entrance - Common controller methods
Describes v0.17.$Rev: 1 $
package YourApp::Controller::Entrance; use CatalystX::Usul::Moose; BEGIN { extends q(CatalystX::Usul::Controller::Entrance) }
Provides controller methods that are common to multiple applications. The methods include welcome pages, authentication, sitemap, documentation, and user registration
Defines the following attributes
default_action
A non empty simple string which defaults to reception. The default action for this controller
reception
docs_uri
A non empty simple string which defaults to /html/index.html. Relative path to the applications documentation
/html/index.html
register_class
A non empty simple string which defaults to UsersDBIC. Name of the model class used to perform user registrations
UsersDBIC
register_profile
A non empty simple string which defaults to users. The name of the user profile used when creating a registered user
users
Activates newly created accounts
Intermediate controller maps to the authentication path part. Three other controllers chain to this one so as to appear in the right place in the navigation menu
Identify yourself to the system. You will need a login id and password to prove your identity to the system
Calls "authenticate" in CatalystX::Usul::Controller
A midpoint in the URI that does nothing except act as a placeholder for the namespace which is entrance
Exposes the method of the same name in the parent class which is responsible for stuffing the stash with all of the non endpoint specific data
Change your password. Passwords will be checked for conformance with local rules
This private method invokes the data model to update a user password
Action to enable Ajax field checking. Calls method of same name in parent class
A midpoint in the URI. A number of other actions are chained off this one. It sets up the navigation menu and form keys
Another midpoint, this one is used by documentation endpoints
Links to the HTML documentation index generated from POD. It can be regenerated with the command
bin/munchies_cli -n -c pod2html
Adds some debug information to the footer div. Called via the async form widget
Displays the POD for the selected module
Displays a table of modules used by the application and their version numbers. It has clickable fields that display POD for the module and it's source code
Action for the Ajax call that puts a navigation tree in a sidebar panel
Intermediate subroutine maps to the reception path part. Both reception landing page and the tutorial chain to this controller
Display the splash page for the application
Redirects client to this controllers default page
Midpoint that stashes a copy of the register model for use by the site registration actions
User self registration page
Private method calls the data model to create a new user account
Displays links to all the rooms on this site
Guides you through the elements common to all rooms on this site
Debug can be turned on/off from the tools menu
None known
There are no known bugs in this module. Please report problems to the address below. Patches are welcome
Peter Flanigan, <Support at RoxSoft.co.uk>
<Support at RoxSoft.co.uk>
Copyright (c) 2014 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
To install CatalystX::Usul, copy and paste the appropriate command in to your terminal.
cpanm
cpanm CatalystX::Usul
CPAN shell
perl -MCPAN -e shell install CatalystX::Usul
For more information on module installation, please visit the detailed CPAN module installation guide.