PDF_Core Class Reference

API for creating PDF, unicode, based on tfpdf. More...

Inheritance diagram for PDF_Core:

Collaboration diagram for PDF_Core:

Public Member Functions
	__construct ( $orientation='P', $unit='mm', $format='A4')
	fill_row ($enable)
	set color for row ,
	get_margin_bottom ()
	get_margin_left ()
	get_margin_right ()
	get_margin_top ()
	get_orientation ()
	get_page_size ()
	get_unit ()
	is_fill ($p_step)
	If the step is even then return 1 and set the backgroup color to blue , otherwise returns 0, and set the background color to white It is use to compute alternated colored row , it the parameter fill in write_cell and cell.
	line_new ($p_step=null)
	Print all the cell stored and call Ln (new line)
	LongLine ($w, $h, $txt, $border=0, $align='', $fill=false)
	add a cell with automatic return to the line if the text is too long, deprecated , it calls only PDFCore::write_cell_
	write_cell ($width, $height=0, $txt='', $border=0, $interline=0, $align='', $fill=false, $link='')
	add a cell the text is not cut and don't return to this line if too large
	write_multi ($width, $interline, $txt, $border=0, $align='', $fill=false)
	add a cell with automatic return to the line if the text is too long

Protected Member Functions
	add_cell (Cellule $Ce)
	check_page_add ()
	Check if a page must be added due a MultiCell.
	count_nb_row ($p_text, $p_colSize)
	Count the number of rows a p_text will take for a multicell.
	print_row ()
	print the current array of cell and reset it , if different colors are set on the same row you have to print it before changing

Protected Attributes
	$bigger
	$cells =array()

Detailed Description

API for creating PDF, unicode, based on tfpdf.

See also

TFPDF

Definition at line 62 of file pdf_core.class.php.

Constructor & Destructor Documentation

__construct()

PDF_Core::__construct	(		$orientation = 'P',
			$unit = 'mm',
			$format = 'A4' )

Definition at line 70 of file pdf_core.class.php.

    {
        $this->bigger=0;
 
        parent::__construct($orientation, $unit, $format);
        $this->AddFont('DejaVu','','DejaVuSans.ttf',true);
        $this->AddFont('DejaVu','I','DejaVuSans-Oblique.ttf',true);
        $this->AddFont('DejaVu','B','DejaVuSans-Bold.ttf',true);
        $this->AddFont('DejaVu','BI','DejaVuSans-BoldOblique.ttf',true);
        $this->AddFont('DejaVuCond','','DejaVuSansCondensed.ttf',true);
        $this->AddFont('DejaVuCond','B','DejaVuSansCondensed-Bold.ttf',true);
        $this->AddFont('DejaVuCond','I','DejaVuSansCondensed-Oblique.ttf',true);
        $this->AddFont('DejaVuCond','BI','DejaVuSansCondensed-BoldOblique.ttf',true);
 
        
 
        $this->cells=array();
    }

Member Function Documentation

add_cell()

PDF_Core::add_cell ( Cellule $Ce )

protected

Definition at line 263 of file pdf_core.class.php.

    {
        $size=count($this->cells);
        $this->cells[$size]=$Ce;
        
    }

References $size.

Referenced by write_cell(), and write_multi().

check_page_add()

PDF_Core::check_page_add ( )

protected

Check if a page must be added due a MultiCell.

Returns

boolean

On doit calculer si le texte dépasse la texte et compter le nombre de lignes que le texte prendrait. Ensuite il faut faire un saut de page (renvoit true) si dépasse

Definition at line 156 of file pdf_core.class.php.

    {
        // break on page
        $size=count($this->cells);
        for ($i=0;$i < $size ; $i++)
        {
            if ($this->cells[$i]->type == 'M' )
            {
                /**
                 * On doit calculer si le texte dépasse la texte et compter le
                 * nombre de lignes que le texte prendrait. Ensuite il faut
                 * faire un saut de page (renvoit true) si dépasse
                 */
                
                $sizetext=$this->GetStringWidth($this->cells[$i]->text);
                
                // if text bigger than column width then check
 
                $y=$this->GetY();
                $nb_row=$this->count_nb_row($this->cells[$i]->text, $this->cells[$i]->width);
                $height=$this->cells[$i]->height*$nb_row;
 
                // If the text is bigger than a sheet of paper then return false
                if ($height >= $this->h) return false;
 
                if ( $y + $height > ($this->h - $this->bMargin -7  ))
                    return true;
 
            }
        }
        return false;
    }

References $height, $i, $nb_row, $size, count_nb_row(), h, type, and width.

Referenced by print_row().

Here is the call graph for this function:

count_nb_row()

PDF_Core::count_nb_row ( $p_text, $p_colSize )

protected

Count the number of rows a p_text will take for a multicell.

Parameters

$p_text	String
$p_colSize	size of the column in User Unit

Definition at line 122 of file pdf_core.class.php.

    {
        // If colSize is bigger than the size of the string then it takes 1 line
        if ( $this->GetStringWidth($p_text) <= $p_colSize) return 1;
        $nRow=0;
        $aWords=explode(' ',$p_text);
        $nb_words=count($aWords);
        $string="";
        
        for ($i=0;$i < $nb_words;$i++){
            // Concatenate String with current word + a space 
            $string.=$aWords[$i];
            
            // if there is a word after add a space
            if ( $i+1 < $nb_words) $string.=" ";
            
            // Compute new size and compare to the colSize
            if ( $this->GetStringWidth($string) >= $p_colSize) {
            // If the size of the string if bigger than we add a row, the current
            // word is the first word of the next line
                $nRow++;
                $string=$aWords[$i];
            }
        }
        $nRow++;
        return $nRow;
        
        
        
    }

References $i, and $string.

Referenced by check_page_add().

fill_row()

PDF_Core::fill_row

(

$enable

)

set color for row ,

Parameters

$enable

(int)set color 0 or disable 1

Returns

0 or 1

Definition at line 358 of file pdf_core.class.php.

    {
        return $this->is_fill($enable);
    }

References is_fill().

Referenced by Print_Ledger_Detail_Item\export().

Here is the call graph for this function:

get_margin_bottom()

PDF_Core::get_margin_bottom

(

)

Definition at line 92 of file pdf_core.class.php.

    {
        return $this->bMargin;
        
    }

get_margin_left()

PDF_Core::get_margin_left

(

)

Definition at line 88 of file pdf_core.class.php.

    {
        return $this->lMargin;
    }

get_margin_right()

PDF_Core::get_margin_right

(

)

Definition at line 101 of file pdf_core.class.php.

    {
        return $this->rMargin;
    }

get_margin_top()

PDF_Core::get_margin_top

(

)

Definition at line 97 of file pdf_core.class.php.

    {
        return $this->tMargin;
    }

get_orientation()

PDF_Core::get_orientation

(

)

Definition at line 105 of file pdf_core.class.php.

    {
        return $this->DefOrientation;
    }

get_page_size()

PDF_Core::get_page_size

(

)

Definition at line 113 of file pdf_core.class.php.

    {
        return $this->DefPageSize;
    }

get_unit()

PDF_Core::get_unit

(

)

Definition at line 109 of file pdf_core.class.php.

    {
        return $this->k;
    }

is_fill()

PDF_Core::is_fill

(

$p_step

)

If the step is even then return 1 and set the backgroup color to blue , otherwise returns 0, and set the background color to white It is use to compute alternated colored row , it the parameter fill in write_cell and cell.

See also

PDF:write_cell

TPDF:cell

Definition at line 342 of file pdf_core.class.php.

    {
        if ($p_step % 2 == 0) {
            $this->SetFillColor(239, 239, 255);
            $fill = 1;
        } else {
            $this->SetFillColor(255, 255, 255);
            $fill = 0;
        }
        return $fill;
    }

References $p_step.

Referenced by fill_row().

line_new()

PDF_Core::line_new

(

$p_step = null

)

Print all the cell stored and call Ln (new line)

Parameters

int

$p_step

Definition at line 325 of file pdf_core.class.php.

                                   {
            $this->print_row();
           if ( $this->bigger==0) 
                parent::Ln($p_step);
            else 
                parent::Ln($this->bigger);
            $this->bigger=0;
    }

References $p_step, and print_row().

Referenced by Card_PDF\export(), Print_Ledger_Detail\export(), Print_Ledger_Detail_Item\export(), Print_Ledger_Financial\export(), Print_Ledger_Misc\export(), Print_Ledger_Simple\export(), Print_Ledger_Simple_Without_Vat\export(), Print_Ledger_Detail_Item\Header(), and Noalyss\Invoice_PDF\header().

Here is the call graph for this function:

LongLine()

PDF_Core::LongLine	(		$w,
			$h,
			$txt,
			$border = 0,
			$align = '',
			$fill = false )

add a cell with automatic return to the line if the text is too long, deprecated , it calls only PDFCore::write_cell_

See also

PDF_Core\write_multi()

Parameters

$w	width (in PDF unit )
$h	interline (in pt)
$txt	text to display
$border	border valid values are 1 : border ,0 : no-border, T : top,B : bottom,L : left,R : right
$align	text align valid values are L : left,R : right
$fill	color true or false

Returns

void

Deprecated

Definition at line 315 of file pdf_core.class.php.

    {
        $this->write_multi($w,$h,$txt,$border,$align,$fill);
 
    }

References $align, $w, and write_multi().

Here is the call graph for this function:

print_row()

PDF_Core::print_row ( )

protected

print the current array of cell and reset it , if different colors are set on the same row you have to print it before changing

// fill red , text white
$this->SetFillColor(255,0,0);
$this->SetTextColor(255,255,255);
$this->write_cell(15,5,"PRICE",0,0,'R',fill:true);
 
// print the cell without a linefeed
$this->print_row();
 
// text in black on green
 
$this->SetTextColor(0,0,0);
$this->SetFillColor(0,255,0);
 
$this->write_cell(15,5,nbm($other['price']),0,0,'R');

See also

TFPDF::SetTextColor()

TFPDF::SetFillColor()

TFPDF::SetFontSize()

Returns

void

Definition at line 213 of file pdf_core.class.php.

    {
        static $e=0;
        $e++;
        if ( $this->check_page_add() == true ) $this->AddPage ();
        $this->bigger=0;
        $size=count($this->cells);
        $cell=$this->cells;
        if ($size == 0 )return;
        for ($i=0;$i < $size ; $i++)
        {
            $a=$cell[$i];
            $a->text= noalyss_str_replace("\\", "", $a->text);
            switch ($a->type)
            {
                case "M":
                $x_m=$this->GetX();
                $y_m=$this->GetY();
                parent::MultiCell(
                                    $a->width, 
                                    $a->height, 
                                    $a->text, 
                                    $a->border, 
                                    $a->align, 
                                    $a->fill
                                );
                $x_m=$x_m+$a->width;
                $tmp=$this->GetY()-$y_m;
                if ( $tmp > $this->bigger) $this->bigger=$tmp;
                $this->SetXY($x_m,$y_m);
                break;
                
                case "C":
                    $height=($this->bigger==0)?$a->height:$this->bigger;
                     parent::Cell(   $a->width, 
                                    $height,
                                    $a->text, 
                                    $a->border, 
                                    $a->new_line, 
                                    $a->align, 
                                    $a->fill, 
                                    $a->link);
                    break;
 
                default:
                    break;
            }
        }
        $this->cells=array();
    }

References $a, $bigger, $cells, $e, $height, $i, $size, $tmp, check_page_add(), and noalyss_str_replace().

Referenced by line_new().

Here is the call graph for this function:

write_cell()

PDF_Core::write_cell	(		$width,
			$height = 0,
			$txt = '',
			$border = 0,
			$interline = 0,
			$align = '',
			$fill = false,
			$link = '' )

add a cell the text is not cut and don't return to this line if too large

Parameters

$width	width (in PDF unit )
$height	height (in PDF unit )
$txt	text to print (unicode)
$border	border valid values are 1 : border ,0 : no-border, T : top,B : bottom,L : left,R : right
$interline	(unit pt ) space between lines
$align	text alignment valid values are L : left,R : right
$fill	color true or false
$link	url

Returns

void

Definition at line 281 of file pdf_core.class.php.

    {
        $this->add_cell(new Cellule($width,$height,$txt,$border,$interline,$align,$fill,$link,'C'));
        
    }

References $align, $height, $width, and add_cell().

Referenced by Card_PDF\export(), Print_Ledger_Detail\export(), Print_Ledger_Detail_Item\export(), Print_Ledger_Financial\export(), Print_Ledger_Misc\export(), Print_Ledger_Simple\export(), Print_Ledger_Simple_Without_Vat\export(), and Print_Ledger_Detail_Item\Header().

Here is the call graph for this function:

write_multi()

PDF_Core::write_multi	(		$width,
			$interline,
			$txt,
			$border = 0,
			$align = '',
			$fill = false )

add a cell with automatic return to the line if the text is too long

Parameters

$width	width (in PDF unit )
$interline	interline (unit pt)
$txt	text to print (unicode)
$border	border valid values are 1 : border ,0 : no-border, T : top,B : bottom,L : left,R : right
$align	text alignment valid values are L : left,R : right
$fill	color true or false

Returns

void

Definition at line 296 of file pdf_core.class.php.

    {
        $this->add_cell(new Cellule($width,$interline,$txt,$border,0,$align,$fill,'','M'));
 
    }

References $align, $width, and add_cell().

Referenced by Print_Ledger_Detail\export(), Print_Ledger_Detail_Item\export(), Print_Ledger_Financial\export(), Print_Ledger_Misc\export(), Print_Ledger_Simple\export(), Print_Ledger_Simple_Without_Vat\export(), Noalyss\Invoice_PDF\header(), and LongLine().

Here is the call graph for this function:

Field Documentation

$bigger

PDF_Core::$bigger

protected

Definition at line 68 of file pdf_core.class.php.

Referenced by print_row().

$cells

PDF_Core::$cells =array()

protected

Definition at line 67 of file pdf_core.class.php.

Referenced by print_row().

---

The documentation for this class was generated from the following file:

• include/lib/pdf_core.class.php