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.
31 use SQL::Translator::Utils 'parse_list_arg';
33 use base 'SQL::Translator::Schema::Object';
37 use vars qw($VERSION $TABLE_COUNT $VIEW_COUNT);
41 # ----------------------------------------------------------------------
43 __PACKAGE__->_attributes( qw/
44 name schema perform_action_when database_events database_event
45 fields table on_table action order
54 my $schema = SQL::Translator::Schema::Trigger->new;
58 # ----------------------------------------------------------------------
59 sub perform_action_when {
63 =head2 perform_action_when
65 Gets or sets whether the event happens "before" or "after" the
68 $trigger->perform_action_when('after');
74 if ( my $arg = shift ) {
77 if ( $arg =~ m/^(before|after)$/i ) {
78 $self->{'perform_action_when'} = $arg;
82 $self->error("Invalid argument '$arg' to perform_action_when");
86 return $self->{'perform_action_when'};
89 # ----------------------------------------------------------------------
96 Obsolete please use database_events!
102 return $self->database_events( @_ );
105 # ----------------------------------------------------------------------
106 sub database_events {
110 =head2 database_events
112 Gets or sets the events that triggers the trigger.
114 my $ok = $trigger->database_events('insert');
119 my @args = ref $_[0] eq 'ARRAY' ? @{ $_[0] } : @_;
122 @args = map { s/\s+/ /g; lc $_ } @args;
123 my %valid = map { $_, 1 } qw[ insert update update_on delete ];
124 my @invalid = grep { !defined $valid{ $_ } } @args;
128 sprintf("Invalid events '%s' in database_events",
134 $self->{'database_events'} = [ @args ];
138 ? @{ $self->{'database_events'} || [] }
139 : $self->{'database_events'};
142 # ----------------------------------------------------------------------
149 Gets and set which fields to monitor for C<database_event>.
152 $view->fields('id', 'name');
153 $view->fields( 'id, name' );
154 $view->fields( [ 'id', 'name' ] );
155 $view->fields( qw[ id name ] );
157 my @fields = $view->fields;
162 my $fields = parse_list_arg( @_ );
165 my ( %unique, @unique );
166 for my $f ( @$fields ) {
167 next if $unique{ $f };
172 $self->{'fields'} = \@unique;
175 return wantarray ? @{ $self->{'fields'} || [] } : $self->{'fields'};
178 # ----------------------------------------------------------------------
185 Gets or set the table on which the trigger works, as a L<SQL::Translator::Schema::Table> object.
186 $trigger->table($triggered_table);
190 my ($self, $arg) = @_;
192 $self->error("Table attribute of a ".__PACKAGE__.
193 " must be a SQL::Translator::Schema::Table")
194 unless ref $arg and $arg->isa('SQL::Translator::Schema::Table');
195 $self->{table} = $arg;
197 return $self->{table};
200 # ----------------------------------------------------------------------
207 Gets or set the table name on which the trigger works, as a string.
208 $trigger->on_table('foo');
212 my ($self, $arg) = @_;
214 my $table = $self->schema->get_table($arg);
215 die "Table named $arg doesn't exist"
217 $self->table($table);
219 return $self->table->name;
222 # ----------------------------------------------------------------------
229 Gets or set the action of the trigger.
243 my $arg = shift || '';
244 $self->{'action'} = $arg if $arg;
245 return $self->{'action'};
248 # ----------------------------------------------------------------------
255 Determine whether the trigger is valid or not.
257 my $ok = $trigger->is_valid;
264 qw[ name perform_action_when database_events on_table action ]
266 return $self->error("Invalid: missing '$attr'") unless $self->$attr();
269 return $self->error("Missing fields for UPDATE ON") if
270 $self->database_event eq 'update_on' && !$self->fields;
275 # ----------------------------------------------------------------------
282 Get or set the trigger's name.
284 my $name = $trigger->name('foo');
289 $self->{'name'} = shift if @_;
290 return $self->{'name'} || '';
293 # ----------------------------------------------------------------------
300 Get or set the trigger's order.
302 my $order = $trigger->order(3);
306 my ( $self, $arg ) = @_;
308 if ( defined $arg && $arg =~ /^\d+$/ ) {
309 $self->{'order'} = $arg;
312 return $self->{'order'} || 0;
315 # ----------------------------------------------------------------------
322 Get or set the trigger's schema object.
324 $trigger->schema( $schema );
325 my $schema = $trigger->schema;
330 if ( my $arg = shift ) {
331 return $self->error('Not a schema object') unless
332 UNIVERSAL::isa( $arg, 'SQL::Translator::Schema' );
333 $self->{'schema'} = $arg;
336 return $self->{'schema'};
339 # ----------------------------------------------------------------------
344 =head2 compare_arrays
350 my ($first, $second) = @_;
351 no warnings; # silence spurious -w undef complaints
353 return 0 unless (ref $first eq 'ARRAY' and ref $second eq 'ARRAY' ) ;
355 return 0 unless @$first == @$second;
357 my @first = sort @$first;
359 my @second = sort @$second;
361 for (my $i = 0; $i < scalar @first; $i++) {
362 return 0 if @first[$i] ne @second[$i];
368 # ----------------------------------------------------------------------
375 Determines if this trigger is the same as another
377 my $is_identical = $trigger1->equals( $trigger2 );
383 my $case_insensitive = shift;
385 return 0 unless $self->SUPER::equals($other);
388 for my $name ( $self->name, $other->name ) {
389 $name = lc $name if $case_insensitive;
393 if ( keys %names > 1 ) {
394 return $self->error('Names not equal');
397 if ( !$self->perform_action_when eq $other->perform_action_when ) {
398 return $self->error('perform_action_when differs');
402 !compare_arrays( [$self->database_events], [$other->database_events] )
404 return $self->error('database_events differ');
407 if ( $self->on_table ne $other->on_table ) {
408 return $self->error('on_table differs');
411 if ( $self->action ne $other->action ) {
412 return $self->error('action differs');
416 !$self->_compare_objects( scalar $self->extra, scalar $other->extra )
418 return $self->error('extras differ');
424 # ----------------------------------------------------------------------
427 undef $self->{'schema'}; # destroy cyclical reference
432 # ----------------------------------------------------------------------
439 Ken Youens-Clark E<lt>kclark@cpan.orgE<gt>.