oqapi/webgui
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Made first argument to SurveyJSON contructor $session for consistency

Browse source 
with rest of wg.

Also added Params::Validate validation.
This commit is contained in:
Patrick Donelan 2009-02-03 08:31:07 +00:00
parent 76d677ab4f
commit d00c8661f3
3 changed files with 31 additions and 45 deletions
Download patch file Download diff file Expand all files Collapse all files

48
lib/WebGUI/Asset/Wobject/Survey/SurveyJSON.pm
View file

@ -48,6 +48,8 @@ likely operate on the question indexed by:
use strict;
use JSON;
use Params::Validate qw(:all);
Params::Validate::validation_options( on_fail => sub { WebGUI::Error::InvalidParam->throw( error => shift ) } );
# N.B. We're currently using Storable::dclone instead of Clone::clone
# because Colin uncovered some Clone bugs in Perl 5.10
@ -57,30 +59,28 @@ use Storable qw/dclone/;
# The maximum value of questionsPerPage is currently hardcoded here
my $MAX_QUESTIONS_PER_PAGE = 20;
=head2 new ( $json, $log )
=head2 new ( $session, json )
Object constructor.
=head3 $json
=head3 $session
A JSON string used to construct a new Perl object. The JSON string should
contain a hash made up of "survey" and "sections" keys.
WebGUI::Session object
=head3 $log
=head3 $json (optional)
The session logger, from $session->log. The class needs nothing else from the
session object.
A JSON string used to construct a new Perl object. The string should represent
a JSON hash made up of "survey" and "sections" keys.
=cut
sub new {
my $class = shift;
my $json = shift;
my $log = shift;
my ($session, $json) = validate_pos(@_, {isa => 'WebGUI::Session' }, { type => SCALAR, optional => 1});
# Create skeleton object..
my $self = {
log => $log,
session => $session,
sections => [],
survey => {},
};
@ -1146,6 +1146,17 @@ sub section {
return $self->{sections}->[ $address->[0] ];
}
=head2 session
Accessor method for the local WebGUI::Session reference
=cut
sub session {
my $self = shift;
return $self->{session};
}
=head2 questions ($address)
Returns a reference to all the questions from a particular section.
@ -1243,21 +1254,4 @@ sub aIndex {
return $address->[2];
}
=head2 log ($message)
Logs an error message using the session logger.
=head3 $message
The message to log. It will be logged as type "error".
=cut
sub log {
my ( $self, $message ) = @_;
if ( defined $self->{log} ) {
$self->{log}->error($message);
}
}
1;