README

Intrudução

O PAXB fornece uma maneira rápida e conveniente de gerar XML a partir de objetos PHP e ler XML em objetos. Ele suporta uma estrutura de ligação que mapeia elementos e atributos XML para propriedades PHP usando atributos no PHP 8.

Requisitos

PHP 8.0+
Extensão dom

Instalação

composer require jeidison/paxb

Atributos suportados

#[XmlAttribute]
#[XmlElement]
#[XmlRootElement]
#[XmlTransient]
#[XmlValue]
#[XmlType]
#[XmlPhpTypeAdapter]

Adaptadores

Ao lidar com tipos que precisam de modificações nos valores antes de gerar o XML, podemos escrever um adaptador para indicar ao PAXB como gerenciar o valor de um tipo específico.

Exemplo de adaptador

<?php
...

class DateBrAdapter implements XmlAdapter
{
    public function marshal(mixed $object): mixed
    {
        return $object->format('d/m/Y');
    }

    public function unmarshal(mixed $object): mixed
    {
        return DateTime::createFromFormat('d/m/Y', $object)
                       ->setTime(null, null, null);
    }
}

Exemplo de uso dos atributos

<?php
...

#[XmlType(propOrder: ["number", "street", "fullAddress"])]
class Address
{
    #[XmlTransient]
    private string $fullAddress;

    #[XmlElement("street")]
    private string $address;

    #[XmlElement]
    private string $number;
    
.
.
.    

class Author
{
    #[XmlElement]
    private string $name;

    #[XmlElement]
    private ?string $birthday = null;

    #[XmlElement]
    private ?string $email = null;

    private ?Address $address = null;
    
.
.
.    

#[XmlRootElement("livros")]
class Book
{
    #[XmlAttribute("identificador")]
    private int $id;

    #[XmlElement("nome")]
    private String $name;

    #[XmlPhpTypeAdapter(DateBrAdapter::class)]
    private DateTime $data;

    /**@var array<Author> */
    #[XmlElement("authors")]
    private array $authors;
    
    ...

Gerando XML

<?php
...

$address = new Address();
$address->setAddress("Rua 10");
$address->setNumber("123");
$address->setFullAddress("123");

$author = new Author();
$author->setName("Jeidison Farias");
$author->setBirthday("");
$author->setEmail("");
$author->setAddress($address);

$book = new Book();
$book->setId(1);
$book->setName("PHP XML Binding");
$book->setAuthors([$author]);
$book->setData(new DateTime());
$book->setAddress($address)

$paxb = PAXB::createMarshaller();
$xml  = $paxb->marshal($book);

echo $xml;
...

Exemplo de XML gerado

<?xml version="1.0" encoding="UTF-8"?>
<livros identificador="1">
    <nome>PHP XML Binding</nome>
    <date>10/09/2021</date>
    <authors>
        <name>Jeidison Farias</name>
        <address>
            <number>123</number>
            <street>Rua 10</street>
        </address>
    </authors>
</livros>

Transformando XML em objetos PHP

<?php
...

$xml = 'O seu XML';

$unmarshaller = PAXB::createUnmarshal(Book::class);
$book = $unmarshaller->unmarshal($xml);

Transformando XSD em classes PHP [WIP]

<?php
...

$parameter = new Xsd2PhpParameter;
$parameter->pathRootXsd = '';
$parameter->withSetters = true;
$parameter->withGetters = true;
$parameter->namespace = '';
$parameter->pathStoreClasses = '';

Xsd2Php::instance()->convert($parameter);

Esse projeto é inspirado no JAXB da linguagem Java.

Autor

Jeidison Farias

License

The MIT License (MIT). Please see License File for more information.

jeidison / paxb

Maintainers

Details