use warnings;
use DBIx::Class::ResultSet;
+use Data::Page;
-use base qw/Class::Data::Inheritable/;
+use base qw/DBIx::Class/;
__PACKAGE__->mk_classdata('_columns' => {});
=head1 DESCRIPTION
-This class is responsible for defining and doing basic operations on
-L<DBIx::Class> objects.
+This class is responsible for defining and doing table-level operations on
+L<DBIx::Class> classes.
=head1 METHODS
-=over 4
-
=cut
sub _register_columns {
$class->mk_group_accessors('column' => @cols);
}
-=item add_columns
+=head2 add_columns
__PACKAGE__->add_columns(qw/col1 col2 col3/);
-Adds columns to the current package, and creates accessors for them
+Adds columns to the current class and creates accessors for them.
=cut
$class->_mk_column_accessors(@cols);
}
-=item search_literal
+=head2 search_literal
my @obj = $class->search_literal($literal_where_cond, @bind);
my $cursor = $class->search_literal($literal_where_cond, @bind);
return $class->search(\$cond, $attrs);
}
-=item count_literal
+=head2 count_literal
my $count = $class->count_literal($literal_where_cond);
return $class->search_literal(@_)->count;
}
-=item count
+=head2 count
my $count = $class->count({ foo => 3 });
return $class->search(@_)->count;
}
-=item search
+=head2 search
- my @obj = $class->search({ foo => 3 });
+ my @obj = $class->search({ foo => 3 }); # "... WHERE foo = 3"
my $cursor = $class->search({ foo => 3 });
+To retrieve all rows, simply call C<search()> with no condition parameter,
+
+ my @all = $class->search(); # equivalent to search({})
+
+If you need to pass in additional attributes (see
+L<DBIx::Class::ResultSet/Attributes> 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 {
$attrs = { %{ pop(@_) } };
}
$attrs->{where} = (@_ == 1 || ref $_[0] eq "HASH" ? shift: {@_});
-
+
my $rs = $class->resultset($attrs);
-
+
return (wantarray ? $rs->all : $rs);
}
my $rs = $rs_class->new($class, @_);
}
-=item search_like
+=head2 search_like
Identical to search except defaults to 'LIKE' instead of '=' in condition
return keys %{$_[0]->_columns};
}
-=item table
+=head2 table
__PACKAGE__->table('tbl_name');
+
+Gets or sets the table name.
=cut
shift->_table_name(@_);
}
-=item find_or_create
+=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
+creates one and returns that instead.
=cut
return defined($exists) ? $exists : $class->create($hash);
}
-sub columns { return keys %{shift->_columns}; }
+=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};
+}
+
+=head2 columns
+
+ my @column_names = $obj->columns;
+
+=cut
-=back
+sub columns {
+ die "columns() is a read-only accessor, did you mean add_columns()?" if (@_ > 1);
+ return keys %{shift->_columns};
+}
+
+1;
=head1 AUTHORS