Skip to content

#1296 [PDF/ODF] add : function initDocumentGenerator #1299

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
evarisk-charles wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

#1296 [PDF/ODF] add : function initDocumentGenerator #1299

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3e391b2
#1296 [PDF/ODF] add : function initDocumentGenerator
evarisk-charles Feb 23, 2026
543f1ca
#1296 [PDF/ODF] add : function initDocumentGenerator
evarisk-charles Feb 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
148 changes: 110 additions & 38 deletions core/modules/saturne/modules_saturne.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -818,6 +818,97 @@ public function buildDocumentFilename($objectDocument, $outputLangs, $object, $m
return $dir . '/' . $fileName;
}


/**
* Init documents values for pdf and ODT
*
* @param Object $object Object of the page you are on.
* @param Translate $outputLangs Lang object to use for output.
* @param array $moreParam More param (Object/user/etc)
* @param string $file Path of the source template
*
* @return void
* @throws Exception
*/
public function initOdtDocument($object, $outputLangs,$moreParam, $file)
{
global $action, $conf, $hookmanager, $mysoc;
$substitutionArray = [];
complete_substitutions_array($substitutionArray, $outputLangs, $object);
// Call the ODTSubstitution hook
$parameters = ['file' => $file, 'object' => $object, 'outputlangs' => $outputLangs, 'substitutionarray' => &$substitutionArray];
$hookmanager->executeHooks('ODTSubstitution', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks

// Open and load template
require_once ODTPHP_PATH . 'odf.php';

// Define substitution array
$substitutionArray = getCommonSubstitutionArray($outputLangs, 0, null, $object);
$arrayObjectFromProperties = $this->get_substitutionarray_each_var_object($object, $outputLangs);
$arraySoc = $this->get_substitutionarray_mysoc($mysoc, $outputLangs);
$arraySoc['mycompany_logo'] = preg_replace('/_small/', '_mini', $arraySoc['mycompany_logo']);

$tmpArray = array_merge($substitutionArray, $arrayObjectFromProperties, $arraySoc, $moreParam['tmparray']);
if (isModEnabled('multicompany')) {
$tmpArray['entity'] = $conf->entity;
} else {
$tmpArray['entity'] = '';
}
}

/**
* Init documents values for pdf
*
* @param Translate $outputLangs Lang object to use for output.
*
* @return void
* @throws Exception
*/
public function initPdfDocument($outputLangs)
{
global $user;

$pdf = pdf_getInstance($this->format);
$defaultFontSize = pdf_getPDFFontSize($outputLangs) + 2;

if (class_exists('TCPDF')) {
$pdf->setPrintHeader(false);
$pdf->setPrintFooter(false);
}

$pdf->SetFont(pdf_getPDFFont($outputLangs));
$pdf->Open();
$pdf->SetDrawColor(128, 128, 128);
$pdf->SetTitle($outputLangs->convToOutputCharset($this->document_type));
$pdf->SetSubject($outputLangs->transnoentities($this->document_type));
$pdf->SetCreator('Dolibarr ' . DOL_VERSION);
$pdf->SetAuthor($outputLangs->convToOutputCharset($user->getFullName($outputLangs)));
$pdf->SetMargins($this->marge_gauche, $this->marge_haute, $this->marge_droite);
$pdf->setPageOrientation($this->orientation, 1, $this->marge_basse);
$pdf->SetAutoPageBreak(1, $this->marge_basse);
}

/**
* Init documents values for pdf and ODT
*
* @param Object $object Object of the page you are on.
* @param Translate $outputLangs Lang object to use for output.
* @param string $srcTemplatePath Path of the source template
* @param array $moreParam More param (Object/user/etc)
* @param string $file Path of the source template
*
* @return void
* @throws Exception
*/
public function initDocumentGenerator($object, $outputLangs,$moreParam, $file)
{
if ($this->type == 'odt') {
$this->initOdtDocument($object, $outputLangs,$moreParam, $file);
} else {
$this->initPdfDocument($outputLangs);
}
}

/**
* Function to build a document on disk
*
Expand Down Expand Up @@ -866,49 +957,30 @@ public function write_file(SaturneDocuments $objectDocument, Translate $outputLa
return -1;
}

// Make substitution
$substitutionArray = [];
complete_substitutions_array($substitutionArray, $outputLangs, $object);
// Call the ODTSubstitution hook
$parameters = ['file' => $file, 'object' => $object, 'outputlangs' => $outputLangs, 'substitutionarray' => &$substitutionArray];
$hookmanager->executeHooks('ODTSubstitution', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks

// Open and load template
require_once ODTPHP_PATH . 'odf.php';
try {
$odfHandler = new odf(
$srcTemplatePath,
[
'PATH_TO_TMP' => $conf->$moduleNameLowerCase->dir_temp,
'ZIP_PROXY' => 'PclZipProxy', // PhpZipProxy or PclZipProxy. Got "bad compression method" error when using PhpZipProxy
'DELIMITER_LEFT' => '{',
'DELIMITER_RIGHT' => '}'
]
);
} catch (Exception $e) {
$this->error = $e->getMessage();
dol_syslog($e->getMessage());
return -1;
}
$this->initDocumentGenerator($object, $outputLangs, $moreParam, $file);

// Define substitution array
$substitutionArray = getCommonSubstitutionArray($outputLangs, 0, null, $object);
$arrayObjectFromProperties = $this->get_substitutionarray_each_var_object($object, $outputLangs);
$arraySoc = $this->get_substitutionarray_mysoc($mysoc, $outputLangs);
$arraySoc['mycompany_logo'] = preg_replace('/_small/', '_mini', $arraySoc['mycompany_logo']);
// Replace labels translated
$tmpArray = $outputLangs->get_translations_for_substitutions();

$tmpArray = array_merge($substitutionArray, $arrayObjectFromProperties, $arraySoc, $moreParam['tmparray']);
if (isModEnabled('multicompany')) {
$tmpArray['entity'] = $conf->entity;
} else {
$tmpArray['entity'] = '';
if ($this->type == 'odt') {
try {
$odfHandler = new odf(
$srcTemplatePath,
[
'PATH_TO_TMP' => $conf->$moduleNameLowerCase->dir_temp,
'ZIP_PROXY' => 'PclZipProxy', // PhpZipProxy or PclZipProxy. Got "bad compression method" error when using PhpZipProxy
'DELIMITER_LEFT' => '{',
'DELIMITER_RIGHT' => '}'
]
);
} catch (Exception $e) {
$this->error = $e->getMessage();
dol_syslog($e->getMessage());
return -1;
}
}

$this->fillTags($odfHandler, $outputLangs, $tmpArray, $moreParam);

// Replace labels translated
$tmpArray = $outputLangs->get_translations_for_substitutions();

// Call the beforeODTSave hook
$parameters = ['odfHandler' => &$odfHandler, 'file' => $file, 'object' => $object, 'outputlangs' => $outputLangs, 'substitutionarray' => &$tmpArray];
$hookmanager->executeHooks('beforeODTSave', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
Expand Down
1 change: 1 addition & 0 deletions lib/medias.lib.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -382,6 +382,7 @@ function saturne_get_thumb_name(string $filename, string $thumbType = 'small', s
$fileExtension = pathinfo($filename, PATHINFO_EXTENSION);

if (!empty($filePath)) {
require_once __DIR__ . './dolibarr.lib.php';
$filePathThumb = $filePath . '/thumbs';
if (!dol_is_dir($filePathThumb)) {
dol_mkdir($filePathThumb);
Expand Down