Name
CatalystX::Usul::Plugin::Controller::ModelHelper - Convenience methods for common model calls
Version
0.7.$Revision: 1181 $
Synopsis
package CatalystX::Usul;
use parent qw(CatalystX::Usul::Base CatalystX::Usul::File);
package CatalystX::Usul::Controller;
use parent qw(Catalyst::Controller CatalystX::Usul);
package YourApp::Controller::YourController;
use parent qw(CatalystX::Usul::Controller);Description
Many convenience methods for common model calls
Subroutines/Methods
add_header
Calls method of the same name on the navigation model
check_field
Creates an XML response to and Ajax call which validates a data value for a given form field. Calls "check_field" in CatalystX::Usul::Model
close_footer
Forces the footer to not be displayed when the page is rendered
close_sidebar
Forces the sidebar to not be displayed when the page is rendered
default
Generates a simple page not found page. No longer called as unknown pages cause a redirect to the controllers default page
help
Generates a context sensitive help page by calling get_help
open_footer
Sets the key/value pair in the browser state cookie that will cause the footer to appear in the generated page
open_sidebar
Sets the key/value pair in the browser state cookie that will cause the sidebar to appear in the generated page
query_array
Exposes the method of the same name in the base model class
query_value
Exposes the method of the same name in the base model class
reset_nav_menu
$model_obj = $self->reset_nav_menu( $c, $key );Calls add_header and clear_controls on the stashed nav_model. Optionally calls an add_menu_* method on the stashed nav_model if $key is one of; back, blank, or close. Returns the stashed nav_model object
select_sidebar_panel
Set the cookie that controls which sidebar panel is visible
set_identity_model
Stashes currently selected realm name. Determines and stashes the current user and roles models based on the current realm
set_popup
Sets the popup flag to stop the browser from caching the window size in the browser state cookie. Clears the main navigation menu and adds a close window link
Diagnostics
None
Configuration and Environment
None
Dependencies
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) 2008 Pete 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