/**
* Returns movement_id for the movement with the specified name, regardless of specified type. If the movement does not already
* exist then it will be created with the specified name, type and locale, as well as with any specified values in the $pa_values array.
* $pa_values keys should be either valid movement fields or attributes.
*
* @param string $ps_movement_name movement label name
* @param int $pn_type_id The type_id of the movement type to use if the movement needs to be created
* @param int $pn_locale_id The locale_id to use if the movement needs to be created (will be used for both the movement locale as well as the label locale)
* @param array $pa_values An optional array of additional values to populate newly created movement records with. These values are *only* used for newly created movements; they will not be applied if the movement named already exists. The array keys should be names of movement fields or valid movement attributes. Values should be either a scalar (for single-value attributes) or an array of values for (multi-valued attributes)
* @param array $pa_options An optional array of options, which include:
* outputErrors - if true, errors will be printed to console [default=false]
* matchOnIdno - try to match on idno if name match fails [default=false]
* dontCreate - if true then new movements will not be created [default=false]
* transaction - if Transaction object is passed, use it for all Db-related tasks [default=null]
* returnInstance = return ca_movements instance rather than movement_id. Default is false.
* generateIdnoWithTemplate = A template to use when setting the idno. The template is a value with automatically-set SERIAL values replaced with % characters. Eg. 2012.% will set the created row's idno value to 2012.121 (assuming that 121 is the next number in the serial sequence.) The template is NOT used if idno is passed explicitly as a value in $pa_values.
* importEvent = if ca_data_import_events instance is passed then the insert/update of the movement will be logged as part of the import
* importEventSource = if importEvent is passed, then the value set for importEventSource is used in the import event log as the data source. If omitted a default value of "?" is used
* log = if KLogger instance is passed then actions will be logged
*/
static function getMovementID($ps_movement_name, $pn_type_id, $pn_locale_id, $pa_values = null, $pa_options = null)
{
if (!is_array($pa_options)) {
$pa_options = array();
}
if (!isset($pa_options['outputErrors'])) {
$pa_options['outputErrors'] = false;
}
$pb_match_on_idno = caGetOption('matchOnIdno', $pa_options, false);
$t_movement = new ca_movements();
if (isset($pa_options['transaction']) && $pa_options['transaction'] instanceof Transaction) {
$t_movement->setTransaction($pa_options['transaction']);
}
$o_event = isset($pa_options['importEvent']) && $pa_options['importEvent'] instanceof ca_data_import_events ? $pa_options['importEvent'] : null;
$vs_event_source = isset($pa_options['importEventSource']) && $pa_options['importEventSource'] ? $pa_options['importEventSource'] : "?";
$o_log = isset($pa_options['log']) && $pa_options['log'] instanceof KLogger ? $pa_options['log'] : null;
$va_find_arr = array();
if ($pn_type_id) {
$va_find_arr['type_id'] = $pn_type_id;
}
if ($pn_parent_id) {
$va_find_arr['parent_id'] = $pn_parent_id;
}
if (!($vs_idno = isset($pa_values['idno']) ? (string) $pa_values['idno'] : null)) {
if (isset($pa_options['generateIdnoWithTemplate']) && $pa_options['generateIdnoWithTemplate']) {
$vs_idno = $t_movement->setIdnoTWithTemplate($pa_options['generateIdnoWithTemplate'], array('dontSetValue' => true));
}
}
if (!($vn_id = ca_movements::find(array_merge(array('preferred_labels' => array('name' => $ps_movement_name)), $va_find_arr), array('returnAs' => 'firstId', 'transaction' => $pa_options['transaction'])))) {
if ($pb_match_on_idno && $vs_idno) {
$va_find_arr['idno'] = $vs_idno;
$vn_id = ca_movements::find($va_find_arr, array('returnAs' => 'firstId', 'transaction' => $pa_options['transaction']));
}
}
if (!$vn_id) {
if (isset($pa_options['dontCreate']) && $pa_options['dontCreate']) {
return false;
}
if ($o_event) {
$o_event->beginItem($vs_event_source, 'ca_movements', 'I');
}
$t_movement->setMode(ACCESS_WRITE);
$t_movement->set('locale_id', $pn_locale_id);
$t_movement->set('type_id', $pn_type_id);
$t_movement->set('access', isset($pa_values['access']) ? $pa_values['access'] : 0);
$t_movement->set('status', isset($pa_values['status']) ? $pa_values['status'] : 0);
$t_movement->set('idno', $vs_idno);
$t_movement->set('parent_id', isset($pa_values['parent_id']) ? $pa_values['parent_id'] : null);
$t_movement->insert();
if ($t_movement->numErrors()) {
if (isset($pa_options['outputErrors']) && $pa_options['outputErrors']) {
print "[Error] " . _t("Could not insert movement %1: %2", $ps_movement_name, join('; ', $t_movement->getErrors())) . "\n";
}
if ($o_log) {
$o_log->logError(_t("Could not insert movement %1: %2", $ps_movement_name, join('; ', $t_movement->getErrors())));
}
return null;
}
$vb_label_errors = false;
$t_movement->addLabel(array('name' => $ps_movement_name), $pn_locale_id, null, true);
if ($t_movement->numErrors()) {
if (isset($pa_options['outputErrors']) && $pa_options['outputErrors']) {
print "[Error] " . _t("Could not set preferred label for movement %1: %2", $ps_movement_name, join('; ', $t_movement->getErrors())) . "\n";
}
if ($o_log) {
$o_log->logError(_t("Could not set preferred label for movement %1: %2", $ps_movement_name, join('; ', $t_movement->getErrors())));
}
$vb_label_errors = true;
}
unset($pa_values['access']);
unset($pa_values['status']);
unset($pa_values['idno']);
$vb_attr_errors = false;
if (is_array($pa_values)) {
foreach ($pa_values as $vs_element => $va_value) {
if (is_array($va_value)) {
// array of values (complex multi-valued attribute)
$t_movement->addAttribute(array_merge($va_value, array('locale_id' => $pn_locale_id)), $vs_element);
} else {
// scalar value (simple single value attribute)
if ($va_value) {
$t_movement->addAttribute(array('locale_id' => $pn_locale_id, $vs_element => $va_value), $vs_element);
}
}
}
}
$t_movement->update();
if ($t_movement->numErrors()) {
if (isset($pa_options['outputErrors']) && $pa_options['outputErrors']) {
print "[Error] " . _t("Could not set values for movement %1: %2", $ps_movement_name, join('; ', $t_movement->getErrors())) . "\n";
}
if ($o_log) {
$o_log->logError(_t("Could not set values for movement %1: %2", $ps_movement_name, join('; ', $t_movement->getErrors())));
}
$vb_attr_errors = true;
}
$vn_movement_id = $t_movement->getPrimaryKey();
if ($o_event) {
if ($vb_attr_errors || $vb_label_errors) {
$o_event->endItem($vn_movement_id, __CA_DATA_IMPORT_ITEM_PARTIAL_SUCCESS__, _t("Errors setting field values: %1", join('; ', $t_movement->getErrors())));
} else {
$o_event->endItem($vn_movement_id, __CA_DATA_IMPORT_ITEM_SUCCESS__, '');
}
}
if ($o_log) {
$o_log->logInfo(_t("Created new movement %1", $ps_movement_name));
}
if (isset($pa_options['returnInstance']) && $pa_options['returnInstance']) {
return $t_movement;
}
} else {
if ($o_event) {
$o_event->beginItem($vs_event_source, 'ca_movements', 'U');
}
$vn_movement_id = $vn_id;
if ($o_event) {
$o_event->endItem($vn_movement_id, __CA_DATA_IMPORT_ITEM_SUCCESS__, '');
}
if ($o_log) {
$o_log->logDebug(_t("Found existing movement %1 in DataMigrationUtils::getMovementID(); total of %2 movements were found", $ps_movement_name, sizeof($va_movement_ids) + 1));
}
if (isset($pa_options['returnInstance']) && $pa_options['returnInstance']) {
return new ca_movements($vn_load_id);
}
}
return $vn_movement_id;
}
/**
* Returns movement_id for the movement with the specified name (and type) or idno (regardless of specified type.) If the movement does not already
* exist then it will be created with the specified name, type and locale, as well as with any specified values in the $pa_values array.
* $pa_values keys should be either valid movement fields or attributes.
*
* @param string $ps_movement_name movement label name
* @param int $pn_type_id The type_id of the movement type to use if the movement needs to be created
* @param int $pn_locale_id The locale_id to use if the movement needs to be created (will be used for both the movement locale as well as the label locale)
* @param array $pa_values An optional array of additional values to populate newly created movement records with. These values are *only* used for newly created movements; they will not be applied if the movement named already exists. The array keys should be names of movement fields or valid movement attributes. Values should be either a scalar (for single-value attributes) or an array of values for (multi-valued attributes)
* @param array $pa_options An optional array of options, which include:
* outputErrors - if true, errors will be printed to console [default=false]
* matchOn = optional list indicating sequence of checks for an existing record; values of array can be "label" and "idno". Ex. array("idno", "label") will first try to match on idno and then label if the first match fails.
* dontCreate - if true then new movements will not be created [default=false]
* transaction - if Transaction object is passed, use it for all Db-related tasks [default=null]
* returnInstance = return ca_movements instance rather than movement_id. Default is false.
* generateIdnoWithTemplate = A template to use when setting the idno. The template is a value with automatically-set SERIAL values replaced with % characters. Eg. 2012.% will set the created row's idno value to 2012.121 (assuming that 121 is the next number in the serial sequence.) The template is NOT used if idno is passed explicitly as a value in $pa_values.
* importEvent = if ca_data_import_events instance is passed then the insert/update of the movement will be logged as part of the import
* importEventSource = if importEvent is passed, then the value set for importEventSource is used in the import event log as the data source. If omitted a default value of "?" is used
* nonPreferredLabels = an optional array of nonpreferred labels to add to any newly created movements. Each label in the array is an array with required movement label values.
* log = if KLogger instance is passed then actions will be logged
* @return bool|\ca_movements|mixed|null
*/
static function getMovementID($ps_movement_name, $pn_type_id, $pn_locale_id, $pa_values = null, $pa_options = null)
{
if (!is_array($pa_options)) {
$pa_options = array();
}
if (!isset($pa_options['outputErrors'])) {
$pa_options['outputErrors'] = false;
}
$pa_match_on = caGetOption('matchOn', $pa_options, array('label', 'idno'), array('castTo' => "array"));
/** @var ca_data_import_events $o_event */
$o_event = isset($pa_options['importEvent']) && $pa_options['importEvent'] instanceof ca_data_import_events ? $pa_options['importEvent'] : null;
$t_movement = new ca_movements();
if (isset($pa_options['transaction']) && $pa_options['transaction'] instanceof Transaction) {
$t_movement->setTransaction($pa_options['transaction']);
if ($o_event) {
$o_event->setTransaction($pa_options['transaction']);
}
}
$vs_event_source = isset($pa_options['importEventSource']) && $pa_options['importEventSource'] ? $pa_options['importEventSource'] : "?";
/** @var KLogger $o_log */
$o_log = isset($pa_options['log']) && $pa_options['log'] instanceof KLogger ? $pa_options['log'] : null;
$vs_idno = isset($pa_values['idno']) ? (string) $pa_values['idno'] : null;
if (preg_match('!\\%!', $vs_idno)) {
$pa_options['generateIdnoWithTemplate'] = $vs_idno;
$vs_idno = null;
}
if (!$vs_idno) {
if (isset($pa_options['generateIdnoWithTemplate']) && $pa_options['generateIdnoWithTemplate']) {
$vs_idno = $t_movement->setIdnoWithTemplate($pa_options['generateIdnoWithTemplate'], array('dontSetValue' => true));
}
}
$vn_id = null;
foreach ($pa_match_on as $vs_match_on) {
switch (strtolower($vs_match_on)) {
case 'label':
case 'labels':
if (trim($ps_movement_name)) {
if ($vn_id = ca_movements::find(array('preferred_labels' => array('name' => $ps_movement_name), 'type_id' => $pn_type_id, 'parent_id' => caGetOption('parent_id', $pa_options, null)), array('returnAs' => 'firstId', 'transaction' => $pa_options['transaction']))) {
break 2;
}
break;
}
case 'idno':
if ($vs_idno == '%') {
break;
}
// don't try to match on an unreplaced idno placeholder
if ($vn_id = ca_movements::find(array('idno' => $vs_idno ? $vs_idno : $ps_movement_name), array('returnAs' => 'firstId', 'transaction' => $pa_options['transaction']))) {
break 2;
}
break;
}
}
if (!$vn_id) {
if (isset($pa_options['dontCreate']) && $pa_options['dontCreate']) {
return false;
}
if ($o_event) {
$o_event->beginItem($vs_event_source, 'ca_movements', 'I');
}
$t_movement->setMode(ACCESS_WRITE);
$t_movement->set('locale_id', $pn_locale_id);
$t_movement->set('type_id', $pn_type_id);
$t_movement->set('access', isset($pa_values['access']) ? $pa_values['access'] : 0);
$t_movement->set('status', isset($pa_values['status']) ? $pa_values['status'] : 0);
$t_movement->set('idno', $vs_idno);
$t_movement->set('parent_id', isset($pa_values['parent_id']) ? $pa_values['parent_id'] : null);
$t_movement->insert();
if ($t_movement->numErrors()) {
if (isset($pa_options['outputErrors']) && $pa_options['outputErrors']) {
print "[Error] " . _t("Could not insert movement %1: %2", $ps_movement_name, join('; ', $t_movement->getErrors())) . "\n";
}
if ($o_log) {
$o_log->logError(_t("Could not insert movement %1: %2", $ps_movement_name, join('; ', $t_movement->getErrors())));
}
return null;
}
$vb_label_errors = false;
$t_movement->addLabel(array('name' => $ps_movement_name), $pn_locale_id, null, true);
if ($t_movement->numErrors()) {
if (isset($pa_options['outputErrors']) && $pa_options['outputErrors']) {
print "[Error] " . _t("Could not set preferred label for movement %1: %2", $ps_movement_name, join('; ', $t_movement->getErrors())) . "\n";
}
if ($o_log) {
$o_log->logError(_t("Could not set preferred label for movement %1: %2", $ps_movement_name, join('; ', $t_movement->getErrors())));
}
$vb_label_errors = true;
}
/** @var IIDNumbering $o_idno */
if ($o_idno = $t_movement->getIDNoPlugInInstance()) {
$va_values = $o_idno->htmlFormValuesAsArray('idno', $vs_idno);
if (!is_array($va_values)) {
$va_values = array($va_values);
}
if (!($vs_sep = $o_idno->getSeparator())) {
$vs_sep = '';
}
if (($vs_proc_idno = join($vs_sep, $va_values)) && $vs_proc_idno != $vs_idno) {
$t_movement->set('idno', $vs_proc_idno);
$t_movement->update();
if ($t_movement->numErrors()) {
if (isset($pa_options['outputErrors']) && $pa_options['outputErrors']) {
print "[Error] " . _t("Could not update idno for %1: %2", $ps_movement_name, join('; ', $t_movement->getErrors())) . "\n";
}
if ($o_log) {
$o_log->logError(_t("Could not update idno for %1: %2", $ps_movement_name, join('; ', $t_movement->getErrors())));
}
return null;
}
}
}
unset($pa_values['access']);
unset($pa_values['status']);
unset($pa_values['idno']);
$vb_attr_errors = false;
if (is_array($pa_values)) {
foreach ($pa_values as $vs_element => $va_values) {
if (!caIsIndexedArray($va_values)) {
$va_values = array($va_values);
}
foreach ($va_values as $va_value) {
if (is_array($va_value)) {
// array of values (complex multi-valued attribute)
$t_movement->addAttribute(array_merge($va_value, array('locale_id' => $pn_locale_id)), $vs_element);
} else {
// scalar value (simple single value attribute)
if ($va_value) {
$t_movement->addAttribute(array('locale_id' => $pn_locale_id, $vs_element => $va_value), $vs_element);
}
}
}
}
$t_movement->update();
if ($t_movement->numErrors()) {
if (isset($pa_options['outputErrors']) && $pa_options['outputErrors']) {
print "[Error] " . _t("Could not set values for movement %1: %2", $ps_movement_name, join('; ', $t_movement->getErrors())) . "\n";
}
if ($o_log) {
$o_log->logError(_t("Could not set values for movement %1: %2", $ps_movement_name, join('; ', $t_movement->getErrors())));
}
$vb_attr_errors = true;
}
}
if (is_array($va_nonpreferred_labels = caGetOption("nonPreferredLabels", $pa_options, null))) {
if (caIsAssociativeArray($va_nonpreferred_labels)) {
// single non-preferred label
$va_labels = array($va_nonpreferred_labels);
} else {
// list of non-preferred labels
$va_labels = $va_nonpreferred_labels;
}
foreach ($va_labels as $va_label) {
$t_movement->addLabel($va_label, $pn_locale_id, null, false);
if ($t_movement->numErrors()) {
if (isset($pa_options['outputErrors']) && $pa_options['outputErrors']) {
print "[Error] " . _t("Could not set non-preferred label for movement %1: %2", $ps_movement_name, join('; ', $t_movement->getErrors())) . "\n";
}
if ($o_log) {
$o_log->logError(_t("Could not set non-preferred label for movement %1: %2", $ps_movement_name, join('; ', $t_movement->getErrors())));
}
}
}
}
$vn_movement_id = $t_movement->getPrimaryKey();
if ($o_event) {
if ($vb_attr_errors || $vb_label_errors) {
$o_event->endItem($vn_movement_id, __CA_DATA_IMPORT_ITEM_PARTIAL_SUCCESS__, _t("Errors setting field values: %1", join('; ', $t_movement->getErrors())));
} else {
$o_event->endItem($vn_movement_id, __CA_DATA_IMPORT_ITEM_SUCCESS__, '');
}
}
if ($o_log) {
$o_log->logInfo(_t("Created new movement %1", $ps_movement_name));
}
if (isset($pa_options['returnInstance']) && $pa_options['returnInstance']) {
return $t_movement;
}
} else {
if ($o_event) {
$o_event->beginItem($vs_event_source, 'ca_movements', 'U');
}
$vn_movement_id = $vn_id;
if ($o_event) {
$o_event->endItem($vn_movement_id, __CA_DATA_IMPORT_ITEM_SUCCESS__, '');
}
if ($o_log) {
$o_log->logDebug(_t("Found existing movement %1 in DataMigrationUtils::getMovementID()", $ps_movement_name));
}
if (isset($pa_options['returnInstance']) && $pa_options['returnInstance']) {
$t_movement = new ca_movements($vn_movement_id);
if (isset($pa_options['transaction']) && $pa_options['transaction'] instanceof Transaction) {
$t_movement->setTransaction($pa_options['transaction']);
}
return $t_movement;
}
}
return $vn_movement_id;
}