pluginGino-mpdf
 All Data Structures Namespaces Files Functions Variables Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
gino_mpdf Class Reference

Classe che funge da interfaccia alla classe plugin_mpdf. More...

Public Member Functions

 __construct ($options=array())
 
 header ($options=array())
 
 footer ($options=array())
 
 content ($options=array())
 
 pdfFromPage ($content, $opts=array())
 
 create ($options=array())
 

Static Public Member Functions

static defineBasicOptions ()
 

Protected Member Functions

 defaultHeader ($options=array())
 
 defaultFooter ($options=array())
 
 setFileName ($options=array())
 
 frontpage ($title)
 
 repeatChar ($string, $num, $break=null)
 
 redirect ($link)
 
 mText ($string, $options=array())
 
 convertHtmlToPdf ($html, $exit=true)
 
 breakpage ()
 
 printTable ($data=array(), $header=array(), $options=array())
 
 arrangeTable ($items, $selected, $options=array())
 

Protected Attributes

 $_registry
 
 $_html
 
 $_pdf
 

Private Member Functions

 parseFieldForArrangeTable ($obj, $field, $options=array())
 

Detailed Description

Classe che funge da interfaccia alla classe plugin_mpdf.

Copyright
2014-2015 Otto srl (http://www.opensource.org/licenses/mit-license.php) The MIT License
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

I metodi header(), footer() e content() contengono i dati del pdf e vengono sovrascritti dalla child class.
I defaultHeader() e defaultFooter() contengono l'header e il footer di default.

I dati in arrivo dal database devono essere gestiti attraverso l'interfaccia di gestione delle stringhe gino_mpdf::mText().

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

Constructor & Destructor Documentation

__construct (   $options = array())

Costruttore

Parameters
array$optionsarray associativo di opzioni
  • html (boolean): indica se mostrare l'html o creare il file pdf
Returns
void

Se si mostra l'html (html=true) la pagina carica lo stesso il file di stile specificato nell'opzione css_file del metodo create().

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

Member Function Documentation

arrangeTable (   $items,
  $selected,
  $options = array() 
)
protected

Tabella che dispone gli elementi su 2/3 colonne a partire da sinistra e dall'alto verso il basso

See Also
parseFieldForArrangeTable()
Parameters
array$itemsarray contente gli oggetti degli elementi della tabella
array$selectedarray contenente i valori id degli elementi selezionati
array$options
  • cols (integer): numero di colonne (default 2, massimo 3)
  • field (mixed):
    • string, nome del campo degli oggetti $items da mostrare
    • array, elenco dei campi degli oggetti $items da mostrare
  • separator (string): separatore dei valori dei campi esplicitati nell'opzione field (nel caso di array)
  • table_class (string): nome della classe del tag table
  • td_class (string): nome della classe del tag td
  • add_rows (string): righe da aggiungere in fondo alla tabella
Returns
string

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

breakpage ( )
protected

Interfaccia al metodo di break page

See Also
plugin_mpdf::breakPage()
Returns
string

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

content (   $options = array())

Definizione dei contenuti di un pdf

Parameters
array$optionsarray associativo di opzioni per la generazione del pdf (
See Also
create())
Returns
string or array

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

convertHtmlToPdf (   $html,
  $exit = true 
)
protected

Interfaccia al metodo di generazione di un testo html compatibile con il pdf

See Also
plugin_mpdf::htmlCreate()
Parameters
string$html
boolean$exit
Returns
string

Da utilizzare per la gestione di pagine con impostazioni personalizzate.

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

create (   $options = array())

Costruisce il file

See Also
Gino.Plugin.plugin_mpdf::definePage()
Gino.Plugin.plugin_mpdf::makeFile()
header()
footer()
content()
Parameters
array$optionsarray associativo di opzioni
  • output (string): tipologia di output del pdf (
See Also
plugin_mpdf::outputs())
  • file
  • inline
  • download
  • string
  • debug (boolean): attiva il debug (default false)
  • content (string): contenuto del file; se nullo va a leggere il metodo self::content()
  • filename (string): nome del file (default doc.pdf)
  • img_dir (string): percorso alle immagini nel pdf
  • save_dir (string): percorso alla directory di salvataggio del file
  • css_file (mixed): percorso ai file css inclusi nel pdf (caricati in
    See Also
    plugin_mpdf::definePage())
  • css_html (string): percorso al file css incluso nel formato html (ad esempio 'app/news/css/web.css') opzioni specifiche del metodo plugin_mpdf::makeFile():
  • title (string)
  • author (string)
  • creator (string)
  • format (string)
  • landscape (boolean)
  • protection (array)
  • user_password (string)
  • owner_password (string)
  • title (string)
  • watermark (boolean)
  • watermark_text (string)
  • top-margin (integer)
  • bottom-margin (integer)
  • header-margin (integer)
  • footer-margin (integer)
  • simpleTables (boolean)
  • showStats (boolean)
  • progressBar (mixed)
  • progbar_heading (string)
  • progbar_altHTML (string) opzioni specifiche del metodo plugin_mpdf::definePage():
  • header (string)
  • footer (string)
  • debug_exit (boolean)
    Returns
    mixed (
    See Also
    plugin_mpdf::makeFile())
  • string, html and output string
  • boolean true, output File
  • exit, output inline and download

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

defaultFooter (   $options = array())
protected

Footer base

Parameters
array$optionsarray associativo di opzioni
  • text1 (string): testo da mostrare nella parte sinistra del piè di pagina
  • text2 (string): testo da mostrare al centro del piè di pagina
Returns
string

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

defaultHeader (   $options = array())
protected

Header base

Parameters
array$optionsarray associativo di opzioni
  • text_left (string): testo da mostrare nella parte sinistra dell'intestazione
  • text_right (string): testo da mostrare nella parte destra dell'intestazione
  • title (string): titolo da mostrare sotto l'intestazione
Returns
string

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

static defineBasicOptions ( )
static

Definisce le impostazioni base per la libreria mPDF

Returns
array

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

footer (   $options = array())

Footer del file pdf

Parameters
array$optionsarray associativo di opzioni
  • img_dir (string): percorso alle immagini
Returns
string

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

frontpage (   $title)
protected

Pagina di copertina

Parameters
string$titletitolo della copertina
Returns
string

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

header (   $options = array())

Header del file pdf

Parameters
array$optionsarray associativo di opzioni
  • img_dir (string): percorso alle immagini
Returns
string

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

mText (   $string,
  $options = array() 
)
protected

Interfaccia di gestione delle stringhe

Se esiste l'oggetto pdf, le stringhe vengono passate al metodo plugin_mpdf::text().

See Also
plugin_mpdf::text()
Parameters
string$stringtesto da gestire
array$optionsarray associativo di opzioni del metodo plugin_mpdf::text()
Returns
string

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

parseFieldForArrangeTable (   $obj,
  $field,
  $options = array() 
)
private

Gestisce i valori delle celle del metodo arrangeTable()

Parameters
object$objoggetto dal quale recuperare i valori dei campi indicati nel parametro field
mixed$field
  • string, nome del campo
  • array, elenco dei nomi dei campi
array$optionsarray associativo di opzioni
  • separator (string): separatore dei valori dei campi esplicitati nel parametro field (nel caso di array)
Returns
string

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

pdfFromPage (   $content,
  $opts = array() 
)

Genera il pdf di una pagina html

See Also
Gino.Plugin.gino_mpdf::defineBasicOptions()
Gino.Plugin.gino_mpdf::create()
Parameters
string$contentcontenuto della risposta
array$optsarray associativo di opzioni
  • link_return (string): indirizzo di reindirizzamento dopo la creazione del file pdf opzioni di gino_mpdf::create()
  • output (string): tipo di output (default inline)
  • filename (string): nome del file
  • img_dir (string): percorso della directory delle immagini per header e footer (es. app/blog/img)
  • save_dir (string): percorso della directory di salvataggio dei file (es. $this->getBaseAbsPath().'/pdf')
  • css_html (string): file css per l'html (es. app/blog/blog_blog.css) opzione del costruttore della classe plugin_mpdf
  • output (string): tipo di output (default inline)
  • debug (boolean): abilita la modalità debug opzioni di plugin_mpdf::makeFile() opzioni di plugin_mpdf::definePage()
  • css_file (mixed): file css per per il pdf (es. array('app/blog/pdf.css', 'css/mpdf.css'))
  • header
  • footer
  • debug_exit
Returns
mixed (void or string)

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

printTable (   $data = array(),
  $header = array(),
  $options = array() 
)
protected

Stampa una tabella composta da n elementi

Parameters
array$dataelementi della tabella, ogni elemento è una riga; ad esempio array(array($record1_field1, $record1_field2), array($record2_field1, $record2_field2))
array$headerintestazioni della tabella, ad esempio:
array("<td width=\"5%\">"._("ID")."</td>", "<td width=\"10%\">"._("Quantità")."</td>")
array$optionsarray associativo di opzioni
  • class (string): nome della classe css
  • style (string): definizione degli stili css (proprietà style)
  • autosize (integer): fattore massimo di restringimento consentito per una singola tabella (con [autosize=1] la tabella non viene ridimensionata)
  • border (integer): valore della proprietà border
Returns
string

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

redirect (   $link)
protected

Redirige il processo di creazione del file all'indirizzo specificato

Si utilizza il javascript perché la funzione header() ritorna l'errore:
Warning: Cannot modify header information - headers already sent in ...

Parameters
string$link

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

repeatChar (   $string,
  $num,
  $break = null 
)
protected

Gestisce la ripetizione di una stringa (uno o più caratteri)

Parameters
string$stringcarattere/i da ripetere
integer$numnumero di ripetizioni
integer$breaknumero di caratteri dopo i quali inserire un tag br
Returns
string

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

setFileName (   $options = array())
protected

Imposta il nome del file pdf

Parameters
array$optionsarray associativo di opzioni
  • name (string): nome base del file
  • date (boolean): indica se mostrare la data di creazione del file (default false)
Returns
string

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

Field Documentation

$_html
protected

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

$_pdf
protected

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

$_registry
protected

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

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