pluginGino-mpdf
 All Data Structures Namespaces Files Functions Variables Pages
plugin_mpdf Class Reference

Classe per la generazione di file pdf. More...

Public Member Functions

 __construct ($options=array())
 
 htmlStart ($options=array())
 
 defaultFooter ()
 
 htmlEnd ()
 
 htmlCreate ($html)
 
 definePage ($text, $options=array())
 
 makeFile ($filename, $options=array())
 
 sendToEmail ($mpdf_output, $filename, $options=array())
 
 dataToDB ($mpdf_output)
 
 getToDataDB ($data)
 
 breakpage ()
 
 longText ($text)
 
 text ($text, $options=array())
 

Static Public Member Functions

static outputs ()
 
static setPhpParams ($options=array())
 
static getMemoryUsage ($options=array())
 

Private Member Functions

 conformFile ($filename='')
 

Private Attributes

 $_output
 
 $_debug
 

Detailed Description

Classe per la generazione di file pdf.

Author
marco guidotti guido.nosp@m.ttim.nosp@m.@gmai.nosp@m.l.co.nosp@m.m
abidibo abidi.nosp@m.bo@g.nosp@m.mail..nosp@m.com

Definition at line 1244 of file plugin.mpdf.php.

Constructor & Destructor Documentation

__construct (   $options = array())

Costruttore

Parameters
arrayoptions array associativo di opzioni
  • output (string): tipo di output del file pdf; deve essere conforme a quelli presenti nel metodo mpdf::outputs()
    • inline: send to standard output; invia il file inline al browser (default)
    • download: download file
    • file: salva localmente il file; indicare il percorso assoluto
    • string: ritorna una stringa
  • debug (boolean): stampa a video il buffer (default false)
Returns
void

Definition at line 1273 of file plugin.mpdf.php.

Member Function Documentation

breakpage ( )

Break di pagina

Returns
string

Definition at line 1888 of file plugin.mpdf.php.

conformFile (   $filename = '')
private

Estrapola il nome del file pdf

Parameters
string$filename
Returns
string

Definition at line 1375 of file plugin.mpdf.php.

dataToDB (   $mpdf_output)

Formatta il contenuto da salvare in un campo del database

Parameters
string$mpdf_outputoutput con opzione 'string'
Returns
string

Definition at line 1856 of file plugin.mpdf.php.

defaultFooter ( )

Footer standard

Returns
string

Definition at line 1472 of file plugin.mpdf.php.

definePage (   $text,
  $options = array() 
)

Definizione del contenuto html

See Also
htmlStart()
htmlEnd()
htmlCreate()
Parameters
string$text
array$optionsarray associativo di opzioni
  • css_file (mixed): percorso ai file css inclusi nel pdf
    • array, elenco dei file (ad esempio array('app/news/css/pdf.css', 'app/news/css/local.css'))
    • string
  • header (string)
  • footer (string)
  • debug_exit (boolean): interrompe il flusso dell'html nel caso di debug attivo
Returns
string

Definition at line 1528 of file plugin.mpdf.php.

static getMemoryUsage (   $options = array())
static

Memoria allocata dallo script php

Parameters
array$optionsarray associativo di opzioni
  • memory_usage (boolean): ritorna l'ammontare di memoria allocata da php (in byte); si tratta della quantità di memoria utilizzata non appena viene eseguito lo script o delle singole istruzioni
  • memory_peak_usage (boolean): ritorna il picco di memoria allocata da php (in byte)
Returns
null

memory_get_usage e memory_get_peak_usage prevedono l'opzione real_usage:

  • true, ritorna la reale dimensione della memoria allocata dal sistema
  • false (o non impostata), soltanto la memoria usata da emalloc()

Richiamando memory_get_peak_usage alla fine dello script si riuscirà a ricavare la più alta allocazione registrata durante l'esecuzione.
Probabilmente è molto più utile questo valore che ottenere i valori di inizio e fine dello script in quanto in questo modo non si tiene conto della memoria allocata e poi deallocata durante il runtime.

Definition at line 1351 of file plugin.mpdf.php.

getToDataDB (   $data)

Recupera il file pdf salvato come stringa in un record del database

Parameters
string$data

Definition at line 1869 of file plugin.mpdf.php.

htmlCreate (   $html)

Processa il testo HTML per renderlo compatibile con la generazione del pdf

See Also
func.mpdf.php, pdfHtmlToEntities()
Parameters
string$htmltesto html
Returns
string or print (debug)

Definition at line 1500 of file plugin.mpdf.php.

htmlEnd ( )

Chiusura del testo html

Returns
string

Definition at line 1486 of file plugin.mpdf.php.

htmlStart (   $options = array())

Imposta l'header e il footer

Parameters
arrayoptions
  • css_file (mixed):
    • string, percorso al file css (default css/mpdf.css)
    • array, elenco dei file css da caricare
  • css_style (string): stili css personalizzati (in un tag style)
  • header (string): header personalizzato
  • footer (mixed):
    • boolean, col valore false il footer non viene mostrato
    • string, footer personalizzato, sono implementate le stringhe sostitutive:
      • NUMPAGE, numero di pagina
      • TOTPAGE, numero totale di pagine
    • in tutti gli altri casi viene mostrato il footer standard
Returns
string

Definition at line 1407 of file plugin.mpdf.php.

longText (   $text)

Contenitore di testo

Parameters
string$text
Returns
string

Definition at line 1899 of file plugin.mpdf.php.

makeFile (   $filename,
  $options = array() 
)

Crea il file pdf

See Also
mPDF::WriteHTML()
mPDF::Output()
Parameters
string$filenamenome del file pdf
array$optionsarray associativo di opzioni
  • title (string): titolo del pdf
  • author (string): autore del pdf
  • creator (string): chi ha generato il pdf
  • watermark (boolean): scritta in sovraimpressione (default false)
  • watermark_text (string): testo della scritta in sovraimpressione (default 'esempio')
  • format (string): formato della pagina (default A4)
  • landscape (boolean): orientamento orizzontale della pagina (default false)
  • mode (string): codifica del testo (default utf-8)
  • protection (array): crittografa e imposta i permessi per il file pdf; il valore di default è null, ovvero il documento non è crittografato e garantisce tutte le autorizzazioni all'utente.
    L'array può includere alcuni, tutti o nessuno dei seguenti valori che indicano i permessi concessi:
    • copy
    • print
    • modify
    • annot-forms
    • fill-forms
    • extract
    • assemble
    • print-highres
  • user_password (string): password utente del pdf
  • owner_password (string): password del proprietario del pdf
  • font_size (integer)
  • font (string)
  • top-margin (integer): distance in mm from top of page to start of text (ignoring any headers)
  • header-margin (integer): distance in mm from top of page to start of header
  • bottom-margin (integer): distance in mm from bottom of page to bottom of text (ignoring any footers)
  • footer-margin (integer): distance in mm from bottom of page to bottom of footer
  • orientation (string): specifica l'orientamento di una nuova pagina; i valori accettati sono:
    • L, landscape
    • P, portrait (default)
  • simpleTables (boolean): disabilita gli stili css complessi delle tabelle (bordi, padding, ecc.) per incrementare le performance (default false)
  • showStats (boolean): visualizza i valori di performance relativi al file pdf (default false); l'opzione sopprime l'output del file pdf e visualizza i dati sul browser, tipo:
    Generated in 0.45 seconds
    Compiled in 0.46 seconds (total)
    Peak Memory usage 10.25MB
    PDF file size 37kB
    Number of fonts 6
  • progressBar (mixed): abilita la visualizzazione di una barra di progresso durante la generazione del file; non è raccomandata come utilizzo generale ma può essere utile in ambiente di sviluppo e nella generazione lenta di documenti
    • 1, visualizza la progress bar
    • 2, visualizza più di una progress bar per un esame dettagliato del progresso
    • false, disabilita la progress bar (default)
  • progbar_heading (string): heading personalizzato della progressBar
  • progbar_altHTML (string): progressBar personalizzata (html) opzioni sui contenuti
  • content (mixed): contenuto del file; se nullo legge il metodo self::content()
    • string, contenuti con pagine aventi la stessa formattazione
    • array, contenuti con pagine che possono cambiare formattazione, come ad esempio l'orientamento; struttura dell'array: array([, string html], array(orientation=>[, string [L|P]], html=>[, string]), ...)
  • object (object): oggetto gino_mpdf
  • img_dir (string): percorso ai file immagine di header/footer
Returns
mixed
  • string (output string)
  • exit (output inline e download)
  • boolean true (output file)

Esempio:

$pdf->makeFile(
$filename,
array(
'title'=>_("Progetto"),
'author'=>_("Otto Srl"),
'creator'=>_("Marco Guidotti"),
'content'=>array($html1, array('orientation'=>'L', 'html'=>$html2)),
'object'=>$this
));

Il costruttore della classe mPDF viene costruito con i seguenti valori di default

function mPDF($mode='',$format='A4',$default_font_size=0,$default_font='',$mgl=15,$mgr=15,$mgt=16,$mgb=16,$mgh=9,$mgf=9, $orientation='P') { ... }

Definition at line 1629 of file plugin.mpdf.php.

static outputs ( )
static

Tipologie di output del pdf

Returns
array

Definition at line 1294 of file plugin.mpdf.php.

sendToEmail (   $mpdf_output,
  $filename,
  $options = array() 
)

Invia il file pdf come allegato email

Parameters
string$mpdf_outputoutput con opzione 'string'
string$filenamenome del file allegato alla email
array$optionsarray associativo di opzioni
  • mailto (string)
  • from_name (string)
  • from_mail (string)
  • replyto (string)
  • subject (string)
  • message (string)
Returns
void
Todo:
Verificare se occorre utilizzare
al posto di

Definition at line 1815 of file plugin.mpdf.php.

static setPhpParams (   $options = array())
static

Imposta alcuni parametri di configurazione in uno script php

Parameters
array$optionsarray associativo di opzioni
  • disable_error (boolean): blocca tutte le segnalazioni d'errore (default false)
  • memory_limit (string): quantità di memoria permessa a PHP nello script (es. 16M); -1 => memoria infinita (pericoloso in produzione!)
  • max_execution_time (integer): tempo massimo di esecuzione dello script in secondi (300 seconds = 5 minutes)
Returns
null

Definition at line 1309 of file plugin.mpdf.php.

text (   $text,
  $options = array() 
)

Gestione del testo

Parameters
string$text
array$optionsarray associativo di opzioni
  • class (string): classe del tag span, es. 'label'
  • style (string): stile del tag span, es. 'color:#000000; font-size:10px';
  • other (string): altro nel tag span
  • type (string): tipo di dato (default text)
Returns
string

Definition at line 1922 of file plugin.mpdf.php.

Field Documentation

$_debug
private

Definition at line 1258 of file plugin.mpdf.php.

$_output
private

Definition at line 1251 of file plugin.mpdf.php.


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