202 lines
3.8 KiB
Perl
202 lines
3.8 KiB
Perl
package WebGUI::Session::Setting;
|
|
|
|
=head1 LEGAL
|
|
|
|
-------------------------------------------------------------------
|
|
WebGUI is Copyright 2001-2012 Plain Black Corporation.
|
|
-------------------------------------------------------------------
|
|
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 strict;
|
|
use Scalar::Util qw(weaken);
|
|
|
|
=head1 NAME
|
|
|
|
Package WebGUI::Session::Setting
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
This package stores and retrieves settings. It is generally only used internally by WebGUI and not by external scripts.
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
use WebGUI::Session::Setting;
|
|
|
|
$settings = WebGUI::Session::Setting->new;
|
|
|
|
$settings->set($name, $value);
|
|
$value = $settings->get($name);
|
|
|
|
$settings->add($name, $value);
|
|
$settings->remove($name);
|
|
|
|
$session = $settings->session;
|
|
|
|
=head1 FUNCTIONS
|
|
|
|
These subroutines are available from this package:
|
|
|
|
=cut
|
|
|
|
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 add ( name, value )
|
|
|
|
Creates a new setting.
|
|
|
|
=head3 name
|
|
|
|
The name of the setting to add.
|
|
|
|
=head3 value
|
|
|
|
The initial value of the setting.
|
|
|
|
=cut
|
|
|
|
sub add {
|
|
my $self = shift;
|
|
$self->set(@_);
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 get ( $param )
|
|
|
|
Returns a hash reference containing all the settings.
|
|
|
|
=head3 $param
|
|
|
|
If $param is defined, then it will return only the setting for that param.
|
|
|
|
=cut
|
|
|
|
sub get {
|
|
my $self = shift;
|
|
my $param = shift;
|
|
if (defined $param) {
|
|
return $self->{_settings}{$param};
|
|
}
|
|
else {
|
|
return $self->{_settings};
|
|
}
|
|
}
|
|
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 has ( $param )
|
|
|
|
Returns true if the requested setting exists in this object's cache of the settings.
|
|
This works better than using ->get, since it doesn't care about the truthiness of
|
|
the value of the setting.
|
|
|
|
This method will have little use outside of upgrade and install scripts, to prevent
|
|
them from creating and/or overwriting existing settings.
|
|
|
|
=head3 $param
|
|
|
|
The setting to check.
|
|
|
|
=cut
|
|
|
|
sub has {
|
|
my $self = shift;
|
|
my $param = shift;
|
|
return exists $self->{_settings}{$param};
|
|
}
|
|
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 new ( session )
|
|
|
|
Constructor.
|
|
|
|
=head3 session
|
|
|
|
A reference to the current WebGUI::Session.
|
|
|
|
=cut
|
|
|
|
sub new {
|
|
my $class = shift;
|
|
my $session = shift;
|
|
my $self = bless { _session => $session }, $class;
|
|
weaken $self->{_session};
|
|
$self->{_settings} = $session->db->buildHashRef("select * from settings", [], {noOrder => 1});
|
|
return $self;
|
|
}
|
|
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 remove ( name )
|
|
|
|
Removes a setting permanently.
|
|
|
|
=head3 name
|
|
|
|
The name of the setting to set.
|
|
|
|
=cut
|
|
|
|
sub remove {
|
|
my $self = shift;
|
|
my $name = shift;
|
|
delete $self->{_settings}{$name};
|
|
$self->session->db->write("delete from settings where name=?",[$name]);
|
|
}
|
|
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 session ( )
|
|
|
|
Returns a reference to the WebGUI::Session object.
|
|
|
|
=cut
|
|
|
|
sub session {
|
|
my $self = shift;
|
|
return $self->{_session};
|
|
}
|
|
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 set ( name, value )
|
|
|
|
Sets the value of a setting.
|
|
|
|
=head3 name
|
|
|
|
The name of the setting to set.
|
|
|
|
=head3 value
|
|
|
|
The value of the setting.
|
|
|
|
=cut
|
|
|
|
sub set {
|
|
my $self = shift;
|
|
my $name = shift;
|
|
my $value = shift;
|
|
$self->{_settings}{$name} = $value;
|
|
$self->session->db->write("REPLACE INTO settings (name, value) VALUES (?, ?)", [$name, $value]);
|
|
}
|
|
|
|
|
|
|
|
1;
|
|
|