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

Fixed some POD formatting.

Browse source
This commit is contained in:
JT Smith 2002-12-17 00:39:48 +00:00
parent 50948d36d6
commit 005e2eb8aa
28 changed files with 148 additions and 159 deletions
Download patch file Download diff file Expand all files Collapse all files

26
lib/WebGUI/Attachment.pm
View file

@ -36,19 +36,23 @@ use WebGUI::Utility;
Package WebGUI::Attachment
=head1 DESCRIPTION
Package to manipulate WebGUI Attachments.
=head1 SYNOPSIS
use WebGUI::Attachment;
$attachment = WebGUI::Attachment->new("file.txt","100","20");
$html = $attachment->box;
$string = $attachment->getFilename;
$url = $attachment->getIcon;
$string = $attachment->getPath;
$integer = $attachment->getSize;
$url = $attachment->getThumbnail;
$string = $attachment->getType;
$url = $attachment->getURL;
$boolean = $attachment->isImage;
$html = $attachment->box;
$string = $attachment->getFilename;
$url = $attachment->getIcon;
$string = $attachment->getPath;
$integer = $attachment->getSize;
$url = $attachment->getThumbnail;
$string = $attachment->getType;
$url = $attachment->getURL;
$boolean = $attachment->isImage;
$attachment->copy("files","10");
$attachment->createThumbnail;
$attachment->delete;
@ -58,10 +62,6 @@ Package WebGUI::Attachment
$filename = $attachment->save("formImage");
$filename = $attachment->saveFromFilesystem($pathToFile);
=head1 DESCRIPTION
Package to manipulate WebGUI Attachments.
=head1 METHODS
These methods are available from this class:

8
lib/WebGUI/Authentication.pm
View file

@ -26,6 +26,10 @@ use WebGUI::SQL;
Package WebGUI::Authentication
=head1 DESCRIPTION
This package is used to access WebGUI's pluggable authentication system.
=head1 SYNOPSIS
use WebGUI::Authentication;
@ -52,10 +56,6 @@ Package WebGUI::Authentication
WebGUI::Authentication::userFormSave();
$error = WebGUI::Authentication::userFormValidate();
=head1 DESCRIPTION
This package is used to access WebGUI's pluggable authentication system.
=head1 METHODS
These functions are available from this package:

36
lib/WebGUI/DateTime.pm
View file

@ -30,28 +30,28 @@ our @EXPORT = qw(&localtime &time &addToTime &addToDate &epochToHuman &epochToSe
Package WebGUI::DateTime
=head1 SYNOPSIS
use WebGUI::DateTime;
$epoch = WebGUI::DateTime::addToDate($epoch, $years, $months, $days);
$epoch = WebGUI::DateTime::addToTime($epoch, $hours, $minutes, $seconds);
($startEpoch, $endEpoch) = WebGUI::DateTime::dayStartEnd($epoch);
$dateString = WebGUI::DateTime::epochToHuman($epoch, $formatString);
$setString = WebGUI::DateTime::epochToSet($epoch);
$day = WebGUI::DateTime::getDayName($dayInteger);
$month = WebGUI::DateTime::getMonthName($monthInteger);
$epoch = WebGUI::DateTime::humanToEpoch($dateString);
$seconds = WebGUI::DateTime::intervalToSeconds($interval, $units);
@date = WebGUI::DateTime::localtime($epoch);
($startEpoch, $endEpoch) = WebGUI::DateTime::monthStartEnd($epoch);
($interval, $units) = WebGUI::DateTime::secondsToInterval($seconds);
$epoch = WebGUI::DateTime::setToEpoch($setString);
$epoch = WebGUI::DateTime::time();
=head1 DESCRIPTION
This package provides easy to use date math functions, which are normally a complete pain.
=head1 SYNOPSIS
use WebGUI::DateTime;
$epoch = WebGUI::DateTime::addToDate($epoch, $years, $months, $days);
$epoch = WebGUI::DateTime::addToTime($epoch, $hours, $minutes, $seconds);
($startEpoch, $endEpoch) = WebGUI::DateTime::dayStartEnd($epoch);
$dateString = WebGUI::DateTime::epochToHuman($epoch, $formatString);
$setString = WebGUI::DateTime::epochToSet($epoch);
$day = WebGUI::DateTime::getDayName($dayInteger);
$month = WebGUI::DateTime::getMonthName($monthInteger);
$epoch = WebGUI::DateTime::humanToEpoch($dateString);
$seconds = WebGUI::DateTime::intervalToSeconds($interval, $units);
@date = WebGUI::DateTime::localtime($epoch);
($startEpoch, $endEpoch) = WebGUI::DateTime::monthStartEnd($epoch);
($interval, $units) = WebGUI::DateTime::secondsToInterval($seconds);
$epoch = WebGUI::DateTime::setToEpoch($setString);
$epoch = WebGUI::DateTime::time();
=head1 METHODS
These functions are available from this package:

6
lib/WebGUI/Discussion.pm
View file

@ -26,11 +26,11 @@ use WebGUI::URL;
use WebGUI::User;
=head1 WebGUI Discussions
This package implements WebGUI's discussion system. However it is outdated and cludgy. We recommend not coding any new systems against this package, but instead wait for the new package that will be created in 6.0.0.
### NOTE: This package implements WebGUI's discussion system. However it is
### outdated and cludgy. We recommend not coding any new systems against this
### package, but instead wait for the new package that will be created in 6.0.0.
=cut
#-------------------------------------------------------------------
sub _deleteReplyTree {

10
lib/WebGUI/ErrorHandler.pm
View file

@ -20,7 +20,11 @@ use WebGUI::Session;
=head1 NAME
WebGUI::ErrorHandler
Package WebGUI::ErrorHandler
=head1 DESCRIPTION
This package provides simple but effective error handling and logging for WebGUI.
=head1 SYNOPSIS
@ -30,10 +34,6 @@ WebGUI::ErrorHandler
WebGUI::ErrorHandler::security(message);
WebGUI::ErrorHandler::warn(message);
=head1 DESCRIPTION
This package provides simple but effective error handling and logging for WebGUI.
=head1 METHODS
These functions are available from this package:

10
lib/WebGUI/Form.pm
View file

@ -27,6 +27,10 @@ use WebGUI::URL;
Package WebGUI::Form
=head1 DESCRIPTION
Base forms package. Eliminates some of the normal code work that goes along with creating forms. Used by the HTMLForm package.
=head1 SYNOPSIS
use WebGUI::Form;
@ -58,11 +62,7 @@ Package WebGUI::Form
$html = WebGUI::Form::yesNo({name=>"happy"});
$html = WebGUI::Form::zipcode({name=>"workZip"});
=head1 DESCRIPTION
Base forms package. Eliminates some of the normal code work that goes along with creating forms. Used by the HTMLForm package.
=head1 FUNCTIONS
=head1 METHODS
All of the functions in this package accept the input of a hash reference containing the parameters to populate the form element. These functions are available from this package:

8
lib/WebGUI/HTML.pm
View file

@ -22,16 +22,16 @@ use WebGUI::Session;
Package WebGUI::HTML
=head1 DESCRIPTION
A package for manipulating and massaging HTML.
=head1 SYNOPSIS
use WebGUI::HTML;
$html = WebGUI::HTML::cleanSegment($html);
$html = WebGUI::HTML::filter($html);
=head1 DESCRIPTION
A package for manipulating and massaging HTML.
=head1 METHODS
These methods are available from this package:

18
lib/WebGUI/HTMLForm.pm
View file

@ -27,6 +27,10 @@ use WebGUI::SQL;
Package WebGUI::HTMLForm
=head1 DESCRIPTION
Package that makes HTML forms typed data and significantly reduces the code needed for properties pages in WebGUI.
=head1 SYNOPSIS
use WebGUI::HTMLForm;
@ -72,10 +76,6 @@ Alternatively each of these methods can also be called with the tag element synt
$f->print;
$f->printRowsOnly;
=head1 DESCRIPTION
Package that makes HTML forms typed data and significantly reduces the code needed for properties pages in WebGUI.
=head1 METHODS
These methods are available from this class:
@ -1341,13 +1341,7 @@ sub readOnly {
}
#-------------------------------------------------------------------
=head2 select
Use of this method is depricated. Use selectList instead.
=cut
#Use of this method is depricated. Use selectList instead.
sub select {
my $self = shift;
return $self->selectList(@_);
@ -1355,7 +1349,7 @@ sub select {
#-------------------------------------------------------------------
=head2 selectList ( name, options [ label, value, size, multiple, extras, subtext, uiLevel ] )
=head2 selectList ( name, options, [ label, value, size, multiple, extras, subtext, uiLevel ] )
Adds a select list row to this form.

8
lib/WebGUI/Icon.pm
View file

@ -27,6 +27,10 @@ our @EXPORT = qw(&helpIcon &becomeIcon &cutIcon &copyIcon &deleteIcon &editIcon
Package WebGUI::Icon
=head1 DESCRIPTION
A package for generating user interface buttons. The subroutines found herein do nothing other than to create a short way of doing much longer repetitive tasks. They simply make the programmer's life easier through fewer keystrokes and less cluttered code.
=head1 SYNOPSIS
use WebGUI::Icon;
@ -44,10 +48,6 @@ Package WebGUI::Icon
$html = viewIcon('op=something');
$html = wobjectIcon();
=head1 DESCRIPTION
A package for generating user interface buttons. The subroutines found herein do nothing other than to create a short way of doing much longer repetitive tasks. They simply make the programmer's life easier through fewer keystrokes and less cluttered code.
=head1 METHODS
These subroutines are available from this package:

14
lib/WebGUI/International.pm
View file

@ -24,17 +24,17 @@ my %international;
Package WebGUI::International
=head1 DESCRIPTION
This package provides an interface to the internationalization system.
=head1 SYNOPSIS
use WebGUI::International;
$string = WebGUI::International::get($internationalId,$namespace,$languageId);
%languages = WebGUI::International::getLanguages();
$string = WebGUI::International::get($internationalId,$namespace);
%languages = WebGUI::International::getLanguages();
=head1 DESCRIPTION
This package provides an interface to the internationalization system.
=head1 FUNCTIONS
=head1 METHODS
These functions are available from this package:

12
lib/WebGUI/Macro.pm
View file

@ -24,18 +24,18 @@ use WebGUI::Session;
Package WebGUI::Macro
=head1 DESCRIPTION
This package is the interface to the WebGUI macro system.
NOTE: This entire system is likely to be replaced in the near future. It has served WebGUI well since the very beginning but lacks the speed and flexibility that WebGUI users will require in the future.
=head1 SYNOPSIS
use WebGUI::Macro;
@array = WebGUI::Macro::getParams($parameterString);
$html = WebGUI::Macro::process($html);
=head1 DESCRIPTION
This package is the interface to the WebGUI macro system.
NOTE: This entire system is likely to be replaced in the near future. It has served WebGUI well since the very beginning but lacks the speed and flexibility that WebGUI users will require in the future.
=head1 METHODS
These functions are available from this package:

8
lib/WebGUI/Mail.pm
View file

@ -24,15 +24,15 @@ use WebGUI::Session;
Package WebGUI::Mail
=head1 DESCRIPTION
This package provides access to use SMTP based email services.
=head1 SYNOPSIS
use WebGUI::Mail;
WebGUI::Mail::send($to,$subject,$message);
=head1 DESCRIPTION
This package provides access to use SMTP based email services.
=head1 METHODS
These methods are available from this class:

8
lib/WebGUI/MessageLog.pm
View file

@ -31,6 +31,10 @@ use WebGUI::Utility;
Package WebGUI::MessageLog
=head1 DESCRIPTION
This package is WebGUI's notification system.
=head1 SYNOPSIS
use WebGUI::MessageLog;
@ -38,10 +42,6 @@ Package WebGUI::MessageLog
WebGUI::MessageLog::addInternationalizedEntry($userId,$groupId,$url,$internationalId);
WebGUI::MessageLog::completeEntry($messageLogId);
=head1 DESCRIPTION
This package is WebGUI's notification system.
=head1 METHODS
These functions are available from this package:

8
lib/WebGUI/Navigation.pm
View file

@ -27,6 +27,10 @@ use WebGUI::URL;
Package WebGUI::Navigation
=head1 DESCRIPTION
A package used to generate navigation.
=head1 SYNOPSIS
use WebGUI::Navigation;
@ -35,10 +39,6 @@ Package WebGUI::Navigation
$html = WebGUI::Navigation::drawHorizontal($tree);
$html = WebGUI::Navigation::drawVertical($tree);
=head1 DESCRIPTION
A package used to generate navigation.
=head1 METHODS
These methods are available from this package:

8
lib/WebGUI/Node.pm
View file

@ -24,6 +24,10 @@ use WebGUI::Session;
Package WebGUI::Node
=head1 DESCRIPTION
Package to manipulate WebGUI storage nodes. The nodes system is a two-tiered filesystem hash that WebGUI uses to keep attachment data separated. There should be no need for anyone other than Plain Black Software to use this package.
=head1 SYNOPSIS
use WebGUI::Node;
@ -34,10 +38,6 @@ Package WebGUI::Node
$node->getPath;
$node->getURL;
=head1 DESCRIPTION
Package to manipulate WebGUI storage nodes. The nodes system is a two-tiered filesystem hash that WebGUI uses to keep attachment data separated. There should be no need for anyone other than Plain Black Software to use this package.
=head1 METHODS
These methods are available from this package:

8
lib/WebGUI/Page.pm
View file

@ -30,6 +30,10 @@ use WebGUI::Template;
Package WebGUI::Page
=head1 DESCRIPTION
This package provides utility functions for WebGUI's page system.
=head1 SYNOPSIS
use WebGUI::Page;
@ -40,10 +44,6 @@ Package WebGUI::Page
$hashRef = WebGUI::Page::getTemplatePositions($templateId);
$url = WebGUI::Page::makeUnique($url,$pageId);
=head1 DESCRIPTION
This package provides utility functions for WebGUI's page system.
=head1 METHODS
These functions are available from this package:

8
lib/WebGUI/Paginator.pm
View file

@ -23,6 +23,10 @@ use WebGUI::URL;
Package WebGUI::Paginator
=head1 DESCRIPTION
Package that paginates rows of arbitrary data for display on the web.
=head1 SYNOPSIS
use WebGUI::Paginator;
@ -43,10 +47,6 @@ Package WebGUI::Paginator
$html = $p->getPageLinks;
$html = $p->getPreviousPageLink;
=head1 DESCRIPTION
Package that paginates rows of arbitrary data for display on the web.
=head1 METHODS
These methods are available from this class:

11
lib/WebGUI/Privilege.pm
View file

@ -26,6 +26,10 @@ use WebGUI::URL;
Package WebGUI::Privilege
=head1 DESCRIPTION
This package provides access to the WebGUI security system and security messages.
=head1 SYNOPSIS
use WebGUI::Privilege;
@ -38,12 +42,7 @@ Package WebGUI::Privilege
$html = WebGUI::Privilege::notMember();
$html = WebGUI::Privilege::vitalComponent();
=head1 DESCRIPTION
This package provides access to the WebGUI security system and security messages.
=head1 FUNCTIONS
=head1 METHODS
These functions are available from this package:

8
lib/WebGUI/Profile.pm
View file

@ -23,15 +23,15 @@ use WebGUI::URL;
Package WebGUI::Profile
=head1 DESCRIPTION
Package that allows getting and setting of user profile information.
=head1 SYNOPSIS
use WebGUI::Profile;
$p = WebGUI::Profile->new(39);
=head1 DESCRIPTION
Package that allows getting and setting of user profile information.
=head1 METHODS
These methods are available from this class:

8
lib/WebGUI/SQL.pm
View file

@ -29,6 +29,10 @@ our @EXPORT = qw(&quote &getNextId);
Package WebGUI::SQL
=head1 DESCRIPTION
Package for interfacing with SQL databases. This package implements Perl DBI functionality in a less code-intensive manner and adds some extra functionality.
=head1 SYNOPSIS
use WebGUI::SQL;
@ -56,10 +60,6 @@ Package WebGUI::SQL
$id = getNextId("wobjectId");
$string = quote($string);
=head1 DESCRIPTION
Package for interfacing with SQL databases. This package implements Perl DBI functionality in a less code-intensive manner and adds some extra functionality.
=head1 METHODS
These methods are available from this package:

8
lib/WebGUI/Search.pm
View file

@ -27,16 +27,16 @@ use WebGUI::SQL;
Package WebGUI::Search
=head1 DESCRIPTION
A package built to take the hassle out of creating advanced search functionality in WebGUI applications.
=head1 SYNOPSIS
use WebGUI::Search;
$sql = WebGUI::Search::buildConstraints(\@fields);
$html = WebGUI::Search::form(\%hidden);
=head1 DESCRIPTION
A package built to take the hassle out of creating advanced search functionality in WebGUI applications.
=head1 METHODS
These methods are available from this package:

16
lib/WebGUI/Session.pm
View file

@ -35,6 +35,14 @@ tie %session, 'Tie::CPHash';
Package WebGUI::Session
=head1 DESCRIPTION
This package is the heart and lifeblood of WebGUI. Without it WebGUI could not exist. By using this package a package gains access to WebGUI's $session variable which contains everything WebGUI needs to know to operate.
NOTE: It is important to distinguish the difference between a WebGUI session and a user session. A user session is attached to a WebGUI session. A WebGUI session is all of the basic data the WebGUI needs to operate.
TIP: The $session variable is a case-insensitive hash. The contents of the has vary, but can be seen by adding debug=1 to the end of any WebGUI URL while logged in as an admin user.
=head1 SYNOPSIS
use WebGUI::Session;
@ -51,14 +59,6 @@ Package WebGUI::Session
WebGUI::Session::setScratch($name,$value);
WebGUI::Session::start($userId);
=head1 DESCRIPTION
This package is the heart and lifeblood of WebGUI. Without it WebGUI could not exist. By using this package a package gains access to WebGUI's $session variable which contains everything WebGUI needs to know to operate.
NOTE: It is important to distinguish the difference between a WebGUI session and a user session. A user session is attached to a WebGUI session. A WebGUI session is all of the basic data the WebGUI needs to operate.
TIP: The $session variable is a case-insensitive hash. The contents of the has vary, but can be seen by adding debug=1 to the end of any WebGUI URL while logged in as an admin user.
=head1 METHODS
These subroutines are available from this package:

8
lib/WebGUI/Style.pm
View file

@ -27,15 +27,15 @@ use WebGUI::Template;
Package WebGUI::Style
=head1 DESCRIPTION
This package contains utility methods for WebGUI's style system.
=head1 SYNOPSIS
use WebGUI::Style;
$style = WebGUI::Style::get();
=head1 DESCRIPTION
This package contains utility methods for WebGUI's style system.
=head1 METHODS
These subroutines are available from this package:

9
lib/WebGUI/Template.pm
View file

@ -28,6 +28,10 @@ use WebGUI::SQL;
Package WebGUI::Template
=head1 DESCRIPTION
This package contains utility methods for WebGUI's template system.
=head1 SYNOPSIS
use WebGUI::Template;
@ -35,11 +39,6 @@ Package WebGUI::Template
$hashRef = WebGUI::Template::getList($namespace);
$html = WebGUI::Template::process($template);
=head1 DESCRIPTION
This package contains utility methods for WebGUI's template system.
=head1 METHODS
These subroutines are available from this package:

8
lib/WebGUI/URL.pm
View file

@ -25,6 +25,10 @@ use WebGUI::Utility;
Package WebGUI::URL
=head1 DESCRIPTION
This package provides URL writing functionality. It is important that all WebGUI URLs be written using these methods so that they can contain any extra information that WebGUI needs to add to the URLs in order to function properly.
=head1 SYNOPSIS
use WebGUI::URL;
@ -36,10 +40,6 @@ Package WebGUI::URL
$string = WebGUI::URL::unescape($string);
$url = WebGUI::URL::urlize($string);
=head1 DESCRIPTION
This package provides URL writing functionality. It is important that all WebGUI URLs be written using these methods so that they can contain any extra information that WebGUI needs to add to the URLs in order to function properly.
=head1 METHODS
These subroutines are available from this package:

8
lib/WebGUI/User.pm
View file

@ -26,6 +26,10 @@ use WebGUI::Authentication;
Package WebGUI::User
=head1 DESCRIPTION
This package provides an object-oriented way of managing WebGUI users as well as getting/setting a users's profile data.
=head1 SYNOPSIS
use WebGUI::User;
@ -43,10 +47,6 @@ Package WebGUI::User
$u->deleteFromGroups(\@arr);
$u->delete;
=head1 DESCRIPTION
This package provides an object-oriented way of managing WebGUI users as well as getting/setting a users's profile data.
=head1 METHODS
These methods are available from this class:

9
lib/WebGUI/Utility.pm
View file

@ -29,6 +29,10 @@ our @EXPORT = qw(&makeTabSafe &makeArrayTabSafe &randomizeHash &commify &randomi
Package WebGUI::Utility
=head1 DESCRIPTION
This package provides miscellaneous but useful utilities to the WebGUI programmer.
=head1 SYNOPSIS
use WebGUI::Utility;
@ -44,11 +48,6 @@ Package WebGUI::Utility
$hashRef = sortHash(\%hash);
$hashRef = sortHashDescending(\%hash);
=head1 DESCRIPTION
This package provides miscellaneous but useful utilities to the WebGUI programmer.
=head1 METHODS
These subroutines are available from this package:

10
lib/WebGUI/Wobject.pm
View file

@ -31,12 +31,14 @@ use WebGUI::Template;
use WebGUI::URL;
use WebGUI::Utility;
=head1 NAME
Package WebGUI::Wobject
=head1 DESCRIPTION
An abstract class for all other wobjects to extend.
=head1 SYNOPSIS
use WebGUI::Wobject;
@ -44,10 +46,6 @@ Package WebGUI::Wobject
See the subclasses in lib/WebGUI/Wobjects for details.
=head1 DESCRIPTION
An abstract class for all other wobjects to extend.
=head1 METHODS
These methods are available from this class: