3 # Copyright ByWater Solutions 2014
4 # Copyright 2016 Koha Development Team
6 # This file is part of Koha.
8 # Koha is free software; you can redistribute it and/or modify it
9 # under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3 of the License, or
11 # (at your option) any later version.
13 # Koha is distributed in the hope that it will be useful, but
14 # WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
25 use Scalar
::Util
qw( blessed looks_like_number );
29 use Koha
::Exceptions
::Object
;
34 Koha::Object - Koha Object base class
39 my $object = Koha::Object->new({ property1 => $property1, property2 => $property2, etc... } );
43 This class must always be subclassed.
51 =head3 Koha::Object->new();
53 my $object = Koha::Object->new();
54 my $object = Koha::Object->new($attributes);
56 Note that this cannot be used to retrieve record from the DB.
61 my ( $class, $attributes ) = @_;
65 my $schema = Koha
::Database
->new->schema;
67 # Remove the arguments which exist, are not defined but NOT NULL to use the default value
68 my $columns_info = $schema->resultset( $class->_type )->result_source->columns_info;
69 for my $column_name ( keys %$attributes ) {
70 my $c_info = $columns_info->{$column_name};
71 next if $c_info->{is_nullable
};
72 next if not exists $attributes->{$column_name} or defined $attributes->{$column_name};
73 delete $attributes->{$column_name};
77 $schema->resultset( $class->_type() )->new($attributes);
80 croak
("No _type found! Koha::Object must be subclassed!")
81 unless $class->_type();
83 bless( $self, $class );
87 =head3 Koha::Object->_new_from_dbic();
89 my $object = Koha::Object->_new_from_dbic($dbic_row);
94 my ( $class, $dbic_row ) = @_;
98 $self->{_result
} = $dbic_row;
100 croak
("No _type found! Koha::Object must be subclassed!")
101 unless $class->_type();
103 croak
( "DBIC result _type " . ref( $self->{_result
} ) . " isn't of the _type " . $class->_type() )
104 unless ref( $self->{_result
} ) eq "Koha::Schema::Result::" . $class->_type();
106 bless( $self, $class );
110 =head3 $object->store();
112 Saves the object in storage.
113 If the object is new, it will be created.
114 If the object previously existed, it will be updated.
117 $self if the store was a success
118 undef if the store failed
125 my $columns_info = $self->_result->result_source->columns_info;
127 # Handle not null and default values for integers and dates
128 foreach my $col ( keys %{$columns_info} ) {
130 if ( _numeric_column_type
( $columns_info->{$col}->{data_type
} ) ) {
131 # Has been passed but not a number, usually an empty string
132 my $value = $self->_result()->get_column($col);
133 if ( defined $value and not looks_like_number
( $value ) ) {
134 if ( $columns_info->{$col}->{is_nullable
} ) {
135 # If nullable, default to null
136 $self->_result()->set_column($col => undef);
138 # If cannot be null, get the default value
139 # What if cannot be null and does not have a default value? Possible?
140 $self->_result()->set_column($col => $columns_info->{$col}->{default_value
});
144 elsif ( _date_or_datetime_column_type
( $columns_info->{$col}->{data_type
} ) ) {
145 # Set to null if an empty string (or == 0 but should not happen)
146 my $value = $self->_result()->get_column($col);
147 if ( defined $value and not $value ) {
148 if ( $columns_info->{$col}->{is_nullable
} ) {
149 $self->_result()->set_column($col => undef);
151 $self->_result()->set_column($col => $columns_info->{$col}->{default_value
});
154 elsif ( not defined $self->$col
155 && $columns_info->{$col}->{datetime_undef_if_invalid
} )
158 $self->_result()->set_column($col => $columns_info->{$col}->{default_value
});
164 return $self->_result()->update_or_insert() ?
$self : undef;
167 # Catch problems and raise relevant exceptions
168 if (ref($_) eq 'DBIx::Class::Exception') {
170 if ( $_->{msg
} =~ /Cannot add or update a child row: a foreign key constraint fails/ ) {
172 # FIXME: MySQL error, if we support more DB engines we should implement this for each
173 if ( $_->{msg
} =~ /FOREIGN KEY \(`(?<column>.*?)`\)/ ) {
174 Koha
::Exceptions
::Object
::FKConstraint
->throw(
175 error
=> 'Broken FK constraint',
176 broken_fk
=> $+{column
}
180 elsif( $_->{msg
} =~ /Duplicate entry '(.*?)' for key '(?<key>.*?)'/ ) {
181 Koha
::Exceptions
::Object
::DuplicateID
->throw(
182 error
=> 'Duplicate ID',
183 duplicate_id
=> $+{key
}
186 elsif( $_->{msg
} =~ /Incorrect (?<type>\w+) value: '(?<value>.*)' for column \W?(?<property>\S+)/ ) { # The optional \W in the regex might be a quote or backtick
188 my $value = $+{value
};
189 my $property = $+{property
};
190 $property =~ s/['`]//g;
191 Koha
::Exceptions
::Object
::BadValue
->throw(
194 property
=> $property =~ /(\w+\.\w+)$/ ?
$1 : $property, # results in table.column without quotes or backtics
198 # Catch-all for foreign key breakages. It will help find other use cases
203 =head3 $object->update();
205 A shortcut for set + store in one call.
210 my ($self, $values) = @_;
211 Koha
::Exceptions
::Object
::NotInStorage
->throw unless $self->in_storage;
212 $self->set($values)->store();
215 =head3 $object->delete();
217 Removes the object from storage.
220 1 if the deletion was a success
221 0 if the deletion failed
222 -1 if the object was never in storage
229 my $deleted = $self->_result()->delete;
230 if ( ref $deleted ) {
231 my $object_class = Koha
::Object
::_get_object_class
( $self->_result->result_class );
232 $deleted = $object_class->_new_from_dbic($deleted);
237 =head3 $object->set( $properties_hashref )
241 property1 => $property1,
242 property2 => $property2,
243 property3 => $propery3,
247 Enables multiple properties to be set at once
250 1 if all properties were set.
251 0 if one or more properties do not exist.
252 undef if all properties exist but a different error
253 prevents one or more properties from being set.
255 If one or more of the properties do not exist,
256 no properties will be set.
261 my ( $self, $properties ) = @_;
263 my @columns = @
{$self->_columns()};
265 foreach my $p ( keys %$properties ) {
266 unless ( grep { $_ eq $p } @columns ) {
267 Koha
::Exceptions
::Object
::PropertyNotFound
->throw( "No property $p for " . ref($self) );
271 return $self->_result()->set_columns($properties) ?
$self : undef;
274 =head3 $object->set_or_blank( $properties_hashref )
276 $object->set_or_blank(
278 property1 => $property1,
279 property2 => $property2,
280 property3 => $propery3,
284 If not listed in $properties_hashref, the property will be set to the default
285 value defined at DB level, or nulled.
291 my ( $self, $properties ) = @_;
293 my $columns_info = $self->_result->result_source->columns_info;
295 foreach my $col ( keys %{$columns_info} ) {
297 next if exists $properties->{$col};
299 if ( $columns_info->{$col}->{is_nullable
} ) {
300 $properties->{$col} = undef;
302 $properties->{$col} = $columns_info->{$col}->{default_value
};
306 return $self->set($properties);
309 =head3 $object->unblessed();
311 Returns an unblessed representation of object.
318 return { $self->_result->get_columns };
321 =head3 $object->get_from_storage;
325 sub get_from_storage
{
326 my ( $self, $attrs ) = @_;
327 my $stored_object = $self->_result->get_from_storage($attrs);
328 return unless $stored_object;
329 my $object_class = Koha
::Object
::_get_object_class
( $self->_result->result_class );
330 return $object_class->_new_from_dbic($stored_object);
333 =head3 $object->TO_JSON
335 Returns an unblessed representation of the object, suitable for JSON output.
343 my $unblessed = $self->unblessed;
344 my $columns_info = Koha
::Database
->new->schema->resultset( $self->_type )
345 ->result_source->{_columns
};
347 foreach my $col ( keys %{$columns_info} ) {
349 if ( $columns_info->{$col}->{is_boolean
} )
350 { # Handle booleans gracefully
352 = ( $unblessed->{$col} )
356 elsif ( _numeric_column_type
( $columns_info->{$col}->{data_type
} )
357 and looks_like_number
( $unblessed->{$col} )
360 # TODO: Remove once the solution for
361 # https://rt.cpan.org/Ticket/Display.html?id=119904
362 # is ported to whatever distro we support by that time
363 $unblessed->{$col} += 0;
365 elsif ( _datetime_column_type
( $columns_info->{$col}->{data_type
} ) ) {
367 return unless $unblessed->{$col};
368 $unblessed->{$col} = output_pref
({
369 dateformat
=> 'rfc3339',
370 dt
=> dt_from_string
($unblessed->{$col}, 'sql'),
378 sub _date_or_datetime_column_type
{
379 my ($column_type) = @_;
387 return ( grep { $column_type eq $_ } @dt_types) ?
1 : 0;
389 sub _datetime_column_type
{
390 my ($column_type) = @_;
397 return ( grep { $column_type eq $_ } @dt_types) ?
1 : 0;
400 sub _numeric_column_type
{
401 # TODO: Remove once the solution for
402 # https://rt.cpan.org/Ticket/Display.html?id=119904
403 # is ported to whatever distro we support by that time
404 my ($column_type) = @_;
406 my @numeric_types = (
418 return ( grep { $column_type eq $_ } @numeric_types) ?
1 : 0;
421 =head3 prefetch_whitelist
423 my $whitelist = $object->prefetch_whitelist()
425 Returns a hash of prefetchable subs and the type they return.
429 sub prefetch_whitelist
{
433 my $relations = $self->_result->result_source->_relationships;
435 foreach my $key (keys %{$relations}) {
436 if($self->can($key)) {
437 my $result_class = $relations->{$key}->{class};
438 my $obj = $result_class->new;
440 $whitelist->{$key} = Koha
::Object
::_get_object_class
( $obj->result_class );
442 $whitelist->{$key} = undef;
452 my $object_for_api = $object->to_api(
473 Returns a representation of the object, suitable for API output.
478 my ( $self, $params ) = @_;
479 my $json_object = $self->TO_JSON;
481 my $to_api_mapping = $self->to_api_mapping;
483 # Rename attributes if there's a mapping
484 if ( $self->can('to_api_mapping') ) {
485 foreach my $column ( keys %{ $self->to_api_mapping } ) {
486 my $mapped_column = $self->to_api_mapping->{$column};
487 if ( exists $json_object->{$column}
488 && defined $mapped_column )
491 $json_object->{$mapped_column} = delete $json_object->{$column};
493 elsif ( exists $json_object->{$column}
494 && !defined $mapped_column )
497 delete $json_object->{$column};
502 my $embeds = $params->{embed
};
505 foreach my $embed ( keys %{$embeds} ) {
506 if ( $embed =~ m/^(?<relation>.*)_count$/
507 and $embeds->{$embed}->{is_count
} ) {
509 my $relation = $+{relation
};
510 $json_object->{$embed} = $self->$relation->count;
514 my $next = $embeds->{$curr}->{children
};
516 my $children = $self->$curr;
518 if ( defined $children and ref($children) eq 'ARRAY' ) {
520 $self->_handle_to_api_child(
521 { child
=> $_, next => $next, curr
=> $curr } )
523 $json_object->{$curr} = \
@list;
526 $json_object->{$curr} = $self->_handle_to_api_child(
527 { child
=> $children, next => $next, curr
=> $curr } );
538 =head3 to_api_mapping
540 my $mapping = $object->to_api_mapping;
542 Generic method that returns the attribute name mappings required to
543 render the object on the API.
545 Note: this only returns an empty I<hashref>. Each class should have its
546 own mapping returned.
554 =head3 from_api_mapping
556 my $mapping = $object->from_api_mapping;
558 Generic method that returns the attribute name mappings so the data that
559 comes from the API is correctly renamed to match what is required for the DB.
563 sub from_api_mapping
{
566 my $to_api_mapping = $self->to_api_mapping;
568 unless ( $self->{_from_api_mapping
} ) {
569 while (my ($key, $value) = each %{ $to_api_mapping } ) {
570 $self->{_from_api_mapping
}->{$value} = $key
575 return $self->{_from_api_mapping
};
580 my $object = Koha::Object->new_from_api;
581 my $object = Koha::Object->new_from_api( $attrs );
583 Creates a new object, mapping the API attribute names to the ones on the DB schema.
588 my ( $class, $params ) = @_;
590 my $self = $class->new;
591 return $self->set_from_api( $params );
596 my $object = Koha::Object->new(...);
597 $object->set_from_api( $attrs )
599 Sets the object's attributes mapping API attribute names to the ones on the DB schema.
604 my ( $self, $from_api_params ) = @_;
606 return $self->set( $self->attributes_from_api( $from_api_params ) );
609 =head3 attributes_from_api
611 my $attributes = attributes_from_api( $params );
613 Returns the passed params, converted from API naming into the model.
617 sub attributes_from_api
{
618 my ( $self, $from_api_params ) = @_;
620 my $from_api_mapping = $self->from_api_mapping;
623 my $columns_info = $self->_result->result_source->columns_info;
625 while (my ($key, $value) = each %{ $from_api_params } ) {
626 my $koha_field_name =
627 exists $from_api_mapping->{$key}
628 ?
$from_api_mapping->{$key}
631 if ( $columns_info->{$koha_field_name}->{is_boolean
} ) {
632 # TODO: Remove when D8 is formally deprecated
633 # Handle booleans gracefully
634 $value = ( $value ) ?
1 : 0;
636 elsif ( _date_or_datetime_column_type
( $columns_info->{$koha_field_name}->{data_type
} ) ) {
638 $value = dt_from_string
($value, 'rfc3339');
641 Koha
::Exceptions
::BadParameter
->throw( parameter
=> $key );
645 $params->{$koha_field_name} = $value;
651 =head3 $object->unblessed_all_relateds
653 my $everything_into_one_hashref = $object->unblessed_all_relateds
655 The unblessed method only retrieves column' values for the column of the object.
656 In a *few* cases we want to retrieve the information of all the prefetched data.
660 sub unblessed_all_relateds
{
664 my $related_resultsets = $self->_result->{related_resultsets
} || {};
665 my $rs = $self->_result;
666 while ( $related_resultsets and %$related_resultsets ) {
667 my @relations = keys %{ $related_resultsets };
669 my $relation = $relations[0];
670 $rs = $rs->related_resultset($relation)->get_cache;
671 $rs = $rs->[0]; # Does it makes sense to have several values here?
672 my $object_class = Koha
::Object
::_get_object_class
( $rs->result_class );
673 my $koha_object = $object_class->_new_from_dbic( $rs );
674 $related_resultsets = $rs->{related_resultsets
};
675 %data = ( %data, %{ $koha_object->unblessed } );
678 %data = ( %data, %{ $self->unblessed } );
682 =head3 $object->_result();
684 Returns the internal DBIC Row object
691 # If we don't have a dbic row at this point, we need to create an empty one
693 Koha
::Database
->new()->schema()->resultset( $self->_type() )->new({});
695 return $self->{_result
};
698 =head3 $object->_columns();
700 Returns an arrayref of the table columns
707 # If we don't have a dbic row at this point, we need to create an empty one
708 $self->{_columns
} ||= [ $self->_result()->result_source()->columns() ];
710 return $self->{_columns
};
713 sub _get_object_class
{
717 if( $type->can('koha_object_class') ) {
718 return $type->koha_object_class;
720 $type =~ s
|Schema
::Result
::||;
726 The autoload method is used only to get and set values for an objects properties.
733 my $method = our $AUTOLOAD;
736 my @columns = @
{$self->_columns()};
737 # Using direct setter/getter like $item->barcode() or $item->barcode($barcode);
738 if ( grep { $_ eq $method } @columns ) {
740 $self->_result()->set_column( $method, @_ );
743 my $value = $self->_result()->get_column( $method );
748 my @known_methods = qw( is_changed id in_storage get_column discard_changes make_column_dirty );
750 Koha
::Exceptions
::Object
::MethodNotCoveredByTests
->throw(
751 error
=> sprintf("The method %s->%s is not covered by tests!", ref($self), $method),
753 ) unless grep { $_ eq $method } @known_methods;
756 my $r = eval { $self->_result->$method(@_) };
758 Koha
::Exceptions
::Object
->throw( ref($self) . "::$method generated this error: " . $@
);
765 This method must be defined in the child class. The value is the name of the DBIC resultset.
766 For example, for borrowers, the _type method will return "Borrower".
772 =head3 _handle_to_api_child
776 sub _handle_to_api_child
{
777 my ($self, $args ) = @_;
779 my $child = $args->{child
};
780 my $next = $args->{next};
781 my $curr = $args->{curr
};
785 if ( defined $child ) {
787 Koha
::Exceptions
::Exception
->throw( "Asked to embed $curr but its return value doesn't implement to_api" )
788 if defined $next and blessed
$child and !$child->can('to_api');
790 if ( blessed
$child ) {
791 $res = $child->to_api({ embed
=> $next });
805 Kyle M Hall <kyle@bywatersolutions.com>
807 Jonathan Druart <jonathan.druart@bugs.koha-community.org>