Koha::Object - Koha Object base class


    use Koha::Object;
    my $object = Koha::Object->new({ property1 => $property1, property2 => $property2, etc... } );


This class must always be subclassed.


Class Methods


my $object = Koha::Object->new(); my $object = Koha::Object->new($attributes);

Note that this cannot be used to retrieve record from the DB.


my $object = Koha::Object->_new_from_dbic($dbic_row);


Saves the object in storage. If the object is new, it will be created. If the object previously existed, it will be updated.

Returns: $self if the store was a success undef if the store failed


Returns true if the object has been previously stored.


Returns true if the object has properties that are different from the properties of the object in storage.


Removes the object from storage.

Returns: 1 if the deletion was a success 0 if the deletion failed -1 if the object was never in storage

$object->set( $properties_hashref )

$object->set( { property1 => $property1, property2 => $property2, property3 => $propery3, } );

Enables multiple properties to be set at once

Returns: 1 if all properties were set. 0 if one or more properties do not exist. undef if all properties exist but a different error prevents one or more properties from being set.

If one or more of the properties do not exist, no properties will be set.


Returns the id of the object if it has one.


Returns an unblessed representation of object.


Returns the internal DBIC Row object


Returns an arrayref of the table columns


The autoload method is used only to get and set values for an objects properties.


This method must be defined in the child class. The value is the name of the DBIC resultset. For example, for borrowers, the type method will return "Borrower".


Kyle M Hall <kyle@bywatersolutions.com>