Template Report With Page Titles

In my previous article, we looked at a Snippet that shows the number of published and unpublished Resources connected to each Template. In this one, we’ll expand that to show each Template with a list of the pagetitles of its attached Resources. We’ll call this one TemplateReportPlus.

The Code

Put this tag on a page where you’d like to see the report:

[[!TemplateReportPlus]]

Paste this code into a Snippet called TemplateReportPlus:

/* TemplateReportPlus snippet */

    /* Make it run in either MODX 2 or MODX 3 */
    $prefix = $modx->getVersionData()['version'] >= 3
      ? 'MODX\Revolution\\'
      : '';

$templates = $modx->getCollection($prefix . 'modTemplate');

$output = '## Template Report';
$output .= "\n<pre>";

foreach ($templates as $template) {
    $id = $template->get('id');
    $name = $template->get('templatename');

    $output .= "\n\n" . $name ;

    /* Published resources */
    $c1 = $modx->newQuery($prefix . 'modResource');
    $c1->where(array(
        'published' => '1',
        'template'  => $id,
    ));
    $output .= "\n    Published";
    $docs = $modx->getCollection($prefix . 'modResource', $c1);

    if (empty($docs)) {
        $output .= "\n        (none)";
    } else {
        foreach ($docs as $doc) {
            $output .= "\n        " . $doc->get('pagetitle');
        }
    }

    /* Unpublished resources */
    $c2 = $modx->newQuery('modResource');
    $c2->where(array(
        'published' => '0',
        'template'  => $id,
    ));
    $output .= "\n    Unpublished";

    $docs = $modx->getCollection('modResource', $c2);

    if (empty($docs)) {
        $output .= "\n        (none)";
    } else {
        foreach ($docs as $doc) {
            $output .= "\n        " . $doc->get('pagetitle');
        }
    }
}
return  $output . '</pre>';

How It Works

The code gets all the site’s Templates with getCollection() in line 2, then loops through them. For each template, first, we get the published Resources (looping through them to add each pagetitle to the output). Then, we get that Template’s unpublished Resources and do the same with them. Finally, we return the output. We’ve wrapped the output in pre tags to preserve the indentation. This could have been done with ul and li tags, but it would take some trial and error, and since this isn’t a page that would be displayed to end users, it might not be worth the trouble.

This Snippet could be made significantly faster, but it probably isn’t going to run very often, so it’s not worth the effort to optimize it.

---

Bob Ray is the author of the MODX: The Official Guide and dozens of MODX Extras including QuickEmail, NewsPublisher, SiteCheck, GoRevo, Personalize, EZfaq, MyComponent and many more. His website is Bob’s Guides. It not only includes a plethora of MODX tutorials but there are some really great bread recipes there, as well.