My RepeaterMatrix scripts

[Clarity]

Hello everyone!

Recently I wrote these scripts for TracyDebugger console in order to make work with RepeaterMatrix easier and faster. I want to present them to the community.

Show relationship between all types, names and labels.

$repeaterMatrixModule = $modules->get('FieldtypeRepeaterMatrix');
$fieldName = 'content_blocks';
$repeaterMatrixField = $fields->get($fieldName);
$typesArray = [];
foreach($repeaterMatrixModule->getMatrixTypes() as $matrixName => $matrixType) {
    $typesArray[$matrixName] = $matrixType . ' ' . $repeaterMatrixModule->getMatrixTypeLabel($matrixType, $repeaterMatrixField);
}
db($typesArray);

Show all pages which have specific type in field (repeater_matrix) with this name:

$repeaterMatrixModule = $modules->get('FieldtypeRepeaterMatrix');
$typeName = 'block_text';
$fieldName = 'content_blocks';
$repeaterMatrixField = $fields->get($fieldName);
$typeId = $repeaterMatrixModule->getMatrixTypeByName($typeName, $repeaterMatrixField);
$typeLabel = $repeaterMatrixModule->getMatrixTypeLabel($typeId, $repeaterMatrixField);
$pagesWithType = $pages->find("{$fieldName}.type={$typeName}");
db($pagesWithType);
db($typeLabel, 'Name of type');

This list can be continued as soon as I'll invent more scripts.

Edited February 1, 2023 by Clarity
Updated scripts.

[bernhard]

Thx for sharing. Screenshots would be nice for all that can not transform code into pictures on the fly in their brain (me included) ? 

[Clarity]

@bernhard, yes, of course. I've added screenshots.

[gebeer]

Thanks for sharing. Your 2nd example can also be written like this

$fieldName = 'content_product';
$typeName = 'product_downloads';
$pagesWithType = $pages->find("{$fieldName}.type={$typeName}");
db($pagesWithType);

No need for looping through all pages. find() accepts the subselector .type. Only drawback with my solution: you don't get the label for the type. 

Actually when trying your example, $typeId returned false and $typeName returned null

$repeaterMatrix = $modules->get('FieldtypeRepeaterMatrix');
$typeId = $repeaterMatrix->getMatrixTypeByName('product_downloads');
db($typeId, '$typeId'); // returns false
$typeName = $repeaterMatrix->getMatrixTypeLabel($typeId);
db($typeName, '$typeName'); // returns null

Which version of Repeater Matrix are you using?

[gebeer]

4 hours ago, gebeer said:

Actually when trying your example, $typeId returned false and $typeName returned null

$repeaterMatrix = $modules->get('FieldtypeRepeaterMatrix');
$typeId = $repeaterMatrix->getMatrixTypeByName('product_downloads');
db($typeId, '$typeId'); // returns false
$typeName = $repeaterMatrix->getMatrixTypeLabel($typeId);
db($typeName, '$typeName'); // returns null

Which version of Repeater Matrix are you using?

I found the reason. It works if you only have 1 repeater matrix field. If you have multiple, you need to pass the field object as 2nd parameter:

$field = $fields->get('content_product');
$repeaterMatrix = $modules->get('FieldtypeRepeaterMatrix');
$typeId = $repeaterMatrix->getMatrixTypeByName('teaser_gallery', $field);

Same goes for $repeaterMatrix->getMatrixTypeLabel(string 'typename', Field $field)

[Clarity]

@gebeer, thank you for improving my scripts. I've updated them.

5 hours ago, gebeer said:

Thanks for sharing. Your 2nd example can also be written like this

$fieldName = 'content_product';
$typeName = 'product_downloads';
$pagesWithType = $pages->find("{$fieldName}.type={$typeName}");
db($pagesWithType);

Also my previous version of this script finds pages in repeaters which is not an intended behavior.