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.
29 Koha::Object - Koha Object base class
34 my $object = Koha::Object->new({ property1 => $property1, property2 => $property2, etc... } );
38 This class must always be subclassed.
46 =head3 Koha::Object->new();
48 my $object = Koha::Object->new();
49 my $object = Koha::Object->new($attributes);
51 Note that this cannot be used to retrieve record from the DB.
56 my ( $class, $attributes ) = @_;
61 Koha
::Database
->new()->schema()->resultset( $class->_type() )
65 croak
("No _type found! Koha::Object must be subclassed!")
66 unless $class->_type();
68 bless( $self, $class );
72 =head3 Koha::Object->_new_from_dbic();
74 my $object = Koha::Object->_new_from_dbic($dbic_row);
79 my ( $class, $dbic_row ) = @_;
83 $self->{_result
} = $dbic_row;
85 croak
("No _type found! Koha::Object must be subclassed!")
86 unless $class->_type();
88 croak
( "DBIC result _type " . ref( $self->{_result
} ) . " isn't of the _type " . $class->_type() )
89 unless ref( $self->{_result
} ) eq "Koha::Schema::Result::" . $class->_type();
91 bless( $self, $class );
95 =head3 $object->store();
97 Saves the object in storage.
98 If the object is new, it will be created.
99 If the object previously existed, it will be updated.
102 $self if the store was a success
103 undef if the store failed
110 return $self->_result()->update_or_insert() ?
$self : undef;
113 =head3 $object->delete();
115 Removes the object from storage.
118 1 if the deletion was a success
119 0 if the deletion failed
120 -1 if the object was never in storage
127 # Deleting something not in storage thows an exception
128 return -1 unless $self->_result()->in_storage();
130 # Return a boolean for succcess
131 return $self->_result()->delete() ?
1 : 0;
134 =head3 $object->set( $properties_hashref )
138 property1 => $property1,
139 property2 => $property2,
140 property3 => $propery3,
144 Enables multiple properties to be set at once
147 1 if all properties were set.
148 0 if one or more properties do not exist.
149 undef if all properties exist but a different error
150 prevents one or more properties from being set.
152 If one or more of the properties do not exist,
153 no properties will be set.
158 my ( $self, $properties ) = @_;
160 my @columns = @
{$self->_columns()};
162 foreach my $p ( keys %$properties ) {
163 unless ( grep {/^$p$/} @columns ) {
164 carp
("No property $p!");
169 return $self->_result()->set_columns($properties) ?
$self : undef;
172 =head3 $object->unblessed();
174 Returns an unblessed representation of object.
181 return { $self->_result->get_columns };
184 =head3 $object->_result();
186 Returns the internal DBIC Row object
193 # If we don't have a dbic row at this point, we need to create an empty one
195 Koha
::Database
->new()->schema()->resultset( $self->_type() )->new({});
197 return $self->{_result
};
200 =head3 $object->_columns();
202 Returns an arrayref of the table columns
209 # If we don't have a dbic row at this point, we need to create an empty one
210 $self->{_columns
} ||= [ $self->_result()->result_source()->columns() ];
212 return $self->{_columns
};
218 The autoload method is used only to get and set values for an objects properties.
225 my $method = our $AUTOLOAD;
228 my @columns = @
{$self->_columns()};
229 # Using direct setter/getter like $item->barcode() or $item->barcode($barcode);
230 if ( grep {/^$method$/} @columns ) {
232 $self->_result()->set_column( $method, @_ );
235 my $value = $self->_result()->get_column( $method );
240 my @known_methods = qw( is_changed id in_storage get_column );
242 carp
"The method $method is not covered by tests or does not exist!" and return unless grep {/^$method$/} @known_methods;
244 my $r = eval { $self->_result->$method(@_) };
246 carp
"No method $method found for " . ref($self) . " " . $@
;
254 This method must be defined in the child class. The value is the name of the DBIC resultset.
255 For example, for borrowers, the _type method will return "Borrower".
265 Kyle M Hall <kyle@bywatersolutions.com>
267 Jonathan Druart <jonathan.druart@bugs.koha-community.org>