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 under the
9 # terms of the GNU General Public License as published by the Free Software
10 # Foundation; either version 3 of the License, or (at your option) any later
13 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
14 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
15 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License along
18 # with Koha; if not, write to the Free Software Foundation, Inc.,
19 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 use Scalar
::Util
qw( 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 if ( defined $self->$col and not looks_like_number
( $self->$col ) ) {
133 if ( $columns_info->{$col}->{is_nullable
} ) {
134 # If nullable, default to null
137 # If cannot be null, get the default value
138 # What if cannot be null and does not have a default value? Possible?
139 $self->$col($columns_info->{$col}->{default_value
});
143 elsif ( _date_or_datetime_column_type
( $columns_info->{$col}->{data_type
} ) ) {
144 # Set to null if an empty string (or == 0 but should not happen)
145 if ( defined $self->$col and not $self->$col ) {
146 if ( $columns_info->{$col}->{is_nullable
} ) {
149 $self->$col($columns_info->{$col}->{default_value
});
156 return $self->_result()->update_or_insert() ?
$self : undef;
159 # Catch problems and raise relevant exceptions
160 if (ref($_) eq 'DBIx::Class::Exception') {
161 if ( $_->{msg
} =~ /Cannot add or update a child row: a foreign key constraint fails/ ) {
163 # FIXME: MySQL error, if we support more DB engines we should implement this for each
164 if ( $_->{msg
} =~ /FOREIGN KEY \(`(?<column>.*?)`\)/ ) {
165 Koha
::Exceptions
::Object
::FKConstraint
->throw(
166 error
=> 'Broken FK constraint',
167 broken_fk
=> $+{column
}
171 elsif( $_->{msg
} =~ /Duplicate entry '(.*?)' for key '(?<key>.*?)'/ ) {
172 Koha
::Exceptions
::Object
::DuplicateID
->throw(
173 error
=> 'Duplicate ID',
174 duplicate_id
=> $+{key
}
177 elsif( $_->{msg
} =~ /Incorrect (?<type>\w+) value: '(?<value>.*)' for column \W?(?<property>\S+)/ ) { # The optional \W in the regex might be a quote or backtick
179 my $value = $+{value
};
180 my $property = $+{property
};
181 $property =~ s/['`]//g;
182 Koha
::Exceptions
::Object
::BadValue
->throw(
185 property
=> $property =~ /(\w+\.\w+)$/ ?
$1 : $property, # results in table.column without quotes or backtics
189 # Catch-all for foreign key breakages. It will help find other use cases
194 =head3 $object->update();
196 A shortcut for set + store in one call.
201 my ($self, $values) = @_;
202 return $self->set($values)->store();
205 =head3 $object->delete();
207 Removes the object from storage.
210 1 if the deletion was a success
211 0 if the deletion failed
212 -1 if the object was never in storage
219 return $self->_result()->delete;
222 =head3 $object->set( $properties_hashref )
226 property1 => $property1,
227 property2 => $property2,
228 property3 => $propery3,
232 Enables multiple properties to be set at once
235 1 if all properties were set.
236 0 if one or more properties do not exist.
237 undef if all properties exist but a different error
238 prevents one or more properties from being set.
240 If one or more of the properties do not exist,
241 no properties will be set.
246 my ( $self, $properties ) = @_;
248 my @columns = @
{$self->_columns()};
250 foreach my $p ( keys %$properties ) {
251 unless ( grep {/^$p$/} @columns ) {
252 Koha
::Exceptions
::Object
::PropertyNotFound
->throw( "No property $p for " . ref($self) );
256 return $self->_result()->set_columns($properties) ?
$self : undef;
259 =head3 $object->unblessed();
261 Returns an unblessed representation of object.
268 return { $self->_result->get_columns };
271 =head3 $object->get_from_storage;
275 sub get_from_storage
{
276 my ( $self, $attrs ) = @_;
277 my $stored_object = $self->_result->get_from_storage($attrs);
278 my $object_class = Koha
::Object
::_get_object_class
( $self->_result->result_class );
279 return $object_class->_new_from_dbic($stored_object);
282 =head3 $object->TO_JSON
284 Returns an unblessed representation of the object, suitable for JSON output.
292 my $unblessed = $self->unblessed;
293 my $columns_info = Koha
::Database
->new->schema->resultset( $self->_type )
294 ->result_source->{_columns
};
296 foreach my $col ( keys %{$columns_info} ) {
298 if ( $columns_info->{$col}->{is_boolean
} )
299 { # Handle booleans gracefully
301 = ( $unblessed->{$col} )
305 elsif ( _numeric_column_type
( $columns_info->{$col}->{data_type
} )
306 and looks_like_number
( $unblessed->{$col} )
309 # TODO: Remove once the solution for
310 # https://rt.cpan.org/Ticket/Display.html?id=119904
311 # is ported to whatever distro we support by that time
312 $unblessed->{$col} += 0;
314 elsif ( _datetime_column_type
( $columns_info->{$col}->{data_type
} ) ) {
316 return unless $unblessed->{$col};
317 $unblessed->{$col} = output_pref
({
318 dateformat
=> 'rfc3339',
319 dt
=> dt_from_string
($unblessed->{$col}, 'sql'),
327 sub _date_or_datetime_column_type
{
328 my ($column_type) = @_;
336 return ( grep { $column_type eq $_ } @dt_types) ?
1 : 0;
338 sub _datetime_column_type
{
339 my ($column_type) = @_;
346 return ( grep { $column_type eq $_ } @dt_types) ?
1 : 0;
349 sub _numeric_column_type
{
350 # TODO: Remove once the solution for
351 # https://rt.cpan.org/Ticket/Display.html?id=119904
352 # is ported to whatever distro we support by that time
353 my ($column_type) = @_;
355 my @numeric_types = (
367 return ( grep { $column_type eq $_ } @numeric_types) ?
1 : 0;
372 my $object_for_api = $object->to_api;
374 Returns a representation of the object, suitable for API output.
380 my $json_object = $self->TO_JSON;
382 # Rename attributes if there's a mapping
383 if ( $self->can('to_api_mapping') ) {
384 foreach my $column ( keys %{$self->to_api_mapping} ) {
385 my $mapped_column = $self->to_api_mapping->{$column};
386 if ( exists $json_object->{$column}
387 && defined $mapped_column )
390 $json_object->{$mapped_column} = delete $json_object->{$column};
392 elsif ( exists $json_object->{$column}
393 && !defined $mapped_column )
396 delete $json_object->{$column};
404 =head3 $object->unblessed_all_relateds
406 my $everything_into_one_hashref = $object->unblessed_all_relateds
408 The unblessed method only retrieves column' values for the column of the object.
409 In a *few* cases we want to retrieve the information of all the prefetched data.
413 sub unblessed_all_relateds
{
417 my $related_resultsets = $self->_result->{related_resultsets
} || {};
418 my $rs = $self->_result;
419 while ( $related_resultsets and %$related_resultsets ) {
420 my @relations = keys %{ $related_resultsets };
422 my $relation = $relations[0];
423 $rs = $rs->related_resultset($relation)->get_cache;
424 $rs = $rs->[0]; # Does it makes sense to have several values here?
425 my $object_class = Koha
::Object
::_get_object_class
( $rs->result_class );
426 my $koha_object = $object_class->_new_from_dbic( $rs );
427 $related_resultsets = $rs->{related_resultsets
};
428 %data = ( %data, %{ $koha_object->unblessed } );
431 %data = ( %data, %{ $self->unblessed } );
435 =head3 $object->_result();
437 Returns the internal DBIC Row object
444 # If we don't have a dbic row at this point, we need to create an empty one
446 Koha
::Database
->new()->schema()->resultset( $self->_type() )->new({});
448 return $self->{_result
};
451 =head3 $object->_columns();
453 Returns an arrayref of the table columns
460 # If we don't have a dbic row at this point, we need to create an empty one
461 $self->{_columns
} ||= [ $self->_result()->result_source()->columns() ];
463 return $self->{_columns
};
466 sub _get_object_class
{
470 if( $type->can('koha_object_class') ) {
471 return $type->koha_object_class;
473 $type =~ s
|Schema
::Result
::||;
479 The autoload method is used only to get and set values for an objects properties.
486 my $method = our $AUTOLOAD;
489 my @columns = @
{$self->_columns()};
490 # Using direct setter/getter like $item->barcode() or $item->barcode($barcode);
491 if ( grep {/^$method$/} @columns ) {
493 $self->_result()->set_column( $method, @_ );
496 my $value = $self->_result()->get_column( $method );
501 my @known_methods = qw( is_changed id in_storage get_column discard_changes make_column_dirty );
503 Koha
::Exceptions
::Object
::MethodNotCoveredByTests
->throw(
504 error
=> sprintf("The method %s->%s is not covered by tests!", ref($self), $method),
506 ) unless grep { /^$method$/ } @known_methods;
509 my $r = eval { $self->_result->$method(@_) };
511 Koha
::Exceptions
::Object
->throw( ref($self) . "::$method generated this error: " . $@
);
518 This method must be defined in the child class. The value is the name of the DBIC resultset.
519 For example, for borrowers, the _type method will return "Borrower".
529 Kyle M Hall <kyle@bywatersolutions.com>
531 Jonathan Druart <jonathan.druart@bugs.koha-community.org>