RepeaterMatrixField::getMatrixTypes()

Return an array of just matrix types in format [ typeName => typeNumber ]

Usage

// basic usage
$array = $repeaterMatrixField->getMatrixTypes();

// usage with all arguments
$array = $repeaterMatrixField->getMatrixTypes(string $indexType = 'name', string $valueType = 'type');

Arguments

NameType(s)Description
$indexType (optional)string

What matrix property to use for the array indexes Default:'name'

$valueType (optional)string

What matrix property to use for the array values Default:'type'

Return value

array

Exceptions

Method can throw exceptions on error:

  • WireException - if given invalid field


Hooking RepeaterMatrixField::getMatrixTypes(…)

You can add your own hook events that are executed either before or after the RepeaterMatrixField::getMatrixTypes(…) method is executed. Examples of both are included below. A good place for hook code such as this is in your /site/ready.php file.

Hooking before

The 'before' hooks are called immediately before each RepeaterMatrixField::getMatrixTypes(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('RepeaterMatrixField::getMatrixTypes', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $RepeaterMatrixField = $event->object;

  // Get values of arguments sent to hook (and optionally modify them)
  $indexType = $event->arguments(0);
  $valueType = $event->arguments(1);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $indexType);
  $event->arguments(1, $valueType);
});

Hooking after

The 'after' hooks are called immediately after each RepeaterMatrixField::getMatrixTypes(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('RepeaterMatrixField::getMatrixTypes', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $RepeaterMatrixField = $event->object;

  // An 'after' hook can retrieve and/or modify the return value
  $return = $event->return;

  // Get values of arguments sent to hook (if needed)
  $indexType = $event->arguments(0);
  $valueType = $event->arguments(1);

  /* Your code here, perhaps modifying the return value */

  // Populate back return value, if you have modified it
  $event->return = $return;
});

RepeaterMatrixField methods and properties

API reference based on ProcessWire core version 3.0.261