1 package SQL::Translator::Schema::Trigger;
3 # ----------------------------------------------------------------------
4 # Copyright (C) 2002-2009 SQLFairy Authors
6 # This program is free software; you can redistribute it and/or
7 # modify it under the terms of the GNU General Public License as
8 # published by the Free Software Foundation; version 2.
10 # This program is distributed in the hope that it will be useful, but
11 # WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 # General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program; if not, write to the Free Software
17 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
19 # -------------------------------------------------------------------
25 SQL::Translator::Schema::Trigger - SQL::Translator trigger object
29 use SQL::Translator::Schema::Trigger;
30 my $trigger = SQL::Translator::Schema::Trigger->new(
32 perform_action_when => 'before', # or after
33 database_events => [qw/update insert/], # also update, update_on, delete
34 fields => [], # if event is "update"
35 on_table => 'foo', # table name
36 action => '...', # text of trigger
37 schema => $schema, # Schema object
42 C<SQL::Translator::Schema::Trigger> is the trigger object.
49 use SQL::Translator::Utils 'parse_list_arg';
51 use base 'SQL::Translator::Schema::Object';
55 use vars qw($VERSION $TABLE_COUNT $VIEW_COUNT);
59 # ----------------------------------------------------------------------
61 __PACKAGE__->_attributes( qw/
62 name schema perform_action_when database_events database_event
63 fields table on_table action order
72 my $schema = SQL::Translator::Schema::Trigger->new;
76 # ----------------------------------------------------------------------
77 sub perform_action_when {
81 =head2 perform_action_when
83 Gets or sets whether the event happens "before" or "after" the
86 $trigger->perform_action_when('after');
92 if ( my $arg = shift ) {
95 if ( $arg =~ m/^(before|after)$/i ) {
96 $self->{'perform_action_when'} = $arg;
100 $self->error("Invalid argument '$arg' to perform_action_when");
104 return $self->{'perform_action_when'};
107 # ----------------------------------------------------------------------
112 =head2 database_event
114 Obsolete please use database_events!
120 return $self->database_events( @_ );
123 # ----------------------------------------------------------------------
124 sub database_events {
128 =head2 database_events
130 Gets or sets the events that triggers the trigger.
132 my $ok = $trigger->database_events('insert');
137 my @args = ref $_[0] eq 'ARRAY' ? @{ $_[0] } : @_;
140 @args = map { s/\s+/ /g; lc $_ } @args;
141 my %valid = map { $_, 1 } qw[ insert update update_on delete ];
142 my @invalid = grep { !defined $valid{ $_ } } @args;
146 sprintf("Invalid events '%s' in database_events",
152 $self->{'database_events'} = [ @args ];
156 ? @{ $self->{'database_events'} || [] }
157 : $self->{'database_events'};
160 # ----------------------------------------------------------------------
167 Gets and set which fields to monitor for C<database_event>.
170 $view->fields('id', 'name');
171 $view->fields( 'id, name' );
172 $view->fields( [ 'id', 'name' ] );
173 $view->fields( qw[ id name ] );
175 my @fields = $view->fields;
180 my $fields = parse_list_arg( @_ );
183 my ( %unique, @unique );
184 for my $f ( @$fields ) {
185 next if $unique{ $f };
190 $self->{'fields'} = \@unique;
193 return wantarray ? @{ $self->{'fields'} || [] } : $self->{'fields'};
196 # ----------------------------------------------------------------------
203 Gets or set the table on which the trigger works, as a L<SQL::Translator::Schema::Table> object.
204 $trigger->table($triggered_table);
208 my ($self, $arg) = @_;
210 $self->error("Table attribute of a ".__PACKAGE__.
211 " must be a SQL::Translator::Schema::Table")
212 unless ref $arg and $arg->isa('SQL::Translator::Schema::Table');
213 $self->{table} = $arg;
215 return $self->{table};
218 # ----------------------------------------------------------------------
225 Gets or set the table name on which the trigger works, as a string.
226 $trigger->on_table('foo');
230 my ($self, $arg) = @_;
232 my $table = $self->schema->get_table($arg);
233 die "Table named $arg doesn't exist"
235 $self->table($table);
237 return $self->table->name;
240 # ----------------------------------------------------------------------
247 Gets or set the actions of the trigger.
261 my $arg = shift || '';
262 $self->{'action'} = $arg if $arg;
263 return $self->{'action'};
266 # ----------------------------------------------------------------------
273 Determine whether the trigger is valid or not.
275 my $ok = $trigger->is_valid;
282 qw[ name perform_action_when database_events on_table action ]
284 return $self->error("Invalid: missing '$attr'") unless $self->$attr();
287 return $self->error("Missing fields for UPDATE ON") if
288 $self->database_event eq 'update_on' && !$self->fields;
293 # ----------------------------------------------------------------------
300 Get or set the trigger's name.
302 my $name = $trigger->name('foo');
307 $self->{'name'} = shift if @_;
308 return $self->{'name'} || '';
311 # ----------------------------------------------------------------------
318 Get or set the trigger's order.
320 my $order = $trigger->order(3);
324 my ( $self, $arg ) = @_;
326 if ( defined $arg && $arg =~ /^\d+$/ ) {
327 $self->{'order'} = $arg;
330 return $self->{'order'} || 0;
333 # ----------------------------------------------------------------------
340 Get or set the trigger's schema object.
342 $trigger->schema( $schema );
343 my $schema = $trigger->schema;
348 if ( my $arg = shift ) {
349 return $self->error('Not a schema object') unless
350 UNIVERSAL::isa( $arg, 'SQL::Translator::Schema' );
351 $self->{'schema'} = $arg;
354 return $self->{'schema'};
357 # ----------------------------------------------------------------------
362 =head2 compare_arrays
368 my ($first, $second) = @_;
369 no warnings; # silence spurious -w undef complaints
371 return 0 unless (ref $first eq 'ARRAY' and ref $second eq 'ARRAY' ) ;
373 return 0 unless @$first == @$second;
375 my @first = sort @$first;
377 my @second = sort @$second;
379 for (my $i = 0; $i < scalar @first; $i++) {
380 return 0 if @first[$i] ne @second[$i];
386 # ----------------------------------------------------------------------
393 Determines if this trigger is the same as another
395 my $is_identical = $trigger1->equals( $trigger2 );
401 my $case_insensitive = shift;
403 return 0 unless $self->SUPER::equals($other);
406 for my $name ( $self->name, $other->name ) {
407 $name = lc $name if $case_insensitive;
411 if ( keys %names > 1 ) {
412 return $self->error('Names not equal');
415 if ( !$self->perform_action_when eq $other->perform_action_when ) {
416 return $self->error('perform_action_when differs');
420 !compare_arrays( [$self->database_events], [$other->database_events] )
422 return $self->error('database_events differ');
425 if ( $self->on_table ne $other->on_table ) {
426 return $self->error('on_table differs');
429 if ( $self->action ne $other->action ) {
430 return $self->error('action differs');
434 !$self->_compare_objects( scalar $self->extra, scalar $other->extra )
436 return $self->error('extras differ');
442 # ----------------------------------------------------------------------
445 undef $self->{'schema'}; # destroy cyclical reference
450 # ----------------------------------------------------------------------
457 Ken Youens-Clark E<lt>kclark@cpan.orgE<gt>.