CatalystX::CRUD::Object - an instance returned from a CatalystX::CRUD::Model
package My::Object; use base qw( CatalystX::CRUD::Object ); sub create { shift->delegate->save } sub read { shift->delegate->load } sub update { shift->delegate->save } sub delete { shift->delegate->remove } 1;
A CatalystX::CRUD::Model returns instances of CatalystX::CRUD::Object.
The assumption is that the Object knows how to manipulate the data it represents, typically by holding an instance of an ORM or other data model in the delegate accessor, and calling methods on that instance.
delegate
So, for example, a CatalystX::CRUD::Object::RDBO has a Rose::DB::Object instance, and calls its RDBO object's methods.
The idea is to provide a common CRUD API for various backend storage systems.
The following methods are provided.
Generic constructor. args may be a hash or hashref.
The delegate() accessor is a holder for the object instance that the CXCO instance has. A CXCO object "hasa" instance of another class in its delegate() slot. The delegate is the thing that does the actual work; the CXCO object just provides a container for the delegate to inhabit.
Think of delegate as a noun, not a verb, as in "The United Nations delegate often slept here."
A CXCO subclass needs to implement at least the following methods:
Write a new object to store.
Load a new object from store.
Write an existing object to store.
Remove an existing object from store.
Return results should be boolean indicating whether the object already exists or not. Expectation is code like:
if ($object->is_new) { $object->create; } else { $object->update; }
Stringify the object. This class overloads the string operators to call this method.
Your delegate class should implement a serialize() method or stringify to something useful.
Some black magic hackery to make Object classes act like they are overloaded delegate()s.
Overrides basic can() method to call can() first on the delegate and secondly (fallback) on the Object class itself.
Peter Karman, <perl at peknet.com>
<perl at peknet.com>
Please report any bugs or feature requests to bug-catalystx-crud at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=CatalystX-CRUD. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
bug-catalystx-crud at rt.cpan.org
You can find documentation for this module with the perldoc command.
perldoc CatalystX::CRUD
You can also look for information at:
Mailing List
https://groups.google.com/forum/#!forum/catalystxcrud
AnnoCPAN: Annotated CPAN documentation
http://annocpan.org/dist/CatalystX-CRUD
CPAN Ratings
http://cpanratings.perl.org/d/CatalystX-CRUD
RT: CPAN's request tracker
http://rt.cpan.org/NoAuth/Bugs.html?Dist=CatalystX-CRUD
Search CPAN
http://search.cpan.org/dist/CatalystX-CRUD
Copyright 2007 Peter Karman, all rights reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
To install CatalystX::CRUD, copy and paste the appropriate command in to your terminal.
cpanm
cpanm CatalystX::CRUD
CPAN shell
perl -MCPAN -e shell install CatalystX::CRUD
For more information on module installation, please visit the detailed CPAN module installation guide.