Name
CatalystX::Usul::Model::Navigation - Navigation links and access control
Version
0.6.$Revision: 1165 $
Synopsis
package MyApp;
use Catalyst qw(ConfigComponents);
# In the application configuration file
<component name="Model::Navigation">
<base_class>CatalystX::Usul::Model::Navigation</base_class>
</component>Description
Provides methods for creating navigation links and access control
Subroutines/Methods
COMPONENT
Called by Catalyst when the application starts it sets the default action from global config and sets up the list of available skins
access_check
$state = $c->model( q(Navigation) )->access_check( @args );Expects to be passed the stash ($c->stash), a key to search in the stash ($args[0]) and a level or room to search for ($args[1]). It returns 0 if the ACL on the requested level/room permits access to the current user. It returns 1 if no ACL was found. It returns 2 if the current user is unknown and the level/room's ACL did not contain the value any which would permit anonymous access. It returns 3 if the current user is explicitly denied access to the selected level/room
This method is called from /add_nav_menu (via the /allowed method which negates the result) to determine which levels the current user has access to. It is also called by /auto to determine if access to the requested endpoint is permitted
It could also be used from an application controller method to allow the display logic to display content based on the users identity
access_control_form
$c->model( q(Navigation) )->form( $namespace, $name );Stuffs the stash with the data for the form that controls access to levels and rooms
add_header
$c->model( q(Navigation) )->add_header;Calls parent method. Adds main and tools menu data. Adds quick link data
Calls "add_nav_menu". This is the main navigation menu
Calls "add_utils_menu"
Calls add_quick_links. Quick links appear in the header and are selected from the rooms config items if the quick_link element is set. It's numeric value determines the sort order of the links
add_help_menu
Help menu options
add_footer
Adds some useful debugging info to the footer
add_menu_back
$c->model( q(Navigation) )->add_menu_back( $args );Adds a history back link to the main navigation menu
add_menu_blank
$c->model( q(Navigation) )->add_menu_blank( $args );Adds some filler to the main navigation menu
add_menu_close
$c->model( q(Navigation) )->add_menu_close( $args );Adds a window close link to the main navigation menu
add_nav_menu
$c->model( q(Navigation) )->add_nav_menu;Returns the data used to generate the main navigation menu. The menu uses a Cone Trees layout which has been flattened to produce a visual trail of breadcrumbs effect, i.e. Home > Reception > Tutorial
add_quick_links
$links = $c->model( q(Navigation) )->add_quick_links;Returns the data used to display "quick" navigation links. Caches data on first use. These usually appear in the header and allow single click access to any endpoint. They are identified in the configuration by adding a quick_link attribute to the rooms element. The quick_link attribute value is an integer which determines the display order
add_sidebar_panel
Adds a sidebar panel containing a tree widget that represents all the action available in the application (another sitemap)
add_tools_menu
Utility menu options
add_tree_panel
$c->model( q(Navigation) )->add_tree_panel;Calls "_get_tree_panel_data" and creates a tree widget using the data. Implements the navigation sidebar
add_utils_menu
$c->model( q(Navigation) )->add_utils_menu;Returns the stash data for the utilities menu. This contains a selection of utility options including: toggle runtime debugging, toggle footer, skin switching, context sensitive help, about popup, email feedback and logout option. Calls "add_help_menu" and "add_tools_menu"
allowed
$bool = $c->model( q(Navigation) )->allowed( @args );Negates the result returned by "access_check". Called from "add_nav_menu" to determine if a page is accessible to a user. If the user does not have access then do not display a link to it
app_closed_form
$c->model( q(Navigation) )->app_closed_form;Allows administrators to authenticate and reopen the application
room_manager_form
$c->model( q(Navigation) )->room_manager_form( $namespace, $name );Allows for editing of the level and room definition elements in the configuration files
select_this
$c->model( q(Navigation) )->select_this( $menu_num, $order, $widget );Make the widget the selected menu item
sitemap
$c->model( q(Navigation) )->sitemap;Displays a table of all the pages on the site
_get_tree_panel_data
$data = $c->model( q(Navigation) )->_get_tree_panel_data;Called by "sitemap" this method generates the table data used by HTML::FormWidgets's Tree subclass
_get_sitemap_data
$data = $c->model( q(Navigation) )->_get_sitemap_data;Called by "sitemap" this method generates an array of hash refs used by HTML::FormWidgets's TabSwapper subclass
_get_sitemap_table
$data = $c->model( q(Navigation) )->_get_sitemap_table( $ns );Called by "_get_sitemap_data" this method generates the table data used by HTML::FormWidgets's Table subclass
_push_menu_link
$self->_push_menu_link( $name, $order, $ref );Pushes an anchor widget $ref onto a menu structure
_unshift_menu_item
$self->_unshift_menu_item( $name, $order, $widget );Unshift an anchor widget onto a menu structure
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) 2011 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