pdf_timespent::write_file()

Complexity

Conditions	46
Paths	> 20000

Size

Total Lines	356
Code Lines	222

Duplication

Lines	0
Ratio	0 %

Importance

Changes

0

<?php
    public function write_file($object, $outputlangs)
    {
        // phpcs:enable
        global $conf, $hookmanager, $langs, $user;

        if (!is_object($outputlangs)) {
            $outputlangs = $langs;
        }
        // For backward compatibility with FPDF, force output charset to ISO, because FPDF expect text to be encoded in ISO
        if (getDolGlobalString('MAIN_USE_FPDF')) {
            $outputlangs->charset_output = 'ISO-8859-1';
        }

        // Load traductions files required by page
        $outputlangs->loadLangs(array("main", "dict", "companies", "projects"));

        if ($conf->project->multidir_output[$object->entity]) {
            //$nblines = count($object->lines);  // This is set later with array of tasks

            $objectref = dol_sanitizeFileName($object->ref);
            $dir = $conf->project->multidir_output[$object->entity];
            if (!preg_match('/specimen/i', $objectref)) {
                $dir .= "/" . $objectref;
            }
            $file = $dir . "/" . $objectref . ".pdf";

            if (!file_exists($dir)) {
                if (dol_mkdir($dir) < 0) {
                    $this->error = $langs->transnoentities("ErrorCanNotCreateDir", $dir);
                    return 0;
                }
            }

            if (file_exists($dir)) {
                // Add pdfgeneration hook
                if (!is_object($hookmanager)) {
                    $hookmanager = new HookManager($this->db);
                }
                $hookmanager->initHooks(array('pdfgeneration'));
                $parameters = array('file' => $file, 'object' => $object, 'outputlangs' => $outputlangs);
                global $action;
                $reshook = $hookmanager->executeHooks('beforePDFCreation', $parameters, $object, $action); // Note that $action and $object may have been modified by some hooks

                // Create pdf instance
                $pdf = pdf_getInstance($this->format);
                $default_font_size = pdf_getPDFFontSize($outputlangs); // Must be after pdf_getInstance
                $pdf->SetAutoPageBreak(1, 0);

                $heightforinfotot = 40; // Height reserved to output the info and total part
                $heightforfreetext = (isset($conf->global->MAIN_PDF_FREETEXT_HEIGHT) ? $conf->global->MAIN_PDF_FREETEXT_HEIGHT : 5); // Height reserved to output the free text on last page
                $heightforfooter = $this->marge_basse + 8; // Height reserved to output the footer (value include bottom margin)
                if (getDolGlobalString('MAIN_GENERATE_DOCUMENTS_SHOW_FOOT_DETAILS')) {
                    $heightforfooter += 6;
                }

                if (class_exists('TCPDF')) {
                    $pdf->setPrintHeader(false);
                    $pdf->setPrintFooter(false);
                }
                $pdf->SetFont(pdf_getPDFFont($outputlangs));
                // Set path to the background PDF File
                if (getDolGlobalString('MAIN_ADD_PDF_BACKGROUND')) {
                    $pagecount = $pdf->setSourceFile($conf->mycompany->dir_output . '/' . getDolGlobalString('MAIN_ADD_PDF_BACKGROUND'));
                    $tplidx = $pdf->importPage(1);
                }

                // Complete object by loading several other information
                $task = new Task($this->db);
                $tasksarray = $task->getTasksArray(0, 0, $object->id);

                if (!$object->id > 0) {  // Special case when used with object = specimen, we may return all lines
                    $tasksarray = array_slice($tasksarray, 0, min(5, count($tasksarray)));
                }

                $object->lines = $tasksarray;
                $nblines = count($object->lines);

                $pdf->Open();
                $pagenb = 0;
                $pdf->SetDrawColor(128, 128, 128);

                $pdf->SetTitle($outputlangs->convToOutputCharset($object->ref));
                $pdf->SetSubject($outputlangs->transnoentities("Project"));
                $pdf->SetCreator("Dolibarr " . DOL_VERSION);
                $pdf->SetAuthor($outputlangs->convToOutputCharset($user->getFullName($outputlangs)));
                $pdf->SetKeyWords($outputlangs->convToOutputCharset($object->ref) . " " . $outputlangs->transnoentities("Project"));
                if (getDolGlobalString('MAIN_DISABLE_PDF_COMPRESSION')) {
                    $pdf->SetCompression(false);
                }

                // @phan-suppress-next-line PhanPluginSuspiciousParamOrder
                $pdf->SetMargins($this->marge_gauche, $this->marge_haute, $this->marge_droite); // Left, Top, Right

                // New page
                $pdf->AddPage();
                if (!empty($tplidx)) {
                    $pdf->useTemplate($tplidx);
                }
                $pagenb++;
                $this->_pagehead($pdf, $object, 1, $outputlangs);
                $pdf->SetFont('', '', $default_font_size - 1);
                $pdf->MultiCell(0, 3, ''); // Set interline to 3
                $pdf->SetTextColor(0, 0, 0);

                $tab_top = 50;
                $tab_top_newpage = (!getDolGlobalInt('MAIN_PDF_DONOTREPEAT_HEAD') ? 42 : 10);

                $tab_height = $this->page_hauteur - $tab_top - $heightforfooter - $heightforfreetext;

                // Show public note
                $notetoshow = empty($object->note_public) ? '' : $object->note_public;
                if ($notetoshow) {
                    $substitutionarray = pdf_getSubstitutionArray($outputlangs, null, $object);
                    complete_substitutions_array($substitutionarray, $outputlangs, $object);
                    $notetoshow = make_substitutions($notetoshow, $substitutionarray, $outputlangs);
                    $notetoshow = convertBackOfficeMediasLinksToPublicLinks($notetoshow);

                    $tab_top -= 2;

                    $pdf->SetFont('', '', $default_font_size - 1);
                    $pdf->writeHTMLCell(190, 3, $this->posxref - 1, $tab_top - 2, dol_htmlentitiesbr($notetoshow), 0, 1);
                    $nexY = $pdf->GetY();
                    $height_note = $nexY - $tab_top;

                    // Rect takes a length in 3rd parameter
                    $pdf->SetDrawColor(192, 192, 192);
                    $pdf->Rect($this->marge_gauche, $tab_top - 2, $this->page_largeur - $this->marge_gauche - $this->marge_droite, $height_note + 2);

                    $tab_height = $tab_height - $height_note;
                    $tab_top = $nexY + 6;
                } else {
                    $height_note = 0;
                }

                $heightoftitleline = 10;
                $iniY = $tab_top + $heightoftitleline + 1;
                $curY = $tab_top + $heightoftitleline + 1;
                $nexY = $tab_top + $heightoftitleline + 1;

                $tmpuser = new User($this->db);

                // TODO We should loop on record of times spent grouped by user instead of lines of tasks

                // Loop on each lines
                for ($i = 0; $i < $nblines; $i++) {
                    $curY = $nexY;
                    $pdf->SetFont('', '', $default_font_size - 1); // Into loop to work with multipage
                    $pdf->SetTextColor(0, 0, 0);

                    $pdf->setTopMargin($tab_top_newpage);
                    $pdf->setPageOrientation('', 1, $heightforfooter + $heightforfreetext + $heightforinfotot); // The only function to edit the bottom margin of current page to set it.
                    $pageposbefore = $pdf->getPage();

                    // Description of line
                    $ref = $object->lines[$i]->ref;
                    $libelleline = $object->lines[$i]->label;
                    //$progress=($object->lines[$i]->progress?$object->lines[$i]->progress.'%':'');
                    $datestart = dol_print_date($object->lines[$i]->date_start, 'day');
                    $dateend = dol_print_date($object->lines[$i]->date_end, 'day');
                    $duration = convertSecondToTime((int)$object->lines[$i]->duration, 'allhourmin');

                    $showpricebeforepagebreak = 1;

                    $pdf->startTransaction();
                    // Label
                    $pdf->SetXY($this->posxlabel, $curY);
                    $pdf->MultiCell($this->posxtimespent - $this->posxlabel, 3, $outputlangs->convToOutputCharset($libelleline), 0, 'L');
                    $pageposafter = $pdf->getPage();
                    if ($pageposafter > $pageposbefore) {   // There is a pagebreak
                        $pdf->rollbackTransaction(true);
                        $pageposafter = $pageposbefore;
                        //print $pageposafter.'-'.$pageposbefore;exit;
                        $pdf->setPageOrientation('', 1, $heightforfooter); // The only function to edit the bottom margin of current page to set it.
                        // Label
                        $pdf->SetXY($this->posxlabel, $curY);
                        $posybefore = $pdf->GetY();
                        $pdf->MultiCell($this->posxtimespent - $this->posxlabel, 3, $outputlangs->convToOutputCharset($libelleline), 0, 'L');
                        $pageposafter = $pdf->getPage();
                        $posyafter = $pdf->GetY();
                        if ($posyafter > ($this->page_hauteur - ($heightforfooter + $heightforfreetext + $heightforinfotot))) { // There is no space left for total+free text
                            if ($i == ($nblines - 1)) { // No more lines, and no space left to show total, so we create a new page
                                $pdf->AddPage('', '', true);
                                if (!empty($tplidx)) {
                                    $pdf->useTemplate($tplidx);
                                }
                                if (!getDolGlobalInt('MAIN_PDF_DONOTREPEAT_HEAD')) {
                                    $this->_pagehead($pdf, $object, 0, $outputlangs);
                                }
                                $pdf->setPage($pageposafter + 1);
                            }
                        } else {
                            // We found a page break

                            // Allows data in the first page if description is long enough to break in multiples pages
                            if (getDolGlobalString('MAIN_PDF_DATA_ON_FIRST_PAGE')) {
                                $showpricebeforepagebreak = 1;
                            } else {
                                $showpricebeforepagebreak = 0;
                            }

                            $forcedesconsamepage = 1;
                            if ($forcedesconsamepage) {
                                $pdf->rollbackTransaction(true);
                                $pageposafter = $pageposbefore;
                                $pdf->setPageOrientation('', 1, $heightforfooter); // The only function to edit the bottom margin of current page to set it.

                                $pdf->AddPage('', '', true);
                                if (!empty($tplidx)) {
                                    $pdf->useTemplate($tplidx);
                                }
                                if (!getDolGlobalInt('MAIN_PDF_DONOTREPEAT_HEAD')) {
                                    $this->_pagehead($pdf, $object, 0, $outputlangs);
                                }
                                $pdf->setPage($pageposafter + 1);
                                $pdf->SetFont('', '', $default_font_size - 1); // On repositionne la police par default
                                $pdf->MultiCell(0, 3, ''); // Set interline to 3
                                $pdf->SetTextColor(0, 0, 0);

                                $pdf->setPageOrientation('', 1, $heightforfooter); // The only function to edit the bottom margin of current page to set it.
                                $curY = $tab_top_newpage + $heightoftitleline + 1;

                                // Label
                                $pdf->SetXY($this->posxlabel, $curY);
                                $posybefore = $pdf->GetY();
                                $pdf->MultiCell($this->posxtimespent - $this->posxlabel, 3, $outputlangs->convToOutputCharset($libelleline), 0, 'L');
                                $pageposafter = $pdf->getPage();
                                $posyafter = $pdf->GetY();
                            }
                        }
                        //var_dump($i.' '.$posybefore.' '.$posyafter.' '.($this->page_hauteur -  ($heightforfooter + $heightforfreetext + $heightforinfotot)).' '.$showpricebeforepagebreak);
                    } else { // No pagebreak
                        $pdf->commitTransaction();
                    }
                    $posYAfterDescription = $pdf->GetY();

                    $nexY = $pdf->GetY();
                    $pageposafter = $pdf->getPage();
                    $pdf->setPage($pageposbefore);
                    $pdf->setTopMargin($this->marge_haute);
                    $pdf->setPageOrientation('', 1, 0); // The only function to edit the bottom margin of current page to set it.

                    // We suppose that a too long description is moved completely on next page
                    if ($pageposafter > $pageposbefore && empty($showpricebeforepagebreak)) {
                        //var_dump($pageposbefore.'-'.$pageposafter.'-'.$showpricebeforepagebreak);
                        $pdf->setPage($pageposafter);
                        $curY = $tab_top_newpage + $heightoftitleline + 1;
                    }

                    $pdf->SetFont('', '', $default_font_size - 1); // We reposition the default font

                    // Ref of task
                    $pdf->SetXY($this->posxref, $curY);
                    $pdf->MultiCell($this->posxlabel - $this->posxref, 3, $outputlangs->convToOutputCharset($ref), 0, 'L');
                    // timespent
                    $pdf->SetXY($this->posxtimespent, $curY);
                    $pdf->MultiCell($this->posxuser - $this->posxtimespent, 3, $duration ? $duration : '', 0, 'R');
                    // Progress
                    //$pdf->SetXY($this->posxprogress, $curY);
                    //$pdf->MultiCell($this->posxuser-$this->posxprogress, 3, $progress, 0, 'R');

                    // User spending time
                    /*var_dump($object->lines[$i]);exit;
                    $tmpuser->fetch($object->lines[$i]->fk_user);
                    $pdf->SetXY($this->posxuser, $curY);
                    $pdf->MultiCell($this->page_largeur - $this->marge_droite - $this->posxuser, 3, $tmpuser->getFullName($outputlangs, 0, -1, 20), 0, 'C');
                    */

                    // Add line
                    if (getDolGlobalString('MAIN_PDF_DASH_BETWEEN_LINES') && $i < ($nblines - 1)) {
                        $pdf->setPage($pageposafter);
                        $pdf->SetLineStyle(array('dash' => '1,1', 'color' => array(80, 80, 80)));
                        //$pdf->SetDrawColor(190,190,200);
                        $pdf->line($this->marge_gauche, $nexY + 1, $this->page_largeur - $this->marge_droite, $nexY + 1);
                        $pdf->SetLineStyle(array('dash' => 0));
                    }

                    $nexY += 2; // Add space between lines

                    // Detect if some page were added automatically and output _tableau for past pages
                    while ($pagenb < $pageposafter) {
                        $pdf->setPage($pagenb);
                        if ($pagenb == 1) {
                            $this->_tableau($pdf, $tab_top, $this->page_hauteur - $tab_top - $heightforfooter, 0, $outputlangs, 0, 1);
                        } else {
                            $this->_tableau($pdf, $tab_top_newpage, $this->page_hauteur - $tab_top_newpage - $heightforfooter, 0, $outputlangs, 1, 1);
                        }
                        $this->_pagefoot($pdf, $object, $outputlangs, 1);
                        $pagenb++;
                        $pdf->setPage($pagenb);
                        $pdf->setPageOrientation('', 1, 0); // The only function to edit the bottom margin of current page to set it.
                        if (!getDolGlobalInt('MAIN_PDF_DONOTREPEAT_HEAD')) {
                            $this->_pagehead($pdf, $object, 0, $outputlangs);
                        }
                        if (!empty($tplidx)) {
                            $pdf->useTemplate($tplidx);
                        }
                    }
                    if (isset($object->lines[$i + 1]->pagebreak) && $object->lines[$i + 1]->pagebreak) {
                        if ($pagenb == 1) {
                            $this->_tableau($pdf, $tab_top, $this->page_hauteur - $tab_top - $heightforfooter, 0, $outputlangs, 0, 1);
                        } else {
                            $this->_tableau($pdf, $tab_top_newpage, $this->page_hauteur - $tab_top_newpage - $heightforfooter, 0, $outputlangs, 1, 1);
                        }
                        $this->_pagefoot($pdf, $object, $outputlangs, 1);
                        // New page
                        $pdf->AddPage();
                        if (!empty($tplidx)) {
                            $pdf->useTemplate($tplidx);
                        }
                        $pagenb++;
                        if (!getDolGlobalInt('MAIN_PDF_DONOTREPEAT_HEAD')) {
                            $this->_pagehead($pdf, $object, 0, $outputlangs);
                        }
                    }
                }

                // Show square
                if ($pagenb == 1) {
                    $this->_tableau($pdf, $tab_top, $this->page_hauteur - $tab_top - $heightforinfotot - $heightforfreetext - $heightforfooter, 0, $outputlangs, 0, 0);
                } else {
                    $this->_tableau($pdf, $tab_top_newpage, $this->page_hauteur - $tab_top_newpage - $heightforinfotot - $heightforfreetext - $heightforfooter, 0, $outputlangs, 1, 0);
                }
                $bottomlasttab = $this->page_hauteur - $heightforinfotot - $heightforfreetext - $heightforfooter + 1;

                // Footer of the page
                $this->_pagefoot($pdf, $object, $outputlangs);
                if (method_exists($pdf, 'AliasNbPages')) {
                    $pdf->AliasNbPages();
                }

                $pdf->Close();

                $pdf->Output($file, 'F');

                // Add pdfgeneration hook
                $hookmanager->initHooks(array('pdfgeneration'));
                $parameters = array('file' => $file, 'object' => $object, 'outputlangs' => $outputlangs);
                global $action;
                $reshook = $hookmanager->executeHooks('afterPDFCreation', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
                if ($reshook < 0) {
                    $this->error = $hookmanager->error;
                    $this->errors = $hookmanager->errors;
                }

                dolChmod($file);

                $this->result = array('fullpath' => $file);

                return 1; // No error
            } else {
                $this->error = $langs->transnoentities("ErrorCanNotCreateDir", $dir);
                return 0;
            }
        } else {
            $this->error = $langs->transnoentities("ErrorConstantNotDefined", "PROJECT_OUTPUTDIR");
            return 0;
        }