API PHP PDF PDF24

Índice

Geral
Download API
Referências de Classe
Amostras de Código
Teste de Geração PDF

Geral

PDF24.org fornece uma GRÁTIS Serviço de geração de PDF para criar ficheiros PDF. Esta API PHP é um interface para este serviço.
A API foi desenvolvido para blogs, fóruns, sistemas wiki e outros softwares de internet baseados em artigos para criar ficheiros PDF de forma fácil. Criadores de blogs, fóruns e sistemas wiki podem usar este API para fornecer um botão PDF.

Download API

Clique no link Download API PDF para baixar a API PHP para PDF.

Referências de Classe

Existem duas principais classes PHP que têm que ser usadas para criar um ficheiros PDF. A classe PDF24Doc fornece a funcionalidade para gerir o conteúdo geral do documento, tais como título e o URL do documento e fornece métodos para adicionar elementos no documento.
A classe PDF24Element representa um elemento de conteúdo dentro de uma PDF24Doc documento. Um elemento de conteúdo é um contentor que contém alguns dados, tais como um título e um conteúdo html.

A tabela a seguir mostra que:

PDF24Doc

PDF24Elemento 1

PDF24Elemento 2

PDF24Element 3

Classe PDF24Doc

Chaves dos Parâmetros

charset

O grupo de caracteres do documento. Por defeito é ISO-8859-1. Os valores presentemente suportados são ISO-8859-1 e UTF-8.

headline

O cabeçalho do documento.

headlineUrl

O URL do cabeçalho do título.

baseUrl

O baseUrl do documento. Este URL é importante se você usar links relativos no conteúdo do corpo dos elementos. Este URL é usado para os links relativos encontrarem imagens e outros conteúdos.

filename

O nome do ficheiro PDF criado, por exemplo meuNomeDeFicheir.

pageSize

O tamanho de cada página do documento. O tamanho é codificado como LARGURAxALTURA onde LARGURA é a largura de cada página em mm e a ALTURA é a altura de cada página em mm. A largura por defeito é de 210 milímetros e a altura por defeito é de 297 milímetros, o que representa uma página A4 ISO.

emailTo

Um ou mais endereços de e-mail separados por ponto e vírgula. Este endereço de e-mail irá receber os ficheiros PDF criados.

emailFrom

O endereço de e-mail do utilizador API, que será exibido como o „De“ num endereço e-mail em e-mails com ficheiros PDF em anexo.

emailSubject

O assunto do e-mail com o ficheiro PDF em anexo.

emailBody

O conteúdo do e-mail com o ficheiro PDF em anexo.

emailBodyType

O tipo do conteúdo do e-mail com o ficheiro PDF em anexo. Os valores válidos são text e html.

emailCharset

Este parâmetro contém o grupo de caracteres do assunto e do conteúdo do e-mail. Os valores suportados presentemente são ISO-8859-1 e UTF-8.

Constructores

PDF24Doc()

Cria um objecto de documento sem parâmetros. Use os métodos setXX para definir parâmetros mais tarde.

PDF24Doc(params)

Cria um objecto do documento e inicializa os parâmetros do documento com os parâmetros indicados em params. params é uma matriz PHP com entradas de valor-chave. A chave é um dos parâmetros acima.

Métodos

addElement(element)

Adiciona o elemento element para o documento PDF. element pode ser uma PDF24Element ou uma Matriz PHP com pares de valor-chave de PDF24Element.

setParam(paramKey, paramValue)

Define um parâmetro de documento com a chave paramKey e o valor paramValue.

setParams(params)

Define os parâmetros de documento em params. Todos os parâmetros previamente adicionados serão removidos.

addParams(params)

Adiciona os parâmetros de documento a partir de params. Parâmetros anteriormente adicionados podem ser substituídos através deste método. params é uma matriz que contém pares de valor-chave.

getParam(paramKey)

Devolve o parâmetro do documento com a chave paramKey.

setCharset(charset)

Define o charset parâmetro do documento para charset. O conjunto de caracteres por defeito é ISO-8859-1.

setHeadline(headline)

Define o headline parâmetro do documento para headline.

setHeadlineUrl(headlineUrl)

Define o headlineUrl parâmetro do documento para headlineUrl.

setBaseUrl(baseUrl)

Define o baseUrl parâmetro do documento para baseUrl.

setFilename(filename)

Define o filename parâmetro do documento para filename.

setPageSize(width, height)

Define o pageSize parâmetro do documento para width, height.

setEmailTo(emailAddr)

Define o emailTo parâmetro do documento para emailAddr.

addEmailTo(emailAddr)

Adiciona o endereço de e-mail emailAddr para a lista de receptores do ficheiro PDF.

setEmailFrom(emailAddr)

Define o emailFrom parâmetro do documento para emailAddr.

setEmailSubject(subject)

Define o emailSubject parâmetro do documento para subject.

setEmailBodyType(bodyType)

Define o emailBodyType parâmetro do documento para bodyType. bodyType pode ser text ou html.

setEmailBody(body)

Define o emailBody parâmetro do documento para body.

setEmailCharset(charset)

Define a codificação do corpo e do objecto do e-mail com o ficheiro PDF em anexo.

createAndSend()

Este método packs todos determinado parâmetro em um pedido de serviço PDF24 e transmite o pedido a PDF24 serviço. Os controlos de serviço a pedido e dá uma resposta que será analisado. Se a resposta for bem-sucedido este método retorna true caso contrário false é devolvido.

Classe PDF24Element

Chaves dos Parâmetros

title

O título do elemento.

url

O URL do elemento. O título e o URL são usados para formar uma ligação.

author

O autor do conteúdo dos elementos.

dateTime

Um timestamp (Qualquer sequência de caracteres que representa uma hora, por exemplo, a data e hora ou apenas data ou hora)

body

O conteúdo do elemento. Pode ser texto simples ou formatado em html.

Constructores

PDF24Element()

Cria um elemento sem parâmetros. Use os métodos setXX para definir parâmetros mais tarde.

PDF24Element(params)

Cria um elemento e inicializa-o com parâmetros indicados em params. params é uma matriz PHP com entradas de valor-chave. A chave é uma das chaves de parâmetros do PDF24Element.

Métodos

setTitle(title)

Define o title parâmetro do elemento para title.

setUrl(url)

Define o url parâmetro do elemento para url. O título e o url juntos formam um link.

setAuthor(author)

Define o author parâmetro do elemento para author.

setDateTime(dateTime)

Define o dateTime parâmetro do elemento para dateTime.

setBody(body)

Define o body parâmetro do elemento para body. body pode ser texto simples ou formatado em html.

setParam(key,value)

Define o valor de um parâmetro com a tecla key para value.

setParams(params)

Define os parâmetros em params. Todos os parâmetros previamente adicionados serão removidos. params é uma matriz contendo pares de valor-chave.

addParams(params)

Adiciona parâmetro dado em params. params é uma matriz PHP contendo pares de valor-chave. Parâmetros anteriormente adicionados podem ser substituídos.

getParam(key)

Retorna o valor de um parâmetro pertencente ao key.

Classe PDF24Response

Parâmetros

header

O cabeçalho da resposta de um pedido de serviço.

body

O conteúdo da resposta a um pedido de serviço.

Métodos

getHeader()

Devolve o cabeçalho da resposta a um pedido de serviço.

getBody()

Devolve o conteúdo da resposta a um pedido de serviço.

__toString()

Devolve uma representação de série do cabeçalho e do conteúdo de um pedido de serviço.

Amostras de código

Incluir primeiro a API:

include(api.php);

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

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

Teste de Geração PDF

Existe uma variante de javascript da API do PDF que usa o mesmo serviço PDF24. As páginas de informações da variante Javascript contêm um Gerador-Teste. Olhar para Gerador Javascript PDF