PDF24 PHP PDF API

Generale

PDF24.org fornisce un Gratuito Servizio di generazione di PDF per creare file PDF. Questa PHP API è un‘interfaccia di questo servizio.
L‘API è stata sviluppata per i blog, Forum, sistemi wiki e altri software internet basati su articoli per creare file PDF in modo semplice. Gli sviluppatori di blog, forum e sistemi wiki possono utilizzare questa API offrendo un pulsante per la conversione PDF.

API Download

Clicca sul link Download il PDF API per scaricare il PDF PHP API.

Riferimenti della class

Ci sono due principali classi PHP che devono essere utilizzate per creare un file PDF. La classe PDF24Doc fornisce la funzionalità per gestire i contenuti generali del documento, come titolo del documento o documento url e fornisce metodi per aggiungere elementi al documento.
La classe PDF24Element rappresenta un elemento contenuto all‘interno di un PDF24Doc documento. Un elemento di contenuto è un container contenente alcuni dati, come un titolo e un corpo html.

La seguente tabella illustra questo:
PDF24Doc
PDF24Element 1
PDF24Element 2
PDF24Element 3

Classe PDF24Doc

Parametri chiave

charset
Il set di caratteri del documento. Il valore predefinito è ISO-8859-1. I valori supportati attualmente sono ISO-8859-1 e UTF-8.
headline
Il titolo del documento.
headlineUrl
Il titolo URL del titolo.
baseUrl
Il baseurl del documento. Questo url è importante se si utilizzano collegamenti relativi nel contenuto del corpo degli elementi. Questo URL viene utilizzato per risolvere link relativi a trovare immagini e altri contenuti.
filename
Il nome del file PDF creato, ad esempio MyFileName.
pageSize
La dimensione di ogni pagina del documento. Il formato è codificato come LARGHEZZAxALTEZZA dove la larghezza è la larghezza di ciascuna pagina in mm e l‘altezza è l‘altezza di ciascuna pagina in mm. La larghezza di default è 210 millimetri e l‘altezza di default è 297 millimetri che rappresenta una pagina ISO A4.
emailTo
Uno o più indirizzi email separati da virgola. Questi indirizzi email riceveranno i file PDF creati.
emailFrom
L‘indirizzo email dell‘utente API che apparirà come indirizzo di provenienza dell‘email con allegati i file PDF.
emailSubject
L‘oggetto della email con il file PDF allegato.
emailBody
Il contenuto della email con il file PDF allegato.
emailBodyType
Il tipo del corpo dell‘email con il file PDF allegato. I valori validi sono text e html.
emailCharset
Questo parametro contiene il set di caratteri del soggetto e del corpo dell‘ email. I valori attuali supportati sono ISO-8859-1 e UTF-8.

Costruttori

PDF24Doc()
Crea un documento oggetto senza parametri. Utilizzare i metodi setXX per impostare i parametri più tardi.
PDF24Doc(params)
Crea un documento oggetto e inizializza i parametri del documento con i parametri indicati in params. params è un vettore PHP con voci chiave-valore. Una chiave è una delle chiavi di sopra dei parametri.

Metodi

addElement(element)
Aggiunge l‘elemento element al documento PDF. element può essere un PDF24Element o un vettore PHP con coppie chiave-valore da PDF24Element.
setParam(paramKey, paramValue)
Imposta un parametro documento con la chiave paramKey e il valore paramValue.
setParams(params)
Consente di impostare i parametri di documento in params. Tutti i parametri precedentemente aggiunti saranno rimossi.
addParams(params)
Aggiunge parametri documento da params. I parametri aggiunti In precedenza possono essere sovrascritti da questo metodo. params è un vettore che contiene le coppie chiave-valore.
getParam(paramKey)
Restituisce il parametro documento con la chiave paramKey.
setCharset(charset)
Imposta il charset parametro del documento a charset. Il charset di default è ISO-8859-1.
setHeadline(headline)
Imposta il headline parametro del documento a headline.
setHeadlineUrl(headlineUrl)
Imposta il headlineUrl parametro del documento a headlineUrl.
setBaseUrl(baseUrl)
Imposta il baseUrl parametro del documento a baseUrl.
setFilename(filename)
Imposta il filename parametro del documento a filename.
setPageSize(width, height)
Imposta il pageSize parametro del documento a width, height.
setEmailTo(emailAddr)
Imposta il emailTo parametro del documento a emailAddr.
addEmailTo(emailAddr)
Aggiunge l‘indirizzo email emailAddr L‘elenco dei destinatari del file PDF.
setEmailFrom(emailAddr)
Imposta il emailFrom parametro del documento a emailAddr.
setEmailSubject(subject)
Imposta il emailSubject parametro del documento a subject.
setEmailBodyType(bodyType)
Imposta il emailBodyType parametro del documento a bodyType. bodyType può essere text o html.
setEmailBody(body)
Imposta il emailBody parametro del documento a body.
setEmailCharset(charset)
Imposta il set di caratteri del corpo e oggetto della email con il file PDF allegato.
createAndSend()
Questo metodo racchiude tutti i parametri in una richiesta di servizio PDF24 e trasmette la richiesta al servizio PDF24. Il servizio controlla la richiesta e dà una risposta che può essereà analizzata. Se la risposta è soddisfacente questo metodo si ripete true altrimenti false viene restituito.

Classe PDF24Element

Parametri chiave

title
Il titolo dell‘elemento.
url
L‘URL dell‘elemento. Il titolo e l‘URL vengono utilizzati per formare un collegamento.
author
L‘autore del contenuto dell‘ elemento.
dateTime
Un timestamp (qualsiasi stringa che rappresenta un timestamp, ad esempio, la data e l‘ora o o solo la data o ora)
body
Il contenuto dell‘elemento. Può essere normale o il testo formattato HTML

Costruttori

PDF24Element()
Crea un elemento senza parametri. Utilizza i metodi setXX per impostare i parametri più tardi.
PDF24Element(params)
Crea un elemento e lo inizializza con i parametri abbandonati params. params è un vettore PHP con voci chiave-valore. Una chiave è uno dei parametri chiave del PDF24Element.

Metodi

setTitle(title)
Imposta il title parametro dell’elemento a title.
setUrl(url)
Imposta il url parametro dell’elemento a url. Il titolo e l‘url insieme formano un link.
setAuthor(author)
Imposta il author parametro dell’elemento a author.
setDateTime(dateTime)
Imposta il dateTime parametro dell’elemento a dateTime.
setBody(body)
Imposta il body parametro dell’elemento a body. body Può essere normale o il testo formattato HTML
setParam(key,value)
Imposta il valore di un parametro con la chiave key a value.
setParams(params)
Consente di impostare i parametri in params. Tutti i parametri precedentemente aggiunti saranno rimossi. params è un vettore contenente le coppie chiave-valore.
addParams(params)
Aggiunge il parametro abbandonato params. params è un vettore PHP che contiene coppie chiave-valore. I parametri aggiunti In precedenza possono essere sovrascritti.
getParam(key)
Restituisce il valore di un parametro appartenente al key.

Classe PDF24Response

Parametri

header
L‘intestazione della risposta di una richiesta di servizio.
body
Il corpo della risposta di una richiesta di servizio.

Metodi

getHeader()
Restituisce l‘intestazione della risposta di una richiesta di servizio.
getBody()
Restituisce il corpo della risposta di una richiesta di servizio
__toString()
Restituisce una stringa di rappresentazione dell‘intestazione e del corpo di una richiesta di servizio

Esempi di codice

Prima includi la API:

include(api.php);

Esempio 1


/*
* Crate a document and add parameter
*/
$doc = new PDF24Doc();
$doc->setCharset('ISO-8859-1');
$doc->setHeadline('This is the headline of the PDF');
$doc->setHeadlineUrl('http://www.pdf24.org');
$doc->setBaseUrl('http://www.pdf24.org');
$doc->setFilename('test');
$doc->setPageSize(210, 297);

$doc->setEmailTo('stefanz@pdf24.org');
$doc->setEmailFrom('stefanz@pdf24.org');
$doc->setEmailSubject('Here is your created PDF file');
$doc->setEmailBody('The created PDF file is attached to this email!');
$doc->setEmailBodyType('text');
$doc->setEmailCharset('ISO-8859-1');

/*
* Create one or more elements
*/
$element = new PDF24Element();
$element->setTitle('This is the title of the element');
$element->setUrl('http://www.pdf24.org');
$element->setAuthor('Stefan Ziegler');
$element->setDateTime('2010-04-15 8:00');
$element->setBody('The is the body of the element');

/*
* Add elements
*/
$doc->addElement($element);

/*
* Create the PDF. Print response if there has been an error.
*/
if(!$doc->createAndSend()) {
	echo $doc->getResponse();
}

Esempio 2


/*
* Create Document with parameter
*/
$doc = new PDF24Doc(array(
	'charset' => 'UTF-8',
	'headline' => 'This is a headline',
	'headlineUrl' => 'http://www.pdf24.org',
	'baseUrl' => 'http://www.pdf24.org',
	'filename' => 'test',
	'pageSize' => '210x297',
	'emailTo' => 'stefanz@pdf24.org',
	'emailFrom' => 'stefanz@pdf24.org',
	'emailSubject' => 'Here is your created PDF file',
	'emailBody' => 'The PDF file is attached to this email!',
	'emailBodyType' => 'text'
));

/*
* Add an element without using PDF24Element
*/
$doc->addElement(array(
	'title' => 'This is the title of the element',
	'url' => 'http://www.pdf24.org',
	'author' => 'Stefan Ziegler',
	'dateTime' => '2010-04-15 8:00',
	'body' => 'This is the body of the element'
));

/*
* Create the PDF. Print response if there has been an error.
*/
if(!$doc->createAndSend()) {
	echo $doc->getResponse();
}

Generazione di prova PDF

Esiste una variante di javascript del PDF API che utilizza lo stesso servizio PDF24. Le pagine informative della variante di Javascript contengono un -Test Generator. Guarda Javascript PDF Generator
» Home » FAQ » Forum » News » Documenti » PDF Creator
» Fax Online » DOC 2 PDF