Name

CatalystX::Usul::Controller::Admin - Administration controller methods

Version

Describes v0.16.$Rev: 1 $

Synopsis

   package YourApp::Controller::Admin;

   use CatalystX::Usul::Moose;

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

   __PACKAGE__->build_subcontrollers;

Description

Controller actions that inherit from CatalystX::Usul::Controller

Configuration and Environment

Defines the following attributes

default_action

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

security_logfile

A non empty simple string which defaults to admin.log. The name of the logfile for the suid administration program

Subroutines/Methods

base

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

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

build_subcontrollers

Exposes method of the same name in the role Class::Usul::TraitFor::LoadingClasses which defines some sub-controllers at runtime

check_field

Forward Ajax requests for this controller to the generic base class method

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

footer

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

logfile_menu

Midpoint off which the log file viewing endpoints are chained

overview

Endpoint for the Ajax call that populates one of the panels on the accordion widget

Generates some blurb for the Overview panel of the sidebar accordion widget

reception

Displays the splash screen for this controller explaining it's purpose

redirect_to_default

Redirects to the splash screen for this level

sessions

Displays the current user sessions stored in the session store

version

Return the version number of this module

view_security_log

Endpoint that displays the log file used by the suid root wrapper script

view_logfile

Endpoint that displays the application server log file

Diagnostics

None

Dependencies

CatalystX::Usul::Controller

CatalystX::Usul::TraitFor::Controller::ModelHelper

CatalystX::Usul::TraitFor::Controller::PersistentState

CatalystX::Usul::Moose

Class::Usul::TraitFor::LoadingClasses

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

cpanm CatalystX::Usul

perl -MCPAN -e shell
install CatalystX::Usul