PDF24 API PHP PDF

Général

PDF24.org fournit un GRATUIT service de génération de PDF pour créer des fichiers PDF. Cette API est une interface PHP pour ce service.
L’API a été développé pour les blogs, forums, wiki et autres systèmes de logiciels internet basé sur des articles pour créer des fichiers PDF de manière simple. Développeur de blogs, forums et les systèmes de wiki peuvent utiliser cette API pour fournir un bouton PDF.

Télécharger API

Cliquez sur le lien Télécharger le PDF API pour télécharger le PDF PHP API.

Références de la classe

Il existe deux principales classes PHP qui doivent être utilisées pour créer un fichier PDF. La classe PDF24Doc fournit les fonctionnalités pour gérer le contenu général des documents telles que le titre du document ou l’URL du document et fournit des méthodes pour ajouter des éléments au document.
La classe PDF24Element représente un élément contenu dans un PDF24Doc document. Un élément de contenu est un récipient contenant des données telles que un titre et un corps HTML.

Le tableau suivant illustre le fait que:
PDF24Doc
PDF24Element 1
PDF24Element 2
PDF24Element 3

Classe PDF24Doc

Les paramètres clés

charset
Le jeu de caractères du document. Par défaut c‘est ISO-8859-1. Présentement les valeurs prises en charge sont ISO-8859-1 et UTF-8.
headline
Le titre du document.
headlineUrl
L‘url titre de l’en-tête
baseUrl
L’URL de base de ce document. Cette URL est importante si vous utilisez des liens relatifs au contenu du corps des éléments. Cette URL est utilisée pour résoudre les liens relatifs à trouver des images et autres contenus.
filename
Le nom du fichier PDF créé, par exemple myFileName.
pageSize
La taille de chaque page du document. La taille est encodée comme LARGEURxHAUTEUR en considérant que la largeur est la largeur de chaque page en mm et la hauteur est la hauteur de chaque page en mm. La largeur par défaut est 210 mm et la hauteur par défaut est 297 mm =m ce qui représente une page A4 ISO.
emailTo
Une ou plusieurs adresses courriels séparées par une virgule. Cette adresse courriel recevront les fichiers PDF créés.
emailFrom
L’adresse courriel de l’utilisateur API qui apparaîtra comme l’adresse courriel ‘De’ dans les courriels avec les fichiers PDF joints.
emailSubject
Le sujet de l’email avec le PDF créé en fichier joint.
emailBody
Le contenu de l’email avec le PDF créé en fichier joint.
emailBodyType
Le type du corps du courriel avec le fichier PDF créé en pièce jointe. Les valeurs valides sont text et html.
emailCharset
Ce paramètre contient le jeu de caractères de l’objet et le corps des courriels. Présentement, les valeurs prises en charge sont ISO-8859-1 et UTF-8.

Constructeurs

PDF24Doc()
Crée un object de document sans paramètres. Utilisez les méthodes setXX afin de nommer les paramètres plus tard.
PDF24Doc(params)
Crée un objet de document et initialise les paramètres du document avec les paramètres donnés dans params. params est un tableau PHP avec des entrées clé-valeur. Une clé est une des clés de paramètres ci-dessus.

Méthodes

addElement(element)
Ajoute l‘élément element au document PDF. element peut être un PDF24Element ou un tableau PHP avec des paires clé-valeur de PDF24Element.
setParam(paramKey, paramValue)
Définit un paramètre de document avec la touche paramKey et la valeur paramValue.
setParams(params)
Définit les paramètres de document params. Tous les paramètres précédemment ajoutés seront supprimés.
addParams(params)
Ajoute des paramètres de document params. Les paramètres ajoutés précédemment peuvent être écrasés par cette méthode. params est un tableau qui contient des paires clé-valeur.
getParam(paramKey)
Retourne le paramètre du document avec la touche paramKey.
setCharset(charset)
Définit le charset paramètre du document à charset. Le jeu de caractères par défaut est ISO-8859-1.
setHeadline(headline)
Définit le headline paramètre du document à headline.
setHeadlineUrl(headlineUrl)
Définit le headlineUrl paramètre du document à headlineUrl.
setBaseUrl(baseUrl)
Définit le baseUrl paramètre du document à baseUrl.
setFilename(filename)
Définit le filename paramètre du document à filename.
setPageSize(width, height)
Définit le pageSize paramètre du document à width, height.
setEmailTo(emailAddr)
Définit le emailTo paramètre du document à emailAddr.
addEmailTo(emailAddr)
Ajoute l‘adresse courriel emailAddr à la liste des récepteurs pour le fichier PDF.
setEmailFrom(emailAddr)
Définit le emailFrom paramètre du document à emailAddr.
setEmailSubject(subject)
Définit le emailSubject paramètre du document à subject.
setEmailBodyType(bodyType)
Définit le emailBodyType paramètre du document à bodyType. bodyType peut être text ou html.
setEmailBody(body)
Définit le emailBody paramètre du document à body.
setEmailCharset(charset)
Définit le charset du corps et l’objet du courriel avec le fichier pdf joint.
createAndSend()
Cette méthode réunit touts les paramètre donnés dans une demande de service PDF24 et transmet la demande au service PDF24. Le service vérifie la demande et donne une réponse qui sera analysée. Si la réponse est couronnée de succès cette méthode retourne true autrement false est retourné.

Classe PDF24Element

Les paramètres clés

title
Le titre de l’élément.
url
L‘URL de l‘élément. Le titre et l‘URL sont utilisés pour former un lien.
author
L‘auteur de la teneur en éléments.
dateTime
Un horodatage (Toute chaîne qui représente un horodatage, par exemple, la date et l’heure ou la date ou l’heure seulement)
body
Le contenu de l’élément. Peut être uni ou texte html.

Constructeurs

PDF24Element()
Crée un élément sans paramètres. Utilisez les méthodes setXX afin de définir des paramètres plus tard.
PDF24Element(params)
Crée un élément et l‘initialise avec les paramètres donnés dans params. params est un tableau PHP avec des entrées clé-valeur. Une clé est l‘une des clés de paramètres ci-dessus PDF24Element.

Méthodes

setTitle(title)
Définit le title paramètre de l’élément à title.
setUrl(url)
Définit le url paramètre de l’élément à url. Le titre et l’URL, ensemble, forment un lien.
setAuthor(author)
Définit le author paramètre de l’élément à author.
setDateTime(dateTime)
Définit le dateTime paramètre de l’élément à dateTime.
setBody(body)
Définit le body paramètre de l’élément à body. body peut être simple ou en texte HTML
setParam(key,value)
Définit la valeur d‘ paramètre avec la touche key à value.
setParams(params)
Définit les paramètres à params. Tous les paramètres précédemment ajoutés seront supprimés. params est un tableau contenant des paires clé-valeur.
addParams(params)
Ajoute paramètre donné dans params. params est un tableau PHP contenant des paires clé-valeur. Auparavant les paramètres ajoutés pouvaient être remplacés.
getParam(key)
Retourne la valeur d‘un paramètre appartenant à key.

Classe PDF24Response

Paramètres

header
L‘en-tête de la réponse d‘une demande de service.
body
Le corps de la réponse d‘une demande de service.

Methodes

getHeader()
Retourne l‘en-tête de la réponse d‘une demande de service.
getBody()
Retourne le corps de la réponse d‘une demande de service
__toString()
Retourne une chaîne de représentation de l‘en-tête et le corps d‘une demande de service

Exemples de code

Inclure l’API en premier:

include(api.php);

Exemple 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();
}

Exemple 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();
}

Test de Generation PDF

Il existe une variante de PDF API JavaScript qui a utilisé le même service PDF24. Les pages d‘information de la variante Javascript contient un test-générateur. Regardez Générateur de Javascript PDF
» Accueil » FAQ » Forum » Nouvelles » Documents » PDF Creator
» Fax Online » DOC 2 PDF