oqapi/webgui
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

changed POD formatting

Browse source
This commit is contained in:
JT Smith 2004-09-14 02:22:38 +00:00
parent bf5a0145ae
commit 2b6eb201a9
55 changed files with 1188 additions and 3220 deletions
Download patch file Download diff file Expand all files Collapse all files

30
lib/WebGUI/Cache.pm
View file

@ -63,14 +63,10 @@ sub delete {
Remove content from the filesystem cache where the key meets the condition of the regular expression.
=over
=item regex
=head3 regex
A regular expression that will match keys in the current namespace. Example: m/^navigation_.*/
=back
=cut
sub deleteByRegex {
@ -100,18 +96,14 @@ sub get {
Constructor.
=over
=item key
=head3 key
A key unique to this namespace. It is used to uniquely identify the cached content.
=item namespace
=head3 namespace
Defaults to the config filename for the current site. The only reason to override the default is if you want the cached content to be shared among all WebGUI instances on this machine. A common alternative namespace is "URL", which is typically used when caching content using the setByHTTP method.
=back
=cut
sub new {
@ -130,18 +122,14 @@ sub new {
Save content to the filesystem cache.
=over
=item content
=head3 content
A scalar variable containing the content to be set.
=item ttl
=head3 ttl
The time to live for this content. This is the amount of time (in seconds) that the content will remain in the cache. Defaults to "60".
=back
=cut
sub set {
@ -156,18 +144,14 @@ sub set {
Retrieves a document via HTTP and stores it in the cache and returns the content as a string.
=over
=item url
=head3 url
The URL of the document to retrieve. It must begin with the standard "http://".
=item ttl
=head3 ttl
The time to live for this content. This is the amount of time (in seconds) that the content will remain in the cache. Defaults to "60".
=back
=cut
sub setByHTTP {