NAME
CGI::WPM::Globals - Perl module that is used by all subclasses of CGI::WPM::Base for managing global program settings, file system and web site hierarchy contexts, providing environment details, gathering and managing user input, collecting and sending user output, and providing utilities like sending e-mail.
DEPENDENCIES
Perl Version
5.004Standard Modules
Net::SMTP 2.15 (used only if we send e-mails; earlier v may work)Nonstandard Modules
CGI::WebUserInput 0.91
CGI::WebUserOutput 0.91SYNOPSIS
This POD is coming when I get the time to write it.
DESCRIPTION
This POD is coming when I get the time to write it.
SYNTAX
This class does not export any functions or methods, so you need to call them using indirect notation. This means using Class->function() for functions and $object->method() for methods.
FUNCTIONS AND METHODS
This module inherits the full public interfaces and functionality of both CGI::WebUserInput and CGI::WebUserOutput, so the POD in those modules is also applicable to this one. However, the new() and initialize() and clone() methods of those modules are overridden by ones defined in this one.
This POD is coming when I get the time to write it.
new([ ROOT[, DELIM[, PREFS[, USER_INPUT]]] ])
initialize([ ROOT[, DELIM[, PREFS[, USER_INPUT]]] ])
clone([ CLONE ]) -- POD for this available below
is_debug([ NEW_VALUE ])
get_errors()
get_error([ INDEX ])
add_error( MESSAGE )
add_no_error()
add_filesystem_error( FILENAME, UNIQUE_STR )
site_root_dir([ NEW_VALUE ])
system_path_delimiter([ NEW_VALUE ])
phys_filename_string( FILENAME )
site_prefs([ NEW_VALUES ])
move_site_prefs([ NEW_VALUES ])
restore_site_prefs()
site_pref( NAME[, NEW_VALUE] )
site_resource_path([ NEW_VALUE ])
site_resource_path_string()
move_current_srp([ CHANGE_VECTOR ])
restore_last_srp()
srp_child( FILENAME )
srp_child_string( FILENAME[, SUFFIX] )
virtual_resource_path([ NEW_VALUE ])
virtual_resource_path_string()
move_current_vrp([ CHANGE_VECTOR ])
restore_last_vrp()
vrp_child( FILENAME )
vrp_child_string( FILENAME[, SUFFIX] )
user_vrp([ NEW_VALUE ])
user_vrp_string()
current_user_vrp_level([ NEW_VALUE ])
inc_user_vrp_level()
dec_user_vrp_level()
current_user_vrp_element([ NEW_VALUE ])
vrp_param_name([ NEW_VALUE ])
persistant_vrp_url([ CHANGE_VECTOR ])
smtp_host([ NEW_VALUE ])
smtp_timeout([ NEW_VALUE ])
site_title([ NEW_VALUE ])
site_owner_name([ NEW_VALUE ])
site_owner_email([ NEW_VALUE ])
site_owner_email_vrp([ NEW_VALUE ])
site_owner_email_html([ VISIBLE_TEXT ])
send_email_message( TO_NAME, TO_EMAIL, FROM_NAME, FROM_EMAIL,
SUBJECT, BODY[, BODY_HEAD_ADD] )
today_date_utc()
get_hash_from_file( PHYS_PATH )
get_prefs_rh( FILENAME )
site_path_str_to_ra( PATH_STRING )
site_path_ra_to_str( PATH_RA )
join_two_path_ra( CURRENT_PATH_RA, CHANGE_VECTOR_RA )
simplify_path_ra( PATH_RA )clone([ CLONE ])
This method initializes a new object to have all of the same properties of the current object and returns it. This new object can be provided in the optional argument CLONE (if CLONE is an object of the same class as the current object); otherwise, a brand new object of the current class is used. Only object properties recognized by CGI::WPM::Globals are set in the clone; other properties are not changed.
AUTHOR
Copyright (c) 1999-2000, Darren R. Duncan. All rights reserved. This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. However, I do request that this copyright information remain attached to the file. If you modify this module and redistribute a changed version then please attach a note listing the modifications.
I am always interested in knowing how my work helps others, so if you put this module to use in any of your own code then please send me the URL. Also, if you make modifications to the module because it doesn't work the way you need, please send me a copy so that I can roll desirable changes into the main release.
Address comments, suggestions, and bug reports to perl@DarrenDuncan.net.
SEE ALSO
perl(1).