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
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.
28 Koha::Objects - Koha Object set base class
33 my @objects = Koha::Objects->search({ borrowernumber => $borrowernumber});
37 This class must be subclassed.
45 =head3 Koha::Objects->new();
47 my $object = Koha::Objects->new();
55 bless( $self, $class );
58 =head3 Koha::Objects->_new_from_dbic();
60 my $object = Koha::Objects->_new_from_dbic( $resultset );
65 my ( $class, $resultset ) = @_;
66 my $self = { _resultset
=> $resultset };
68 bless( $self, $class );
71 =head3 Koha::Objects->find();
73 my $object = Koha::Objects->find($id);
74 my $object = Koha::Objects->find( { keypart1 => $keypart1, keypart2 => $keypart2 } );
79 my ( $self, $id ) = @_;
81 return unless defined($id);
83 my $result = $self->_resultset()->find($id);
85 return unless $result;
87 my $object = $self->object_class()->_new_from_dbic( $result );
92 =head3 Koha::Objects->find_or_create();
94 my $object = Koha::Objects->find_or_create( $attrs );
99 my ( $self, $params ) = @_;
101 my $result = $self->_resultset->find_or_create($params);
103 return unless $result;
105 my $object = $self->object_class->_new_from_dbic($result);
110 =head3 Koha::Objects->search();
112 my @objects = Koha::Objects->search($params);
117 my ( $self, $params, $attributes ) = @_;
120 my @dbic_rows = $self->_resultset()->search($params, $attributes);
122 return $self->_wrap(@dbic_rows);
126 my $class = ref($self) ?
ref($self) : $self;
127 my $rs = $self->_resultset()->search($params, $attributes);
129 return $class->_new_from_dbic($rs);
133 =head3 Koha::Objects->count();
135 my @objects = Koha::Objects->count($params);
140 my ( $self, $params ) = @_;
142 return $self->_resultset()->count($params);
145 =head3 Koha::Objects->pager();
147 my $pager = Koha::Objects->pager;
153 return $self->_resultset->pager;
156 =head3 Koha::Objects->next();
158 my $object = Koha::Objects->next();
160 Returns the next object that is part of this set.
161 Returns undef if there are no more objects to return.
168 my $result = $self->_resultset()->next();
169 return unless $result;
171 my $object = $self->object_class()->_new_from_dbic( $result );
176 =head3 Koha::Objects->reset();
178 Koha::Objects->reset();
180 resets iteration so the next call to next() will start agein
181 with the first object in a set.
188 $self->_resultset()->reset();
193 =head3 Koha::Objects->as_list();
195 Koha::Objects->as_list();
197 Returns an arrayref of the objects in this set.
204 my @dbic_rows = $self->_resultset()->all();
206 my @objects = $self->_wrap(@dbic_rows);
208 return wantarray ?
@objects : \
@objects;
211 =head3 Koha::Objects->unblessed
213 Returns an unblessed representation of objects.
220 return [ map { $_->unblessed } $self->as_list ];
223 =head3 Koha::Objects->_wrap
225 wraps the DBIC object in a corresponding Koha object
230 my ( $self, @dbic_rows ) = @_;
232 my @objects = map { $self->object_class()->_new_from_dbic( $_ ) } @dbic_rows;
239 Koha::Objects->search({ $key => $value})->update( \%values );
241 Sets the specified columns in the resultset to the supplied values in a single query.
246 my ( $self, $params ) = @_;
247 return $self->_resultset()->update($params);
250 =head3 Koha::Objects->_resultset
252 Returns the internal resultset or creates it if undefined
260 $self->{_resultset
} ||=
261 Koha
::Database
->new()->schema()->resultset( $self->_type() );
263 return $self->{_resultset
};
266 return Koha
::Database
->new()->schema()->resultset( $self->_type() );
272 my @columns = Koha::Objects->columns
274 Return the table columns
280 return Koha
::Database
->new->schema->resultset( $class->_type )->result_source->columns;
287 The _type method must be set for all child classes.
288 The value returned by it should be the DBIC resultset name.
289 For example, for holds, _type should return 'Reserve'.
297 This method must be set for all child classes.
298 The value returned by it should be the name of the Koha
299 object class that is returned by this class.
300 For example, for holds, object_class should return 'Koha::Hold'.
310 Kyle M Hall <kyle@bywatersolutions.com>