getObject

Is there any decent extended documentation on the use of getObject()?

http://bobsguides.com/revolution-objects.html

Or, even better:

http://www.amazon.com/MODX-Official-Guide-Bob-Ray/dp/0983619409

Thank you for your responses. BobRay, your site is helpful and your books looks interesting as well.

I have gathered that xpdo::getObject() returns an object, and that "get()" is a public method on that object. I was looking for a listing of all the public attributes and methods associated with the object returned by getObject(). I would also like similar information for other modx api methods. Does that type of detailed documentation exist anywhere?

The book covers a lot of that in the text, but the true reference section for that is in the Appendix. There are methods of xPDOOBject which all MODX objects are descended from, such as get(), getOne(), getMany(), etc.

There is also the $modx object, which extends the xPDO object. Between them, there are many utility methods like getObject(), getCollection(), getIterator(), getChunk(), getParentIds(), etc., all available with $modx->methodName();

Finally, there are the object-specific methods like $resource->getTVValue() and getContent().

There's a handy list of the object fields (all available with $object->get('fieldname') ) here: http://bobsguides.com/modx-object-quick-reference.html

BTW, the digital edition of the book should be out soon. [ed. note: BobRay last edited this post 12 years, 8 months ago.]

This is about as close as you'll get, other than the appendix to Bob's book http://api.modx.com/revolution/2.2/

There's also W. Shawn Wilkerson's book as well as a number of articles on his site http://www.shawnwilkerson.com/modx-revolution/

If you want a quick reference to the fields (and relations and indexes, etc.) of a specific xPDOObject derivative when coding, you can look at the map file for that class. It will be in the mysql/ subdirectory of the model with the same (lowercased) name of the class, e.g. mymodel/packagename/mysql/myclass.map.inc.php

Shawn has several object Cheat Sheets, as well as a snippet that generates a nice output list of this information. http://www.shawnwilkerson.com/modx-revolution/2012/03/04/object-cheat-sheets/

Thank you for all your replies. BobRay, your explanation is great. The object quick reference on bobsguides (http://bobsguides.com/modx-object-quick-reference.html), and shawn's object cheat sheets are exactly what I was looking for.

It would be nice if the modx documentation (http://rtfm.modx.com/) allowed users to comment, like the php docs on php.net (http://www.php.net/manual/en/)...BobRay's brief description above would probably be helpful to a lot of people, and would be nice to have right on the xpdo::getObject reference page.

BobRay, do you have an estimated date for the digital version of your book?

I'm hoping to have it out in the next few days.