OpenGuides::CGI - An OpenGuides helper for CGI-related things.
Does CGI stuff for OpenGuides. Distributed and installed as part of the OpenGuides project, not intended for independent installation. This documentation is probably only useful to OpenGuides developers.
Saving preferences in a cookie:
use Config::Tiny; use OpenGuides::CGI; use OpenGuides::Template; use OpenGuides::Utils; my $config = Config::Tiny->read( "wiki.conf" ); my $cookie = OpenGuides::CGI->make_prefs_cookie( config => $config, username => "Kake", include_geocache_link => 1, preview_above_edit_box => 1, latlong_traditional => 1, omit_help_links => 1, show_minor_edits_in_rc => 1, default_edit_type => "tidying", cookie_expires => "never", track_recent_changes_views => 1, ); my $wiki = OpenGuides::Utils->make_wiki_object( config => $config ); print OpenGuides::Template->output( wiki => $wiki, config => $config, template => "preferences.tt", cookies => $cookie ); # and to retrive prefs later: my %prefs = OpenGuides::CGI->get_prefs_from_cookie( config => $config );
Tracking visits to Recent Changes:
use Config::Tiny; use OpenGuides::CGI; use OpenGuides::Template; use OpenGuides::Utils; my $config = Config::Tiny->read( "wiki.conf" ); my $cookie = OpenGuides::CGI->make_recent_changes_cookie( config => $config, );
my $cookie = OpenGuides::CGI->make_prefs_cookie( config => $config, username => "Kake", include_geocache_link => 1, preview_above_edit_box => 1, latlong_traditional => 1, omit_help_links => 1, show_minor_edits_in_rc => 1, default_edit_type => "tidying", cookie_expires => "never", track_recent_changes_views => 1, );
Croaks unless a Config::Tiny object is supplied as config. Acceptable values for cookie_expires are never, month, year; anything else will default to month.
config
cookie_expires
never
month
year
my %prefs = OpenGuides::CGI->get_prefs_from_cookie( config => $config );
Croaks unless a Config::Tiny object is supplied as config. Returns default values for any parameter not specified in cookie.
my $cookie = OpenGuides::CGI->make_recent_changes_cookie( config => $config, );
Makes a cookie that stores the time now as the time of the latest visit to Recent Changes. Or, if clear_cookie is specified and true, makes a cookie with an expiration date in the past:
clear_cookie
my $cookie = OpenGuides::CGI->make_recent_changes_cookie( config => $config, clear_cookie => 1, );
my %prefs = OpenGuides::CGI->get_last_recent_changes_visit_from_cookie( config => $config );
Croaks unless a Config::Tiny object is supplied as config. Returns the time (as seconds since epoch) of the user's last visit to Recent Changes.
The OpenGuides Project (openguides-dev@openguides.org)
Copyright (C) 2003-4 The OpenGuides Project. All Rights Reserved.
This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
To install OpenGuides, copy and paste the appropriate command in to your terminal.
cpanm
cpanm OpenGuides
CPAN shell
perl -MCPAN -e shell install OpenGuides
For more information on module installation, please visit the detailed CPAN module installation guide.