X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FTable.pm;h=e1bbe7d0d00688111b25fd39192901ba8e0c912b;hb=958bcea5fcf02c0c13e934dd03103d8421dcc144;hp=6caae423c5520fdec79bd651d2ba86467eac6280;hpb=5464485558c3ed1050cfb6d3dfbab11a0de16915;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/Table.pm b/lib/DBIx/Class/Table.pm index 6caae42..e1bbe7d 100644 --- a/lib/DBIx/Class/Table.pm +++ b/lib/DBIx/Class/Table.pm @@ -3,9 +3,10 @@ package DBIx::Class::Table; use strict; use warnings; -use DBIx::Class::Cursor; +use DBIx::Class::ResultSet; +use Data::Page; -use base qw/Class::Data::Inheritable/; +use base qw/DBIx::Class/; __PACKAGE__->mk_classdata('_columns' => {}); @@ -13,7 +14,9 @@ __PACKAGE__->mk_classdata('_table_name'); __PACKAGE__->mk_classdata('table_alias'); # FIXME: Doesn't actually do anything yet! -__PACKAGE__->mk_classdata('_cursor_class' => 'DBIx::Class::Cursor'); +__PACKAGE__->mk_classdata('_resultset_class' => 'DBIx::Class::ResultSet'); + +sub iterator_class { shift->_resultset_class(@_) } =head1 NAME @@ -23,120 +26,13 @@ DBIx::Class::Table - Basic table methods =head1 DESCRIPTION -This class is responsible for defining and doing basic operations on -L objects. +This class is responsible for defining and doing table-level operations on +L classes. =head1 METHODS -=over 4 - =cut -sub new { - my ($class, $attrs) = @_; - $class = ref $class if ref $class; - my $new = bless({ _column_data => { } }, $class); - if ($attrs) { - die "attrs must be a hashref" unless ref($attrs) eq 'HASH'; - while (my ($k, $v) = each %{$attrs}) { - $new->store_column($k => $v); - } - } - return $new; -} - -sub insert { - my ($self) = @_; - return if $self->in_database; - #use Data::Dumper; warn Dumper($self); - my $sth = $self->_get_sth('insert', [ keys %{$self->{_column_data}} ], - $self->_table_name, undef); - $sth->execute(values %{$self->{_column_data}}); - $sth->finish; - $self->in_database(1); - $self->{_dirty_columns} = {}; - return $self; -} - -sub in_database { - my ($self, $val) = @_; - $self->{_in_database} = $val if @_ > 1; - return $self->{_in_database}; -} - -sub create { - my ($class, $attrs) = @_; - die "create needs a hashref" unless ref $attrs eq 'HASH'; - return $class->new($attrs)->insert; -} - -sub update { - my ($self) = @_; - die "Not in database" unless $self->in_database; - my @to_update = keys %{$self->{_dirty_columns} || {}}; - return -1 unless @to_update; - my $sth = $self->_get_sth('update', \@to_update, - $self->_table_name, $self->_ident_cond); - my $rows = $sth->execute( (map { $self->{_column_data}{$_} } @to_update), - $self->_ident_values ); - $sth->finish; - if ($rows == 0) { - die "Can't update $self: row not found"; - } elsif ($rows > 1) { - die "Can't update $self: updated more than one row"; - } - $self->{_dirty_columns} = {}; - return $self; -} - -sub delete { - my $self = shift; - if (ref $self) { - die "Not in database" unless $self->in_database; - #warn $self->_ident_cond.' '.join(', ', $self->_ident_values); - my $sth = $self->_get_sth('delete', undef, - $self->_table_name, $self->_ident_cond); - $sth->execute($self->_ident_values); - $sth->finish; - $self->in_database(undef); - } else { - my $attrs = { }; - if (@_ > 1 && ref $_[$#_] eq 'HASH') { - $attrs = { %{ pop(@_) } }; - } - my $query = (ref $_[0] eq 'HASH' ? $_[0] : {@_}); - my ($cond, @param) = $self->_cond_resolve($query, $attrs); - my $sth = $self->_get_sth('delete', undef, $self->_table_name, $cond); - $sth->execute(@param); - $sth->finish; - } - return $self; -} - -sub get_column { - my ($self, $column) = @_; - die "Can't fetch data as class method" unless ref $self; - die "No such column '${column}'" unless $self->_columns->{$column}; - return $self->{_column_data}{$column} - if exists $self->{_column_data}{$column}; - return undef; -} - -sub set_column { - my $self = shift; - my ($column) = @_; - my $ret = $self->store_column(@_); - $self->{_dirty_columns}{$column} = 1; - return $ret; -} - -sub store_column { - my ($self, $column, $value) = @_; - die "No such column '${column}'" unless $self->_columns->{$column}; - die "set_column called for ${column} without value" if @_ < 3; - return $self->{_column_data}{$column} = $value; -} - sub _register_columns { my ($class, @cols) = @_; my $names = { %{$class->_columns} }; @@ -149,105 +45,188 @@ sub _mk_column_accessors { $class->mk_group_accessors('column' => @cols); } +=head2 add_columns + + __PACKAGE__->add_columns(qw/col1 col2 col3/); + +Adds columns to the current class and creates accessors for them. + +=cut + sub add_columns { my ($class, @cols) = @_; $class->_register_columns(@cols); $class->_mk_column_accessors(@cols); } -sub retrieve_from_sql { +=head2 search_literal + + my @obj = $class->search_literal($literal_where_cond, @bind); + my $cursor = $class->search_literal($literal_where_cond, @bind); + +=cut + +sub search_literal { my ($class, $cond, @vals) = @_; $cond =~ s/^\s*WHERE//i; - my $attrs = (ref $vals[$#vals] eq 'HASH' ? pop(@vals) : {}); - my @cols = $class->_select_columns($attrs); - my $sth = $class->_get_sth( 'select', \@cols, $class->_table_name, $cond); - #warn "$cond @vals"; - return $class->sth_to_objects($sth, \@vals, \@cols, { where => $cond }); + my $attrs = (ref $vals[$#vals] eq 'HASH' ? { %{ pop(@vals) } } : {}); + $attrs->{bind} = \@vals; + return $class->search(\$cond, $attrs); } -sub sth_to_objects { - my ($class, $sth, $args, $cols, $attrs) = @_; - my @cols = ((ref $cols eq 'ARRAY') ? @$cols : @{$sth->{NAME_lc}} ); - my $cursor_class = $class->_cursor_class; - eval "use $cursor_class;"; - my $cursor = $cursor_class->new($class, $sth, $args, \@cols, $attrs); - return (wantarray ? $cursor->all : $cursor); +=head2 count_literal + + my $count = $class->count_literal($literal_where_cond); + +=cut + +sub count_literal { + my $class = shift; + return $class->search_literal(@_)->count; } -sub _row_to_object { # WARNING: Destructive to @$row - my ($class, $cols, $row) = @_; - my $new = $class->new; - $new->store_column($_, shift @$row) for @$cols; - $new->in_database(1); - return $new; +=head2 count + + my $count = $class->count({ foo => 3 }); + +=cut + +sub count { + my $class = shift; + return $class->search(@_)->count; } +=head2 search + + my @obj = $class->search({ foo => 3 }); # "... WHERE foo = 3" + my $cursor = $class->search({ foo => 3 }); + +To retrieve all rows, simply call C with no condition parameter, + + my @all = $class->search(); # equivalent to search({}) + +If you need to pass in additional attributes (see +L for details) an empty hash indicates +no condition, + + my @all = $class->search({}, { cols => [qw/foo bar/] }); # "SELECT foo, bar FROM $class_table" + +=cut + sub search { my $class = shift; + #warn "@_"; my $attrs = { }; if (@_ > 1 && ref $_[$#_] eq 'HASH') { $attrs = { %{ pop(@_) } }; } - my $query = ref $_[0] eq "HASH" ? shift: {@_}; - my ($cond, @param) = $class->_cond_resolve($query, $attrs); - return $class->retrieve_from_sql($cond, @param, $attrs); + $attrs->{where} = (@_ == 1 || ref $_[0] eq "HASH" ? shift: {@_}); + + my $rs = $class->resultset($attrs); + + return (wantarray ? $rs->all : $rs); +} + +sub resultset { + my $class = shift; + + my $rs_class = $class->_resultset_class; + eval "use $rs_class;"; + my $rs = $rs_class->new($class, @_); } +=head2 search_like + +Identical to search except defaults to 'LIKE' instead of '=' in condition + +=cut + sub search_like { my $class = shift; my $attrs = { }; if (@_ > 1 && ref $_[$#_] eq 'HASH') { $attrs = pop(@_); } - return $class->search(@_, { %$attrs, cmp => 'LIKE' }); + my $query = ref $_[0] eq "HASH" ? { %{shift()} }: {@_}; + $query->{$_} = { 'like' => $query->{$_} } for keys %$query; + return $class->search($query, { %$attrs }); } sub _select_columns { return keys %{$_[0]->_columns}; } -sub copy { - my ($self, $changes) = @_; - my $new = bless({ _column_data => { %{$self->{_column_data}}} }, ref $self); - $new->set_column($_ => $changes->{$_}) for keys %$changes; - return $new->insert; -} +=head2 table -sub _cond_resolve { - my ($self, $query, $attrs) = @_; - return '1 = 1' unless keys %$query; - my $op = $attrs->{'cmp'} || '='; - my $cond = join(' AND ', - map { (defined $query->{$_} - ? "$_ $op ?" - : (do { delete $query->{$_}; "$_ IS NULL"; })); - } keys %$query); - return ($cond, values %$query); -} + __PACKAGE__->table('tbl_name'); + +Gets or sets the table name. + +=cut sub table { shift->_table_name(@_); } +=head2 find_or_create + + $class->find_or_create({ key => $val, ... }); + +Searches for a record matching the search condition; if it doesn't find one, +creates one and returns that instead. + +=cut + sub find_or_create { my $class = shift; my $hash = ref $_[0] eq "HASH" ? shift: {@_}; - my ($exists) = $class->search($hash); + my $exists = $class->find($hash); return defined($exists) ? $exists : $class->create($hash); } -sub retrieve_all { - my ($class) = @_; - return $class->retrieve_from_sql( '1' ); +=head2 has_column + + if ($obj->has_column($col)) { ... } + +Returns 1 if the class has a column of this name, 0 otherwise. + +=cut + +sub has_column { + my ($self, $column) = @_; + return exists $self->_columns->{$column}; } -1; +=head2 column_info + + my $info = $obj->column_info($col); + +Returns the column metadata hashref for a column. + +=cut + +sub column_info { + my ($self, $column) = @_; + die "No such column $column" unless exists $self->_columns->{$column}; + return $self->_columns->{$column}; +} -=back +=head2 columns + + my @column_names = $obj->columns; + +=cut + +sub columns { + die "columns() is a read-only accessor, did you mean add_columns()?" if (@_ > 1); + return keys %{shift->_columns}; +} + +1; =head1 AUTHORS -Matt S. Trout +Matt S. Trout =head1 LICENSE