/**
* Returns lot_id for the lot with the specified label (and type) or idno (regardless of specified type.) If the lot does not already
* exist then it will be created with the specified idno, name, type and locale, as well as with any specified values in the $pa_values array.
* $pa_values keys should be either valid lot fields or attributes.
*
* @param string $ps_idno_stub Lot identifier
* @param string $ps_lot_name Lot name
* @param int $pn_type_id The type_id of the object type to use if the object needs to be created
* @param int $pn_locale_id The locale_id to use if the object needs to be created (will be used for both the object locale as well as the label locale)
* @param array $pa_values An optional array of additional values to populate newly created object records with. These values are *only* used for newly created objects; they will not be applied if the object named already exists. The array keys should be names of ca_object_lots fields or valid object 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]
* dontCreate - if true then new lots will not be created [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.
* transaction - if Transaction object is passed, use it for all Db-related tasks [default=null]
* returnInstance = return ca_object_lots instance rather than object_id. Default is false.
* importEvent = if ca_data_import_events instance is passed then the insert/update of the object 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 lots. Each label in the array is an array with required lot label values.
* log = if KLogger instance is passed then actions will be logged
* @return bool|\ca_object_lots|mixed|null
*/
static function getObjectLotID($ps_idno_stub, $ps_lot_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_lot = new ca_object_lots();
if (isset($pa_options['transaction']) && $pa_options['transaction'] instanceof Transaction) {
$t_lot->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;
$vn_id = null;
if (preg_match('!\\%!', $ps_idno_stub)) {
$pa_options['generateIdnoWithTemplate'] = $ps_idno_stub;
$ps_idno_stub = null;
}
if (!$ps_idno_stub) {
if (isset($pa_options['generateIdnoWithTemplate']) && $pa_options['generateIdnoWithTemplate']) {
$ps_idno_stub = $t_lot->setIdnoWithTemplate($pa_options['generateIdnoWithTemplate'], array('dontSetValue' => true));
}
}
foreach ($pa_match_on as $vs_match_on) {
switch (strtolower($vs_match_on)) {
case 'label':
case 'labels':
if (trim($ps_lot_name)) {
if ($vn_id = ca_object_lots::find(array('preferred_labels' => array('name' => $ps_lot_name), 'type_id' => $pn_type_id), array('returnAs' => 'firstId', 'transaction' => $pa_options['transaction']))) {
break 2;
}
}
break;
case 'idno':
if ($ps_idno_stub == '%') {
break;
}
// don't try to match on an unreplaced idno placeholder
if ($vn_id = ca_object_lots::find(array('idno_stub' => $ps_idno_stub ? $ps_idno_stub : $ps_lot_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_object_lots', 'I');
}
$t_lot->setMode(ACCESS_WRITE);
$t_lot->set('locale_id', $pn_locale_id);
$t_lot->set('type_id', $pn_type_id);
$t_lot->set('lot_status_id', isset($pa_values['lot_status_id']) ? $pa_values['lot_status_id'] : null);
$t_lot->set('access', isset($pa_values['access']) ? $pa_values['access'] : 0);
$t_lot->set('status', isset($pa_values['status']) ? $pa_values['status'] : 0);
$t_lot->set('idno_stub', $ps_idno_stub);
$t_lot->insert();
if ($t_lot->numErrors()) {
if (isset($pa_options['outputErrors']) && $pa_options['outputErrors']) {
print "[Error] " . _t("Could not insert lot %1: %2", $ps_lot_name, join('; ', $t_lot->getErrors())) . "\n";
}
if ($o_log) {
$o_log->logError(_t("Could not insert lot %1: %2", $ps_lot_name, join('; ', $t_lot->getErrors())));
}
return null;
}
$vb_label_errors = false;
$t_lot->addLabel(array('name' => $ps_lot_name), $pn_locale_id, null, true);
if ($t_lot->numErrors()) {
if (isset($pa_options['outputErrors']) && $pa_options['outputErrors']) {
print "[Error] " . _t("Could not set preferred label for lot %1: %2", $ps_lot_name, join('; ', $t_lot->getErrors())) . "\n";
}
if ($o_log) {
$o_log->logError(_t("Could not set preferred label for lot %1: %2", $ps_lot_name, join('; ', $t_lot->getErrors())));
}
$vb_label_errors = true;
}
/** @var IIDNumbering $o_idno */
if ($o_idno = $t_lot->getIDNoPlugInInstance()) {
$va_values = $o_idno->htmlFormValuesAsArray('idno', $ps_idno_stub);
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 != $ps_idno_stub) {
$t_lot->set('idno', $vs_proc_idno);
$t_lot->update();
if ($t_lot->numErrors()) {
if (isset($pa_options['outputErrors']) && $pa_options['outputErrors']) {
print "[Error] " . _t("Could not update idno for %1: %2", $ps_lot_name, join('; ', $t_lot->getErrors())) . "\n";
}
if ($o_log) {
$o_log->logError(_t("Could not idno for %1: %2", $ps_lot_name, join('; ', $t_lot->getErrors())));
}
return null;
}
}
}
unset($pa_values['access']);
unset($pa_values['status']);
unset($pa_values['idno_stub']);
unset($pa_values['lot_status_id']);
$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_lot->addAttribute(array_merge($va_value, array('locale_id' => $pn_locale_id)), $vs_element);
} else {
// scalar value (simple single value attribute)
if ($va_value) {
$t_lot->addAttribute(array('locale_id' => $pn_locale_id, $vs_element => $va_value), $vs_element);
}
}
}
}
$t_lot->update();
if ($t_lot->numErrors()) {
if (isset($pa_options['outputErrors']) && $pa_options['outputErrors']) {
print "[Error] " . _t("Could not set values for lot %1: %2", $ps_lot_name, join('; ', $t_lot->getErrors())) . "\n";
}
if ($o_log) {
$o_log->logError(_t("Could not set values for lot %1: %2", $ps_lot_name, join('; ', $t_lot->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_lot->addLabel($va_label, $pn_locale_id, null, false);
if ($t_lot->numErrors()) {
if (isset($pa_options['outputErrors']) && $pa_options['outputErrors']) {
print "[Error] " . _t("Could not set non-preferred label for lot %1: %2", $ps_lot_name, join('; ', $t_lot->getErrors())) . "\n";
}
if ($o_log) {
$o_log->logError(_t("Could not set non-preferred label for lot %1: %2", $ps_lot_name, join('; ', $t_lot->getErrors())));
}
}
}
}
$vn_lot_id = $t_lot->getPrimaryKey();
if ($o_event) {
if ($vb_attr_errors || $vb_label_errors) {
$o_event->endItem($vn_lot_id, __CA_DATA_IMPORT_ITEM_PARTIAL_SUCCESS__, _t("Errors setting field values: %1", join('; ', $t_lot->getErrors())));
} else {
$o_event->endItem($vn_lot_id, __CA_DATA_IMPORT_ITEM_SUCCESS__, '');
}
}
if ($o_log) {
$o_log->logInfo(_t("Created new lot %1", $ps_lot_name));
}
if (isset($pa_options['returnInstance']) && $pa_options['returnInstance']) {
return $t_lot;
}
} else {
if ($o_event) {
$o_event->beginItem($vs_event_source, 'ca_object_lots', 'U');
}
$vn_lot_id = $vn_id;
if ($o_event) {
$o_event->endItem($vn_lot_id, __CA_DATA_IMPORT_ITEM_SUCCESS__, '');
}
if ($o_log) {
$o_log->logDebug(_t("Found existing lot %1 in DataMigrationUtils::getObjectLotID()", $ps_lot_name));
}
if (isset($pa_options['returnInstance']) && $pa_options['returnInstance']) {
$t_lot = new ca_object_lots($vn_lot_id);
if (isset($pa_options['transaction']) && $pa_options['transaction'] instanceof Transaction) {
$t_lot->setTransaction($pa_options['transaction']);
}
return $t_lot;
}
}
return $vn_lot_id;
}
