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 It returns undef if no results were found
81 my $object = Koha::Objects->find( { col1 => $val1, col2 => $val2 } );
82 my $object = Koha::Objects->find( $id );
83 my $object = Koha::Objects->find( $idpart1, $idpart2, $attrs ); # composite PK
88 my ( $self, @pars ) = @_;
92 unless (!@pars || none { defined($_) } @pars) {
93 my $result = $self->_resultset()->find(@pars);
95 $object = $self->object_class()->_new_from_dbic($result);
102 =head3 Koha::Objects->find_or_create();
104 my $object = Koha::Objects->find_or_create( $attrs );
109 my ( $self, $params ) = @_;
111 my $result = $self->_resultset->find_or_create($params);
113 return unless $result;
115 my $object = $self->object_class->_new_from_dbic($result);
120 =head3 Koha::Objects->search();
122 my @objects = Koha::Objects->search($params);
127 my ( $self, $params, $attributes ) = @_;
130 my @dbic_rows = $self->_resultset()->search($params, $attributes);
132 return $self->_wrap(@dbic_rows);
136 my $class = ref($self) ? ref($self) : $self;
137 my $rs = $self->_resultset()->search($params, $attributes);
139 return $class->_new_from_dbic($rs);
143 =head3 search_related
145 my @objects = Koha::Objects->search_related( $rel_name, $cond?, \%attrs? );
146 my $objects = Koha::Objects->search_related( $rel_name, $cond?, \%attrs? );
148 Searches the specified relationship, optionally specifying a condition and attributes for matching records.
153 my ( $self, $rel_name, @params ) = @_;
155 return if !$rel_name;
157 my @dbic_rows = $self->_resultset()->search_related($rel_name, @params);
158 return if !@dbic_rows;
159 my $object_class = _get_objects_class( $dbic_rows[0]->result_class );
161 eval "require $object_class";
162 return _wrap( $object_class, @dbic_rows );
165 my $rs = $self->_resultset()->search_related($rel_name, @params);
167 my $object_class = _get_objects_class( $rs->result_class );
169 eval "require $object_class";
170 return _new_from_dbic( $object_class, $rs );
176 my $object = Koha::Objects->search({}, { rows => 1 })->single
178 Returns one and only one object that is part of this set.
179 Returns undef if there are no objects found.
181 This is optimal as it will grab the first returned result without instantiating
185 http://search.cpan.org/dist/DBIx-Class/lib/DBIx/Class/Manual/Cookbook.pod#Retrieve_one_and_only_one_row_from_a_resultset
192 my $single = $self->_resultset()->single;
193 return unless $single;
195 return $self->object_class()->_new_from_dbic($single);
198 =head3 Koha::Objects->next();
200 my $object = Koha::Objects->next();
202 Returns the next object that is part of this set.
203 Returns undef if there are no more objects to return.
210 my $result = $self->_resultset()->next();
211 return unless $result;
213 my $object = $self->object_class()->_new_from_dbic( $result );
218 =head3 Koha::Objects->last;
220 my $object = Koha::Objects->last;
222 Returns the last object that is part of this set.
223 Returns undef if there are no object to return.
230 my $count = $self->_resultset->count;
231 return unless $count;
233 my ( $result ) = $self->_resultset->slice($count - 1, $count - 1);
235 my $object = $self->object_class()->_new_from_dbic( $result );
242 =head3 Koha::Objects->reset();
244 Koha::Objects->reset();
246 resets iteration so the next call to next() will start agein
247 with the first object in a set.
254 $self->_resultset()->reset();
259 =head3 Koha::Objects->as_list();
261 Koha::Objects->as_list();
263 Returns an arrayref of the objects in this set.
270 my @dbic_rows = $self->_resultset()->all();
272 my @objects = $self->_wrap(@dbic_rows);
274 return wantarray ? @objects : \@objects;
277 =head3 Koha::Objects->unblessed
279 Returns an unblessed representation of objects.
286 return [ map { $_->unblessed } $self->as_list ];
289 =head3 Koha::Objects->get_column
291 Return all the values of this set for a given column
296 my ($self, $column_name) = @_;
297 return $self->_resultset->get_column( $column_name )->all;
300 =head3 Koha::Objects->TO_JSON
302 Returns an unblessed representation of objects, suitable for JSON output.
309 return [ map { $_->TO_JSON } $self->as_list ];
312 =head3 Koha::Objects->to_api
314 Returns a representation of the objects, suitable for API output .
319 my ($self, $params) = @_;
321 return [ map { $_->to_api($params) } $self->as_list ];
324 =head3 Koha::Objects->_wrap
326 wraps the DBIC object in a corresponding Koha object
331 my ( $self, @dbic_rows ) = @_;
333 my @objects = map { $self->object_class->_new_from_dbic( $_ ) } @dbic_rows;
338 =head3 Koha::Objects->_resultset
340 Returns the internal resultset or creates it if undefined
348 $self->{_resultset} ||=
349 Koha::Database->new()->schema()->resultset( $self->_type() );
351 return $self->{_resultset};
354 return Koha::Database->new()->schema()->resultset( $self->_type() );
358 sub _get_objects_class {
362 if( $type->can('koha_objects_class') ) {
363 return $type->koha_objects_class;
365 $type =~ s|Schema::Result::||;
371 my @columns = Koha::Objects->columns
373 Return the table columns
379 return Koha::Database->new->schema->resultset( $class->_type )->result_source->columns;
384 The autoload method is used call DBIx::Class method on a resultset.
386 Important: If you plan to use one of the DBIx::Class methods you must provide
387 relevant tests in t/db_dependent/Koha/Objects.t
388 Currently count, pager, update and delete are covered.
393 my ( $self, @params ) = @_;
395 my @known_methods = qw( count is_paged pager update delete result_class single slice );
396 my $method = our $AUTOLOAD;
400 unless ( grep { /^$method$/ } @known_methods ) {
401 my $class = ref($self) ? ref($self) : $self;
402 Koha::Exceptions::Object::MethodNotCoveredByTests->throw(
403 error => sprintf("The method %s->%s is not covered by tests!", $class, $method),
408 my $r = eval { $self->_resultset->$method(@params) };
410 carp "No method $method found for " . ref($self) . " " . $@;
418 The _type method must be set for all child classes.
419 The value returned by it should be the DBIC resultset name.
420 For example, for holds, _type should return 'Reserve'.
428 This method must be set for all child classes.
429 The value returned by it should be the name of the Koha
430 object class that is returned by this class.
431 For example, for holds, object_class should return 'Koha::Hold'.
441 Kyle M Hall <kyle@bywatersolutions.com>