Peter Flanigan > CatalystX-Usul-0.17.1 > CatalystX::Usul::Controller::Entrance

Download:
catalystx-usul/CatalystX-Usul-0.17.1.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

Open  0
View/Report Bugs
Module Version: v0.17.1   Source  

Name ^

CatalystX::Usul::Controller::Entrance - Common controller methods

Version ^

Describes v0.17.$Rev: 1 $

Synopsis ^

   package YourApp::Controller::Entrance;

   use CatalystX::Usul::Moose;

   BEGIN { extends q(CatalystX::Usul::Controller::Entrance) }

Description ^

Provides controller methods that are common to multiple applications. The methods include welcome pages, authentication, sitemap, documentation, and user registration

Configuration and Environment ^

Defines the following attributes

default_action

A non empty simple string which defaults to reception. The default action for this controller

docs_uri

A non empty simple string which defaults to /html/index.html. Relative path to the applications documentation

register_class

A non empty simple string which defaults to UsersDBIC. Name of the model class used to perform user registrations

register_profile

A non empty simple string which defaults to users. The name of the user profile used when creating a registered user

Subroutines/Methods ^

activate_account

Activates newly created accounts

auth

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

authentication

Identify yourself to the system. You will need a login id and password to prove your identity to the system

authentication_login

Calls "authenticate" in CatalystX::Usul::Controller

base

A midpoint in the URI that does nothing except act as a placeholder for the namespace which is entrance

begin

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_password

Change your password. Passwords will be checked for conformance with local rules

change_password_set

This private method invokes the data model to update a user password

check_field

Action to enable Ajax field checking. Calls method of same name in parent class

common

A midpoint in the URI. A number of other actions are chained off this one. It sets up the navigation menu and form keys

doc_base

Another midpoint, this one is used by documentation endpoints

documentation

Links to the HTML documentation index generated from POD. It can be regenerated with the command

   bin/munchies_cli -n -c pod2html

footer

Adds some debug information to the footer div. Called via the async form widget

module_docs

Displays the POD for the selected module

modules

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

navigation_sidebar

Action for the Ajax call that puts a navigation tree in a sidebar panel

reception_base

Intermediate subroutine maps to the reception path part. Both reception landing page and the tutorial chain to this controller

reception

Display the splash page for the application

redirect_to_default

Redirects client to this controllers default page

register_base

Midpoint that stashes a copy of the register model for use by the site registration actions

register

User self registration page

register_create

Private method calls the data model to create a new user account

sitemap

Displays links to all the rooms on this site

tutorial

Guides you through the elements common to all rooms on this site

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 ^

None known

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) 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

syntax highlighting: