Find all images with a certain tag including ones in repeaters

[abdus]

A simple recursive function that walks over all image fields and those inside repeaters(including FieldtypeFieldsetPage) to find images tagged with a certain tag(s). It can easily be extended to file fields by changing instanceof FieldtypeImage to FieldtypeFile, or be restricted to file fields by adding a !$type instanceof FieldtypeFile, too. Adapted from ProcessPageEditLink::getFilesPage() method.

/**
 * Find all images tagged with a certain tag in a page including repeater items.
 * 
 * @param $page Page to search tagged images
 * @param $tag string|array Image tag(s). Can be 'foo' for single, 'foo|bar' for multiple OR tags, 'foo,bar' or ['foo', 'bar'] for multiple AND tags
 * @return array Tagged images in [basename => Pageimage] associated array form or empty an array
 */
function findTaggedImages(Page $page, $tag)
{
    $tagged = [];
    foreach ($page->template->fieldgroup as $f) {
        $type = $f->type;
        if ($type instanceof FieldtypeImage) {
            /** @var Pageimages $images */
            $images = $page->{$f->name};
            if (!$images) continue;
            $tagged = array_merge($tagged, $images->findTag($tag)->getArray());
        } else if ($type instanceof FieldtypeRepeater) {
            $items = $page->{$f->name};
            if (!$items) continue;
            if ($items instanceof PageArray) {
                foreach ($page->$f as $item) $tagged = array_merge($tagged, findTaggedImages($item, $tag));
            }
            // FieldtypeFieldsetPage returns a single page instead of a PageArray
            elseif ($items instanceof Page) {
                $tagged = array_merge($tagged, findTaggedImages($items, $tag));
            }
        }
    }
    return $tagged;
}

And can be used as 

$featuredImages = findTaggedImages($page, 'featured');
// get first featured image
$featured = reset($featuredImages); // or array_shift($featuredImages)

 

[matjazp]

54 minutes ago, abdus said:

} else if ($type instanceof FieldtypeRepeater) {

Shouldn't that be:

} else if ($type instanceof FieldtypeRepeater || $type instanceof FieldtypeFieldsetPage) {

or perhaps:

} else if(wireInstanceOf($type, 'FieldtypeRepeater')) { 

to support FieldtypeFieldsetPage? 

[abdus]

3 minutes ago, matjazp said:

support FieldtypeFieldsetPage? 

FieldtypeFieldsetPage extends FieldtypeRepeater, so you dont need to explicity specify FieldtypeFieldsetPage.

class FieldtypeFieldsetPage extends FieldtypeRepeater implements ConfigurableModule { ... }

[matjazp]

I saw the change in ProcessPageEditImageSelect.module:

- if($field->type instanceof FieldtypeRepeater) {
+ if(wireInstanceOf($field->type, 'FieldtypeRepeater')) {

 

[abdus]

Hmm, it still works without wireInstanceOf() (which I believe is used for PW2 compatibility), but one bug I've found is that since FieldtypeFieldsetPage is a single repeater item, it doesnt return a RepeaterPageArray, instead returns the only item. Adding a check fixes it

else if ($type instanceof FieldtypeRepeater) {
    $items = $page->{$f->name};
    if (!$items) continue;
    if ($items instanceof PageArray) {
        foreach ($page->$f as $item) $tagged = array_merge($tagged, findTaggedImages($item, $tag));
    }
    // FieldtypeFieldsetPage returns a single page instead of a PageArray
    elseif ($items instanceof Page) {
        $tagged = array_merge($tagged, findTaggedImages($items, $tag));
    }
}

Updated the code in OP

[matjazp]

 Could this:

else if ($type instanceof FieldtypeRepeater) {
    $items = $page->{$f->name};
    if (!$items) continue;
    if ($items instanceof PageArray) {
        foreach ($page->$f as $item) $tagged = array_merge($tagged, findTaggedImages($item, $tag));
    }
    // FieldtypeFieldsetPage returns a single page instead of a PageArray
    elseif ($items instanceof Page) {
        $tagged = array_merge($tagged, findTaggedImages($items, $tag));
    }
}

be like this?

else if ($type instanceof FieldtypeRepeater) {
    $items = $page->{$f->name};
    if ($items instanceof Page) $items = array($items);
    if ($items) foreach ($page->$f as $item) $tagged = array_merge($tagged, findTaggedImages($item, $tag));
}

I'm not a programmer at all and haven't tested this so I might be completely wrong  

[bernhard]

it should always be a pagearray when you get the unformatted value:

// change this
$items = $page->{$f->name};

// to this
$items = $page->getUnformatted($f->name);

then you don't need the additional "else" statement