fetch('string:{crmRegion name=testBlank}{/crmRegion}');
$expected = '';
$this->assertEquals($expected, $actual);
}
/**
* When a {crmRegion} is not blank and when there are no extra snippets,
* the output is only determined by the {crmRegion} block.
*/
public function testDefault() {
$smarty = CRM_Core_Smarty::singleton();
$actual = $smarty->fetch('string:{crmRegion name=testDefault}default
{/crmRegion}');
$expected = 'default
';
$this->assertEquals($expected, $actual);
}
/**
* Disable the normal content of a {crmRegion} and apply different content from a snippet
*/
public function testOverride() {
CRM_Core_Region::instance('testOverride')->update('default', [
'disabled' => TRUE,
]);
CRM_Core_Region::instance('testOverride')->add([
'markup' => 'override
',
]);
$smarty = CRM_Core_Smarty::singleton();
$actual = $smarty->fetch('string:{crmRegion name=testOverride}default
{/crmRegion}');
$expected = 'override
';
$this->assertEquals($expected, $actual);
}
/**
* Test that each of the major content formats are correctly evaluated.
*/
public function testAllTypes() {
CRM_Core_Region::instance('testAllTypes')->add([
'markup' => 'some-markup
',
]);
CRM_Core_Region::instance('testAllTypes')->add([
// note: 'template' would normally be a file name
'template' => 'string:smarty-is-{$snippet.extrainfo}
',
'extrainfo' => 'dynamic',
]);
CRM_Core_Region::instance('testAllTypes')->add([
// note: returns a value which gets appended to the region
'callback' => 'implode',
'arguments' => ['-', ['callback', 'with', 'specific', 'args
']],
]);
CRM_Core_Region::instance('testAllTypes')->add([
// note: returns a value which gets appended to the region
'callback' => function(&$spec, &$html) {
return "callback-return
";
},
]);
CRM_Core_Region::instance('testAllTypes')->add([
// note: returns void; directly modifies region's $html
'callback' => function(&$spec, &$html) {
$html = "callback-ref
" . $html;
},
]);
CRM_Core_Region::instance('testAllTypes')->add([
'scriptUrl' => '/foo%20bar.js',
]);
CRM_Core_Region::instance('testAllTypes')->add([
'script' => 'alert("hi");',
]);
CRM_Core_Region::instance('testAllTypes')->add([
'jquery' => '$("div");',
]);
CRM_Core_Region::instance('testAllTypes')->add([
'styleUrl' => '/foo%20bar.css',
]);
CRM_Core_Region::instance('testAllTypes')->add([
'style' => 'body { background: black; }',
]);
$smarty = CRM_Core_Smarty::singleton();
$actual = $smarty->fetch('string:{crmRegion name=testAllTypes}default
{/crmRegion}');
$expected = "callback-ref
"
. "default
"
. "some-markup
"
. "smarty-is-dynamic
"
. "callback-with-specific-args
"
. "callback-return
"
. "\n"
. "\n"
. "\n"
. "\n"
. "\n";
$this->assertEquals($expected, $actual);
}
/**
* Test of nested arrangement in which one {crmRegion} directly includes another {crmRegion}
*/
public function testDirectNest() {
CRM_Core_Region::instance('testDirectNestOuter')->add([
'template' => 'string:O={$snippet.weight} ',
'weight' => -5,
]);
CRM_Core_Region::instance('testDirectNestOuter')->add([
'template' => 'string:O={$snippet.weight} ',
'weight' => 5,
]);
CRM_Core_Region::instance('testDirectNestInner')->add([
'template' => 'string:I={$snippet.weight} ',
'weight' => -5,
]);
CRM_Core_Region::instance('testDirectNestInner')->add([
'template' => 'string:I={$snippet.weight} ',
'weight' => 5,
]);
$smarty = CRM_Core_Smarty::singleton();
$actual = $smarty->fetch('string:{crmRegion name=testDirectNestOuter}left {crmRegion name=testDirectNestInner}middle {/crmRegion}right {/crmRegion}');
$expected = 'O=-5 left I=-5 middle I=5 right O=5 ';
$this->assertEquals($expected, $actual);
}
/**
* Test of nested arrangement in which one {crmRegion} is enhanced with a snippet which, in turn, includes another {crmRegion}
*/
public function testIndirectNest() {
CRM_Core_Region::instance('testIndirectNestOuter')->add([
// Note: all three $snippet references are bound to the $snippet which caused this template to be included,
// regardless of any nested {crmRegion}s
'template' => 'string: O={$snippet.region}{crmRegion name=testIndirectNestInner} O={$snippet.region}{/crmRegion} O={$snippet.region}',
]);
CRM_Core_Region::instance('testIndirectNestInner')->add([
'template' => 'string: I={$snippet.region}',
]);
$smarty = CRM_Core_Smarty::singleton();
$actual = $smarty->fetch('string:{crmRegion name=testIndirectNestOuter}default{/crmRegion}');
$expected = 'default O=testIndirectNestOuter O=testIndirectNestOuter I=testIndirectNestInner O=testIndirectNestOuter';
$this->assertEquals($expected, $actual);
}
/**
* Output from an inner-region should not be executed verbatim; this is obvious but good to verify
*/
public function testNoInjection() {
CRM_Core_Region::instance('testNoInjectionOuter')->add([
'template' => 'string:{$snippet.scarystuff} ',
'scarystuff' => '{$is_outer_scary}',
]);
CRM_Core_Region::instance('testNoInjectionInner')->add([
'template' => 'string:{$snippet.scarystuff} ',
'scarystuff' => '{$is_inner_scary}',
]);
$smarty = CRM_Core_Smarty::singleton();
$smarty->assign('is_outer_scary', 'egad');
$smarty->assign('is_inner_scary', 'egad');
$smarty->assign('also_scary', 'egad');
$actual = $smarty->fetch('string:{crmRegion name=testNoInjectionOuter}left {crmRegion name=testNoInjectionInner}middle {literal}{$also_scary}{/literal} {/crmRegion}right {/crmRegion}');
$expected = 'left middle {$also_scary} {$is_inner_scary} right {$is_outer_scary} ';
$this->assertEquals($expected, $actual);
}
/**
* Make sure that standard Smarty variables ($smarty->assign(...)) as well
* as the magical $snippet variable both evaluate correctly.
*/
public function testSmartyVars() {
$smarty = CRM_Core_Smarty::singleton();
$smarty->assign('extrainfo', 'one');
CRM_Core_Region::instance('testSmartyVars')->add([
'template' => 'string:var-style-{$extrainfo}
',
]);
CRM_Core_Region::instance('testSmartyVars')->add([
'template' => 'string:var-style-{$snippet.extrainfo}
',
'extrainfo' => 'two',
]);
$actual = $smarty->fetch('string:{crmRegion name=testSmartyVars}default
{/crmRegion}');
$expected = 'default
var-style-one
var-style-two
';
$this->assertEquals($expected, $actual);
}
public function testWeight() {
CRM_Core_Region::instance('testWeight')->add([
'markup' => 'prepend-5
',
'weight' => -5,
]);
CRM_Core_Region::instance('testWeight')->add([
'markup' => 'append+3
',
'weight' => 3,
]);
CRM_Core_Region::instance('testWeight')->add([
'markup' => 'prepend-3
',
'weight' => -3,
]);
CRM_Core_Region::instance('testWeight')->add([
'markup' => 'append+5
',
'weight' => 5,
]);
$smarty = CRM_Core_Smarty::singleton();
$actual = $smarty->fetch('string:{crmRegion name=testWeight}default
{/crmRegion}');
$expected = 'prepend-5
prepend-3
default
append+3
append+5
';
$this->assertEquals($expected, $actual);
}
}