node
$issuerNode = $invoiceNode->getElementsByTagName('issuer')->item(0);
// create the two element nodes that should be added
$uidNode = $dom->createElement('uid', $invoice_uid);
$markNode = $dom->createElement('mark', $invoice_mark);
// take care of the mark node first, because it will go after uid
$invoiceNode->insertBefore($markNode, $issuerNode);
// take care of the uid node, by placing it before the mark node
$invoiceNode->insertBefore($uidNode, $markNode);
// update the final XML content before it gets saved
$correlated_einv_final_xml = $dom->saveXML();
}
// prepare data transmission values to be updated
$config_param_name = $this->getCorrelatedInvoiceParamName($extras['einvid'], $extras['bid']);
$env_fee_data['xml'] = $correlated_einv_final_xml;
$env_fee_data['transmission'] = [
'ts' => time(),
'uid' => $invoice_uid,
'mark' => $invoice_mark,
'qrurl' => $invoice_qrcode,
'qrcode_img' => '',
'pdf' => '',
];
if ($invoice_qrcode) {
// generate the QR Code for the environmental fee invoice as well
// the QR Code PNG file name
$filename = "aade_qrcode_env_{$extras['bid']}_{$extras['einvid']}.png";
if ($this->generateQRCodeImage($invoice_qrcode, VikBookingMydataAadeConstants::getQRCodeBase('path', $filename))) {
// set the QR Code image property
$env_fee_data['transmission']['qrcode_img'] = $filename;
}
}
// immediately update data transmission values before generating the PDF invoice
VBOFactory::getConfig()->set($config_param_name, $env_fee_data);
// generate the PDF (courtesy) for the correlated invoice (will set the PDF path in case of success)
if ($this->generateAnalogicEnvFeeInvoice($env_fee_data)) {
// update data transmission values again, as they will contain the path to the PDF file
VBOFactory::getConfig()->set($config_param_name, $env_fee_data);
}
return true;
}
// at this point we expect an error
if (!isset($res_obj->response->errors) || !isset($res_obj->response->errors->error)) {
// errors should be set, but if they aren't, this is unexpected
$this->setError('Unexpected nodes in XML response (missing errors or error)');
$this->setError('' . htmlentities($response->body) . '
');
return false;
}
// loop through the errors
foreach ($res_obj->response->errors->error as $resp_err) {
$err_code = isset($resp_err->code) ? (string)$resp_err->code : '0';
$err_mess = isset($resp_err->message) ? (string)$resp_err->message : '???';
$this->setError(sprintf('Error (%s): %s', $err_code, $err_mess));
}
return false;
}
/**
* Generates a PDF file for the correlated invoice for the environmental fee.
*
* @param array &$env_fee_data the raw environmental fee information data.
*
* @return bool
*
* @since 1.16.7 (J) - 1.6.7 (WP)
*/
public function generateAnalogicEnvFeeInvoice(&$env_fee_data)
{
// get the customer information
$customer = VikBooking::getCPinInstance()->getCustomerFromBooking($env_fee_data['bid']);
// build a dummy invoice associative array with the information required
$invoice = [
'id' => -1,
'number' => $this->getPreviousCorrelatedInvoiceData($env_fee_data['einvid'], $env_fee_data['bid']),
'for_date' => strtotime($this->getPreviousCorrelatedInvoiceData($env_fee_data['einvid'], $env_fee_data['bid'], 'date')),
'rawcont' => [
'totalnet' => 0,
'totaltax' => $env_fee_data['envfee']['fee_cost'],
'totaltot' => $env_fee_data['envfee']['fee_cost'],
'rows' => [
[
'service' => $env_fee_data['envfee']['name'],
'net' => 0,
'tax' => $env_fee_data['envfee']['fee_cost'],
'tot' => $env_fee_data['envfee']['fee_cost'],
],
],
],
'env_fee_data' => $env_fee_data,
'feeseries' => 'C',
];
// load the custom invoice template file
list($invoice_tmpl, $pdfparams) = VikBooking::loadCustomInvoiceTmpl($invoice, $customer);
// trigger an event to allow third-party plugins to manipulate the content of the custom invoice
VBOFactory::getPlatform()->getDispatcher()->trigger('onMydataBeforeGenerateEnvFeeCourtesyInvoice', [$env_fee_data, $invoice, $invoice_tmpl]);
// parse the content of the template file
$invoice_body = VikBooking::parseCustomInvoiceTemplate($invoice_tmpl, $invoice, $customer);
// reload booking details
$booking_details = VikBooking::getBookingInfoFromID($env_fee_data['bid']);
// force the execution of the conditional text rules
VikBooking::getConditionalRulesInstance()
->set(
[
'booking',
'rooms',
],
[
$booking_details,
VikBooking::loadOrdersRoomsData($env_fee_data['bid']),
]
)
->parseTokens($invoice_body);
// load dependencies
if (!class_exists('TCPDF')) {
require_once(VBO_SITE_PATH . DIRECTORY_SEPARATOR . "helpers" . DIRECTORY_SEPARATOR . "tcpdf" . DIRECTORY_SEPARATOR . 'tcpdf.php');
}
$usepdffont = is_file(VBO_SITE_PATH . DIRECTORY_SEPARATOR . "helpers" . DIRECTORY_SEPARATOR . "tcpdf" . DIRECTORY_SEPARATOR . "fonts" . DIRECTORY_SEPARATOR . "dejavusans.php") ? 'dejavusans' : 'helvetica';
/**
* Trigger event to allow third party plugins to return a specific font name.
*/
$custom_pdf_font = VBOFactory::getPlatform()->getDispatcher()->filter('onGetPdfFontNameVikBooking', [$usepdffont]);
if (is_array($custom_pdf_font) && !empty($custom_pdf_font[0])) {
$usepdffont = $custom_pdf_font[0];
}
// write the PDF on file
$pdffname = implode('_', ['envfee', $booking_details['id'], ($booking_details['sid'] ?: $booking_details['ts'])]) . '.pdf';
$pathpdf = VBO_SITE_PATH . DIRECTORY_SEPARATOR . "helpers" . DIRECTORY_SEPARATOR . "invoices" . DIRECTORY_SEPARATOR . "generated" . DIRECTORY_SEPARATOR . $pdffname;
if (is_file($pathpdf)) {
@unlink($pathpdf);
}
$pdf_page_format = is_array($pdfparams['pdf_page_format']) ? $pdfparams['pdf_page_format'] : constant($pdfparams['pdf_page_format']);
$pdf = new TCPDF(constant($pdfparams['pdf_page_orientation']), constant($pdfparams['pdf_unit']), $pdf_page_format, true, 'UTF-8', false);
$pdf->SetTitle(JText::translate('VBOINVNUM') . ' ' . $invoice['number']);
// header for each page of the pdf
if ($pdfparams['show_header'] == 1 && count($pdfparams['header_data']) > 0) {
$pdf->SetHeaderData($pdfparams['header_data'][0], $pdfparams['header_data'][1], $pdfparams['header_data'][2], $pdfparams['header_data'][3], $pdfparams['header_data'][4], $pdfparams['header_data'][5]);
}
// change some currencies to their unicode (decimal) value
$currencyname = VikBooking::getCurrencyName();
$unichr_map = array('EUR' => 8364, 'USD' => 36, 'AUD' => 36, 'CAD' => 36, 'GBP' => 163);
if (array_key_exists($currencyname, $unichr_map)) {
$invoice_body = str_replace($currencyname, TCPDF_FONTS::unichr($unichr_map[$currencyname]), $invoice_body);
}
// header and footer fonts
$pdf->setHeaderFont(array($usepdffont, '', $pdfparams['header_font_size']));
$pdf->setFooterFont(array($usepdffont, '', $pdfparams['footer_font_size']));
// margins
$pdf->SetMargins(constant($pdfparams['pdf_margin_left']), constant($pdfparams['pdf_margin_top']), constant($pdfparams['pdf_margin_right']));
$pdf->SetHeaderMargin(constant($pdfparams['pdf_margin_header']));
$pdf->SetFooterMargin(constant($pdfparams['pdf_margin_footer']));
$pdf->SetAutoPageBreak(true, constant($pdfparams['pdf_margin_bottom']));
$pdf->setImageScale(constant($pdfparams['pdf_image_scale_ratio']));
$pdf->SetFont($usepdffont, '', (int)$pdfparams['body_font_size']);
if ($pdfparams['show_header'] == 0 || !$pdfparams['header_data']) {
$pdf->SetPrintHeader(false);
}
if ($pdfparams['show_footer'] == 0) {
$pdf->SetPrintFooter(false);
}
$pdf->AddPage();
$pdf->writeHTML($invoice_body, true, false, true, false, '');
$pdf->lastPage();
$pdf->Output($pathpdf, 'F');
if (!is_file($pathpdf)) {
return false;
}
if (VBOPlatformDetection::isWordPress()) {
/**
* @wponly - trigger files mirroring
*/
VikBookingLoader::import('update.manager');
VikBookingUpdateManager::triggerUploadBackup($pathpdf);
}
// set the PDF file name at last
$env_fee_data['transmission']['pdf'] = $pdffname;
return true;
}
/**
* Returns the calculated tariffs given their IDs per room booked.
*
* @param array $booking the booking array with one array-room per array value
*
* @return array associative array of tariffs for each room booked
*/
protected function getBookingTariffs($booking)
{
$tars = [];
$is_package = (!empty($booking[0]['pkg']));
foreach ($booking as $kor => $or) {
$num = $kor + 1;
if ($is_package || (!empty($or['cust_cost']) && $or['cust_cost'] > 0.00)) {
// package or custom cost set from the back-end does not need calculation
continue;
}
$q = "SELECT * FROM `#__vikbooking_dispcost` WHERE `id`=".(int)$or['idtar'].";";
$this->dbo->setQuery($q);
$tar = $this->dbo->loadAssocList();
if ($tar) {
$tar = VikBooking::applySeasonsRoom($tar, $or['checkin'], $or['checkout']);
// apply OBP rules
$tar = VBORoomHelper::getInstance()->applyOBPRules($tar, $or, $or['adults']);
$tars[$num] = $tar[0];
}
}
return $tars;
}
/**
* Transmits the electronic invoices to myDATA according to the input parameters.
* This is a 'driver action', and so it's called before getBookingsData()
* in the view. This method will save/update records in the DB so that when
* the view re-calls getBookingsData(), the information will be up to date.
*
* @return boolean True if at least one e-invoice was transmitted
*/
public function transmitEInvoices()
{
// make sure the transmission settings are not empty
$settings = $this->loadSettings();
if ($settings === false || !$settings['params']) {
$this->setError('Missing settings to transmit the invoices. Please set up the driver settings first.');
return false;
}
// make sure the settings we need are not empty
$required = [
$settings['params']['aade_user_id'],
$settings['params']['aade_subscription_key'],
];
foreach ($required as $reqset) {
if (empty($reqset)) {
$this->setError('Invalid settings to transmit the invoices. Please make sure to provide all the information from the driver settings.');
return false;
}
}
// call the main method to generate rows, cols and bookings array
$this->getBookingsData();
if ($this->getError() || !$this->bookings) {
return false;
}
// get the driver ID
$driver_id = $this->getDriverId();
// pool of e-invoice IDs to transmit
$einvspool = [];
$einvnumbs = [];
// electronic invoices IDs referenced to booking IDs
$einvs_bids_ref = [];
// list of eco-fee-only invoices to be (re-)transmitted
$ecofee_einvs_retn = [];
foreach ($this->bookings as $gbook) {
// check whether this booking ID was set to be skipped from transmission
$exclude = VikRequest::getInt('excludesendbid'.$gbook[0]['id'], 0, 'request');
if ($exclude > 0) {
// skipping this invoice from transmission
continue;
}
// make sure an electronic invoice was already issued for this booking ID by this driver
if (empty($gbook[0]['einvid']) || $gbook[0]['einvdriver'] != $this->getDriverId()) {
// no e-invoices available for this booking, skipping
continue;
}
// check if an e-invoice was already sent for this booking
if ($gbook[0]['einvsent'] > 0) {
$resend = VikRequest::getInt('resendbid'.$gbook[0]['id'], 0, 'request');
$resendecofee = VikRequest::getInt('resendecofeebid'.$gbook[0]['id'], 0, 'request');
if ($resendecofee) {
// push record for the eco-fee invoice re-transmit only
$ecofee_einvs_retn[] = $gbook[0];
continue;
}
if (!$resend) {
// we do not re-send the invoice for this booking ID
continue;
}
}
// push e-invoice ID to the pool
array_push($einvspool, $gbook[0]['einvid']);
// push also the corresponding invoice number
array_push($einvnumbs, $gbook[0]['einvnum']);
// set the e-invoice ID/booking ID relation
$einvs_bids_ref[$gbook[0]['einvid']] = $gbook[0]['id'];
}
if ($einvspool && $ecofee_einvs_retn) {
// pre-check: conflict with re-transmission of eco-fee invoice(s) and main invoice first transmission or re-transmission
$this->setWarning('If you choose to re-transmit just eco-fee invoices, then any other main invoice should be excluded from the transmission to avoid conflicts.');
return false;
}
if (!$ecofee_einvs_retn) {
// attempt to transmit or re-transmit the main invoices with their (eventually) related eco-fee invoices
if (!$einvspool) {
// no e-invoices generated or ready to be transmitted
$this->setWarning('No e-invoices generated or ready to be transmitted to myDATA. Please generate first the XML invoices or select some for the re-transmission.');
return false;
}
// build one XML file for all XML e-invoices (if more than one)
$einv_xml_body = $this->buildTransmissionXMLBody($einvspool, $settings);
if ($einv_xml_body === false) {
// something went wrong with the creation of the XML file
$this->setError('Error creating the XML file for the request. Unable to proceed.');
return false;
}
if ($this->debugging()) {
// when in debug mode, the raw XML request is sent to output
$this->setWarning('Raw XML request for Debug Mode');
$this->setWarning(' ' . htmlentities($einv_xml_body) . '
');
}
// transmit e-invoices to myDATA
$response = $this->myDATARequestPOST('SendInvoices', $einv_xml_body, $settings);
if ($response->code != 200) {
// the request was not successful, and the XML invoices were not parsed at all by myDATA
$this->setError(sprintf('Invalid response (code %s): %s', $response->code, htmlspecialchars($response->body)));
$this->setError('Could not send the invoice(s) to myDATA.');
return false;
}
if ($this->debugging()) {
// when in debug mode, the raw XML response is sent to output
$this->setWarning('Raw XML response for Debug Mode');
$this->setWarning(' ' . htmlentities($response->body) . '
');
}
// check if the XML response contains errors, and adjust the e-invoices that succeeded
list($success, $valid_einv_marks, $valid_einv_uids, $valid_qrcode_urls) = $this->myDATAParseXMLResponse($response->body, $einvspool, $einvnumbs);
if (!$success) {
// some errors occurred
if (!is_array($valid_einv_marks) || !$valid_einv_marks) {
$this->setError('Could not send the invoice(s) to myDATA.');
return false;
} else {
// some e-invoices were transmitted successfully
$einvspool = array_keys($valid_einv_marks);
}
}
// update ProgressivoInvio driver setting by increasing it for the next run
$this->updateProgressiveNumber(++$settings['progcount']);
// set to transmitted=1 all e-invoice IDs that were transmitted with success
foreach ($einvspool as $einvid) {
// find the corresponding booking ID
$einv_bid = $einvs_bids_ref[$einvid] ?? 0;
// flag to check if the PDF invoice should be refreshed
$qrcode_fname = null;
// prepare "transmission data" object
$trans_data = new stdClass;
$trans_data->invoice_uid = (isset($valid_einv_uids[$einvid]) && $einvid != $valid_einv_uids[$einvid] ? $valid_einv_uids[$einvid] : null);
$trans_data->invoice_mark = (isset($valid_einv_marks[$einvid]) && $einvid != $valid_einv_marks[$einvid] ? $valid_einv_marks[$einvid] : null);
$trans_data->invoice_qrcode = (isset($valid_qrcode_urls[$einvid]) && $einvid != $valid_qrcode_urls[$einvid] ? $valid_qrcode_urls[$einvid] : null);
$trans_data->qrcode_img = null;
$trans_data->trans_dtime = date('Y-m-d H:i:s');
if ($trans_data->invoice_qrcode) {
/**
* Attempt to generate the QR Code image file for the current invoice correctly transmitted.
*
* @since 1.16.7 (J) - 1.6.7 (WP)
*/
$qrcode_fname = $this->generateInvoiceQRCode($einvid, $einv_bid, $trans_data);
if ($qrcode_fname) {
$trans_data->qrcode_img = $qrcode_fname;
}
}
/**
* Update the original XML on main invoice to change the content of the nodes UID and Mark, even
* if they will be removed at runtime before the transmission after the myDATA update (Jan 2026).
*
* @since 1.18.6 (J) - 1.8.6 (WP)
*/
$updatedEinvoiceXML = null;
$prev_einv_data = $this->loadEInvoiceDetails($einvid);
if ($trans_data->invoice_uid && $trans_data->invoice_mark && !empty($prev_einv_data['xml'])) {
// load XML e-invoice
$dom = new DOMDocument();
$dom->preserveWhiteSpace = false;
$dom->formatOutput = true;
$dom->loadXML($prev_einv_data['xml']);
// locate the parent node
$invoiceNode = $dom->getElementsByTagName('invoice')->item(0);
// locate the node
$uidNode = $invoiceNode->getElementsByTagName('uid')->item(0);
if ($uidNode) {
// replace text content
$uidNode->nodeValue = $trans_data->invoice_uid;
}
// locate the node
$markNode = $invoiceNode->getElementsByTagName('mark')->item(0);
if ($markNode) {
// replace text content
$markNode->nodeValue = $trans_data->invoice_mark;
}
// turn flag on for updating the XML content
$updatedEinvoiceXML = $dom->saveXML();
}
// build e-invoice object for update (with "transmission data")
$data = new stdClass;
$data->id = $einvid;
$data->transmitted = 1;
$data->trans_data = json_encode($trans_data);
if ($updatedEinvoiceXML) {
// e-invoice XML content should be updated
$data->xml = $updatedEinvoiceXML;
}
// update e-invoice record
$this->updateEInvoice($data);
// check if the PDF invoice requires a refresh to let the conditional text rules run after having updated the e-invoice
if ($qrcode_fname) {
// attempt to refresh the PDF invoice, if available, in case it uses the Conditional Text Rules
if ($this->refreshPdfInvoice($einv_bid)) {
$qrcode_url = VikBookingMydataAadeConstants::getQRCodeBase('uri', $qrcode_fname);
// trigger an event to allow third-party plugins to do something, like sending the invoice via email
VBOFactory::getPlatform()->getDispatcher()->trigger('onMydataAfterQrcodeInvoiceSubmitted', [$einv_bid, $einvid, $trans_data, $qrcode_url]);
}
}
/**
* Check if an e-invoice for the environmental fee was prepared to be generated and transmitted as well.
*
* @since 1.16.7 (J) - 1.6.7 (WP)
*/
$env_fee_inv_details = VBOFactory::getConfig()->getArray($this->getCorrelatedInvoiceParamName($einvid, $einv_bid), []);
if ($env_fee_inv_details && $trans_data->invoice_mark) {
/**
* It is recommended to sleep at least one second after the main invoice has been
* transmitted and before the correlated invoice gets transmitted to ensure the
* main invoice mark is registered on the myDATA platform.
*/
sleep(1);
// use the obtained invoice mark to adjust and transmit the environmental fee invoice
$env_fee_tn_result = $this->transmitCorrelatedInvoice(
$trans_data,
$env_fee_inv_details,
[
'einvid' => $einvid,
'bid' => $einv_bid,
]
);
/**
* Store within the main e-invoice record the transmission result and timestamp for the eco-fee invoice.
* This is useful for eventually allowing to re-transmit just the eco-fee invoice in case of errors, usually
* caused by a premature transmission of the eco-fee invoice before the main invoice mark is registered.
*
* @since 1.18.3 (J) - 1.8.3 (WP)
*/
if (is_object($data ?? null) && is_object($trans_data ?? null)) {
// set the eco-fee invoice transmission result within the main invoice transaction data object
$trans_data->env_fee_tn_res = (int) $env_fee_tn_result;
$trans_data->env_fee_tn_ts = time();
// update object property
$data->trans_data = json_encode($trans_data);
// update main e-invoice record
$this->updateEInvoice($data);
}
}
}
// display info message
$this->setInfo('Electronic invoices transmitted: ' . count($einvspool));
} else {
/**
* Retry to (re-)transmit just the selected eco-fee invoice(s).
*
* @since 1.18.3 (J) - 1.8.3 (WP)
*/
$eco_fee_invs_retn_attempts = 0;
$eco_fee_invs_retn_success = 0;
foreach ($ecofee_einvs_retn as $ecofee_einv_data) {
// get the eco-fee e-invoice details
$env_fee_inv_details = VBOFactory::getConfig()->getArray($this->getCorrelatedInvoiceParamName($ecofee_einv_data['einvid'], $ecofee_einv_data['id']), []);
// get the main e-invoice transaction data
$trans_data = $ecofee_einv_data['einvtndata'] ?? null;
if ($env_fee_inv_details && is_array($trans_data) && ($trans_data['invoice_mark'] ?? null)) {
// increase global retry counter
$eco_fee_invs_retn_attempts++;
// use the previous invoice mark to adjust and transmit the environmental fee invoice
$env_fee_tn_result = $this->transmitCorrelatedInvoice(
$trans_data,
$env_fee_inv_details,
[
'einvid' => $ecofee_einv_data['einvid'],
'bid' => $ecofee_einv_data['id'],
]
);
if ($env_fee_tn_result) {
// increase success counter
$eco_fee_invs_retn_success++;
}
// always update the transmission result for the eco-fee invoice within the main invoice transaction data object
$trans_data['env_fee_tn_res'] = (int) $env_fee_tn_result;
$trans_data['env_fee_tn_ts'] = time();
// build the object record for update
$main_record = new stdClass;
$main_record->id = $ecofee_einv_data['einvid'];
$main_record->trans_data = json_encode($trans_data);
// update main e-invoice record
$this->updateEInvoice($main_record);
}
}
// display info message
$this->setInfo('Electronic invoices (eco-fee) re-transmitted: ' . $eco_fee_invs_retn_attempts . ' - Success counter: ' . $eco_fee_invs_retn_success);
}
// we need to unset the bookings var so that the later call to getBookingsData() made by the View will reload the information
$this->bookings = [];
// unset also cols, rows and footer row to not merge data
$this->cols = [];
$this->rows = [];
$this->footerRow = [];
return true;
}
/**
* Generates one XML string for the request body to myDATA. If more
* than one e-invoice ID passed, attempts to parse all XML files for
* the already generated e-invoices in order to compose one single
* XML request body that contains all invoices. Every e-invoice has
* got an XML file compliant for the transmission, but when we need
* to transmit in mass multiple e-invoices, we try to use just one
* HTTP request by merging all e-invoices into one single XML file.
*
* @param array $einvspool an array of e-invoice IDs
* @param array $settings the driver settings
*
* @return bool|string false on failure or XML request body string.
*/
protected function buildTransmissionXMLBody($einvspool, $settings)
{
if (!is_array($einvspool) || !$einvspool) {
return false;
}
// the list of XML strings
$xml_strings = [];
// generate XML files for the requested e-invoice IDs
foreach ($einvspool as $einvid) {
// load e-invoice details
$einv_data = $this->loadEInvoiceDetails($einvid);
if (!$einv_data || !is_array($einv_data) || empty($einv_data['xml'])) {
// all e-invoices must exist as they will be set to transmitted=1 so we break the process
$this->setError('Unable to load data for the electronic invoice ID ' . $einvid);
return false;
}
/**
* Customers have reported an update to myDATA that no longer accepts the XML nodes
* and (right under the node ) otherwise errors with code 273
* will be raised stating that such details will be generated and provided by myDATA.
*
* @since 1.18.6 (J) - 1.8.6 (WP)
*/
$xmlObj = simplexml_load_string($einv_data['xml']);
if ($xmlObj->invoice->uid ?? null) {
// delete nodes
unset($xmlObj->invoice->uid, $xmlObj->invoice->mark);
// re-build XML string
$einv_data['xml'] = $xmlObj->asXML();
}
// push e-invoice content
$xml_strings[] = $einv_data['xml'];
}
if (!$xml_strings) {
// no XML files created, break the process
return false;
}
if (count($xml_strings) === 1) {
// just one XML file, no need to build an XML container
return $xml_strings[0];
}
// return one whole XML request body for all e-invoices
return $this->mergeXMLInvoices($xml_strings);
}
/**
* Given a list of XML e-invoice strings, attempts to merge them
* into one single XML to avoid making one HTTP request per e-invoice.
*
* @param array $xml_strings list of XML strings for each e-invoice.
*
* @return bool|string false or whole XML string for all e-invoices.
*/
protected function mergeXMLInvoices($xml_strings)
{
if (!is_array($xml_strings) || !$xml_strings) {
return false;
}
if (count($xml_strings) === 1) {
return $xml_strings[0];
}
if (!class_exists('SimpleXMLElement')) {
/**
* We cannot afford to do a string manipulation only because SimpleXMLElement
* is missing on the server. It has to be available, it's a native library.
*/
$this->setError('SimpleXMLElement is missing on your server.');
$this->setError('This is unusual, and you should contact your hosting company to enable this native PHP library.');
$this->setError('You can only transmit single e-invoices, not more than one because SimpleXMLElement is missing');
return false;
}
/**
* Define the XML root element for the InvoicesDoc message.
* Namespace attributes will affect the incomeClassification sub nodes.
*
* @see VikBookingMydataAadeConstants::getInvoiceNamespaceAttributes();
* @see https://mydata-dev.portal.azure-api.net/issues/5f3c411ac75730207831ead4
*/
$root_namespaces = VikBookingMydataAadeConstants::getInvoiceNamespaceAttributes();
$xml_root = <<
XML;
// get the SimpleXMLElement object
$xml = new SimpleXMLElement($xml_root);
// define the namespace rules for the children elements of
$child_nmspaces = [
'incomeClassification' => VikBookingMydataAadeConstants::getInvoiceChildrenNamespace()
];
// parse all e-invoices
$parsed = 0;
foreach ($xml_strings as $k => $einvoice) {
$xml_einvoice = simplexml_load_string($einvoice);
if (!is_object($xml_einvoice)) {
$this->setWarning('Unable to parse the XML of the e-invoice index ' . ($k + 1));
$this->setWarning($this->libxml_display_errors());
continue;
}
// append XML tree to a new node
$invoice_node = $xml->addChild('invoice');
$this->simpleXmlAppendTree($invoice_node, $xml_einvoice->invoice, $child_nmspaces);
// increase parsed invoices
$parsed++;
}
if (!$parsed) {
$this->setError('No e-invoices could be parsed to merge the XML trees and related nodes into one single XML body.');
return false;
}
// get the whole XML request body just built from all e-invoices
$full_xml = $xml->asXML();
/**
* When appending child nodes with namespaces to "", these may be added as
* "category1_3" so with both
* the proper namespace in the node name, but also with the attribute 'xmlns:N1="N1"' which is making
* the whole XML failing according to the schema. Therefore, we manipulate the string to remove such attributes.
*/
if (!empty($child_nmspaces['incomeClassification'])) {
$seek_pattern = $child_nmspaces['incomeClassification'];
$full_xml = str_replace('xmlns:' . $seek_pattern . '="' . $seek_pattern . '"', '', $full_xml);
}
// attempt to properly format the XML string
$this->formatXmlString($full_xml);
// return the whole XML request body containing all the e-invoices
return $full_xml;
}
/**
* Recursive method to append a SimpleXMLElement tree node, and
* related children nodes, to another SimpleXMLElement. Used to
* dinamically add an entire tree of a single e-invoice XML file
* under a single node of the whole XML request body.
*
* @param SimpleXMLElement $xml_to the node where the tree will be appended.
* @param SimpleXMLElement $xml_from the element to append with all its children.
* @param array $child_nmspaces associative list of children namespaces.
*
* @return void
*/
protected function simpleXmlAppendTree(&$xml_to, &$xml_from, $child_nmspaces = [])
{
$child_nmspace = null;
$child_isprefix = false;
$node_name = $xml_to->getName();
if (!empty($child_nmspaces[$node_name])) {
$child_nmspace = $child_nmspaces[$node_name];
$child_isprefix = true;
}
foreach ($xml_from->children($child_nmspace, $child_isprefix) as $xml_child) {
$add_node_name = $xml_child->getName();
if (!empty($child_nmspace)) {
$add_node_name = "$child_nmspace:$add_node_name";
}
$xml_temp = $xml_to->addChild($add_node_name, (string)$xml_child, $child_nmspace);
foreach ($xml_child->attributes() as $attr_key => $attr_value) {
$xml_temp->addAttribute($attr_key, $attr_value);
}
$this->simpleXmlAppendTree($xml_temp, $xml_child, $child_nmspaces);
}
}
/**
* Loads the details of the given e-invoice ID. The given ID should not be obliterated.
*
* @param int $einvid the ID of the e-invoice
*
* @return mixed array if the e-invoice exists and is not obliterated, false otherwise.
*/
protected function loadEInvoiceDetails($einvid)
{
if (empty($einvid)) {
return false;
}
$q = "SELECT * FROM `#__vikbooking_einvoicing_data` WHERE `id`=" . (int)$einvid . " AND `obliterated`=0;";
$this->dbo->setQuery($q);
$einv = $this->dbo->loadAssoc();
return $einv ? $einv : false;
}
/**
* Performs a POST request to the myDATA infrastructure.
*
* @param string $url_path the path to append to the base endpoint URI.
* @param mixed $body the request body.
* @param array $settings driver settings or any other option to inject.
*
* @return JHttpResponse object with code and body properties
*/
protected function myDATARequestPOST($url_path = '', $body = null, $settings = [])
{
if (empty($settings)) {
$settings = $this->loadSettings();
}
$aade_user_id = $settings['params']['aade_user_id'];
$aade_subscription_key = $settings['params']['aade_subscription_key'];
$aade_endp_url = $settings['params']['mydata_endpoint_url'];
if (!empty($settings['params']['test_mode'])) {
$aade_endp_url = VikBookingMydataAadeConstants::getDevEndpointBaseUrl();
}
if (!empty($url_path)) {
$aade_endp_url .= ltrim($url_path, '/');
}
// build request headers
$headers = [
'Content-Type' => 'application/xml',
'aade-user-id' => $aade_user_id,
'Ocp-Apim-Subscription-Key' => $aade_subscription_key,
];
// invoke CMS native transporter
$transporter = new JHttp;
$response = $transporter->post($aade_endp_url, $body, $headers);
if ($response->code != 200) {
$this->setError('Erroneous response with HTTP code ' . $response->code);
$this->setError(htmlentities($response->body));
}
return $response;
}
/**
* Checks if the XML response string from myDATA contains errors.
* Returns an array with boolean "success" and array with "einv_id => einv_mark".
*
* @param string $body the raw response body from the request.
* @param array $einvspool list of e-invoice ids in VBO just transmitted.
* @param array $einvnumbs list of e-invoice numbers in VBO just transmitted.
*
* @return array to be used with list($success, $valid_einv_marks, $valid_einv_uids, $valid_qrcode_urls).
*/
protected function myDATAParseXMLResponse($body, $einvspool = [], $einvnumbs = [])
{
// the default information to return
$success = false;
$valid_einv_marks = [];
$valid_einv_uids = [];
$valid_qrcode_urls = [];
$res_obj = $body;
if (!is_object($res_obj)) {
$res_obj = simplexml_load_string($body);
}
if (!is_object($res_obj) || !isset($res_obj->response)) {
$this->setError('Could not parse XML response');
$this->setError('' . htmlentities($body) . '
');
return [$success, $valid_einv_marks, $valid_einv_uids, $valid_qrcode_urls];
}
// errors counter
$errors_found = 0;
// loop through each response node
foreach ($res_obj->response as $invoice_resp) {
if (!isset($invoice_resp->statusCode)) {
$this->setError('Unexpected nodes in XML response (missing statusCode)');
$this->setError('' . htmlentities($body) . '
');
return [$success, $valid_einv_marks, $valid_einv_uids, $valid_qrcode_urls];
}
/**
* Endpoint POST /SendInvoices only (/CancelInvoice would not return this data).
* Get the index of the current invoice response (line-number starts from 1).
*/
$invoice_index = isset($invoice_resp->index) ? (int)$invoice_resp->index : 0;
// check if we have a successful status code for this invoice
if (!strcasecmp((string)$invoice_resp->statusCode, 'Success')) {
// success!
if ($invoice_index > 0 && isset($einvspool[($invoice_index - 1)])) {
// push successful invoice
$einv_id = $einvspool[($invoice_index - 1)];
// get the invoice UID
$invoice_uid = isset($invoice_resp->invoiceUid) ? (string)$invoice_resp->invoiceUid : $einv_id;
$valid_einv_uids[$einv_id] = $invoice_uid;
// get the invoice mark (needed for a later cancellation)
$invoice_mark = isset($invoice_resp->invoiceMark) ? (string)$invoice_resp->invoiceMark : $einv_id;
$valid_einv_marks[$einv_id] = $invoice_mark;
/**
* Check if a QRCode URL is available for the electronic invoice.
* Valid property name should be "qrUrl".
*
* @since 1.16.7 (J) - 1.6.7 (WP)
*/
$invoice_qrcode = isset($invoice_resp->qrUrl) ? (string)$invoice_resp->qrUrl : $einv_id;
$invoice_qrcode = !isset($invoice_resp->qrUrl) && isset($invoice_resp->qrCodeUrl) ? (string)$invoice_resp->qrCodeUrl : $invoice_qrcode;
$valid_qrcode_urls[$einv_id] = $invoice_qrcode;
}
continue;
}
// at this point we expect an error
if (!isset($invoice_resp->errors) || !isset($invoice_resp->errors->error)) {
// errors should be set, but if they aren't, this is unexpected
$this->setError('Unexpected nodes in XML response (missing errors or error)');
$this->setError('' . htmlentities($body) . '
');
return [$success, $valid_einv_marks, $valid_einv_uids, $valid_qrcode_urls];
}
// loop through the errors
foreach ($invoice_resp->errors->error as $resp_err) {
$errors_found++;
$err_code = isset($resp_err->code) ? (string)$resp_err->code : '0';
$err_mess = isset($resp_err->message) ? (string)$resp_err->message : '???';
$inv_numb = isset($einvnumbs[($invoice_index - 1)]) ? $einvnumbs[($invoice_index - 1)] : '???';
$this->setError(sprintf('Error (%s) in invoice index %d (#%s): %s', $err_code, $invoice_index, $inv_numb, $err_mess));
}
}
// if we had no errors at all, the response was successful
$success = (!$errors_found);
return [$success, $valid_einv_marks, $valid_einv_uids, $valid_qrcode_urls];
}
/**
* Downloads the electronic invoices by storing temporary files.
* This is a 'driver action', and so it's called before getBookingsData()
* in the view. This method will not save/update records in the DB.
*
* @return void
*/
public function downloadEInvoices()
{
// make sure the transmission settings are not empty
$settings = $this->loadSettings();
if ($settings === false || !$settings['params']) {
$this->setError('Missing settings. Please set up the driver first.');
return false;
}
// call the main method to generate rows, cols and bookings array
$this->getBookingsData();
if (strlen($this->getError()) || !$this->bookings) {
return false;
}
// pool of e-invoice IDs to download
$einvspool = [];
foreach ($this->bookings as $gbook) {
// make sure an electronic invoice was already issued for this booking ID by this driver
if (empty($gbook[0]['einvid']) || $gbook[0]['einvdriver'] != $this->getDriverId()) {
// no e-invoices available for this booking, skipping
continue;
}
// push e-invoice ID to the pool
array_push($einvspool, $gbook[0]['einvid']);
}
if (!$einvspool) {
// no e-invoices generated
$this->setWarning('No electronic invoices can be downloaded. Please generate them first.');
return false;
}
// build one whole XML file
$einv_xml_body = $this->buildTransmissionXMLBody($einvspool, $settings);
if ($einv_xml_body === false) {
// something went wrong with the creation of the file to download
$this->setError('Could not generate the XML file containing all the electronic invoices.');
return false;
}
// force the download of the XML string
header('Content-Disposition: attachment; filename="mydata-aade-einvoices' . date('Y-m-d') . '.xml"');
header("Content-Type: text/xml");
header("Content-Length:" . strlen($einv_xml_body));
header('Connection: close');
echo $einv_xml_body;
exit;
}
/**
* Forces the display of an electronic invoice. This is a 'driver action', and so it's called
* before getBookingsData() in the view. This method will not save/update records in the DB.
* This method truncates the execution of the script to read the XML data.
*
* @return void
*/
public function viewEInvoice()
{
$einvid = VikRequest::getInt('einvid', 0, 'request');
$einv_data = $this->loadEInvoiceDetails($einvid);
if (!$einv_data) {
die('Missing e-invoice ID');
}
// force the output
header("Content-type:text/xml");
echo $einv_data['xml'];
exit;
}
/**
* Removes an electonic invoice. This is a 'driver action',
* and so it's called before getBookingsData() in the view.
* It also removes the analogic version in PDF of the invoice.
*
* @return void
*/
public function removeEInvoice()
{
$einvid = VikRequest::getInt('einvid', '', 'request');
$einv_data = $this->loadEInvoiceDetails($einvid);
if (!$einv_data) {
$this->setError('Missing e-invoice ID. Unable to delete the e-invoice.');
return false;
}
// get "transmission data" (if any)
$trans_data = !empty($einv_data['trans_data']) ? json_decode($einv_data['trans_data']) : null;
if (is_object($trans_data) && !empty($trans_data->invoice_mark)) {
/**
* This invoice was transmitted before, make sure to cancel it also from myDATA.
* However, the endpoint requires a "mark" value for the invoice, which could be the
* invoiceMark property upon a successful submission or the number we pass to compose
* the XML of the electronic invoice (our progressive number). There are two "mark"
* values, but we got errors for both, hence we don't know which one to use. We always
* check if $trans_data->invoice_mark is not empty so that we know the invoice was
* already transmitted before to myDATA and accepted.
*
* @todo what's the right invoice mark? the "number" is inside the XML that we generate
* even before the transmission, while "invoice_mark" is returned in the myDATA response.
*/
$mydata_invoice_mark = $einv_data['number'];
$mydata_invoice_mark = $trans_data->invoice_mark;
/**
* Check if a correlated invoice was transmitted, because it should be removed first.
*
* @since 1.16.7 (J) - 1.6.7 (WP)
*/
$correlated_inv_data_tn = $this->getPreviousCorrelatedInvoiceData($einv_data['id'], $einv_data['idorder'], 'transmission');
if ($correlated_inv_data_tn && !empty($correlated_inv_data_tn['mark'])) {
// delete the correlated invoice first, by making the POST request
$response = $this->myDATARequestPOST('CancelInvoice?mark=' . $correlated_inv_data_tn['mark']);
if ($response->code != 200) {
// the request was not successful
$this->setWarning(sprintf('Invalid response (code %s): %s', $response->code, htmlspecialchars($response->body)));
$this->setWarning('Could not cancel the correlated invoice from myDATA with mark ' . $correlated_inv_data_tn['mark']);
} else {
// check the XML response
$xml_result = $this->myDATAParseXMLResponse($response->body);
if ($xml_result[0]) {
// success! the correlated invoice was cancelled from myDATA
$this->setInfo(sprintf('Correlated invoice mark %s successfully cancelled from myDATA', $correlated_inv_data_tn['mark']));
/**
* IMPORTANT: sleep for 2 seconds, or deleting immediately the main invoice below may
* result into an error like "Error (255) in invoice index 0 (#???): Invoice with MARK 400001924172498
* cannot be cancelled because it is connected with active invoice with MARK 400001924172499"
*/
sleep(2);
}
}
// always delete the record for the correlated invoice
VBOFactory::getConfig()->remove($this->getCorrelatedInvoiceParamName($einv_data['id'], $einv_data['idorder']));
// check if the PDF version of the environmental fee exists
if (!empty($correlated_inv_data_tn['pdf'])) {
$envfee_pathpdf = VBO_SITE_PATH . DIRECTORY_SEPARATOR . "helpers" . DIRECTORY_SEPARATOR . "invoices" . DIRECTORY_SEPARATOR . "generated" . DIRECTORY_SEPARATOR . $correlated_inv_data_tn['pdf'];
if (is_file($envfee_pathpdf)) {
@unlink($envfee_pathpdf);
}
}
}
// make the POST request
$response = $this->myDATARequestPOST('CancelInvoice?mark=' . $mydata_invoice_mark);
if ($response->code != 200) {
// the request was not successful, and the XML invoices were not parsed at all by myDATA
$this->setWarning(sprintf('Invalid response (code %s): %s', $response->code, htmlspecialchars($response->body)));
$this->setWarning('Could not cancel the invoice from myDATA.');
} else {
// check the XML response
$xml_result = $this->myDATAParseXMLResponse($response->body);
if ($xml_result[0]) {
// success! the invoice was cancelled from myDATA
$this->setInfo(sprintf('Invoice mark %s (#%s) successfully cancelled from myDATA', $trans_data->invoice_mark, $einv_data['number']));
}
}
}
// remove e-invoice
$q = "DELETE FROM `#__vikbooking_einvoicing_data` WHERE `id`=".$einv_data['id'].";";
$this->dbo->setQuery($q);
$this->dbo->execute();
// remove analogic invoice for this booking
$pdfremoved = false;
if (!empty($einv_data['idorder'])) {
$pdfname = '';
$q = "SELECT * FROM `#__vikbooking_invoices` WHERE `idorder`=".(int)$einv_data['idorder'].";";
$this->dbo->setQuery($q);
$analogic = $this->dbo->loadAssoc();
if ($analogic) {
$pdfname = $analogic['file_name'];
$q = "DELETE FROM `#__vikbooking_invoices` WHERE `idorder`=".(int)$einv_data['idorder'].";";
$this->dbo->setQuery($q);
$this->dbo->execute();
}
$pdfpath = VBO_SITE_PATH . DIRECTORY_SEPARATOR . 'helpers' . DIRECTORY_SEPARATOR . 'invoices' . DIRECTORY_SEPARATOR . 'generated' . DIRECTORY_SEPARATOR . $pdfname;
if (!empty($pdfname) && is_file($pdfpath)) {
$pdfremoved = true;
@unlink($pdfpath);
}
}
$this->setInfo(($pdfremoved ? 'Electronic and PDF invoices deleted' : 'Electronic invoice deleted'));
}
/**
* Attempts to generate a QR Code PNG image file with the e-invoice URL.
*
* @param int $einv_id the generated e-invoice record ID.
* @param int $bid the reservation record ID.
* @param object $data transaction data object with myDATA values.
*
* @return string empty string in case of failure, or generated QR Code file name.
*
* @since 1.16.7 (J) - 1.6.7 (WP)
*/
protected function generateInvoiceQRCode($einv_id, $bid, $data)
{
if (!is_object($data) || empty($data->invoice_qrcode)) {
return '';
}
// the QR Code PNG file name
$filename = "aade_qrcode_{$bid}_{$einv_id}.png";
// generate the image
if ($this->generateQRCodeImage($data->invoice_qrcode, VikBookingMydataAadeConstants::getQRCodeBase('path', $filename))) {
// file was written successfully
return $filename;
}
// an error has occurred
return '';
}
/**
* Generates a QR Code image with the given URL in the given path.
*
* @param string $url the URL to be assigned (content) to the QR Code.
* @param string $path the full path where the file should be saved.
*
* @return bool
*/
protected function generateQRCodeImage($url, $path)
{
try {
// require the TCPDF 2D Barcode library
require_once VBO_SITE_PATH . DIRECTORY_SEPARATOR . "helpers" . DIRECTORY_SEPARATOR . "tcpdf" . DIRECTORY_SEPARATOR . 'tcpdf_barcodes_2d.php';
// set the barcode content and type
$barCode = new TCPDF2DBarcode($url, 'QRCODE,H');
// generate the QR code as PNG image
$qr = $barCode->getBarcodePngData(
VikBookingMydataAadeConstants::QRCODE_PNG_WIDTH,
VikBookingMydataAadeConstants::QRCODE_PNG_HEIGHT,
explode(',', preg_replace("/[^0-9\.\,]/", '', VikBookingMydataAadeConstants::QRCODE_PNG_COLOR_RGB))
);
// write the image on disk
return (bool)JFile::write($path, $qr);
} catch (Throwable $t) {
// do nothing
}
return false;
}
/**
* Right after obtaining a QR Code for an electronic invoice, the driver
* calls this method to refresh the PDF (courtesy) invoice so that any
* conditional text rule used on the invoice template file will run correctly.
*
* @param int $bid the reservation record ID for which the invoice should be refreshed.
*
* @return bool
*
* @since 1.16.7 (J) - 1.6.7 (WP)
*/
protected function refreshPdfInvoice($bid)
{
return (bool)VikBooking::generateBookingInvoice(
// load booking details
VikBooking::getBookingInfoFromID($bid),
// do not set an invoice number, because the previous one must be used
$invoice_num = 0,
// do not set an invoice suffix, because the previous one must be used
$invoice_suff = '',
// do not set an invoice date, because the previous one must be used
$invoice_date = '',
// company information will be re-fetched
$company_info = '',
// translation is not needed
$translate = false,
// set the argument to request a re-generation (refresh) of the existing invoice
$refresh_pdf = true
);
}
/**
* Validates the XML against the Schema.
*
* @param string $xml the xml string to validate
*
* @return null|boolean
*/
protected function validateXmlAgainstSchema($xml) {
if (!class_exists('DOMDocument')) {
// we cannot validate the XML because DOMDocument is missing
return null;
}
$schema_path = VikBookingMydataAadeConstants::getSchemaPath();
libxml_use_internal_errors(true);
$dom = new DOMDocument();
$dom->load($xml);
if (!$dom->schemaValidate($schema_path)) {
$this->setWarning('The schema validation of the electronic XML invoice returned errors, but they may be related to an unreadable schema.');
$this->setWarning($this->libxml_display_errors());
return false;
}
return true;
}
/**
* Formats the XML errors occurred
*
* @return string the error string
*/
protected function libxml_display_errors() {
$errorstr = "";
$errors = libxml_get_errors();
foreach ($errors as $error) {
$errorstr .= $this->libxml_display_error($error);
}
libxml_clear_errors();
return $errorstr;
}
/**
* Explanation of the XML error
*
* @param object $error the libxml error object
*
* @return string the explained error occurred
*/
protected function libxml_display_error($error) {
$return = "\n";
switch ($error->level) {
case LIBXML_ERR_WARNING :
$return .= "Warning ".$error->code.": ";
break;
case LIBXML_ERR_ERROR :
$return .= "Error ".$error->code.": ";
break;
case LIBXML_ERR_FATAL :
$return .= "Fatal Error ".$error->code.": ";
break;
}
$return .= trim($error->message);
if ($error->file) {
$return .= " in " . $error->file;
}
$return .= " on line " . $error->line . "\n";
return $return;
}
/**
* Override method to show the overlay content.
* Used to display the edit form of the raw XML.
* This method echoes the string to be displayed.
*
* @return void
*/
public function printOverlayContent()
{
$content = VikRequest::getString('drivercontent', '', 'request');
$einvid = VikRequest::getInt('einvid', 0, 'request');
$envfeebid = VikRequest::getInt('envfeebid', 0, 'request');
if ($content == 'editEInvoice' && !empty($einvid)) {
$einv_data = $this->loadEInvoiceDetails($einvid);
if (!$einv_data) {
return;
}
if ($envfeebid) {
$correlated_invoice = $this->getPreviousCorrelatedInvoiceData($einvid, $envfeebid, $type = 'record');
if ($correlated_invoice) {
$einv_data['correlated_invoice'] = $correlated_invoice;
}
}
// path to edit invoice layout file
$fpath = $this->driverHelperPath . 'editeinvoice.php';
// load helper file and echo its content
echo $this->loadHelperFile($fpath, $einv_data);
return;
}
}
/**
* Updates the XML of an electonic invoice. This is a 'driver action',
* and so it's called before getBookingsData() in the view.
*
* @return bool
*/
public function updateXmlEInvoice()
{
$einvid = VikRequest::getInt('einvid', '', 'request');
$newxml = VikRequest::getString('newxml', '', 'request', VIKREQUEST_ALLOWRAW);
$einv_data = $this->loadEInvoiceDetails($einvid);
if (!$einv_data) {
$this->setError('Invoice not found');
return false;
}
if (empty($newxml)) {
$this->setError('Empty XML content');
return false;
}
$jdate = new JDate;
$data = new stdClass;
$data->id = $einv_data['id'];
$data->created_on = $jdate->toSql();
$data->xml = $newxml;
return $this->updateEInvoice($data);
}
/**
* Updates the XML of a correlated electonic invoice. This is a 'driver action',
* and so it's called before getBookingsData() in the view.
*
* @return bool
*
* @since 1.16.7 (J) - 1.6.7 (WP)
*/
public function updateCorrelatedXmlEInvoice()
{
$einvid = VikRequest::getInt('einvid', 0, 'request');
$envfeebid = VikRequest::getInt('envfeebid', 0, 'request');
$newxml = VikRequest::getString('newxml', '', 'request', VIKREQUEST_ALLOWRAW);
// get the invoice record
$correlated_inv_raw_data = VBOFactory::getConfig()->getArray($this->getCorrelatedInvoiceParamName($einvid, $envfeebid), []);
if (!$correlated_inv_raw_data) {
return false;
}
// update the XML source code
$correlated_inv_raw_data['xml'] = $newxml;
// update record
VBOFactory::getConfig()->set($this->getCorrelatedInvoiceParamName($einvid, $envfeebid), $correlated_inv_raw_data);
return true;
}
/**
* Extracts only numbers from a given string, by optionally
* stripping the current year. Useful to find an invoice number.
*
* @param string $str the string to look for numbers
* @param boolean $stripy whether to strip the current year
*
* @return string either an empty string or all numbers as a concatenated string
*/
protected function getOnlyNumbers($str, $stripy = false)
{
if ($stripy) {
$str = str_replace(date('Y'), '', $str);
}
preg_match_all('/\d+/', $str, $matches);
return implode('', $matches[0]);
}
}
';
}
}
} else {
// if empty customer ($val) print danger button to assign a customer to this booking ID
$cont = '' . JText::translate('VBOCREATENEWCUST') . '';
}
return $cont;
},
'value' => (count($customer) ? $customer['first_name'].' '.$customer['last_name'] : '')
),
array(
'key' => 'country',
'callback' => function ($val) {
return !empty($val) ? $val : '-----';
},
'value' => $countryfull
),
array(
'key' => 'city',
'attr' => array(
'class="center"'
),
'callback' => function ($val) use ($customer) {
$goto = base64_encode('index.php?option=com_vikbooking&task=einvoicing');
if (empty($val)) {
if (count($customer) && !empty($customer['id'])) {
// just an empty City, edit the customer
$cont = '' . JText::translate('VBCONFIGCLOSINGDATEADD') . '';
} else {
$cont = '-----';
}
return $cont;
}
if (count($customer) && empty($customer['zip'])) {
// postal code is mandatory
return 'No Postal Code';
}
if (count($customer) && empty($customer['address'])) {
// address is mandatory
return 'No Address';
}
return $val;
},
'value' => (count($customer) && !empty($customer['city']) ? $customer['city'] : '')
),
array(
'key' => 'vat',
'attr' => array(
'class="center"'
),
'callback' => function ($val) use ($customer, $bid) {
if (!empty($val)) {
$cont = $val;
} else {
$goto = base64_encode('index.php?option=com_vikbooking&task=einvoicing');
if (count($customer) && !empty($customer['id'])) {
// empty VAT Number, which may be mandatory for both issuer and counterpart
$cont = '' . JText::translate('VBCONFIGCLOSINGDATEADD') . '';
} else {
// if empty customer ($val) print danger button to assign a customer to this booking ID
$cont = '' . JText::translate('VBCONFIGCLOSINGDATEADD') . '';
}
}
return $cont;
},
'value' => (count($customer) && !empty($customer['vat']) ? $customer['vat'] : '')
),
array(
'key' => 'company',
'callback' => function ($val) use ($customer) {
$cont = !empty($val) ? $val : '-----';
if (count($customer)) {
$goto = base64_encode('index.php?option=com_vikbooking&task=einvoicing');
$cont = ''.$cont.'';
}
return $cont;
},
'value' => (count($customer) && !empty($customer['company']) ? $customer['company'] : '')
),
array(
'key' => 'tot',
'attr' => array(
'class="center"'
),
'callback' => function ($val) use ($currency_symb) {
return $currency_symb.' '.VikBooking::numberFormat($val);
},
'value' => $gbook[0]['total']
),
array(
'key' => 'commands',
'attr' => array(
'class="center"'
),
'callback' => function ($val) use ($bid, $noinvoicereason) {
if ($val === 0 || $val === 1) {
// invoice cannot be issued or is about to be issued
return '';
}
$buttons = [];
if ($val === -1 || $val === -2) {
// invoice generated or generated and transmitted
array_push($buttons, '');
array_push($buttons, '');
$correlated_inv_numb = $this->getPreviousCorrelatedInvoiceData($noinvoicereason, $bid);
if ($correlated_inv_numb) {
array_push($buttons, '');
}
array_push($buttons, '');
}
return implode("\n", $buttons);
},
'value' => $canbeinvoiced
),
array(
'key' => 'action',
'attr' => array(
'class="center vbo-einvoicing-cellaction"',
'data-einvaction="'.$canbeinvoiced.'"'
),
'callback' => function ($val) use ($bid, $noinvoicereason, $einvnum, $einvtndata) {
if ($val === 0) {
// invoice cannot be issued
$noinvoicereason = empty($noinvoicereason) ? 'Missing data to generate the invoice' : $noinvoicereason;
return '';
}
if ($val === -1) {
// e-invoice already issued and transmitted: print drop down to let the customer regenerate this invoice and obliterate the other or to re-send
return '';
}
if ($val === -2) {
// e-invoice already issued but NOT transmitted: print drop down to let the customer regenerate this invoice and obliterate the other
return '';
}
// invoice can be issued: print drop down to let the customer skip this generation
return '';
},
'value' => $canbeinvoiced
),
));
}
// sort rows
$this->sortRows($pkrsort, $pkrorder);
// build footer rows
$totcols = count($this->cols);
$footerstats = [];
foreach ($this->rows as $k => $row) {
foreach ($row as $col) {
if ($col['key'] != 'action') {
continue;
}
if (!isset($footerstats[$col['value']])) {
$footerstats[$col['value']] = 0;
}
$footerstats[$col['value']]++;
}
}
$avgcolspan = floor($totcols / count($footerstats));
$footercells = [];
foreach ($footerstats as $canbeinvoiced => $tot) {
switch ($canbeinvoiced) {
case 1:
$descr = 'To be invoiced';
break;
case -1:
$descr = 'Transmitted invoices';
break;
case -2:
$descr = 'Generated invoices';
break;
default:
$descr = 'Not billable';
break;
}
array_push($footercells, array(
'attr' => array(
'class="vbo-report-total vbo-driver-total"',
'colspan="'.$avgcolspan.'"'
),
'value' => '