modX.paramValueIsTrue

modX::paramValueIsTrue¶

Reads $params[$key] and accepts only true, 'true', 1 and '1'. Anything else counts as false, including a missing key, 'TRUE', 'on' and 'yes'.

Use $returnBoolAsString when the result is written into generated code: JavaScript built through nowdoc or heredoc cannot take a PHP boolean literal.

Syntax¶

bool paramValueIsTrue (array $params, string|int $key, [bool $returnBoolAsString = false])

• $params (array) parameters to read
• $key (string|int) key to evaluate
• $returnBoolAsString (bool) return 'true' or 'false' instead of booleans, by default false

Example¶

$props = array('grow' => 'true', 'resize' => '0');

$grow = $modx->paramValueIsTrue($props, 'grow');        // true
$resize = $modx->paramValueIsTrue($props, 'resize');    // false
$flag = $modx->paramValueIsTrue($props, 'grow', true);  // 'true'

See Also¶

• modX