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->search();
94 my @objects = Koha::Objects->search($params);
99 my ( $self, $params, $attributes ) = @_;
102 my @dbic_rows = $self->_resultset()->search($params, $attributes);
104 return $self->_wrap(@dbic_rows);
108 my $class = ref($self) ?
ref($self) : $self;
109 my $rs = $self->_resultset()->search($params, $attributes);
111 return $class->_new_from_dbic($rs);
115 =head3 Koha::Objects->count();
117 my @objects = Koha::Objects->count($params);
122 my ( $self, $params ) = @_;
124 return $self->_resultset()->count($params);
127 =head3 Koha::Objects->pager();
129 my $pager = Koha::Objects->pager;
135 return $self->_resultset->pager;
138 =head3 Koha::Objects->next();
140 my $object = Koha::Objects->next();
142 Returns the next object that is part of this set.
143 Returns undef if there are no more objects to return.
150 my $result = $self->_resultset()->next();
151 return unless $result;
153 my $object = $self->object_class()->_new_from_dbic( $result );
158 =head3 Koha::Objects->reset();
160 Koha::Objects->reset();
162 resets iteration so the next call to next() will start agein
163 with the first object in a set.
170 $self->_resultset()->reset();
175 =head3 Koha::Objects->as_list();
177 Koha::Objects->as_list();
179 Returns an arrayref of the objects in this set.
186 my @dbic_rows = $self->_resultset()->all();
188 my @objects = $self->_wrap(@dbic_rows);
190 return wantarray ?
@objects : \
@objects;
193 =head3 Koha::Objects->unblessed
195 Returns an unblessed representation of objects.
202 return [ map { $_->unblessed } $self->as_list ];
205 =head3 Koha::Objects->_wrap
207 wraps the DBIC object in a corresponding Koha object
212 my ( $self, @dbic_rows ) = @_;
214 my @objects = map { $self->object_class()->_new_from_dbic( $_ ) } @dbic_rows;
219 =head3 Koha::Objects->_resultset
221 Returns the internal resultset or creates it if undefined
229 $self->{_resultset
} ||=
230 Koha
::Database
->new()->schema()->resultset( $self->_type() );
232 return $self->{_resultset
};
235 return Koha
::Database
->new()->schema()->resultset( $self->_type() );
241 The _type method must be set for all child classes.
242 The value returned by it should be the DBIC resultset name.
243 For example, for holds, _type should return 'Reserve'.
251 This method must be set for all child classes.
252 The value returned by it should be the name of the Koha
253 object class that is returned by this class.
254 For example, for holds, object_class should return 'Koha::Hold'.
264 Kyle M Hall <kyle@bywatersolutions.com>