Jump to main content Jump to doc navigation

modX.toPlaceholders

Mark Hamstra Ibochkarev

Last updated Nov 27th, 2019 | Page history | Improve this page | Report an issue

modX::toPlaceholders

Sets placeholders from values stored in arrays and objects.

Each recursive level in the $placeholders array adds to the prefix, building an access path using an optional separator.

Syntax

API Doc: modX::toPlaceholders()

array toPlaceholders (array|object  $subject, [string $prefix = ''], [string $separator = '.'], [boolean $restore = false])

Example

Set an array of placeholders and prefix with 'my.' Returns a multi-dimensional array containing up to two elements: 'keys' which always contains an array of placeholder keys that were set, and optionally, if the restore parameter is true, 'restore' containing an array of placeholder values that were overwritten by the method.

$modx->toPlaceholders(array(
  'name' => 'John',
  'email' => 'jdoe@gmail.com',
),'my');

Example with Nested Placeholders

Using nested data as the $placeholders:

$modx->toPlaceholders(array(
  'document' => array('pagetitle' => 'My Page')
));

Corresponds to placeholders such as [[+document.pagetitle]]

Note that using a $prefix on nested placeholders adds the $prefix to the front of each key. For example:

$modx->toPlaceholders(
  array(
    'test' => 'this',
    'document' => array('pagetitle' => 'My Page')
  ), 'tmp'
);

Would have placeholders such as [[+tmp.test]] and [[+tmp.document.pagetitle]]

See Also