xPDO.getCollection
Last updated Apr 20th, 2021 | Page history | Improve this page | Report an issue
Support the team building MODX with a monthly donation.
The budget raised through OpenCollective is transparent, including payouts, and any contributor can apply to be paid for their work on MODX.
Backers
Budget
$306 per month—let's make that $500!
Learn morexPDO::getCollection¶
Retrieves a collection of xPDOObjects
by the specified xPDOCriteria
.
If none are found, returns an empty array.
Syntax¶
API Docs: https://api.modx.com/revolution/2.2/db_core_xpdo_xpdo.class.html#\xPDO::getCollection()
array getCollection (string $className, [xPDOCriteria|array|str|int $criteria = null], [bool|int $cacheFlag = true])
Remember, if you are using xPDO map and class files that were generated from XML schema, the classname is not the same as your table name. If in doubt, have a look at the schema XML file, e.g.
<object class="MyClassName" table="my_class_name" extends="xPDOObject">
Examples¶
Get a collection of Box objects with a width of 40.
$boxes = $xpdo->getCollection('Box',array(
'width' => 40,
));
Get Pages¶
Often getCollection is used inside MODX Snippets, so you will call it via the $modx object and you will be fetching built-in MODX object collections, such as pages.
$pages = $modx->getCollection('modResource', array('template' => 3));
Know Your Objects!
Remember that you need to call the collection by its object name. You may find it quite handy to keep open your core/model/schema/modx.mysql.schema.xml
file so you can review your object names, e.g. "modResource" for pages, or "modChunk" for chunks etc.