X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FTable.pm;h=717e52275e5e95795b5d13f66e664e385a07954c;hb=fea3d0452969e98afc0296ba80f90a91ab7dc1be;hp=21eaa23cdfd3a52f20a1af2d67a7a98ee5425c55;hpb=181d4574c4ca1881f288c525a16b7236a8c4e800;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/Table.pm b/lib/DBIx/Class/Table.pm index 21eaa23..717e522 100644 --- a/lib/DBIx/Class/Table.pm +++ b/lib/DBIx/Class/Table.pm @@ -4,25 +4,18 @@ use strict; use warnings; use DBIx::Class::ResultSet; -use Data::Page; use Carp qw/croak/; use base qw/DBIx::Class/; +__PACKAGE__->load_components(qw/AccessorGroup/); -__PACKAGE__->mk_classdata('_columns' => {}); - -__PACKAGE__->mk_classdata('_table_name'); - -__PACKAGE__->mk_classdata('table_alias'); # FIXME: Doesn't actually do anything yet! - -__PACKAGE__->mk_classdata('_resultset_class' => 'DBIx::Class::ResultSet'); - -sub iterator_class { shift->_resultset_class(@_) } +__PACKAGE__->mk_group_accessors('simple' => + qw/_columns _primaries name resultset_class result_class storage/); =head1 NAME -DBIx::Class::Table - Basic table methods +DBIx::Class::Table - Table object =head1 SYNOPSIS @@ -35,162 +28,52 @@ L classes. =cut -sub _register_columns { - my ($class, @cols) = @_; - my $names = { %{$class->_columns} }; - $names->{$_} ||= {} for @cols; - $class->_columns($names); -} - -sub _mk_column_accessors { - my ($class, @cols) = @_; - $class->mk_group_accessors('column' => @cols); +sub new { + my ($class, $attrs) = @_; + $class = ref $class if ref $class; + my $new = bless({ %{$attrs || {}} }, $class); + $new->{resultset_class} ||= 'DBIx::Class::ResultSet'; + $new->{_columns} ||= {}; + $new->{name} ||= "!!NAME NOT SET!!"; + return $new; } -=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); -} - -=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) } } : {}); - $attrs->{bind} = \@vals; - return $class->search(\$cond, $attrs); -} - -=head2 count_literal - - my $count = $class->count_literal($literal_where_cond); - -=cut - -sub count_literal { - my $class = shift; - return $class->search_literal(@_)->count; -} - -=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; - my $attrs = { }; - croak "Table not defined for ". ( ref $class || $class ) unless $class->table(); - if (@_ > 1 && ref $_[$#_] eq 'HASH') { - $attrs = { %{ pop(@_) } }; + my ($self, @cols) = @_; + while (my $col = shift @cols) { + $self->_columns->{$col} = (ref $cols[0] ? shift : {}); } - $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 +*add_column = \&add_columns; -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(@_); - } - my $query = ref $_[0] eq "HASH" ? { %{shift()} }: {@_}; - $query->{$_} = { 'like' => $query->{$_} } for keys %$query; - return $class->search($query, { %$attrs }); -} +=head2 add_columns -sub _select_columns { - return keys %{$_[0]->_columns}; -} + $table->add_columns(qw/col1 col2 col3/); -=head2 table + $table->add_columns('col1' => \%col1_info, 'col2' => \%col2_info, ...); - __PACKAGE__->table('tbl_name'); - -Gets or sets the table name. +Adds columns to the table object. If supplied key => hashref pairs uses +the hashref as the column_info for that column. -=cut - -sub table { - shift->_table_name(@_); -} +=head2 add_column -=head2 find_or_create + $table->add_column('col' => \%info?); - $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. +Convenience alias to add_columns =cut -sub find_or_create { - my $class = shift; - my $hash = ref $_[0] eq "HASH" ? shift: {@_}; - my $exists = $class->find($hash); - return defined($exists) ? $exists : $class->create($hash); +sub resultset { + my $self = shift; + return $self->{resultset} ||= $self->resultset_class->new($self); } =head2 has_column if ($obj->has_column($col)) { ... } -Returns 1 if the class has a column of this name, 0 otherwise. +Returns 1 if the table has a column of this name, 0 otherwise. =cut @@ -213,8 +96,8 @@ sub column_info { return $self->_columns->{$column}; } -=head2 columns - +=head2 columns + my @column_names = $obj->columns; =cut @@ -224,6 +107,42 @@ sub columns { return keys %{shift->_columns}; } +=head2 set_primary_key(@cols) + +Defines one or more columns as primary key for this table. Should be +called after C. + +=cut + +sub set_primary_key { + my ($self, @cols) = @_; + # check if primary key columns are valid columns + for (@cols) { + $self->throw("No such column $_ on table ".$self->name) + unless $self->has_column($_); + } + $self->_primaries(\@cols); +} + +=head2 primary_columns + +Read-only accessor which returns the list of primary keys. + +=cut + +sub primary_columns { + return @{shift->_primaries||[]}; +} + +=head2 from + +Returns the FROM entry for the table (i.e. the table name) + +=cut + +sub from { return shift->name(@_); } + + 1; =head1 AUTHORS