diff options
author | ivan <ivan> | 2005-02-08 20:22:46 +0000 |
---|---|---|
committer | ivan <ivan> | 2005-02-08 20:22:46 +0000 |
commit | fc9e97f6cab72de473288470c0681534caf25ea5 (patch) | |
tree | 1aa26f5ab82003b2fb01eb77936b5771c056129c /FS/FS/clientapi_session.pm | |
parent | 85b4db91819ef43709a7d9728af3a7f1aa37b07a (diff) |
make self-service session cache module configurable, start framework for in-database session cache
Diffstat (limited to 'FS/FS/clientapi_session.pm')
-rw-r--r-- | FS/FS/clientapi_session.pm | 121 |
1 files changed, 121 insertions, 0 deletions
diff --git a/FS/FS/clientapi_session.pm b/FS/FS/clientapi_session.pm new file mode 100644 index 0000000..f71a126 --- /dev/null +++ b/FS/FS/clientapi_session.pm @@ -0,0 +1,121 @@ +package FS::clientapi_session; + +use strict; +use vars qw( @ISA ); +use FS::Record qw( qsearch qsearchs ); + +@ISA = qw(FS::Record); + +=head1 NAME + +FS::clientapi_session - Object methods for clientapi_session records + +=head1 SYNOPSIS + + use FS::clientapi_session; + + $record = new FS::clientapi_session \%hash; + $record = new FS::clientapi_session { 'column' => 'value' }; + + $error = $record->insert; + + $error = $new_record->replace($old_record); + + $error = $record->delete; + + $error = $record->check; + +=head1 DESCRIPTION + +An FS::clientapi_session object represents an FS::ClientAPI session. +FS::clientapi_session inherits from FS::Record. The following fields are +currently supported: + +=over 4 + +=item sessionnum - primary key + +=item sessionid - session ID + +=item namespace - session namespace + +=back + +=head1 METHODS + +=over 4 + +=item new HASHREF + +Creates a new record. To add the record to the database, see L<"insert">. + +Note that this stores the hash reference, not a distinct copy of the hash it +points to. You can ask the object for a copy with the I<hash> method. + +=cut + +# the new method can be inherited from FS::Record, if a table method is defined + +sub table { 'clientapi_session'; } + +=item insert + +Adds this record to the database. If there is an error, returns the error, +otherwise returns false. + +=cut + +# the insert method can be inherited from FS::Record + +=item delete + +Delete this record from the database. + +=cut + +# the delete method can be inherited from FS::Record + +=item replace OLD_RECORD + +Replaces the OLD_RECORD with this one in the database. If there is an error, +returns the error, otherwise returns false. + +=cut + +# the replace method can be inherited from FS::Record + +=item check + +Checks all fields to make sure this is a valid record. If there is +an error, returns the error, otherwise returns false. Called by the insert +and replace methods. + +=cut + +# the check method should currently be supplied - FS::Record contains some +# data checking routines + +sub check { + my $self = shift; + + my $error = + $self->ut_numbern('primary_key') + || $self->ut_number('validate_other_fields') + ; + return $error if $error; + + $self->SUPER::check; +} + +=back + +=head1 BUGS + +=head1 SEE ALSO + +L<FS::ClientAPI>, <FS::Record>, schema.html from the base documentation. + +=cut + +1; + |