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
8 # under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
12 # Koha is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
23 use List::MoreUtils qw( none );
27 use Koha::Exceptions::Object;
28 use Koha::DateUtils qw( dt_from_string );
32 Koha::Objects - Koha Object set base class
37 my $objects = Koha::Objects->search({ borrowernumber => $borrowernumber});
41 This class must be subclassed.
49 =head3 Koha::Objects->new();
51 my $object = Koha::Objects->new();
59 bless( $self, $class );
62 =head3 Koha::Objects->_new_from_dbic();
64 my $object = Koha::Objects->_new_from_dbic( $resultset );
69 my ( $class, $resultset ) = @_;
70 my $self = { _resultset => $resultset };
72 bless( $self, $class );
75 =head3 Koha::Objects->find();
77 Similar to DBIx::Class::ResultSet->find this method accepts:
78 \%columns_values | @pk_values, { key => $unique_constraint, %attrs }?
79 Strictly speaking, columns_values should only refer to columns under an
82 It returns undef if no results were found
84 my $object = Koha::Objects->find( { col1 => $val1, col2 => $val2 } );
85 my $object = Koha::Objects->find( $id );
86 my $object = Koha::Objects->find( $idpart1, $idpart2, $attrs ); # composite PK
91 my ( $self, @pars ) = @_;
95 unless (!@pars || none { defined($_) } @pars) {
96 my $result = $self->_resultset()->find(@pars);
98 $object = $self->object_class()->_new_from_dbic($result);
105 =head3 Koha::Objects->find_or_create();
107 my $object = Koha::Objects->find_or_create( $attrs );
112 my ( $self, $params ) = @_;
114 my $result = $self->_resultset->find_or_create($params);
116 return unless $result;
118 my $object = $self->object_class->_new_from_dbic($result);
126 my $objects = Koha::Objects->search([$params, $attributes]);
127 while (my $object = $objects->next) {
131 This B<instantiates> the I<Koha::Objects> class, and generates a resultset
132 based on the query I<$params> and I<$attributes> that are passed (like in DBIC).
137 my ( $self, $params, $attributes ) = @_;
139 my $class = ref($self) ? ref($self) : $self;
140 my $rs = $self->_resultset()->search($params, $attributes);
142 return $class->_new_from_dbic($rs);
145 =head3 search_related
147 my $objects = Koha::Objects->search_related( $rel_name, $cond?, \%attrs? );
149 Searches the specified relationship, optionally specifying a condition and attributes for matching records.
154 my ( $self, $rel_name, @params ) = @_;
156 return if !$rel_name;
158 my $rs = $self->_resultset()->search_related($rel_name, @params);
160 my $object_class = _get_objects_class( $rs->result_class );
162 eval "require $object_class";
163 return _new_from_dbic( $object_class, $rs );
173 if ( Class::Inspector->function_exists( $self->object_class, 'delete' ) ) {
175 $self->_resultset->result_source->schema->txn_do( sub {
176 $self->reset; # If we iterated already over the set
177 while ( my $o = $self->next ) {
182 return $objects_deleted;
185 return $self->_resultset->delete;
190 my $objects = Koha::Objects->new; # or Koha::Objects->search
191 $objects->update( $fields, [ { no_triggers => 0/1 } ] );
193 This method overloads the DBIC inherited one so if code-level triggers exist
194 (through the use of an overloaded I<update> or I<store> method in the Koha::Object
195 based class) those are called in a loop on the resultset.
197 If B<no_triggers> is passed and I<true>, then the DBIC update method is called
198 directly. This feature is important for performance, in cases where no code-level
199 triggers should be triggered. The developer will explicitly ask for this and QA should
200 catch wrong uses as well.
205 my ($self, $fields, $options) = @_;
207 Koha::Exceptions::Object::NotInstantiated->throw(
212 my $no_triggers = $options->{no_triggers};
216 && ( Class::Inspector->function_exists( $self->object_class, 'update' )
217 or Class::Inspector->function_exists( $self->object_class, 'store' ) )
221 $self->_resultset->result_source->schema->txn_do( sub {
222 while ( my $o = $self->next ) {
227 return $objects_updated;
230 return $self->_resultset->update($fields);
233 =head3 filter_by_last_update
235 my $filtered_objects = $objects->filter_by_last_update
237 days exclusive by default (will be inclusive if days_inclusive is passed and set)
243 sub filter_by_last_update {
244 my ( $self, $params ) = @_;
245 my $timestamp_column_name = $params->{timestamp_column_name} || 'timestamp';
246 my $days_inclusive = $params->{days_inclusive} || 0;
248 Koha::Exceptions::MissingParameter->throw(
249 "Missing mandatory parameter: days or from or to")
250 unless exists $params->{days}
251 or exists $params->{from}
252 or exists $params->{to};
254 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
255 if ( exists $params->{days} ) {
256 my $dt = Koha::DateUtils::dt_from_string();
257 my $operator = $days_inclusive ? '<=' : '<';
258 $conditions->{$operator} = $dtf->format_date( $dt->subtract( days => $params->{days} ) );
260 if ( exists $params->{from} ) {
261 my $from = ref($params->{from}) ? $params->{from} : dt_from_string($params->{from});
262 $conditions->{'>='} = $dtf->format_date( $from );
264 if ( exists $params->{to} ) {
265 my $to = ref($params->{to}) ? $params->{to} : dt_from_string($params->{to});
266 $conditions->{'<='} = $dtf->format_date( $to );
269 return $self->search(
271 $timestamp_column_name => $conditions
278 my $object = Koha::Objects->search({}, { rows => 1 })->single
280 Returns one and only one object that is part of this set.
281 Returns undef if there are no objects found.
283 This is optimal as it will grab the first returned result without instantiating
287 http://search.cpan.org/dist/DBIx-Class/lib/DBIx/Class/Manual/Cookbook.pod#Retrieve_one_and_only_one_row_from_a_resultset
294 my $single = $self->_resultset()->single;
295 return unless $single;
297 return $self->object_class()->_new_from_dbic($single);
300 =head3 Koha::Objects->next();
302 my $object = Koha::Objects->next();
304 Returns the next object that is part of this set.
305 Returns undef if there are no more objects to return.
312 my $result = $self->_resultset()->next();
313 return unless $result;
315 my $object = $self->object_class()->_new_from_dbic( $result );
320 =head3 Koha::Objects->last;
322 my $object = Koha::Objects->last;
324 Returns the last object that is part of this set.
325 Returns undef if there are no object to return.
332 my $count = $self->_resultset->count;
333 return unless $count;
335 my ( $result ) = $self->_resultset->slice($count - 1, $count - 1);
337 my $object = $self->object_class()->_new_from_dbic( $result );
344 my $empty_rs = Koha::Objects->new->empty;
346 Sets the resultset empty. This is handy for consistency on method returns
347 (e.g. if we know in advance we won't have results but want to keep returning
355 Koha::Exceptions::Object::NotInstantiated->throw(
360 $self = $self->search(\'0 = 1');
361 $self->_resultset()->set_cache([]);
366 =head3 Koha::Objects->reset();
368 Koha::Objects->reset();
370 resets iteration so the next call to next() will start agein
371 with the first object in a set.
378 $self->_resultset()->reset();
383 =head3 Koha::Objects->as_list();
385 Koha::Objects->as_list();
387 Returns an arrayref of the objects in this set.
394 my @dbic_rows = $self->_resultset()->all();
396 my @objects = $self->_wrap(@dbic_rows);
398 return wantarray ? @objects : \@objects;
401 =head3 Koha::Objects->unblessed
403 Returns an unblessed representation of objects.
410 return [ map { $_->unblessed } $self->as_list ];
413 =head3 Koha::Objects->get_column
415 Return all the values of this set for a given column
420 my ($self, $column_name) = @_;
421 return $self->_resultset->get_column( $column_name )->all;
424 =head3 Koha::Objects->TO_JSON
426 Returns an unblessed representation of objects, suitable for JSON output.
433 return [ map { $_->TO_JSON } $self->as_list ];
436 =head3 Koha::Objects->to_api
438 Returns a representation of the objects, suitable for API output .
443 my ($self, $params) = @_;
445 return [ map { $_->to_api($params) } $self->as_list ];
448 =head3 attributes_from_api
450 my $attributes = $objects->attributes_from_api( $api_attributes );
452 Translates attributes from the API to DBIC
456 sub attributes_from_api {
457 my ( $self, $attributes ) = @_;
459 $self->{_singular_object} ||= $self->object_class->new();
460 return $self->{_singular_object}->attributes_from_api( $attributes );
463 =head3 from_api_mapping
465 my $mapped_attributes_hash = $objects->from_api_mapping;
467 Attributes map from the API to DBIC
471 sub from_api_mapping {
474 $self->{_singular_object} ||= $self->object_class->new();
475 return $self->{_singular_object}->from_api_mapping;
478 =head3 prefetch_whitelist
480 my $whitelist = $object->prefetch_whitelist()
482 Returns a hash of prefetchable subs and the type it returns
486 sub prefetch_whitelist {
489 $self->{_singular_object} ||= $self->object_class->new();
491 $self->{_singular_object}->prefetch_whitelist;
494 =head3 Koha::Objects->_wrap
496 wraps the DBIC object in a corresponding Koha object
501 my ( $self, @dbic_rows ) = @_;
503 my @objects = map { $self->object_class->_new_from_dbic( $_ ) } @dbic_rows;
508 =head3 Koha::Objects->_resultset
510 Returns the internal resultset or creates it if undefined
518 $self->{_resultset} ||=
519 Koha::Database->new()->schema()->resultset( $self->_type() );
521 return $self->{_resultset};
524 return Koha::Database->new()->schema()->resultset( $self->_type() );
528 sub _get_objects_class {
532 if( $type->can('koha_objects_class') ) {
533 return $type->koha_objects_class;
535 $type =~ s|Schema::Result::||;
541 my @columns = Koha::Objects->columns
543 Return the table columns
549 return Koha::Database->new->schema->resultset( $class->_type )->result_source->columns;
554 The autoload method is used call DBIx::Class method on a resultset.
556 Important: If you plan to use one of the DBIx::Class methods you must provide
557 relevant tests in t/db_dependent/Koha/Objects.t
558 Currently count, is_paged, pager, result_class, single and slice are covered.
563 my ( $self, @params ) = @_;
565 my @known_methods = qw( count is_paged pager result_class single slice );
566 my $method = our $AUTOLOAD;
570 unless ( grep { $_ eq $method } @known_methods ) {
571 my $class = ref($self) ? ref($self) : $self;
572 Koha::Exceptions::Object::MethodNotCoveredByTests->throw(
573 error => sprintf("The method %s->%s is not covered by tests!", $class, $method),
578 my $r = eval { $self->_resultset->$method(@params) };
580 carp "No method $method found for " . ref($self) . " " . $@;
588 The _type method must be set for all child classes.
589 The value returned by it should be the DBIC resultset name.
590 For example, for holds, _type should return 'Reserve'.
598 This method must be set for all child classes.
599 The value returned by it should be the name of the Koha
600 object class that is returned by this class.
601 For example, for holds, object_class should return 'Koha::Hold'.
611 Kyle M Hall <kyle@bywatersolutions.com>