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
20 scope => 'row', # or statement
25 C<SQL::Translator::Schema::Trigger> is the trigger object.
33 use SQL::Translator::Utils 'parse_list_arg';
35 use base 'SQL::Translator::Schema::Object';
39 our ( $TABLE_COUNT, $VIEW_COUNT );
41 our $VERSION = '1.59';
43 __PACKAGE__->_attributes( qw/
44 name schema perform_action_when database_events database_event
45 fields table on_table action order scope
54 my $schema = SQL::Translator::Schema::Trigger->new;
58 sub perform_action_when {
62 =head2 perform_action_when
64 Gets or sets whether the event happens "before" or "after" the
67 $trigger->perform_action_when('after');
73 if ( my $arg = shift ) {
76 if ( $arg =~ m/^(before|after)$/i ) {
77 $self->{'perform_action_when'} = $arg;
81 $self->error("Invalid argument '$arg' to perform_action_when");
85 return $self->{'perform_action_when'};
94 Obsolete please use database_events!
100 return $self->database_events( @_ );
103 sub database_events {
107 =head2 database_events
109 Gets or sets the events that triggers the trigger.
111 my $ok = $trigger->database_events('insert');
116 my @args = ref $_[0] eq 'ARRAY' ? @{ $_[0] } : @_;
119 @args = map { s/\s+/ /g; lc $_ } @args;
120 my %valid = map { $_, 1 } qw[ insert update update_on delete ];
121 my @invalid = grep { !defined $valid{ $_ } } @args;
125 sprintf("Invalid events '%s' in database_events",
131 $self->{'database_events'} = [ @args ];
135 ? @{ $self->{'database_events'} || [] }
136 : $self->{'database_events'};
145 Gets and set which fields to monitor for C<database_event>.
148 $view->fields('id', 'name');
149 $view->fields( 'id, name' );
150 $view->fields( [ 'id', 'name' ] );
151 $view->fields( qw[ id name ] );
153 my @fields = $view->fields;
158 my $fields = parse_list_arg( @_ );
161 my ( %unique, @unique );
162 for my $f ( @$fields ) {
163 next if $unique{ $f };
168 $self->{'fields'} = \@unique;
171 return wantarray ? @{ $self->{'fields'} || [] } : $self->{'fields'};
180 Gets or set the table on which the trigger works, as a L<SQL::Translator::Schema::Table> object.
181 $trigger->table($triggered_table);
185 my ($self, $arg) = @_;
187 $self->error("Table attribute of a ".__PACKAGE__.
188 " must be a SQL::Translator::Schema::Table")
189 unless ref $arg and $arg->isa('SQL::Translator::Schema::Table');
190 $self->{table} = $arg;
192 return $self->{table};
201 Gets or set the table name on which the trigger works, as a string.
202 $trigger->on_table('foo');
206 my ($self, $arg) = @_;
208 my $table = $self->schema->get_table($arg);
209 die "Table named $arg doesn't exist"
211 $self->table($table);
213 return $self->table->name;
222 Gets or set the action of the trigger.
236 my $arg = shift || '';
237 $self->{'action'} = $arg if $arg;
238 return $self->{'action'};
247 Determine whether the trigger is valid or not.
249 my $ok = $trigger->is_valid;
256 qw[ name perform_action_when database_events on_table action ]
258 return $self->error("Invalid: missing '$attr'") unless $self->$attr();
261 return $self->error("Missing fields for UPDATE ON") if
262 $self->database_event eq 'update_on' && !$self->fields;
273 Get or set the trigger's name.
275 my $name = $trigger->name('foo');
280 $self->{'name'} = shift if @_;
281 return $self->{'name'} || '';
290 Get or set the trigger's order.
292 my $order = $trigger->order(3);
296 my ( $self, $arg ) = @_;
298 if ( defined $arg && $arg =~ /^\d+$/ ) {
299 $self->{'order'} = $arg;
302 return $self->{'order'} || 0;
312 Get or set the trigger's scope (row or statement).
314 my $scope = $trigger->scope('statement');
318 my ( $self, $arg ) = @_;
320 if ( defined $arg ) {
321 return $self->error( "Invalid scope '$arg'" )
322 unless $arg =~ /^(row|statement)$/i;
324 $self->{scope} = $arg;
327 return $self->{scope} || '';
336 Get or set the trigger's schema object.
338 $trigger->schema( $schema );
339 my $schema = $trigger->schema;
344 if ( my $arg = shift ) {
345 return $self->error('Not a schema object') unless
346 UNIVERSAL::isa( $arg, 'SQL::Translator::Schema' );
347 $self->{'schema'} = $arg;
350 return $self->{'schema'};
357 =head2 compare_arrays
363 my ($first, $second) = @_;
364 no warnings; # silence spurious -w undef complaints
366 return 0 unless (ref $first eq 'ARRAY' and ref $second eq 'ARRAY' ) ;
368 return 0 unless @$first == @$second;
370 my @first = sort @$first;
372 my @second = sort @$second;
374 for (my $i = 0; $i < scalar @first; $i++) {
375 return 0 if @first[$i] ne @second[$i];
387 Determines if this trigger is the same as another
389 my $is_identical = $trigger1->equals( $trigger2 );
395 my $case_insensitive = shift;
397 return 0 unless $self->SUPER::equals($other);
400 for my $name ( $self->name, $other->name ) {
401 $name = lc $name if $case_insensitive;
405 if ( keys %names > 1 ) {
406 return $self->error('Names not equal');
409 if ( !$self->perform_action_when eq $other->perform_action_when ) {
410 return $self->error('perform_action_when differs');
414 !compare_arrays( [$self->database_events], [$other->database_events] )
416 return $self->error('database_events differ');
419 if ( $self->on_table ne $other->on_table ) {
420 return $self->error('on_table differs');
423 if ( $self->action ne $other->action ) {
424 return $self->error('action differs');
428 !$self->_compare_objects( scalar $self->extra, scalar $other->extra )
430 return $self->error('extras differ');
438 undef $self->{'schema'}; # destroy cyclical reference
448 Ken Youens-Clark E<lt>kclark@cpan.orgE<gt>.