Koha::Objects - Koha Object set base class
use Koha::Objects;
my @objects = Koha::Objects->search({ borrowernumber => $borrowernumber});
This class must be subclassed.
my $object = Koha::Objects->new();
my $object = Koha::Objects->_new_from_dbic( $resultset );
Similar to DBIx::Class::ResultSet->find this method accepts: \%columns_values | @pk_values, { key => $unique_constraint, %attrs }? Strictly speaking, columns_values should only refer to columns under an unique constraint.
It returns undef if no results were found
my $object = Koha::Objects->find( { col1 => $val1, col2 => $val2 } ); my $object = Koha::Objects->find( $id ); my $object = Koha::Objects->find( $idpart1, $idpart2, $attrs ); # composite PK
my $object = Koha::Objects->find_or_create( $attrs );
my @objects = Koha::Objects->search($params);
my @objects = Koha::Objects->search_related( $rel_name, $cond?, \%attrs? );
my $objects = Koha::Objects->search_related( $rel_name, $cond?, \%attrs? );
Searches the specified relationship, optionally specifying a condition and attributes for matching records.
my $object = Koha::Objects->search({}, { rows => 1 })->single
Returns one and only one object that is part of this set. Returns undef if there are no objects found.
This is optimal as it will grab the first returned result without instantiating a cursor.
See: http://search.cpan.org/dist/DBIx-Class/lib/DBIx/Class/Manual/Cookbook.pod#Retrieve_one_and_only_one_row_from_a_resultset
my $object = Koha::Objects->next();
Returns the next object that is part of this set. Returns undef if there are no more objects to return.
my $object = Koha::Objects->last;
Returns the last object that is part of this set. Returns undef if there are no object to return.
Koha::Objects->reset();
resets iteration so the next call to next() will start agein with the first object in a set.
Koha::Objects->as_list();
Returns an arrayref of the objects in this set.
Returns an unblessed representation of objects.
Return all the values of this set for a given column
Returns an unblessed representation of objects, suitable for JSON output.
Returns a representation of the objects, suitable for API output .
wraps the DBIC object in a corresponding Koha object
Returns the internal resultset or creates it if undefined
my @columns = Koha::Objects->columns
Return the table columns
The autoload method is used call DBIx::Class method on a resultset.
Important: If you plan to use one of the DBIx::Class methods you must provide relevant tests in t/db_dependent/Koha/Objects.t Currently count, pager, update and delete are covered.
The _type method must be set for all child classes. The value returned by it should be the DBIC resultset name. For example, for holds, _type should return 'Reserve'.
This method must be set for all child classes. The value returned by it should be the name of the Koha object class that is returned by this class. For example, for holds, object_class should return 'Koha::Hold'.
Kyle M Hall <kyle@bywatersolutions.com>