PHP API PDF24 PDF

General

pdf24.org proporciona un libre Servicio de generación de PDF para crear archivos PDF. Esta API PHP es una interfaz para este servicio.
La API ha sido desarrollada para los blogs, los foros, sistemas Wiki y otros programas de Internet basados en artículos para crear archivos PDF de una manera fácil. Los desarrolladores de blogs, foros y sistemas wiki pueden utilizar esta API para proporcionar un botón PDF.

Descargar API

Click en el enlace Descargar PDF API para descargar el PDF PHP API.

Referencias de Clase

Hay dos clases principales de PHP que tienen que ser usadas para crear un archivo PDF. La clase PDF24Doc proporciona la funcionalidad para administrar el contenido general del documento como título del documento o URL del documento y proporciona métodos para agregar elementos al documento.
La clase PDF24Element representa un elemento de contenido dentro de un PDF24Doc documento. Un elemento de contenido es un recipiente que contiene algunos datos como el título y un cuerpo en HTML.

En la tabla siguiente se ilustra esto:
PDF24Doc
PDF24Element 1
PDF24Element 2
PDF24Element 3

Clase PDF24Doc

Los parámetros claves

charset
El juego de caracteres del documento. El valor predeterminado es ISO-8859-1. Los valores admitidos ahora son ISO-8859-1 y UTF-8.
headline
El titular del documento.
headlineUrl
La url titular del titular.
baseUrl
El Url básica del documento. Esta URL es importante si usted utiliza enlaces relativos en el contenido del cuerpo de los elementos. Esta URL se utiliza para resolver los vínculos relativos para encontrar imágenes y otros contenidos.
filename
El nombre de archivo del archivo creado, por ejemplo, miNombredeArchivo.
pageSize
El tamaño de cada página en el documento. El tamaño se codifica como ANCHOxALTO done ANCHO es el ancho de cada página en mm. y ALTO es la altura de cada página en mm. El ancho por defecto es 210 mm. y la altura por defecto es 297 mm. lo que representa una página ISO A4.
emailTo
Una o más direcciones de correo electrónico separadas por punto y coma. Estas direcciones de correo electrónico recibirán los archivos PDF creados.
emailFrom
La dirección de correo electrónico del usuario API que aparecerá como remitente en mensajes de correo electrónico con los archivos PDF adjuntos.
emailSubject
El asunto del correo electrónico con el archivo PDF adjunto creado.
emailBody
El contenido del correo electrónico con el archivo PDF adjunto creado.
emailBodyType
El tipo del cuerpo del mensaje con el archivo PDF adjunto creado. Los valores válidos son text y html.
emailCharset
Este parámetro contiene el juego de caracteres del asunto y cuerpo del mensaje del correo electrónico. Los valores admitidos son actualmente ISO-8859-1 y UTF-8.

Constructores

PDF24Doc()
Crea un objeto de documento sin parámetros. Utilice los métodos setXX para establecer los parámetros más EMPEZAR.
PDF24Doc(params)
Crea un objeto de documento e inicia los parámetros de documento con los parámetros indicados en params. params PHP es una matriz con las entradas de valor-clave. Una clave es una de las claves de parámetros anteriores.

Métodos

addElement(element)
Agrega el elemento element al documento PDF. element puede ser un PDF24Element o una matriz de PHP con pares de valor-clave de PDF24Element.
setParam(paramKey, paramValue)
Establece un parámetro documento con la clave paramKey y el valor paramValue.
setParams(params)
Establece los parámetros de documento en params. Todos los parámetros previamente agregados serán eliminados.
addParams(params)
Agrega parámetros de documento de params. Parámetros previamente añadidos pueden ser sobrescritos por este método. params es una matriz que contiene pares de valor-clave.
getParam(paramKey)
Devuelve el parámetro de documento con la clave paramKey.
setCharset(charset)
Establece el charset parámetros del documento para charset. El juego de caracteres por defecto es ISO-8859-1.
setHeadline(headline)
Establece el headline parámetros del documento para headline.
setHeadlineUrl(headlineUrl)
Establece el headlineUrl parámetros del documento para headlineUrl.
setBaseUrl(baseUrl)
Establece el baseUrl parámetros del documento para baseUrl.
setFilename(filename)
Establece el filename parámetros del documento para filename.
setPageSize(width, height)
Establece el pageSize parámetros del documento para width, height.
setEmailTo(emailAddr)
Establece el emailTo parámetros del documento para emailAddr.
addEmailTo(emailAddr)
Agrega la dirección de correo electrónico emailAddr a la lista de receptores para el archivo PDF.
setEmailFrom(emailAddr)
Establece el emailFrom parámetros del documento para emailAddr.
setEmailSubject(subject)
Establece el emailSubject parámetros del documento para subject.
setEmailBodyType(bodyType)
Establece el emailBodyType parámetros del documento para bodyType. bodyType puede ser text o html.
setEmailBody(body)
Establece el emailBody parámetros del documento para body.
setEmailCharset(charset)
Establece el conjunto de caracteres del cuerpo y del asunto del correo electrónico con el archivo PDF adjunto.
createAndSend()
Este método empaqueta todos los parámetros dados en una solicitud de servicio PDF24 y transmite la solicitud al servicio PDF24. El servicio comprueba la solicitud y da una respuesta que puede ser analizada. Si la respuesta es correcta este método retorna. true de otra manera false se devuelve.

Clase PDF24Element

Los parámetros claves

title
El título del elemento.
url
La URL del elemento. El título y la URL se utilizan para formar un enlace.
author
El autor del contenido del elemento.
dateTime
Una marca de tiempo (Cualquier cadena que representa una marca de tiempo, por ejemplo, fecha y hora o la fecha sólo o la hora)
body
El contenido del elemento. Puede ser normal o en texto con formato HTML.

Constructores

PDF24Element()
Crea un elemento sin parámetros. Utilice los métodos setXX para establecer los parámetros más EMPEZAR.
PDF24Element(params)
Crea un elemento y lo inicializa con parámetros indicados en params. params es una matriz PHP con las entradas de valor-clave. Una clave es una de las claves del parámetro del Elemento PDF24 de arriba.

Métodos

setTitle(title)
Establece el title parámetros del elemento para title.
setUrl(url)
Establece el url parámetros del elemento para url. El título y la url en conjunto forman un vínculo.
setAuthor(author)
Establece el author parámetros del elemento para author.
setDateTime(dateTime)
Establece el dateTime parámetros del elemento para dateTime.
setBody(body)
Establece el body parámetros del elemento para body. body puede ser normal o texto con formato HTML.
setParam(key,value)
Establece el valor de un parámetro con la tecla key A value.
setParams(params)
Establece los parámetros en params. Todos los parámetros previamente agregados serán eliminados. params es una matriz que contiene pares de valor-clave.
addParams(params)
Agrega los parámetros dados en params. params es una matriz de PHP que contiene pares de valor-clave. Parámetros anteriormente añadidos se pueden sobrescribir.
getParam(key)
Devuelve el valor de un parámetro que pertenece a key.

Clase PDF24Response

Parámetros

header
El encabezado de la respuesta de una solicitud de servicio.
body
El cuerpo de la respuesta de una solicitud de servicio.

Métodos

getHeader()
Devuelve el título de la respuesta de una solicitud de servicio.
getBody()
Devuelve el cuerpo de la respuesta de una solicitud de servicio
__toString()
Devuelve una representación de cadena del título y el cuerpo de una solicitud de servicio.

Ejemplos de código

Incluya el API primero:

include(api.php);

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

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

Prueba de generación de PDF

Existe una variante DEL Javascript del API PDF que usa el mismo servicio de PDF24. Las páginas de información de la variante Javascript contienen un generador de prueas. Mirar en Generador de Javascript PDF
» Página de Inicio
» PDF » PDF Creator » Fax Online