Bug 16082: Display a friendly "patron does not exist" message if that's the case...
[koha.git] / Koha / Object.pm
blob9d23fb421e6295ee86881b6eacb0425425caf057
1 package Koha::Object;
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
10 # version.
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.
20 use Modern::Perl;
22 use Carp;
24 use Koha::Database;
26 =head1 NAME
28 Koha::Object - Koha Object base class
30 =head1 SYNOPSIS
32 use Koha::Object;
33 my $object = Koha::Object->new({ property1 => $property1, property2 => $property2, etc... } );
35 =head1 DESCRIPTION
37 This class must always be subclassed.
39 =head1 API
41 =head2 Class Methods
43 =cut
45 =head3 Koha::Object->new();
47 my $object = Koha::Object->new();
48 my $object = Koha::Object->new($attributes);
50 Note that this cannot be used to retrieve record from the DB.
52 =cut
54 sub new {
55 my ( $class, $attributes ) = @_;
56 my $self = {};
58 if ($attributes) {
59 $self->{_result} =
60 Koha::Database->new()->schema()->resultset( $class->_type() )
61 ->new($attributes);
64 croak("No _type found! Koha::Object must be subclassed!")
65 unless $class->_type();
67 bless( $self, $class );
71 =head3 Koha::Object->_new_from_dbic();
73 my $object = Koha::Object->_new_from_dbic($dbic_row);
75 =cut
77 sub _new_from_dbic {
78 my ( $class, $dbic_row ) = @_;
79 my $self = {};
81 # DBIC result row
82 $self->{_result} = $dbic_row;
84 croak("No _type found! Koha::Object must be subclassed!")
85 unless $class->_type();
87 croak( "DBIC result _type " . ref( $self->{_result} ) . " isn't of the _type " . $class->_type() )
88 unless ref( $self->{_result} ) eq "Koha::Schema::Result::" . $class->_type();
90 bless( $self, $class );
94 =head3 $object->store();
96 Saves the object in storage.
97 If the object is new, it will be created.
98 If the object previously existed, it will be updated.
100 Returns:
101 $self if the store was a success
102 undef if the store failed
104 =cut
106 sub store {
107 my ($self) = @_;
109 return $self->_result()->update_or_insert() ? $self : undef;
112 =head3 $object->in_storage();
114 Returns true if the object has been previously stored.
116 =cut
118 sub in_storage {
119 my ($self) = @_;
121 return $self->_result()->in_storage();
124 =head3 $object->is_changed();
126 Returns true if the object has properties that are different from
127 the properties of the object in storage.
129 =cut
131 sub is_changed {
132 my ( $self, @columns ) = @_;
134 return $self->_result()->is_changed(@columns);
137 =head3 $object->delete();
139 Removes the object from storage.
141 Returns:
142 1 if the deletion was a success
143 0 if the deletion failed
144 -1 if the object was never in storage
146 =cut
148 sub delete {
149 my ($self) = @_;
151 # Deleting something not in storage thows an exception
152 return -1 unless $self->_result()->in_storage();
154 # Return a boolean for succcess
155 return $self->_result()->delete() ? 1 : 0;
158 =head3 $object->set( $properties_hashref )
160 $object->set(
162 property1 => $property1,
163 property2 => $property2,
164 property3 => $propery3,
168 Enables multiple properties to be set at once
170 Returns:
171 1 if all properties were set.
172 0 if one or more properties do not exist.
173 undef if all properties exist but a different error
174 prevents one or more properties from being set.
176 If one or more of the properties do not exist,
177 no properties will be set.
179 =cut
181 sub set {
182 my ( $self, $properties ) = @_;
184 my @columns = @{$self->_columns()};
186 foreach my $p ( keys %$properties ) {
187 unless ( grep {/^$p$/} @columns ) {
188 carp("No property $p!");
189 return 0;
193 return $self->_result()->set_columns($properties) ? $self : undef;
196 =head3 $object->id();
198 Returns the id of the object if it has one.
200 =cut
202 sub id {
203 my ($self) = @_;
205 my ( $id ) = $self->_result()->id();
207 return $id;
210 =head3 $object->unblessed();
212 Returns an unblessed representation of object.
214 =cut
216 sub unblessed {
217 my ($self) = @_;
219 return { $self->_result->get_columns };
222 =head3 $object->_result();
224 Returns the internal DBIC Row object
226 =cut
228 sub _result {
229 my ($self) = @_;
231 # If we don't have a dbic row at this point, we need to create an empty one
232 $self->{_result} ||=
233 Koha::Database->new()->schema()->resultset( $self->_type() )->new({});
235 return $self->{_result};
238 =head3 $object->_columns();
240 Returns an arrayref of the table columns
242 =cut
244 sub _columns {
245 my ($self) = @_;
247 # If we don't have a dbic row at this point, we need to create an empty one
248 $self->{_columns} ||= [ $self->_result()->result_source()->columns() ];
250 return $self->{_columns};
254 =head3 AUTOLOAD
256 The autoload method is used only to get and set values for an objects properties.
258 =cut
260 sub AUTOLOAD {
261 my $self = shift;
263 my $method = our $AUTOLOAD;
264 $method =~ s/.*://;
266 my @columns = @{$self->_columns()};
267 # Using direct setter/getter like $item->barcode() or $item->barcode($barcode);
268 if ( grep {/^$method$/} @columns ) {
269 if ( @_ ) {
270 $self->_result()->set_column( $method, @_ );
271 return $self;
272 } else {
273 my $value = $self->_result()->get_column( $method );
274 return $value;
278 carp "No method $method!";
279 return;
282 =head3 _type
284 This method must be defined in the child class. The value is the name of the DBIC resultset.
285 For example, for borrowers, the _type method will return "Borrower".
287 =cut
289 sub _type { }
291 sub DESTROY { }
293 =head1 AUTHOR
295 Kyle M Hall <kyle@bywatersolutions.com>
297 =cut