Some documentation for existing methods.
This commit is contained in:
parent
03b1ac5436
commit
de7b145ac3
1 changed files with 39 additions and 0 deletions
|
@ -28,6 +28,29 @@ our @EXPORT = qw(
|
||||||
our $VERSION = '0.02';
|
our $VERSION = '0.02';
|
||||||
|
|
||||||
######################################################################
|
######################################################################
|
||||||
|
|
||||||
|
=begin new
|
||||||
|
|
||||||
|
Create new Supporters object.
|
||||||
|
|
||||||
|
Arguments:
|
||||||
|
|
||||||
|
=over
|
||||||
|
|
||||||
|
=item $dbh
|
||||||
|
|
||||||
|
Scalar references for the database handle, already opened and pointing to
|
||||||
|
the right database.
|
||||||
|
|
||||||
|
=item $ledgerCmd
|
||||||
|
|
||||||
|
Scalar string that contains the main ledger command (without arguments) to
|
||||||
|
run for looking up Supporter donation data.
|
||||||
|
|
||||||
|
=back
|
||||||
|
|
||||||
|
=cut
|
||||||
|
|
||||||
sub new ($$) {
|
sub new ($$) {
|
||||||
my $package = shift;
|
my $package = shift;
|
||||||
my($dbh, $ledgerCmd) = @_;
|
my($dbh, $ledgerCmd) = @_;
|
||||||
|
@ -36,10 +59,26 @@ sub new ($$) {
|
||||||
$package);
|
$package);
|
||||||
}
|
}
|
||||||
######################################################################
|
######################################################################
|
||||||
|
|
||||||
|
=begin dbh
|
||||||
|
|
||||||
|
Accessor method, returns the database handle currently used by this
|
||||||
|
Supporters object.
|
||||||
|
|
||||||
|
=cut
|
||||||
|
|
||||||
sub dbh ($) {
|
sub dbh ($) {
|
||||||
return $_[0]->{dbh};
|
return $_[0]->{dbh};
|
||||||
}
|
}
|
||||||
######################################################################
|
######################################################################
|
||||||
|
|
||||||
|
=begin ledgerCmd
|
||||||
|
|
||||||
|
Accessor method, returns the ledger command currently used by this Supporters
|
||||||
|
object.
|
||||||
|
|
||||||
|
=cut
|
||||||
|
|
||||||
sub ledgerCmd ($) {
|
sub ledgerCmd ($) {
|
||||||
return $_[0]->{ledgerCmd};
|
return $_[0]->{ledgerCmd};
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in a new issue