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

56
lib/WebGUI/Paginator.pm
View file

@ -64,14 +64,10 @@ These methods are available from this class:
Adds paginator template vars to a hash reference.
=over
=item hashRef
=head3 hashRef
The hash reference to append the variables to.
=back
=cut
sub appendTemplateVars {
@ -282,16 +278,12 @@ sub getNumberOfPages {
Returns the data from the page specified as a string.
NOTE: This is really only useful if you passed in an array reference of strings when you created this object.
B<NOTE:> This is really only useful if you passed in an array reference of strings when you created this object.
=over
=item pageNumber
=head3 pageNumber
Defaults to the page you're currently viewing. This is mostly here as an override and probably has no real use.
=back
=cut
sub getPage {
@ -305,14 +297,10 @@ sub getPage {
Returns the data from the page specified as an array reference.
=over
=item pageNumber
=head3 pageNumber
Defaults to the page you're currently viewing. This is mostly here as an override and probably has no real use.
=back
=cut
sub getPageData {
@ -348,14 +336,10 @@ sub getPageNumber {
Returns links to all pages in this paginator.
=over
=item limit
=head3 limit
An integer representing the maximum number of page links to return. Defaultly all page links will be returned.
=back
=cut
sub getPageLinks {
@ -429,26 +413,22 @@ sub getRowCount {
Constructor.
=over
=item currentURL
=head3 currentURL
The URL of the current page including attributes. The page number will be appended to this in all links generated by the paginator.
=item paginateAfter
=head3 paginateAfter
The number of rows to display per page. If left blank it defaults to 50.
=item pageNumber
=head3 pageNumber
By default the page number will be determined by looking at $session{form}{pn}. If that is empty the page number will be defaulted to "1". If you'd like to override the page number specify it here.
=item formVar
=head3 formVar
Specify the form variable the paginator should use in it's links. Defaults to "pn".
=back
=cut
sub new {
@ -466,14 +446,10 @@ sub new {
Provide the paginator with data by giving it an array reference.
=over
=item arrayRef
=head3 arrayRef
The array reference that contains the data to be paginated.
=back
=cut
sub setDataByArrayRef {
@ -490,24 +466,20 @@ sub setDataByArrayRef {
Retrieves a data set from a database and replaces whatever data set was passed in through the constructor.
NOTE: This retrieves only the current page's data for efficiency.
B<NOTE:> This retrieves only the current page's data for efficiency.
=over
=item query
=head3 query
An SQL query that will retrieve a data set.
=item dbh
=head3 dbh
A DBI-style database handler. Defaults to the WebGUI site handler.
=item unconditional
=head3 unconditional
A boolean indicating that the query should be read unconditionally. Defaults to "0". If set to "1" and the unconditional read results in an error, the error will be returned by this method.
=back
=cut
sub setDataByQuery {