1 package SQL::Translator::Schema::Trigger;
3 # ----------------------------------------------------------------------
5 # ----------------------------------------------------------------------
6 # Copyright (C) 2002-4 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($VERSION $TABLE_COUNT $VIEW_COUNT);
58 $VERSION = sprintf "%d.%02d", q$Revision$ =~ /(\d+)\.(\d+)/;
60 # ----------------------------------------------------------------------
62 __PACKAGE__->_attributes( qw/
63 name schema perform_action_when database_event database_events fields table on_table action
73 my $schema = SQL::Translator::Schema::Trigger->new;
77 # ----------------------------------------------------------------------
78 sub perform_action_when {
82 =head2 perform_action_when
84 Gets or sets whether the event happens "before" or "after" the
87 $trigger->perform_action_when('after');
93 if ( my $arg = shift ) {
96 if ( $arg =~ m/^(before|after)$/i ) {
97 $self->{'perform_action_when'} = $arg;
101 $self->error("Invalid argument '$arg' to perform_action_when");
105 return $self->{'perform_action_when'};
108 # ----------------------------------------------------------------------
113 =head2 database_event
115 Obosolete please use database_events!
122 if ( my $arg = shift ) {
123 $self->database_events( [$arg] );
126 return $self->error("Please use database_events the trigger has more then one events!") if (scalar @{$self->{'database_events'}} > 1);
128 warn 'database_event is obsolete please use database_events';
129 return (@{ $self->{'database_events'} })[0];
131 # ----------------------------------------------------------------------
132 sub database_events {
136 =head2 database_events
138 Gets or sets the events that triggers the trigger.
140 my $ok = $trigger->database_event('insert');
146 if ( my $arg = shift ) {
147 if (ref $arg eq "ARRAY"){
151 return $self->error("Invalid event '$_' in database_events") unless ( $_ =~ /^(insert|update|update_on|delete)$/ );
153 @{ $self->{'database_events'} } = @$arg;
156 return $self->error("Invalid argument to database_events");
161 return $self->{'database_events'};
164 # ----------------------------------------------------------------------
171 Gets and set which fields to monitor for C<database_event>.
174 $view->fields('id', 'name');
175 $view->fields( 'id, name' );
176 $view->fields( [ 'id', 'name' ] );
177 $view->fields( qw[ id name ] );
179 my @fields = $view->fields;
184 my $fields = parse_list_arg( @_ );
187 my ( %unique, @unique );
188 for my $f ( @$fields ) {
189 next if $unique{ $f };
194 $self->{'fields'} = \@unique;
197 return wantarray ? @{ $self->{'fields'} || [] } : $self->{'fields'};
200 # ----------------------------------------------------------------------
207 Gets or set the table on which the trigger works, as a L<SQL::Translator::Schema::Table> object.
208 $trigger->table($triggered_table);
212 my ($self, $arg) = @_;
214 $self->error("Table attribute of a ".__PACKAGE__.
215 " must be a SQL::Translator::Schema::Table")
216 unless ref $arg and $arg->isa('SQL::Translator::Schema::Table');
217 $self->{table} = $arg;
219 return $self->{table};
222 # ----------------------------------------------------------------------
229 Gets or set the table name on which the trigger works, as a string.
230 $trigger->on_table('foo');
234 my ($self, $arg) = @_;
236 my $table = $self->schema->get_table($arg);
237 die "Table named $arg doesn't exist"
239 $self->table($table);
241 return $self->table->name;
244 # ----------------------------------------------------------------------
251 Gets or set the actions of the trigger.
265 my $arg = shift || '';
266 $self->{'action'} = $arg if $arg;
267 return $self->{'action'};
270 # ----------------------------------------------------------------------
277 Determine whether the trigger is valid or not.
279 my $ok = $trigger->is_valid;
286 qw[ name perform_action_when database_event on_table action ]
288 return $self->error("No $attr") unless $self->$attr();
291 return $self->error("Missing fields for UPDATE ON") if
292 $self->database_event eq 'update_on' && !$self->fields;
297 # ----------------------------------------------------------------------
304 Get or set the trigger's name.
306 my $name = $trigger->name('foo');
311 $self->{'name'} = shift if @_;
312 return $self->{'name'} || '';
315 # ----------------------------------------------------------------------
322 Get or set the trigger's order.
324 my $order = $trigger->order(3);
328 my ( $self, $arg ) = @_;
330 if ( defined $arg && $arg =~ /^\d+$/ ) {
331 $self->{'order'} = $arg;
334 return $self->{'order'} || 0;
337 # ----------------------------------------------------------------------
344 Get or set the trigger's schema object.
346 $trigger->schema( $schema );
347 my $schema = $trigger->schema;
352 if ( my $arg = shift ) {
353 return $self->error('Not a schema object') unless
354 UNIVERSAL::isa( $arg, 'SQL::Translator::Schema' );
355 $self->{'schema'} = $arg;
358 return $self->{'schema'};
361 # ----------------------------------------------------------------------
366 =head2 compare_arrays
372 my ($first, $second) = @_;
373 no warnings; # silence spurious -w undef complaints
375 return 0 unless (ref $first eq 'ARRAY' and ref $second eq 'ARRAY' ) ;
376 return 0 unless @$first == @$second;
377 my @first = sort @$first;
378 my @second = sort @$second;
379 for (my $i = 0; $i < scalar @first; $i++) {
380 return 0 if @first[$i] ne @second[$i];
385 # ----------------------------------------------------------------------
392 Determines if this trigger is the same as another
394 my $isIdentical = $trigger1->equals( $trigger2 );
400 my $case_insensitive = shift;
402 return 0 unless $self->SUPER::equals($other);
403 return 0 unless $case_insensitive ? uc($self->name) eq uc($other->name) : $self->name eq $other->name;
404 #return 0 unless $self->is_valid eq $other->is_valid;
405 return 0 unless $self->perform_action_when eq $other->perform_action_when;
406 return 0 unless compare_arrays($self->database_events,$other->database_events) ;
407 return 0 unless $self->on_table eq $other->on_table;
408 return 0 unless $self->action eq $other->action;
409 return 0 unless $self->_compare_objects(scalar $self->extra, scalar $other->extra);
413 # ----------------------------------------------------------------------
416 undef $self->{'schema'}; # destroy cyclical reference
421 # ----------------------------------------------------------------------
427 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.