WebGUI 3.3.0 release
This commit is contained in:
JT Smith
parent
40bb7fed59
commit
80f7752f32
41 changed files with 1662 additions and 402 deletions
|
|
@ -1,14 +1,18 @@
|
|||
package WebGUI::SQL;
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
# WebGUI is Copyright 2001-2002 Plain Black Software.
|
||||
#-------------------------------------------------------------------
|
||||
# Please read the legal notices (docs/legal.txt) and the license
|
||||
# (docs/license.txt) that came with this distribution before using
|
||||
# this software.
|
||||
#-------------------------------------------------------------------
|
||||
# http://www.plainblack.com info@plainblack.com
|
||||
#-------------------------------------------------------------------
|
||||
=head1 LEGAL
|
||||
|
||||
-------------------------------------------------------------------
|
||||
WebGUI is Copyright 2001-2002 Plain Black Software.
|
||||
-------------------------------------------------------------------
|
||||
Please read the legal notices (docs/legal.txt) and the license
|
||||
(docs/license.txt) that came with this distribution before using
|
||||
this software.
|
||||
-------------------------------------------------------------------
|
||||
http://www.plainblack.com info@plainblack.com
|
||||
-------------------------------------------------------------------
|
||||
|
||||
=cut
|
||||
|
||||
use CGI::Carp qw(fatalsToBrowser);
|
||||
use DBI;
|
||||
|
|
@ -21,12 +25,76 @@ use WebGUI::Session;
|
|||
our @ISA = qw(Exporter);
|
||||
our @EXPORT = qw("e &getNextId);
|
||||
|
||||
=head1 NAME
|
||||
|
||||
Package WebGUI::SQL
|
||||
|
||||
=head1 SYNOPSIS
|
||||
|
||||
use WebGUI::SQL;
|
||||
$sth = WebGUI::SQL->new($sql);
|
||||
$sth = WebGUI::SQL->read($sql);
|
||||
$sth = WebGUI::SQL->unconditionalRead($sql);
|
||||
$sth->array;
|
||||
$sth->getColumnNames;
|
||||
$sth->hash;
|
||||
$sth->hashRef;
|
||||
$sth->rows;
|
||||
$sth->finish;
|
||||
|
||||
@arr = WebGUI::SQL->buildArray($sql);
|
||||
%hash = WebGUI::SQL->buildHash($sql);
|
||||
@arr = WebGUI::SQL->quickArray($sql);
|
||||
%hash = WebGUI::SQL->quickHash($sql);
|
||||
|
||||
WebGUI::SQL->write($sql);
|
||||
|
||||
$id = getNextId("widgetId");
|
||||
$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:
|
||||
|
||||
=cut
|
||||
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 array ( )
|
||||
|
||||
Returns the next row of data as an array.
|
||||
|
||||
=cut
|
||||
|
||||
sub array {
|
||||
return $_[0]->{_sth}->fetchrow_array() or WebGUI::ErrorHandler::fatalError("Couldn't fetch array. ".$_[0]->{_sth}->errstr);
|
||||
}
|
||||
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 buildArray ( sql [, dbh ] )
|
||||
|
||||
Builds an array of data from a series of rows.
|
||||
|
||||
=item sql
|
||||
|
||||
An SQL query. The query must select only one column of data.
|
||||
|
||||
=item dbh
|
||||
|
||||
By default this method uses the WebGUI database handler. However,
|
||||
you may choose to pass in your own if you wish.
|
||||
|
||||
=cut
|
||||
|
||||
sub buildArray {
|
||||
my ($sth, $data, @array, $i);
|
||||
$sth = WebGUI::SQL->read($_[1],$_[2]);
|
||||
|
|
@ -39,7 +107,25 @@ sub buildArray {
|
|||
return @array;
|
||||
}
|
||||
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 buildHash ( sql [, dbh ] )
|
||||
|
||||
Builds a hash of data from a series of rows.
|
||||
|
||||
=item sql
|
||||
|
||||
An SQL query. The query must select only two columns of data, the
|
||||
first being the key for the hash, the second being the value.
|
||||
|
||||
=item dbh
|
||||
|
||||
By default this method uses the WebGUI database handler. However,
|
||||
you may choose to pass in your own if you wish.
|
||||
|
||||
=cut
|
||||
|
||||
sub buildHash {
|
||||
my ($sth, %hash, @data);
|
||||
tie %hash, "Tie::IxHash";
|
||||
|
|
@ -55,17 +141,48 @@ sub buildHash {
|
|||
return %hash;
|
||||
}
|
||||
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 finish ( )
|
||||
|
||||
Ends a query after calling the "new" or "read" methods.
|
||||
|
||||
=cut
|
||||
|
||||
sub finish {
|
||||
return $_[0]->{_sth}->finish;
|
||||
}
|
||||
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getColumnNames {
|
||||
|
||||
Returns an array of column names. Use with a "read" method.
|
||||
|
||||
=cut
|
||||
|
||||
sub getColumnNames {
|
||||
return @{$_[0]->{_sth}->{NAME}};
|
||||
}
|
||||
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getNextId ( idName )
|
||||
|
||||
Increments an incrementer of the specified type and returns the
|
||||
value. NOTE: This is not a regular method, but is an exported
|
||||
subroutine.
|
||||
|
||||
=item idName
|
||||
|
||||
Specify the name of one of the incrementers in the incrementer
|
||||
table.
|
||||
|
||||
=cut
|
||||
|
||||
sub getNextId {
|
||||
my ($id);
|
||||
($id) = WebGUI::SQL->quickArray("select nextValue from incrementer where incrementerId='$_[0]'");
|
||||
|
|
@ -73,7 +190,16 @@ sub getNextId {
|
|||
return $id;
|
||||
}
|
||||
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 hash
|
||||
|
||||
Returns the next row of data in the form of a hash. Must be
|
||||
executed on a statement handler returned by the "read" method.
|
||||
|
||||
=cut
|
||||
|
||||
sub hash {
|
||||
my ($hashRef);
|
||||
$hashRef = $_[0]->{_sth}->fetchrow_hashref();
|
||||
|
|
@ -84,12 +210,38 @@ sub hash {
|
|||
}
|
||||
}
|
||||
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 hashRef
|
||||
|
||||
Returns the next row of data in the form of a hash reference. Must
|
||||
be executed on a statement handler returned by the "read" method.
|
||||
|
||||
=cut
|
||||
|
||||
sub hashRef {
|
||||
return $_[0]->{_sth}->fetchrow_hashref() or WebGUI::ErrorHandler::fatalError("Couldn't fetch hashref. ".$_[0]->{_sth}->errstr);
|
||||
}
|
||||
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 new ( sql [, dbh ] )
|
||||
|
||||
Constructor. Returns a statement handler.
|
||||
|
||||
=item sql
|
||||
|
||||
An SQL query.
|
||||
|
||||
=item dbh
|
||||
|
||||
By default this method uses the WebGUI database handler. However,
|
||||
you may choose to pass in your own if you wish.
|
||||
|
||||
=cut
|
||||
|
||||
sub new {
|
||||
my ($class, $sql, $dbh, $sth);
|
||||
$class = shift;
|
||||
|
|
@ -100,7 +252,24 @@ sub new {
|
|||
bless ({_sth => $sth}, $class);
|
||||
}
|
||||
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 quickArray ( sql [, dbh ] )
|
||||
|
||||
Executes a query and returns a single row of data as an array.
|
||||
|
||||
=item sql
|
||||
|
||||
An SQL query.
|
||||
|
||||
=item dbh
|
||||
|
||||
By default this method uses the WebGUI database handler. However,
|
||||
you may choose to pass in your own if you wish.
|
||||
|
||||
=cut
|
||||
|
||||
sub quickArray {
|
||||
my ($sth, @data);
|
||||
$sth = WebGUI::SQL->new($_[1],$_[2]);
|
||||
|
|
@ -109,7 +278,24 @@ sub quickArray {
|
|||
return @data;
|
||||
}
|
||||
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 quickHash ( sql [, dbh ] )
|
||||
|
||||
Executes a query and returns a single row of data as a hash.
|
||||
|
||||
=item sql
|
||||
|
||||
An SQL query.
|
||||
|
||||
=item dbh
|
||||
|
||||
By default this method uses the WebGUI database handler. However,
|
||||
you may choose to pass in your own if you wish.
|
||||
|
||||
=cut
|
||||
|
||||
sub quickHash {
|
||||
my ($sth, $data);
|
||||
$sth = WebGUI::SQL->new($_[1],$_[2]);
|
||||
|
|
@ -120,23 +306,83 @@ sub quickHash {
|
|||
}
|
||||
}
|
||||
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 quote ( string )
|
||||
|
||||
Returns a string quoted and ready for insert into the database.
|
||||
NOTE: This is not a regular method, but is an exported subroutine.
|
||||
|
||||
=item string
|
||||
|
||||
Any scalar variable that needs to be escaped to be inserted into
|
||||
the database.
|
||||
|
||||
=cut
|
||||
|
||||
sub quote {
|
||||
my $value = $_[0]; #had to add this here cuz Tie::CPHash variables cause problems otherwise.
|
||||
return $WebGUI::Session::session{dbh}->quote($value);
|
||||
}
|
||||
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 read ( sql [, dbh ] )
|
||||
|
||||
An alias of the "new" method. Returns a statement handler.
|
||||
|
||||
=item sql
|
||||
|
||||
An SQL query.
|
||||
|
||||
=item dbh
|
||||
|
||||
By default this method uses the WebGUI database handler. However,
|
||||
you may choose to pass in your own if you wish.
|
||||
|
||||
=cut
|
||||
|
||||
sub read {
|
||||
return WebGUI::SQL->new($_[1],$_[2],$_[3]);
|
||||
}
|
||||
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 rows ( )
|
||||
|
||||
Returns the number of rows in a statement handler created by the
|
||||
"read" method.
|
||||
|
||||
=cut
|
||||
|
||||
sub rows {
|
||||
return $_[0]->{_sth}->rows;
|
||||
}
|
||||
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 unconditionalRead ( sql [, dbh ] )
|
||||
|
||||
An alias of the "read" method except that it will not cause a fatal
|
||||
error in WebGUI if the query is invalid. This is useful for user
|
||||
generated queries such as those in the SQL Report. Returns a
|
||||
statement handler.
|
||||
|
||||
=item sql
|
||||
|
||||
An SQL query.
|
||||
|
||||
=item dbh
|
||||
|
||||
By default this method uses the WebGUI database handler. However,
|
||||
you may choose to pass in your own if you wish.
|
||||
|
||||
=cut
|
||||
|
||||
sub unconditionalRead {
|
||||
my ($sth);
|
||||
$sth = $_[2]->prepare($_[1]);
|
||||
|
|
@ -144,7 +390,26 @@ sub unconditionalRead {
|
|||
bless ({_sth => $sth}, $_[0]);
|
||||
}
|
||||
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 write ( sql [, dbh ] )
|
||||
|
||||
A method specifically designed for writing to the database in an
|
||||
efficient manner. Writing can be accomplished using the "new"
|
||||
method, but it is not as efficient.
|
||||
|
||||
=item sql
|
||||
|
||||
An SQL insert or update.
|
||||
|
||||
=item dbh
|
||||
|
||||
By default this method uses the WebGUI database handler. However,
|
||||
you may choose to pass in your own if you wish.
|
||||
|
||||
=cut
|
||||
|
||||
sub write {
|
||||
my ($dbh);
|
||||
$dbh = $_[2] || $WebGUI::Session::session{dbh};
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue