public function testInterstitialTemplateProcessing()
{
// should only be one
$vn_relation_id = $this->opt_object_left->get('ca_objects_x_objects.relation_id');
$this->assertTrue(is_numeric($vn_relation_id));
$va_opts = array('resolveLinksUsing' => 'ca_objects', 'primaryIDs' => array('ca_objects' => array($this->opt_object_left->getPrimaryKey())));
// we're reading from the left side, so the right side pop up
$this->assertEquals('Test Dataset', caProcessTemplateForIDs('^ca_objects.preferred_labels', 'ca_objects_x_objects', array($vn_relation_id), $va_opts));
$this->assertEquals('is related to', caProcessTemplateForIDs('^relationship_typename', 'ca_objects_x_objects', array($vn_relation_id), $va_opts));
$this->assertEquals('is related to', caProcessTemplateForIDs('<unit relativeTo="ca_objects_x_objects">^relationship_typename</unit>', 'ca_objects', array($this->opt_object_left->getPrimaryKey()), $va_opts));
}
public function testInterstitialTemplateProcessing()
{
// should only be one
$vn_relation_id = $this->opt_homer->get('ca_entities_x_entities.relation_id');
$this->assertTrue(is_numeric($vn_relation_id));
$va_opts = array('resolveLinksUsing' => 'ca_entities', 'primaryIDs' => array('ca_entities' => array($this->opt_bart->getPrimaryKey())));
// we're reading from Bart, so Homer should pop up
$this->assertEquals('Homer J. Simpson', caProcessTemplateForIDs('^ca_entities.preferred_labels', 'ca_entities_x_entities', array($vn_relation_id), $va_opts));
// Try getting the rel type from the relationship record
// We don't need $va_opts to do that, by the way!
$this->assertEquals('is related to', caProcessTemplateForIDs('^relationship_typename', 'ca_entities_x_entities', array($vn_relation_id)));
// Try getting the rel type from the Homer record
// We don't need $va_opts to do that either
$this->assertEquals('is related to', caProcessTemplateForIDs('<unit relativeTo="ca_entities_x_entities">^relationship_typename</unit>', 'ca_entities', array($this->opt_homer->getPrimaryKey())));
}
public function testGets()
{
$vm_ret = $this->opt_loan_in->get('ca_loans.related');
$this->assertEquals('New Loan Out', $vm_ret);
$va_items = $this->opt_loan_in->getRelatedItems('ca_loans');
$vn_relation_id = array_shift(caExtractArrayValuesFromArrayOfArrays($va_items, 'relation_id'));
// The relationship we created is Loan Out <-> Loan In, so evaluating with loan in as primary ID should give us the loan out
$va_opts = array('resolveLinksUsing' => 'ca_loans', 'primaryIDs' => array('ca_loans' => array($this->opt_loan_in->getPrimaryKey())));
$vm_ret = caProcessTemplateForIDs("^ca_loans.preferred_labels", 'ca_loans_x_loans', array($vn_relation_id), $va_opts);
$this->assertEquals('New Loan Out', $vm_ret);
// Now for the other side ...
$va_opts = array('resolveLinksUsing' => 'ca_loans', 'primaryIDs' => array('ca_loans' => array($this->opt_loan_out->getPrimaryKey())));
$vm_ret = caProcessTemplateForIDs("^ca_loans.preferred_labels", 'ca_loans_x_loans', array($vn_relation_id), $va_opts);
$this->assertEquals('New Loan In', $vm_ret);
}
public function testSiblingRestrictToTypesDisplayTemplates()
{
$vm_ret = DisplayTemplateParser::evaluate("<unit delimiter='; ' restrictToTypes='image' relativeTo='ca_objects.siblings'>^ca_objects.preferred_labels.name</unit>", "ca_objects", array($this->opt_another_child_object->getPrimaryKey()), array('returnAsArray' => true));
$this->assertInternalType('array', $vm_ret);
$this->assertCount(1, $vm_ret);
$this->assertEquals('My test still; Another test still', $vm_ret[0]);
$vm_ret = DisplayTemplateParser::evaluate("<unit delimiter='; ' restrictToTypes='moving_image' relativeTo='ca_objects.siblings'>^ca_objects.preferred_labels.name</unit>", "ca_objects", array($this->opt_another_child_object->getPrimaryKey()), array('returnAsArray' => true));
$this->assertInternalType('array', $vm_ret);
$this->assertCount(1, $vm_ret);
$this->assertEquals('A child movie', $vm_ret[0]);
}
public function testExpressionTag()
{
// unit tag inside expression
$this->assertEquals($this->opn_entity_id, caProcessTemplateForIDs('<expression>max(<unit relativeTo="ca_entities" delimiter=",">^ca_entities.entity_id</unit>)</expression>', 'ca_objects', array($this->opt_object->getPrimaryKey())));
// just a plain tag .. 'My test image' is 13 chars
$this->assertEquals(13, caProcessTemplateForIDs('<expression>length(^ca_objects.preferred_labels)</expression>', 'ca_objects', array($this->opt_object->getPrimaryKey())));
// plain old scalars
$this->assertEquals(9, caProcessTemplateForIDs('<expression>5 + 4</expression>', 'ca_objects', array($this->opt_object->getPrimaryKey())));
// get entity names and their string lengths
$this->assertEquals('Homer J. Simpson, 16; Bart Simpson, 12', caProcessTemplateForIDs('<unit relativeTo="ca_entities">^ca_entities.preferred_labels, <expression>length(^ca_entities.preferred_labels)</expression></unit>', 'ca_objects', array($this->opt_object->getPrimaryKey())));
// scalars in ifdef (false)
$this->assertEmpty(caProcessTemplateForIDs('<ifdef code="ca_objects.description"><expression>5+9</expression></ifdef>', 'ca_objects', array($this->opt_object->getPrimaryKey())));
// scalars in ifdef (true)
$this->assertEquals(9, caProcessTemplateForIDs('<ifdef code="ca_entities"><expression>5+4</expression></ifdef>', 'ca_objects', array($this->opt_object->getPrimaryKey())));
// hacked up way to count number of relationships
$this->assertEquals(2, caProcessTemplateForIDs('<expression>sizeof(<unit relativeTo="ca_entities" delimiter=",">^ca_entities.entity_id</unit>)</expression>', 'ca_objects', array($this->opt_object->getPrimaryKey())));
// no relationships exist for collections
$this->assertEquals(0, caProcessTemplateForIDs('<expression>sizeof(<unit relativeTo="ca_collections" delimiter=",">^ca_collections.collection_id</unit>)</expression>', 'ca_objects', array($this->opt_object->getPrimaryKey())));
// no relationships exist for collections
$this->assertEquals(0, caProcessTemplateForIDs('<expression>sizeof(<unit relativeTo="ca_collections" delimiter=",">^ca_collections.collection_id</unit>)</expression>', 'ca_objects', array($this->opt_object->getPrimaryKey())));
// age calculation
$this->assertEquals(41, caProcessTemplateForIDs('<expression>age("23 June 1912", "7 June 1954")</expression>', 'ca_objects', array($this->opt_object->getPrimaryKey())));
}
/**
* Prepopulate record fields according to rules in prepopulate.conf
*
* @param BundlableLabelableBaseModelWithAttributes $t_instance The table instance to prepopulate
* @param array $pa_options Options array. Available options are:
* prepopulateConfig = override path to prepopulate.conf, e.g. for testing purposes
* @return bool success or not
*/
public function prepopulateFields(&$t_instance, $pa_options = null)
{
if (!$t_instance->getPrimaryKey()) {
return false;
}
if ($vs_prepopulate_cfg = caGetOption('prepopulateConfig', $pa_options, null)) {
$this->opo_plugin_config = Configuration::load($vs_prepopulate_cfg);
}
if (!($this->opo_plugin_config->get('prepopulate_fields_on_save') || $this->opo_plugin_config->get('prepopulate_fields_on_load'))) {
return false;
}
$va_rules = $this->opo_plugin_config->get('prepopulate_rules');
if (!$va_rules || !is_array($va_rules) || sizeof($va_rules) < 1) {
return false;
}
global $g_ui_locale_id;
// we need to unset the form timestamp to disable the 'Changes have been made since you loaded this data' warning when we update() $this
// the warning makes sense because an update()/insert() is called before we arrive here but after the form_timestamp ... but we chose to ignore it
//$vn_timestamp = $_REQUEST['form_timestamp'];
//unset($_REQUEST['form_timestamp']);
$vb_we_set_transaction = true;
if (!$t_instance->inTransaction()) {
$t_instance->setTransaction(new Transaction($t_instance->getDb()));
$vb_we_set_transaction = true;
}
// process rules
$va_expression_vars = array();
// we only process those if and when we need them
foreach ($va_rules as $vs_rule_key => $va_rule) {
if ($t_instance->tableName() != $va_rule['table']) {
continue;
}
// check target
$vs_target = $va_rule['target'];
if (strlen($vs_target) < 1) {
Debug::msg("[prepopulateFields()] skipping rule {$vs_rule_key} because target is not set");
continue;
}
// check template
$vs_template = $va_rule['template'];
if (strlen($vs_template) < 1) {
Debug::msg("[prepopulateFields()] skipping rule {$vs_rule_key} because template is not set");
continue;
}
$vs_mode = caGetOption('mode', $va_rule, 'merge');
// respect restrictToTypes option
if ($va_rule['restrictToTypes'] && is_array($va_rule['restrictToTypes']) && sizeof($va_rule['restrictToTypes']) > 0) {
if (!in_array($t_instance->getTypeCode(), $va_rule['restrictToTypes'])) {
Debug::msg("[prepopulateFields()] skipping rule {$vs_rule_key} because current record type " . $t_instance->getTypeCode() . " is not in restrictToTypes");
continue;
}
}
// skip this rule if expression is true
if ($va_rule['skipIfExpression'] && strlen($va_rule['skipIfExpression']) > 0) {
$va_tags = caGetTemplateTags($va_rule['skipIfExpression']);
foreach ($va_tags as $vs_tag) {
if (!isset($va_expression_vars[$vs_tag])) {
$va_expression_vars[$vs_tag] = $t_instance->get($vs_tag, array('returnIdno' => true, 'delimiter' => ';'));
}
}
if (ExpressionParser::evaluate($va_rule['skipIfExpression'], $va_expression_vars)) {
Debug::msg("[prepopulateFields()] skipping rule {$vs_rule_key} because skipIfExpression evaluated true");
continue;
}
}
// evaluate template
$vs_value = caProcessTemplateForIDs($vs_template, $t_instance->tableNum(), array($t_instance->getPrimaryKey()), array('path' => true));
Debug::msg("[prepopulateFields()] processed template for rule {$vs_rule_key} value is: " . $vs_value);
// inject into target
$va_parts = explode('.', $vs_target);
// intrinsic or simple (non-container) attribute
if (sizeof($va_parts) == 2) {
// intrinsic
if ($t_instance->hasField($va_parts[1])) {
switch (strtolower($vs_mode)) {
case 'overwrite':
// always set
$t_instance->set($va_parts[1], $vs_value);
break;
case 'addifempty':
default:
if (!$t_instance->get($va_parts[1])) {
$t_instance->set($va_parts[1], $vs_value);
} else {
Debug::msg("[prepopulateFields()] rule {$vs_rule_key}: intrinsic skipped because it already has value and mode is addIfEmpty or merge");
}
break;
}
// attribute/element
} elseif ($t_instance->hasElement($va_parts[1])) {
$va_attributes = $t_instance->getAttributesByElement($va_parts[1]);
if (sizeof($va_attributes) > 1) {
Debug::msg("[prepopulateFields()] containers with multiple values are not supported");
continue;
}
switch (strtolower($vs_mode)) {
case 'overwrite':
// always replace first value we find
$t_instance->replaceAttribute(array($va_parts[1] => $vs_value, 'locale_id' => $g_ui_locale_id), $va_parts[1]);
break;
default:
case 'addifempty':
// only add value if none exists
if (!$t_instance->get($vs_target)) {
$t_instance->replaceAttribute(array($va_parts[1] => $vs_value, 'locale_id' => $g_ui_locale_id), $va_parts[1]);
}
break;
}
}
// "container"
} elseif (sizeof($va_parts) == 3) {
// actual container
if ($t_instance->hasElement($va_parts[1])) {
$va_attr = $t_instance->getAttributesByElement($va_parts[1]);
switch (sizeof($va_attr)) {
case 1:
switch (strtolower($vs_mode)) {
case 'overwrite':
$vo_attr = array_pop($va_attr);
$va_value = array($va_parts[2] => $vs_value);
foreach ($vo_attr->getValues() as $o_val) {
if ($o_val->getElementCode() != $va_parts[2]) {
$va_value[$o_val->getElementCode()] = $o_val->getDisplayValue();
}
}
$t_instance->_editAttribute($vo_attr->getAttributeID(), $va_value);
break;
case 'addifempty':
$vo_attr = array_pop($va_attr);
$va_value = array($va_parts[2] => $vs_value);
$vb_update = false;
foreach ($vo_attr->getValues() as $o_val) {
if ($o_val->getElementCode() != $va_parts[2]) {
$va_value[$o_val->getElementCode()] = $o_val->getDisplayValue();
} else {
if (!$o_val->getDisplayValue()) {
$vb_update = true;
}
}
}
if ($vb_update) {
$t_instance->editAttribute($vo_attr->getAttributeID(), $va_parts[1], $va_value);
}
break;
default:
Debug::msg("[prepopulateFields()] unsupported mode {$vs_mode} for target bundle");
break;
}
break;
case 0:
// if no container value exists, always add it (ignoring mode)
$t_instance->addAttribute(array($va_parts[2] => $vs_value, 'locale_id' => $g_ui_locale_id), $va_parts[1]);
break;
default:
Debug::msg("[prepopulateFields()] containers with multiple values are not supported");
break;
}
// labels
} elseif ($va_parts[1] == 'preferred_labels' || $va_parts[1] == 'nonpreferred_labels') {
$vb_preferred = $va_parts[1] == 'preferred_labels';
if (!($t_label = $t_instance->getAppDatamodel()->getInstanceByTableName($t_instance->getLabelTableName(), true))) {
continue;
}
if (!$t_label->hasField($va_parts[2])) {
continue;
}
switch ($t_instance->getLabelCount($vb_preferred)) {
case 0:
// if no value exists, always add it (ignoring mode)
$t_instance->addLabel(array($va_parts[2] => $vs_value), $g_ui_locale_id, null, $vb_preferred);
break;
case 1:
switch (strtolower($vs_mode)) {
case 'overwrite':
case 'addifempty':
$va_labels = $t_instance->getLabels(null, $vb_preferred ? __CA_LABEL_TYPE_PREFERRED__ : __CA_LABEL_TYPE_NONPREFERRED__);
if (sizeof($va_labels)) {
$va_labels = caExtractValuesByUserLocale($va_labels);
$va_label = array_shift($va_labels);
$va_label = $va_label[0];
$va_label[$va_parts[2]] = $vs_value;
$vb_update = false;
if (strtolower($vs_mode) == 'overwrite') {
$va_label[$va_parts[2]] = $vs_value;
$vb_update = true;
} else {
if (strlen(trim($va_label[$va_parts[2]])) == 0) {
// in addifempty mode only edit label when field is not set
$va_label[$va_parts[2]] = $vs_value;
$vb_update = true;
}
}
if ($vb_update) {
$t_instance->editLabel($va_label['label_id'], $va_label, $g_ui_locale_id, null, $vb_preferred);
}
} else {
$t_instance->addLabel(array($va_parts[2] => $vs_value), $g_ui_locale_id, null, $vb_preferred);
}
break;
default:
Debug::msg("[prepopulateFields()] unsupported mode {$vs_mode} for target bundle");
break;
}
break;
default:
Debug::msg("[prepopulateFields()] records with multiple labels are not supported");
break;
}
}
}
}
$vn_old_mode = $t_instance->getMode();
$t_instance->setMode(ACCESS_WRITE);
$t_instance->update();
$t_instance->setMode($vn_old_mode);
//$_REQUEST['form_timestamp'] = $vn_timestamp;
if ($t_instance->numErrors() > 0) {
foreach ($t_instance->getErrors() as $vs_error) {
Debug::msg("[prepopulateFields()] there was an error while updating the record: " . $vs_error);
}
if ($vb_we_set_transaction) {
$t_instance->removeTransaction(false);
}
return false;
}
if ($vb_we_set_transaction) {
$t_instance->removeTransaction(true);
}
return true;
}
/**
* @expectedException Exception
*/
public function testDetailDispatchWithInvalidType()
{
global $g_request;
$g_request->setParameter('id', $this->opt_moving_image->getPrimaryKey(), 'GET');
SimpleService::dispatch('testDetail', $g_request);
}
