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.
28 Koha::Objects - Koha Object set base class
33 my @objects = Koha::Objects->search({ borrowernumber => $borrowernumber});
37 This class must be subclassed.
45 =head3 Koha::Objects->new();
47 my $object = Koha::Objects->new();
55 bless( $self, $class );
58 =head3 Koha::Objects->_new_from_dbic();
60 my $object = Koha::Objects->_new_from_dbic( $resultset );
65 my ( $class, $resultset ) = @_;
66 my $self = { _resultset => $resultset };
68 bless( $self, $class );
71 =head3 Koha::Objects->find();
73 my $object = Koha::Objects->find($id);
74 my $object = Koha::Objects->find( { keypart1 => $keypart1, keypart2 => $keypart2 } );
79 my ( $self, $id ) = @_;
81 return unless defined($id);
83 my $result = $self->_resultset()->find($id);
85 return unless $result;
87 my $object = $self->object_class()->_new_from_dbic( $result );
92 =head3 Koha::Objects->find_or_create();
94 my $object = Koha::Objects->find_or_create( $attrs );
99 my ( $self, $params ) = @_;
101 my $result = $self->_resultset->find_or_create($params);
103 return unless $result;
105 my $object = $self->object_class->_new_from_dbic($result);
110 =head3 Koha::Objects->search();
112 my @objects = Koha::Objects->search($params);
117 my ( $self, $params, $attributes ) = @_;
120 my @dbic_rows = $self->_resultset()->search($params, $attributes);
122 return $self->_wrap(@dbic_rows);
126 my $class = ref($self) ? ref($self) : $self;
127 my $rs = $self->_resultset()->search($params, $attributes);
129 return $class->_new_from_dbic($rs);
133 =head3 search_related
135 my @objects = Koha::Objects->search_related( $rel_name, $cond?, \%attrs? );
136 my $objects = Koha::Objects->search_related( $rel_name, $cond?, \%attrs? );
138 Searches the specified relationship, optionally specifying a condition and attributes for matching records.
143 my ( $self, $rel_name, @params ) = @_;
145 return if !$rel_name;
147 my @dbic_rows = $self->_resultset()->search_related($rel_name, @params);
148 return if !@dbic_rows;
149 my $object_class = _get_objects_class( $dbic_rows[0]->result_class );
151 eval "require $object_class";
152 return _wrap( $object_class, @dbic_rows );
155 my $rs = $self->_resultset()->search_related($rel_name, @params);
157 my $object_class = _get_objects_class( $rs->result_class );
159 eval "require $object_class";
160 return _new_from_dbic( $object_class, $rs );
166 my $object = Koha::Objects->search({}, { rows => 1 })->single
168 Returns one and only one object that is part of this set.
169 Returns undef if there are no objects found.
171 This is optimal as it will grab the first returned result without instantiating
175 http://search.cpan.org/dist/DBIx-Class/lib/DBIx/Class/Manual/Cookbook.pod#Retrieve_one_and_only_one_row_from_a_resultset
182 my $single = $self->_resultset()->single;
183 return unless $single;
185 return $self->object_class()->_new_from_dbic($single);
188 =head3 Koha::Objects->next();
190 my $object = Koha::Objects->next();
192 Returns the next object that is part of this set.
193 Returns undef if there are no more objects to return.
200 my $result = $self->_resultset()->next();
201 return unless $result;
203 my $object = $self->object_class()->_new_from_dbic( $result );
208 =head3 Koha::Objects->reset();
210 Koha::Objects->reset();
212 resets iteration so the next call to next() will start agein
213 with the first object in a set.
220 $self->_resultset()->reset();
225 =head3 Koha::Objects->as_list();
227 Koha::Objects->as_list();
229 Returns an arrayref of the objects in this set.
236 my @dbic_rows = $self->_resultset()->all();
238 my @objects = $self->_wrap(@dbic_rows);
240 return wantarray ? @objects : \@objects;
243 =head3 Koha::Objects->unblessed
245 Returns an unblessed representation of objects.
252 return [ map { $_->unblessed } $self->as_list ];
255 =head3 Koha::Objects->TO_JSON
257 Returns an unblessed representation of objects, suitable for JSON output.
264 return [ map { $_->TO_JSON } $self->as_list ];
267 =head3 Koha::Objects->_wrap
269 wraps the DBIC object in a corresponding Koha object
274 my ( $self, @dbic_rows ) = @_;
276 my @objects = map { $self->object_class->_new_from_dbic( $_ ) } @dbic_rows;
281 =head3 Koha::Objects->_resultset
283 Returns the internal resultset or creates it if undefined
291 $self->{_resultset} ||=
292 Koha::Database->new()->schema()->resultset( $self->_type() );
294 return $self->{_resultset};
297 return Koha::Database->new()->schema()->resultset( $self->_type() );
301 sub _get_objects_class {
305 if( $type->can('koha_objects_class') ) {
306 return $type->koha_objects_class;
308 $type =~ s|Schema::Result::||;
314 my @columns = Koha::Objects->columns
316 Return the table columns
322 return Koha::Database->new->schema->resultset( $class->_type )->result_source->columns;
327 The autoload method is used call DBIx::Class method on a resultset.
329 Important: If you plan to use one of the DBIx::Class methods you must provide
330 relevant tests in t/db_dependent/Koha/Objects.t
331 Currently count, pager, update and delete are covered.
336 my ( $self, @params ) = @_;
338 my @known_methods = qw( count pager update delete result_class single );
339 my $method = our $AUTOLOAD;
342 carp "The method $method is not covered by tests" and return unless grep {/^$method$/} @known_methods;
343 my $r = eval { $self->_resultset->$method(@params) };
345 carp "No method $method found for " . ref($self) . " " . $@;
353 The _type method must be set for all child classes.
354 The value returned by it should be the DBIC resultset name.
355 For example, for holds, _type should return 'Reserve'.
363 This method must be set for all child classes.
364 The value returned by it should be the name of the Koha
365 object class that is returned by this class.
366 For example, for holds, object_class should return 'Koha::Hold'.
376 Kyle M Hall <kyle@bywatersolutions.com>