loncom/LONCAPA.pm - diff

Return to LONCAPA.pm CVS log

Up to [LON-CAPA] / loncom

Diff for /loncom/LONCAPA.pm between versions 1.24 and 1.25

-version 1.24, 2007/07/02 21:15:29
+version 1.25, 2008/11/17 13:22:01
  Line 27
  #
  ###
+ =head1 NAME
+ Apache::LONCAPA
+ LONCAPA - Basic routines
+ =head1 SYNOPSIS
+ Generally useful routines
+ =head1 EXPORTED SUBROUTINES
+ =over 4
+ =item *
+ escape() : unpack non-word characters into CGI-compatible hex codes
+ =item *
+ unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
+ =item *
+ add_get_param() :
+  Inputs:  url (with or without exit GET from parameters), hash ref of
+               form name => value pairs
+  Return: url with properly added the form name elements and values to the
+          the url doing proper escaping of the values and joining with ? or &
+          as needed
+ =back
+ =cut
  package LONCAPA;
  use strict;
- Line 170  sub propath {
+ Line 206  sub propath {
  #---------------------------------------------------------------
- #
- # Manipulation of hash based databases (factoring out common code
+ =pod
- # for later use as we refactor.
- #
+ =item tie_domain_hash()
- #  Ties a domain level resource file to a hash.
- #  If requested a history entry is created in the associated hist file.
+ Manipulation of hash based databases (factoring out common code
- #
+ for later use as we refactor.
- #  Parameters:
- #     domain    - Name of the domain in which the resource file lives.
+  Ties a domain level resource file to a hash.
- #     namespace - Name of the hash within that domain.
+  If requested a history entry is created in the associated hist file.
- #     how       - How to tie the hash (e.g. GDBM_WRCREAT()).
- #     loghead   - Optional parameter, if present a log entry is created
+  Parameters:
- #                 in the associated history file and this is the first part
+     domain    - Name of the domain in which the resource file lives.
- #                  of that entry.
+     namespace - Name of the hash within that domain.
- #     logtail   - Goes along with loghead,  The actual logentry is of the
+     how       - How to tie the hash (e.g. GDBM_WRCREAT()).
- #                 form $loghead:<timestamp>:logtail.
+     loghead   - Optional parameter, if present a log entry is created
- # Returns:
+                 in the associated history file and this is the first part
- #    Reference to a hash bound to the db file or alternatively undef
+                  of that entry.
- #    if the tie failed.
+     logtail   - Goes along with loghead,  The actual logentry is of the
- #
+                 form $loghead:<timestamp>:logtail.
+ Returns:
+    Reference to a hash bound to the db file or alternatively undef
+    if the tie failed.
+ =cut
  sub tie_domain_hash {
      my ($domain,$namespace,$how,$loghead,$logtail) = @_;
- Line 208  sub tie_domain_hash {
+ Line 250  sub tie_domain_hash {
  sub untie_domain_hash {
      return &_locking_hash_untie(@_);
  }
- #
- #   Ties a user's resource file to a hash.
+ =pod
- #   If necessary, an appropriate history
- #   log file entry is made as well.
+ =item tie_user_hash()
- #   This sub factors out common code from the subs that manipulate
- #   the various gdbm files that keep keyword value pairs.
+   Ties a user's resource file to a hash.
- # Parameters:
+   If necessary, an appropriate history
- #   domain       - Name of the domain the user is in.
+   log file entry is made as well.
- #   user         - Name of the 'current user'.
+   This sub factors out common code from the subs that manipulate
- #   namespace    - Namespace representing the file to tie.
+   the various gdbm files that keep keyword value pairs.
- #   how          - What the tie is done to (e.g. GDBM_WRCREAT().
+ Parameters:
- #   loghead      - Optional first part of log entry if there may be a
+   domain       - Name of the domain the user is in.
- #                  history file.
+   user         - Name of the 'current user'.
- #   what         - Optional tail of log entry if there may be a history
+   namespace    - Namespace representing the file to tie.
- #                  file.
+   how          - What the tie is done to (e.g. GDBM_WRCREAT().
- # Returns:
+   loghead      - Optional first part of log entry if there may be a
- #   hash to which the database is tied.  It's up to the caller to untie.
+                  history file.
- #   undef if the has could not be tied.
+   what         - Optional tail of log entry if there may be a history
- #
+                  file.
+ Returns:
+   hash to which the database is tied.  It's up to the caller to untie.
+   undef if the has could not be tied.
+ =cut
  sub tie_user_hash {
      my ($domain,$user,$namespace,$how,$loghead,$what) = @_;
- Line 241  sub untie_user_hash {
+ Line 289  sub untie_user_hash {
      return &_locking_hash_untie(@_);
  }
- # routines if you just have a filename
+ =pod
- # return tied hashref or undef
+ =item locking_hash_tie()
+ routines if you just have a filename
+ return tied hashref or undef
+ =cut
  sub locking_hash_tie {
      my ($filename,$how)=@_;
- Line 416  BEGIN {
+ Line 470  BEGIN {
  __END__
- =pod
- =head1 NAME
- LONCAPA - Basic routines
- =head1 SYNOPSIS
- Generally useful routines
- =head1 EXPORTED SUBROUTINES
- =over 4
- =item *
- escape() : unpack non-word characters into CGI-compatible hex codes
- =item *
- unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
- =item *
- add_get_param() :
-  Inputs:  url (with or without exit GET from parameters), hash ref of
-               form name => value pairs
-  Return: url with properly added the form name elements and values to the
-          the url doing proper escaping of the values and joining with ? or &
-          as needed
- =back

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>

Removed from v.1.24
changed lines
	Added in v.1.25