Fix SYNOPSIS - RT#70156

[dbsrgits/DBIx-Class-UserStamp.git] / lib / DBIx / Class / UserStamp.pm

package DBIx::Class::UserStamp;

use base qw(DBIx::Class);

use warnings;
use strict;

our $VERSION = '0.11';

__PACKAGE__->load_components( qw/DynamicDefault/ );

=head1 NAME

DBIx::Class::UserStamp - Automatically set update and create user id fields

=head1 DESCRIPTION

Automatically set fields on 'update' and 'create' that hold user id 
values in a table. This can be used for any user id based  
field that needs trigger like functionality when a record is 
added or updated.

=head1 SYNOPSIS

 package MyApp::Schema;

 __PACKAGE__->mk_group_accessors('simple' => qw/current_user_id/);


 package MyApp::Model::MyAppDB;
 use Moose;
 use namespace::autoclean;

 extends 'Catalyst::Model::DBIC::Schema';
 with 'Catalyst::Component::InstancePerContext';

 sub build_per_context_instance {
   my ($meth, $self) = (shift, shift);
   my ($c) = @_; # There are other params but we dont care about them
   my $new = bless({ %$self }, ref($self));
   my $user_info = $c->_user_in_session;
   $new->schema($new->schema->clone);
   my $user = $new->schema->resultset('User')->new_result({ %$user_info });
   $new->schema->current_user_id($user->id) if (defined $user_info);
   return $new;
 }


 package MyApp::Schema::SomeTable;

 __PACKAGE__->load_components(qw( UserStamp ... Core ));

 __PACKAGE__->add_columns(
    id => { data_type => 'integer' },
    u_created => { data_type => 'int', store_user_on_create => 1 },
    u_updated => { data_type => 'int',
        store_user_on_create => 1, store_user_on_update => 1 },
 );

Now, any update or create actions will update the specified columns with the
current user_id, using the current_user_id accessor.

This is effectively trigger emulation to ease user id field insertion

=cut

sub add_columns {
    my ($self, @cols) = @_;
    my @columns;

    while (my $col = shift @cols) {
        my $info = ref $cols[0] ? shift @cols : {};

        if ( delete $info->{store_user_on_update} ) {
            $info->{dynamic_default_on_update} = 'get_current_user_id';
        }
        if ( delete $info->{store_user_on_create} ) {
            $info->{dynamic_default_on_create} = 'get_current_user_id';
        }

        push @columns, $col => $info;
    }

    return $self->next::method(@columns);
}

=head1 METHODS

=head2 get_current_user_id

This method is meant to be overridden.  The default is to return a 
schema accessor called current_user_id which should be populated as such.

=cut
sub get_current_user_id { shift->result_source->schema->current_user_id }

=head1 AUTHOR

 Matt S. Trout     <mst@shadowcatsystems.co.uk>

=head1 CONTRIBUTORS

 John Goulah     <jgoulah@cpan.org>
 Florian Ragwitz <rafl@debian.org>

=head1 COPYRIGHT

This program is free software; you can redistribute
it and/or modify it under the same terms as Perl itself.

=cut

1;