About RockFinder

Highly Efficient and Flexible SQL Finder Module

Category 1Development Tools
Modules that have more to do with assisting development of a site rather than managing its content.
Category 2Import/Export
Modules that work with importing or exporting data.
Category 3Process Modules
Process modules are apps that run in the ProcessWire admin.
Release StateBeta
Close to stable, but users are advised to be cautious and test thoroughly.*
Authorbernhard
Module Version1.1.1
Class NameRockFinder
Compatibility3.0
Date AddedMay 13, 2018
Last UpdatedJanuary 22, 2019
Recommended ByNew recommendations may take up to 1 day to appear.

Instructions

This module's files should be placed in /site/modules/RockFinder/
How to install or uninstall modules

README

RockFinder

WHY?

This module was built to fill the gap between simple $pages->find() operations and complex SQL queries.

The problem with $pages->find() is that it loads all pages into memory and that can be a problem when querying multiple thousands of pages. Even $pages->findMany() loads all pages into memory and therefore is a lot slower than regular SQL.

The problem with SQL on the other hand is, that the queries are quite complex to build. All fields are separate tables, some repeatable fields use multiple rows for their content that belong to only one single page, you always need to check for the page status (which is not necessary on regular find() operations and therefore nobody is used to that).

In short: It is far too much work to efficiently and easily get an array of data based on PW pages and fields and I need that a lot for my RockGrid module to build all kinds of tabular data.


Basic Usage

getObjects()

Returns an array of objects.

screenshot

getArrays()

Returns an array of arrays.

screenshot

getValues()

Returns a flat array of values of the given column/field.

screenshot

getPages()

Returns PW Page objects.

$finder = new RockFinder('template=invoice, limit=5', ['value', 'date']);
$finder->getPages();

By default uses the id column, but another one can be specified:

screenshot


Advanced Usage

Joins

It is possible to join multiple finders. This is useful whenever you have singlepage reference fields and want to show properties of the referenced page. A simple example could be this join:

$finder1 = new RockFinder('template=rockproject', ['title', 'rockproject_client']);
$finder2 = new RockFinder('template=rockcontact', ['title']);
// join finder
$finder1->join($finder2, 'contact', ['id' => 'rockproject_client']);

The syntac is like this:

$baseFinder->join($joinedFinder, 'joinedFinderAlias', ['fieldNameOfJoinedFinder' => 'fieldNameOfBaseFinder']);

A more advanced example is this one, joining three finders. Notice that $finder3 is manually joined on a column of $finder2 (having alias contact). You canachieve this by providing not only the field name (then it would join to the base finder) but also providing the finder-alias and the fieldname manually.

You have to use this syntax for your "fieldname": {alias}.{alias}_{fieldname}.

In this example we are joining projects (finder1) and their related clients(single page reference field of project) and then we join the referral contact of the project's client based on the "camefrom" id of finder2:

$finder1 = new RockFinder('template=rockproject', [
  'title',
  'rockproject_client',
]);
$finder2 = new RockFinder('template=rockcontact', [
  'title',
  'rockcontact_camefrom',
]);
$finder3 = new RockFinder('template=rockcontact', [
  'title',
]);
// join finders
$finder1->join($finder2, 'contact', ['id' => 'rockproject_client']);
$finder1->join($finder3, 'referral', ['id' => 'contact.contact_rockcontact_camefrom']);
return $finder1;

complex join

Filters & Access Control

You can filter the resulting rows by custom callbacks:

// show only rows that have an id > 3
$finder = new RockFinder('id>0, limit=5', ['title', 'status']);
$finder->filter(function($row) {
  return $row->id > 3;
});

img

You can also use these filters for showing only editable pages by the current user. Be careful! This will load pages into memory and you will lose the performance benefits of RockFinder / direct SQL queries.

$finder->filter(function($row) {
  $page = $this->wire->pages->get($row->id);
  return $page->editable();
});

One thing to mention is that you can apply these filters BEFORE or AFTER closures have been applied. If you apply them BEFORE executing the closures it might be a little more performant (because closures will not be executed for rows that have been removed by the filter), but you will not have access to columns that are populated via closures (like page path).

Custom SQL: Aggregations, Groupings, Distincts...

You can apply any custom SQL with this technique:

$finder = new RockFinder('template=invoice, limit=0', ['value', 'date']);
$sql = $finder->getSQL();
$finder->sql = "SELECT * FROM ($sql) AS tmp";
d($finder->getObjects());

Real example:

$finder = new RockFinder('template=invoice, limit=0', ['value', 'date']);
$sql = $finder->getSQL();
$finder->sql = "SELECT id, SUM(value) AS revenue, DATE_FORMAT(date, '%Y-%m') AS dategroup FROM ($sql) AS tmp GROUP BY dategroup";
d($finder->getObjects());

screenshot

Notice that this query takes only 239ms and uses 0.19MB of memory while it queries and aggregates more than 10.000 pages!

You can also add custom SQL queries like this: https://processwire.com/talk/topic/19226-rockfinder-highly-efficient-and-flexible-sql-finder-module/?do=findComment&comment=167804 to easily do "reverse queries", for example show all projects that have the current page selected in a page-reference-field.

Closures

ATTENTION: This executes a $pages->find() operation on each row, so this makes the whole query significantly slower than without using closures. Closures are a good option if you need to query complex data and only have a very limited number of rows.

screenshot

Querying more complex fields (page reference fields, repeaters, etc)

Querying those fields is not an easy task in SQL because the field's data is spread across several database tables. This data then needs to be joined and you need to make sure that the sort order stays untouched. RockFinder takes care of all that and makes the final query very easy.

See this example of a page reference field called cats:

screenshot

The example also shows how you can control the returned content (for example changing the separator symbol). For every supported fieldtype there is a corresponding readme-file in the fieldTypes folder of this repo.

You can create custom fieldType-queries by placing a file in /site/assets/RockFinder. This makes this module very versatile and you should be able to handle even the most complex edge-case.


Multilanguage

Multilanguage is ON by default. Options:

$finder->strictLanguage = false;
$finder->multiLang = true;

Setting strictLang = true means that RockFinder will return the result of the queried field in the active language of the user. If strictLang is set to false, the finder will return the field's value in the user's language and if that is empty, it will return the first available value.

Comments

No comments yet. Be the first to post!

Post a Comment

Your e-mail is kept confidential and not included with your comment. Website is optional.