3 # Copyright ByWater Solutions 2014
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it under the
8 # terms of the GNU General Public License as published by the Free Software
9 # Foundation; either version 3 of the License, or (at your option) any later
12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
14 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License along
17 # with Koha; if not, write to the Free Software Foundation, Inc.,
18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 use List
::MoreUtils
qw( none );
29 Koha::Objects - Koha Object set base class
34 my @objects = Koha::Objects->search({ borrowernumber => $borrowernumber});
38 This class must be subclassed.
46 =head3 Koha::Objects->new();
48 my $object = Koha::Objects->new();
56 bless( $self, $class );
59 =head3 Koha::Objects->_new_from_dbic();
61 my $object = Koha::Objects->_new_from_dbic( $resultset );
66 my ( $class, $resultset ) = @_;
67 my $self = { _resultset
=> $resultset };
69 bless( $self, $class );
72 =head3 Koha::Objects->find();
74 Similar to DBIx::Class::ResultSet->find this method accepts:
75 \%columns_values | @pk_values, { key => $unique_constraint, %attrs }?
76 Strictly speaking, columns_values should only refer to columns under an
79 my $object = Koha::Objects->find( { col1 => $val1, col2 => $val2 } );
80 my $object = Koha::Objects->find( $id );
81 my $object = Koha::Objects->find( $idpart1, $idpart2, $attrs ); # composite PK
86 my ( $self, @pars ) = @_;
88 croak
'Cannot use "->find" in list context' if wantarray;
90 return if !@pars || none
{ defined($_) } @pars;
92 my $result = $self->_resultset()->find( @pars );
94 return unless $result;
96 my $object = $self->object_class()->_new_from_dbic( $result );
101 =head3 Koha::Objects->find_or_create();
103 my $object = Koha::Objects->find_or_create( $attrs );
108 my ( $self, $params ) = @_;
110 my $result = $self->_resultset->find_or_create($params);
112 return unless $result;
114 my $object = $self->object_class->_new_from_dbic($result);
119 =head3 Koha::Objects->search();
121 my @objects = Koha::Objects->search($params);
126 my ( $self, $params, $attributes ) = @_;
129 my @dbic_rows = $self->_resultset()->search($params, $attributes);
131 return $self->_wrap(@dbic_rows);
135 my $class = ref($self) ?
ref($self) : $self;
136 my $rs = $self->_resultset()->search($params, $attributes);
138 return $class->_new_from_dbic($rs);
142 =head3 search_related
144 my @objects = Koha::Objects->search_related( $rel_name, $cond?, \%attrs? );
145 my $objects = Koha::Objects->search_related( $rel_name, $cond?, \%attrs? );
147 Searches the specified relationship, optionally specifying a condition and attributes for matching records.
152 my ( $self, $rel_name, @params ) = @_;
154 return if !$rel_name;
156 my @dbic_rows = $self->_resultset()->search_related($rel_name, @params);
157 return if !@dbic_rows;
158 my $object_class = _get_objects_class
( $dbic_rows[0]->result_class );
160 eval "require $object_class";
161 return _wrap
( $object_class, @dbic_rows );
164 my $rs = $self->_resultset()->search_related($rel_name, @params);
166 my $object_class = _get_objects_class
( $rs->result_class );
168 eval "require $object_class";
169 return _new_from_dbic
( $object_class, $rs );
175 my $object = Koha::Objects->search({}, { rows => 1 })->single
177 Returns one and only one object that is part of this set.
178 Returns undef if there are no objects found.
180 This is optimal as it will grab the first returned result without instantiating
184 http://search.cpan.org/dist/DBIx-Class/lib/DBIx/Class/Manual/Cookbook.pod#Retrieve_one_and_only_one_row_from_a_resultset
191 my $single = $self->_resultset()->single;
192 return unless $single;
194 return $self->object_class()->_new_from_dbic($single);
197 =head3 Koha::Objects->next();
199 my $object = Koha::Objects->next();
201 Returns the next object that is part of this set.
202 Returns undef if there are no more objects to return.
209 my $result = $self->_resultset()->next();
210 return unless $result;
212 my $object = $self->object_class()->_new_from_dbic( $result );
217 =head3 Koha::Objects->last;
219 my $object = Koha::Objects->last;
221 Returns the last object that is part of this set.
222 Returns undef if there are no object to return.
229 my $count = $self->_resultset->count;
230 return unless $count;
232 my ( $result ) = $self->_resultset->slice($count - 1, $count - 1);
234 my $object = $self->object_class()->_new_from_dbic( $result );
241 =head3 Koha::Objects->reset();
243 Koha::Objects->reset();
245 resets iteration so the next call to next() will start agein
246 with the first object in a set.
253 $self->_resultset()->reset();
258 =head3 Koha::Objects->as_list();
260 Koha::Objects->as_list();
262 Returns an arrayref of the objects in this set.
269 my @dbic_rows = $self->_resultset()->all();
271 my @objects = $self->_wrap(@dbic_rows);
273 return wantarray ?
@objects : \
@objects;
276 =head3 Koha::Objects->unblessed
278 Returns an unblessed representation of objects.
285 return [ map { $_->unblessed } $self->as_list ];
288 =head3 Koha::Objects->get_column
290 Return all the values of this set for a given column
295 my ($self, $column_name) = @_;
296 return $self->_resultset->get_column( $column_name )->all;
299 =head3 Koha::Objects->TO_JSON
301 Returns an unblessed representation of objects, suitable for JSON output.
308 return [ map { $_->TO_JSON } $self->as_list ];
311 =head3 Koha::Objects->to_api
313 Returns a representation of the objects, suitable for API output .
320 return [ map { $_->to_api } $self->as_list ];
323 =head3 Koha::Objects->_wrap
325 wraps the DBIC object in a corresponding Koha object
330 my ( $self, @dbic_rows ) = @_;
332 my @objects = map { $self->object_class->_new_from_dbic( $_ ) } @dbic_rows;
337 =head3 Koha::Objects->_resultset
339 Returns the internal resultset or creates it if undefined
347 $self->{_resultset
} ||=
348 Koha
::Database
->new()->schema()->resultset( $self->_type() );
350 return $self->{_resultset
};
353 return Koha
::Database
->new()->schema()->resultset( $self->_type() );
357 sub _get_objects_class
{
361 if( $type->can('koha_objects_class') ) {
362 return $type->koha_objects_class;
364 $type =~ s
|Schema
::Result
::||;
370 my @columns = Koha::Objects->columns
372 Return the table columns
378 return Koha
::Database
->new->schema->resultset( $class->_type )->result_source->columns;
383 The autoload method is used call DBIx::Class method on a resultset.
385 Important: If you plan to use one of the DBIx::Class methods you must provide
386 relevant tests in t/db_dependent/Koha/Objects.t
387 Currently count, pager, update and delete are covered.
392 my ( $self, @params ) = @_;
394 my @known_methods = qw( count is_paged pager update delete result_class single slice );
395 my $method = our $AUTOLOAD;
399 unless ( grep { /^$method$/ } @known_methods ) {
400 my $class = ref($self) ?
ref($self) : $self;
401 Koha
::Exceptions
::Object
::MethodNotCoveredByTests
->throw(
402 error
=> sprintf("The method %s->%s is not covered by tests!", $class, $method),
407 my $r = eval { $self->_resultset->$method(@params) };
409 carp
"No method $method found for " . ref($self) . " " . $@
;
417 The _type method must be set for all child classes.
418 The value returned by it should be the DBIC resultset name.
419 For example, for holds, _type should return 'Reserve'.
427 This method must be set for all child classes.
428 The value returned by it should be the name of the Koha
429 object class that is returned by this class.
430 For example, for holds, object_class should return 'Koha::Hold'.
440 Kyle M Hall <kyle@bywatersolutions.com>