1 package SQL::Translator::Schema::Trigger;
7 SQL::Translator::Schema::Trigger - SQL::Translator trigger object
11 use SQL::Translator::Schema::Trigger;
12 my $trigger = SQL::Translator::Schema::Trigger->new(
14 perform_action_when => 'before', # or after
15 database_events => [qw/update insert/], # also update, update_on, delete
16 fields => [], # if event is "update"
17 on_table => 'foo', # table name
18 action => '...', # text of trigger
19 schema => $schema, # Schema object
24 C<SQL::Translator::Schema::Trigger> is the trigger object.
32 use SQL::Translator::Utils 'parse_list_arg';
34 use base 'SQL::Translator::Schema::Object';
38 our ( $TABLE_COUNT, $VIEW_COUNT );
40 our $VERSION = '1.59';
42 __PACKAGE__->_attributes( qw/
43 name schema perform_action_when database_events database_event
44 fields table on_table action order
53 my $schema = SQL::Translator::Schema::Trigger->new;
57 sub perform_action_when {
61 =head2 perform_action_when
63 Gets or sets whether the event happens "before" or "after" the
66 $trigger->perform_action_when('after');
72 if ( my $arg = shift ) {
75 if ( $arg =~ m/^(before|after)$/i ) {
76 $self->{'perform_action_when'} = $arg;
80 $self->error("Invalid argument '$arg' to perform_action_when");
84 return $self->{'perform_action_when'};
93 Obsolete please use database_events!
99 return $self->database_events( @_ );
102 sub database_events {
106 =head2 database_events
108 Gets or sets the events that triggers the trigger.
110 my $ok = $trigger->database_events('insert');
115 my @args = ref $_[0] eq 'ARRAY' ? @{ $_[0] } : @_;
118 @args = map { s/\s+/ /g; lc $_ } @args;
119 my %valid = map { $_, 1 } qw[ insert update update_on delete ];
120 my @invalid = grep { !defined $valid{ $_ } } @args;
124 sprintf("Invalid events '%s' in database_events",
130 $self->{'database_events'} = [ @args ];
134 ? @{ $self->{'database_events'} || [] }
135 : $self->{'database_events'};
144 Gets and set which fields to monitor for C<database_event>.
147 $view->fields('id', 'name');
148 $view->fields( 'id, name' );
149 $view->fields( [ 'id', 'name' ] );
150 $view->fields( qw[ id name ] );
152 my @fields = $view->fields;
157 my $fields = parse_list_arg( @_ );
160 my ( %unique, @unique );
161 for my $f ( @$fields ) {
162 next if $unique{ $f };
167 $self->{'fields'} = \@unique;
170 return wantarray ? @{ $self->{'fields'} || [] } : $self->{'fields'};
179 Gets or set the table on which the trigger works, as a L<SQL::Translator::Schema::Table> object.
180 $trigger->table($triggered_table);
184 my ($self, $arg) = @_;
186 $self->error("Table attribute of a ".__PACKAGE__.
187 " must be a SQL::Translator::Schema::Table")
188 unless ref $arg and $arg->isa('SQL::Translator::Schema::Table');
189 $self->{table} = $arg;
191 return $self->{table};
200 Gets or set the table name on which the trigger works, as a string.
201 $trigger->on_table('foo');
205 my ($self, $arg) = @_;
207 my $table = $self->schema->get_table($arg);
208 die "Table named $arg doesn't exist"
210 $self->table($table);
212 return $self->table->name;
221 Gets or set the action of the trigger.
235 my $arg = shift || '';
236 $self->{'action'} = $arg if $arg;
237 return $self->{'action'};
246 Determine whether the trigger is valid or not.
248 my $ok = $trigger->is_valid;
255 qw[ name perform_action_when database_events on_table action ]
257 return $self->error("Invalid: missing '$attr'") unless $self->$attr();
260 return $self->error("Missing fields for UPDATE ON") if
261 $self->database_event eq 'update_on' && !$self->fields;
272 Get or set the trigger's name.
274 my $name = $trigger->name('foo');
279 $self->{'name'} = shift if @_;
280 return $self->{'name'} || '';
289 Get or set the trigger's order.
291 my $order = $trigger->order(3);
295 my ( $self, $arg ) = @_;
297 if ( defined $arg && $arg =~ /^\d+$/ ) {
298 $self->{'order'} = $arg;
301 return $self->{'order'} || 0;
310 Get or set the trigger's schema object.
312 $trigger->schema( $schema );
313 my $schema = $trigger->schema;
318 if ( my $arg = shift ) {
319 return $self->error('Not a schema object') unless
320 UNIVERSAL::isa( $arg, 'SQL::Translator::Schema' );
321 $self->{'schema'} = $arg;
324 return $self->{'schema'};
331 =head2 compare_arrays
337 my ($first, $second) = @_;
338 no warnings; # silence spurious -w undef complaints
340 return 0 unless (ref $first eq 'ARRAY' and ref $second eq 'ARRAY' ) ;
342 return 0 unless @$first == @$second;
344 my @first = sort @$first;
346 my @second = sort @$second;
348 for (my $i = 0; $i < scalar @first; $i++) {
349 return 0 if @first[$i] ne @second[$i];
361 Determines if this trigger is the same as another
363 my $is_identical = $trigger1->equals( $trigger2 );
369 my $case_insensitive = shift;
371 return 0 unless $self->SUPER::equals($other);
374 for my $name ( $self->name, $other->name ) {
375 $name = lc $name if $case_insensitive;
379 if ( keys %names > 1 ) {
380 return $self->error('Names not equal');
383 if ( !$self->perform_action_when eq $other->perform_action_when ) {
384 return $self->error('perform_action_when differs');
388 !compare_arrays( [$self->database_events], [$other->database_events] )
390 return $self->error('database_events differ');
393 if ( $self->on_table ne $other->on_table ) {
394 return $self->error('on_table differs');
397 if ( $self->action ne $other->action ) {
398 return $self->error('action differs');
402 !$self->_compare_objects( scalar $self->extra, scalar $other->extra )
404 return $self->error('extras differ');
412 undef $self->{'schema'}; # destroy cyclical reference
422 Ken Youens-Clark E<lt>kclark@cpan.orgE<gt>.