1 package SQL::Translator::Schema::Trigger;
3 # ----------------------------------------------------------------------
5 # ----------------------------------------------------------------------
6 # Copyright (C) 2002-2009 SQLFairy Authors
8 # This program is free software; you can redistribute it and/or
9 # modify it under the terms of the GNU General Public License as
10 # published by the Free Software Foundation; version 2.
12 # This program is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 # General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with this program; if not, write to the Free Software
19 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
21 # -------------------------------------------------------------------
27 SQL::Translator::Schema::Trigger - SQL::Translator trigger object
31 use SQL::Translator::Schema::Trigger;
32 my $trigger = SQL::Translator::Schema::Trigger->new(
34 perform_action_when => 'before', # or after
35 database_event => 'insert', # Obsolete please use database_events!
36 database_events => [qw/update instert/], # or update, update_on, delete
37 fields => [], # fields if event is "update"
38 on_table => 'foo', # table name
39 action => '...', # text of trigger
40 schema => $schema, # Schema object
45 C<SQL::Translator::Schema::Trigger> is the trigger object.
52 use SQL::Translator::Utils 'parse_list_arg';
54 use base 'SQL::Translator::Schema::Object';
56 use vars qw($TABLE_COUNT $VIEW_COUNT);
58 # ----------------------------------------------------------------------
60 __PACKAGE__->_attributes( qw/
61 name schema perform_action_when database_event database_events fields table on_table action
71 my $schema = SQL::Translator::Schema::Trigger->new;
75 # ----------------------------------------------------------------------
76 sub perform_action_when {
80 =head2 perform_action_when
82 Gets or sets whether the event happens "before" or "after" the
85 $trigger->perform_action_when('after');
91 if ( my $arg = shift ) {
94 if ( $arg =~ m/^(before|after)$/i ) {
95 $self->{'perform_action_when'} = $arg;
99 $self->error("Invalid argument '$arg' to perform_action_when");
103 return $self->{'perform_action_when'};
106 # ----------------------------------------------------------------------
111 =head2 database_event
113 Obosolete please use database_events!
120 if ( my $arg = shift ) {
121 $self->database_events( [$arg] );
124 return $self->error("Please use database_events the trigger has more then one events!") if (scalar @{$self->{'database_events'}} > 1);
126 warn 'database_event is obsolete please use database_events';
127 return (@{ $self->{'database_events'} })[0];
129 # ----------------------------------------------------------------------
130 sub database_events {
134 =head2 database_events
136 Gets or sets the events that triggers the trigger.
138 my $ok = $trigger->database_event('insert');
144 if ( my $arg = shift ) {
145 if (ref $arg eq "ARRAY"){
149 return $self->error("Invalid event '$_' in database_events") unless ( $_ =~ /^(insert|update|update_on|delete)$/ );
151 @{ $self->{'database_events'} } = @$arg;
154 return $self->error("Invalid argument to database_events");
159 return $self->{'database_events'};
162 # ----------------------------------------------------------------------
169 Gets and set which fields to monitor for C<database_event>.
172 $view->fields('id', 'name');
173 $view->fields( 'id, name' );
174 $view->fields( [ 'id', 'name' ] );
175 $view->fields( qw[ id name ] );
177 my @fields = $view->fields;
182 my $fields = parse_list_arg( @_ );
185 my ( %unique, @unique );
186 for my $f ( @$fields ) {
187 next if $unique{ $f };
192 $self->{'fields'} = \@unique;
195 return wantarray ? @{ $self->{'fields'} || [] } : $self->{'fields'};
198 # ----------------------------------------------------------------------
205 Gets or set the table on which the trigger works, as a L<SQL::Translator::Schema::Table> object.
206 $trigger->table($triggered_table);
210 my ($self, $arg) = @_;
212 $self->error("Table attribute of a ".__PACKAGE__.
213 " must be a SQL::Translator::Schema::Table")
214 unless ref $arg and $arg->isa('SQL::Translator::Schema::Table');
215 $self->{table} = $arg;
217 return $self->{table};
220 # ----------------------------------------------------------------------
227 Gets or set the table name on which the trigger works, as a string.
228 $trigger->on_table('foo');
232 my ($self, $arg) = @_;
234 my $table = $self->schema->get_table($arg);
235 die "Table named $arg doesn't exist"
237 $self->table($table);
239 return $self->table->name;
242 # ----------------------------------------------------------------------
249 Gets or set the actions of the trigger.
263 my $arg = shift || '';
264 $self->{'action'} = $arg if $arg;
265 return $self->{'action'};
268 # ----------------------------------------------------------------------
275 Determine whether the trigger is valid or not.
277 my $ok = $trigger->is_valid;
284 qw[ name perform_action_when database_event on_table action ]
286 return $self->error("No $attr") unless $self->$attr();
289 return $self->error("Missing fields for UPDATE ON") if
290 $self->database_event eq 'update_on' && !$self->fields;
295 # ----------------------------------------------------------------------
302 Get or set the trigger's name.
304 my $name = $trigger->name('foo');
309 $self->{'name'} = shift if @_;
310 return $self->{'name'} || '';
313 # ----------------------------------------------------------------------
320 Get or set the trigger's order.
322 my $order = $trigger->order(3);
326 my ( $self, $arg ) = @_;
328 if ( defined $arg && $arg =~ /^\d+$/ ) {
329 $self->{'order'} = $arg;
332 return $self->{'order'} || 0;
335 # ----------------------------------------------------------------------
342 Get or set the trigger's schema object.
344 $trigger->schema( $schema );
345 my $schema = $trigger->schema;
350 if ( my $arg = shift ) {
351 return $self->error('Not a schema object') unless
352 UNIVERSAL::isa( $arg, 'SQL::Translator::Schema' );
353 $self->{'schema'} = $arg;
356 return $self->{'schema'};
359 # ----------------------------------------------------------------------
364 =head2 compare_arrays
370 my ($first, $second) = @_;
371 no warnings; # silence spurious -w undef complaints
373 return 0 unless (ref $first eq 'ARRAY' and ref $second eq 'ARRAY' ) ;
374 return 0 unless @$first == @$second;
375 my @first = sort @$first;
376 my @second = sort @$second;
377 for (my $i = 0; $i < scalar @first; $i++) {
378 return 0 if @first[$i] ne @second[$i];
383 # ----------------------------------------------------------------------
390 Determines if this trigger is the same as another
392 my $isIdentical = $trigger1->equals( $trigger2 );
398 my $case_insensitive = shift;
400 return 0 unless $self->SUPER::equals($other);
401 return 0 unless $case_insensitive ? uc($self->name) eq uc($other->name) : $self->name eq $other->name;
402 #return 0 unless $self->is_valid eq $other->is_valid;
403 return 0 unless $self->perform_action_when eq $other->perform_action_when;
404 return 0 unless compare_arrays($self->database_events,$other->database_events) ;
405 return 0 unless $self->on_table eq $other->on_table;
406 return 0 unless $self->action eq $other->action;
407 return 0 unless $self->_compare_objects(scalar $self->extra, scalar $other->extra);
411 # ----------------------------------------------------------------------
414 undef $self->{'schema'}; # destroy cyclical reference
419 # ----------------------------------------------------------------------
425 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.