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]);
128 my $objects = Koha::Objects->search([$params, $attributes]);
129 while (my $object = $objects->next) {
133 This B<instantiates> the I<Koha::Objects> class, and generates a resultset
134 based on the query I<$params> and I<$attributes> that are passed (like in DBIC).
136 In B<list context> it returns an array of I<Koha::Object> objects.
137 In B<scalar context> it returns an iterator.
142 my ( $self, $params, $attributes ) = @_;
145 my @dbic_rows = $self->_resultset()->search($params, $attributes);
147 return $self->_wrap(@dbic_rows);
151 my $class = ref($self) ? ref($self) : $self;
152 my $rs = $self->_resultset()->search($params, $attributes);
154 return $class->_new_from_dbic($rs);
158 =head3 search_related
160 my @objects = Koha::Objects->search_related( $rel_name, $cond?, \%attrs? );
161 my $objects = Koha::Objects->search_related( $rel_name, $cond?, \%attrs? );
163 Searches the specified relationship, optionally specifying a condition and attributes for matching records.
168 my ( $self, $rel_name, @params ) = @_;
170 return if !$rel_name;
172 my @dbic_rows = $self->_resultset()->search_related($rel_name, @params);
173 return if !@dbic_rows;
174 my $object_class = _get_objects_class( $dbic_rows[0]->result_class );
176 eval "require $object_class";
177 return _wrap( $object_class, @dbic_rows );
180 my $rs = $self->_resultset()->search_related($rel_name, @params);
182 my $object_class = _get_objects_class( $rs->result_class );
184 eval "require $object_class";
185 return _new_from_dbic( $object_class, $rs );
196 if ( Class::Inspector->function_exists( $self->object_class, 'delete' ) ) {
198 $self->_resultset->result_source->schema->txn_do( sub {
199 $self->reset; # If we iterated already over the set
200 while ( my $o = $self->next ) {
205 return $objects_deleted;
208 return $self->_resultset->delete;
213 my $objects = Koha::Objects->new; # or Koha::Objects->search
214 $objects->update( $fields, [ { no_triggers => 0/1 } ] );
216 This method overloads the DBIC inherited one so if code-level triggers exist
217 (through the use of an overloaded I<update> or I<store> method in the Koha::Object
218 based class) those are called in a loop on the resultset.
220 If B<no_triggers> is passed and I<true>, then the DBIC update method is called
221 directly. This feature is important for performance, in cases where no code-level
222 triggers should be triggered. The developer will explicitly ask for this and QA should
223 catch wrong uses as well.
228 my ($self, $fields, $options) = @_;
230 Koha::Exceptions::Object::NotInstantiated->throw(
235 my $no_triggers = $options->{no_triggers};
239 && ( Class::Inspector->function_exists( $self->object_class, 'update' )
240 or Class::Inspector->function_exists( $self->object_class, 'store' ) )
244 $self->_resultset->result_source->schema->txn_do( sub {
245 while ( my $o = $self->next ) {
250 return $objects_updated;
253 return $self->_resultset->update($fields);
256 =head3 filter_by_last_update
258 my $filtered_objects = $objects->filter_by_last_update
266 sub filter_by_last_update {
267 my ( $self, $params ) = @_;
268 my $timestamp_column_name = $params->{timestamp_column_name} || 'timestamp';
270 Koha::Exceptions::MissingParameter->throw(
271 "Missing mandatory parameter: days or from or to")
272 unless exists $params->{days}
273 or exists $params->{from}
274 or exists $params->{to};
276 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
277 if ( exists $params->{days} ) {
278 $conditions->{'<'} = $dtf->format_date( dt_from_string->subtract( days => $params->{days} ) );
280 if ( exists $params->{from} ) {
281 my $from = ref($params->{from}) ? $params->{from} : dt_from_string($params->{from});
282 $conditions->{'>='} = $dtf->format_date( $from );
284 if ( exists $params->{to} ) {
285 my $to = ref($params->{to}) ? $params->{to} : dt_from_string($params->{to});
286 $conditions->{'<='} = $dtf->format_date( $to );
289 return $self->_resultset->search(
291 $timestamp_column_name => $conditions
298 my $object = Koha::Objects->search({}, { rows => 1 })->single
300 Returns one and only one object that is part of this set.
301 Returns undef if there are no objects found.
303 This is optimal as it will grab the first returned result without instantiating
307 http://search.cpan.org/dist/DBIx-Class/lib/DBIx/Class/Manual/Cookbook.pod#Retrieve_one_and_only_one_row_from_a_resultset
314 my $single = $self->_resultset()->single;
315 return unless $single;
317 return $self->object_class()->_new_from_dbic($single);
320 =head3 Koha::Objects->next();
322 my $object = Koha::Objects->next();
324 Returns the next object that is part of this set.
325 Returns undef if there are no more objects to return.
332 my $result = $self->_resultset()->next();
333 return unless $result;
335 my $object = $self->object_class()->_new_from_dbic( $result );
340 =head3 Koha::Objects->last;
342 my $object = Koha::Objects->last;
344 Returns the last object that is part of this set.
345 Returns undef if there are no object to return.
352 my $count = $self->_resultset->count;
353 return unless $count;
355 my ( $result ) = $self->_resultset->slice($count - 1, $count - 1);
357 my $object = $self->object_class()->_new_from_dbic( $result );
364 my $empty_rs = Koha::Objects->new->empty;
366 Sets the resultset empty. This is handy for consistency on method returns
367 (e.g. if we know in advance we won't have results but want to keep returning
375 Koha::Exceptions::Object::NotInstantiated->throw(
380 $self = $self->search(\'0 = 1');
381 $self->_resultset()->set_cache([]);
386 =head3 Koha::Objects->reset();
388 Koha::Objects->reset();
390 resets iteration so the next call to next() will start agein
391 with the first object in a set.
398 $self->_resultset()->reset();
403 =head3 Koha::Objects->as_list();
405 Koha::Objects->as_list();
407 Returns an arrayref of the objects in this set.
414 my @dbic_rows = $self->_resultset()->all();
416 my @objects = $self->_wrap(@dbic_rows);
418 return wantarray ? @objects : \@objects;
421 =head3 Koha::Objects->unblessed
423 Returns an unblessed representation of objects.
430 return [ map { $_->unblessed } $self->as_list ];
433 =head3 Koha::Objects->get_column
435 Return all the values of this set for a given column
440 my ($self, $column_name) = @_;
441 return $self->_resultset->get_column( $column_name )->all;
444 =head3 Koha::Objects->TO_JSON
446 Returns an unblessed representation of objects, suitable for JSON output.
453 return [ map { $_->TO_JSON } $self->as_list ];
456 =head3 Koha::Objects->to_api
458 Returns a representation of the objects, suitable for API output .
463 my ($self, $params) = @_;
465 return [ map { $_->to_api($params) } $self->as_list ];
468 =head3 attributes_from_api
470 my $attributes = $objects->attributes_from_api( $api_attributes );
472 Translates attributes from the API to DBIC
476 sub attributes_from_api {
477 my ( $self, $attributes ) = @_;
479 $self->{_singular_object} ||= $self->object_class->new();
480 return $self->{_singular_object}->attributes_from_api( $attributes );
483 =head3 from_api_mapping
485 my $mapped_attributes_hash = $objects->from_api_mapping;
487 Attributes map from the API to DBIC
491 sub from_api_mapping {
494 $self->{_singular_object} ||= $self->object_class->new();
495 return $self->{_singular_object}->from_api_mapping;
498 =head3 prefetch_whitelist
500 my $whitelist = $object->prefetch_whitelist()
502 Returns a hash of prefetchable subs and the type it returns
506 sub prefetch_whitelist {
509 $self->{_singular_object} ||= $self->object_class->new();
511 $self->{_singular_object}->prefetch_whitelist;
514 =head3 Koha::Objects->_wrap
516 wraps the DBIC object in a corresponding Koha object
521 my ( $self, @dbic_rows ) = @_;
523 my @objects = map { $self->object_class->_new_from_dbic( $_ ) } @dbic_rows;
528 =head3 Koha::Objects->_resultset
530 Returns the internal resultset or creates it if undefined
538 $self->{_resultset} ||=
539 Koha::Database->new()->schema()->resultset( $self->_type() );
541 return $self->{_resultset};
544 return Koha::Database->new()->schema()->resultset( $self->_type() );
548 sub _get_objects_class {
552 if( $type->can('koha_objects_class') ) {
553 return $type->koha_objects_class;
555 $type =~ s|Schema::Result::||;
561 my @columns = Koha::Objects->columns
563 Return the table columns
569 return Koha::Database->new->schema->resultset( $class->_type )->result_source->columns;
574 The autoload method is used call DBIx::Class method on a resultset.
576 Important: If you plan to use one of the DBIx::Class methods you must provide
577 relevant tests in t/db_dependent/Koha/Objects.t
578 Currently count, is_paged, pager, result_class, single and slice are covered.
583 my ( $self, @params ) = @_;
585 my @known_methods = qw( count is_paged pager result_class single slice );
586 my $method = our $AUTOLOAD;
590 unless ( grep { $_ eq $method } @known_methods ) {
591 my $class = ref($self) ? ref($self) : $self;
592 Koha::Exceptions::Object::MethodNotCoveredByTests->throw(
593 error => sprintf("The method %s->%s is not covered by tests!", $class, $method),
598 my $r = eval { $self->_resultset->$method(@params) };
600 carp "No method $method found for " . ref($self) . " " . $@;
608 The _type method must be set for all child classes.
609 The value returned by it should be the DBIC resultset name.
610 For example, for holds, _type should return 'Reserve'.
618 This method must be set for all child classes.
619 The value returned by it should be the name of the Koha
620 object class that is returned by this class.
621 For example, for holds, object_class should return 'Koha::Hold'.
631 Kyle M Hall <kyle@bywatersolutions.com>