webwork3/lib/DB/Schema/Result/UserSet.pm at eec4b1965c0126c2b7d185fbab3cc2852074c5b0 · openwebwork/webwork3 · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
package DB::Schema::Result::UserSet;
use base qw/DBIx::Class::Core DB::Validation/;

use strict;
use warnings;
use feature 'signatures';
no warnings qw/experimental::signatures/;

=head1 DESCRIPTION

This is the database schema for a UserSet, which plays two roles:

=item 1

This overrides any ProblemSet for a particular user

=item 2

This is the super class for a UserSet version of a HomeworkSet, Quiz and ReviewSet.

=head2 fields

=over

=item *

C<set_id>: database id (autoincrement integer)

=item *

C<set_name>: name of the set

=item *

C<course_id>: id of the course the set is in (foreign key)

=item *

C<set_visible>: (boolean) visiblility of the set to a student

=item *

C<set_version>: (non-negative integer) the version of the user set.

=item *

C<set_dates>: a hash of dates related to the problem set.  Note: different types
have different date fields.

=item *

C<set_params>: a hash of additional parameters of the problem set.  Note: different problem set
types have different params fields.

=back

=cut

__PACKAGE__->table('user_set');

__PACKAGE__->load_components(qw/InflateColumn::Serializer InflateColumn::Boolean Core/);

__PACKAGE__->add_columns(
	user_set_id => {
		data_type         => 'integer',
		size              => 16,
		is_auto_increment => 1,
	},
	set_id => {
		data_type => 'integer',
		size      => 16,
	},
	course_user_id => {
		data_type => 'integer',
		size      => 16,
	},
	set_version => {
		data_type          => 'integer',
		size               => 16,
		default_value      => 0,
		retrieve_on_insert => 1,
	},
	set_visible => {
		data_type   => 'boolean',
		is_nullable => 1
	},
	# Store dates as a JSON object.
	set_dates => {
		data_type          => 'text',
		size               => 256,
		default_value      => '{}',
		retrieve_on_insert => 1,
		serializer_class   => 'JSON',
		serializer_options => { utf8 => 1 }
	},
	# Store params as a JSON object.
	set_params => {
		data_type          => 'text',
		size               => 256,
		default_value      => '{}',
		retrieve_on_insert => 1,
		serializer_class   => 'JSON',
		serializer_options => { utf8 => 1 }
	}
);

__PACKAGE__->set_primary_key('user_set_id');
__PACKAGE__->add_unique_constraint([qw/set_id course_user_id set_version/]);
__PACKAGE__->belongs_to(
	course_users => 'DB::Schema::Result::CourseUser',
	{ 'foreign.course_user_id' => 'self.course_user_id' }
);
__PACKAGE__->belongs_to(problem_set => 'DB::Schema::Result::ProblemSet', 'set_id');
__PACKAGE__->has_many(user_problems => 'DB::Schema::Result::UserProblem', 'user_set_id');

1;