Xezilaires is a PHP library which helps to iterate structured Excel spreadsheets, normalize rows into value objects, validate, serialize into CSV, JSON, XML.
- we create a PHP class which will hold our Excel row data
- we next create spreadsheet iterator instance
- passing the path to the Excel file we wish to read
- passing the configuration mapping the Excel columns into PHP properties
- as we're iterating, we are getting an value object (instance of the defined class) for each row
Think of it as an "ORM" (Object Relation Manager) for an Excel file. An OEM (Object Excel Manager), if you will.
class Product
{
private $name;
}
$symfonySerializer = new \Symfony\Component\Serializer\Serializer([
new \Symfony\Component\Serializer\Normalizer\PropertyNormalizer(),
]);
$normalizer = new \Xezilaires\Bridge\Symfony\Serializer\ObjectSerializer($symfonySerializer);
$iteratorFactory = new \Xezilaires\SpreadsheetIteratorFactory($normalizer, [
\Xezilaires\Bridge\PhpSpreadsheet\Spreadsheet::class,
]);
$iterator = $iteratorFactory->fromFile(
// https://github.com/sigwinhq/xezilaires-dev/raw/master/src/Xezilaires/Test/resources/fixtures/products.xlsx
new \SplFileObject(__DIR__.'/../../src/Xezilaires/Test/resources/fixtures/products.xlsx'),
new \Xezilaires\Metadata\Mapping(
Model\Product::class,
[
'name' => new \Xezilaires\Metadata\ColumnReference('A'),
],
[
// options
'start' => 2,
]
)
);
use Xezilaires\Attribute as XLS;
#[XLS\Options(header=1, start=2)]
class Product
{
#[@XLS\HeaderReference(header="Name")]
private $name;
}
$symfonySerializer = new \Symfony\Component\Serializer\Serializer([
new \Symfony\Component\Serializer\Normalizer\PropertyNormalizer(),
]);
$normalizer = new \Xezilaires\Bridge\Symfony\Serializer\ObjectSerializer($symfonySerializer);
$iteratorFactory = new \Xezilaires\SpreadsheetIteratorFactory($normalizer, [
\Xezilaires\Bridge\PhpSpreadsheet\Spreadsheet::class,
]);
$attributeDriver = new \Xezilaires\Metadata\Attribute\AttributeDriver();
$iterator = $iteratorFactory->fromFile(
// https://github.com/sigwinhq/xezilaires-dev/raw/master/src/Xezilaires/Test/resources/fixtures/products.xlsx
new \SplFileObject(__DIR__.'/../../src/Xezilaires/Test/resources/fixtures/products.xlsx'),
$attributeDriver->getMetadataMapping(Product::class, ['reverse' => true])
);
See more examples in the docs/examples/
folder.
start
, which row do we start on
(integer, optional, default:1
)header
, which row contains the header labels
(integer, optional if not usingHeaderReference
, default:null
)reverse
, do we iterate the rows in reverse, from end to start
(boolean, optional, default:false
)sequential
, is the key sequential (0, 1, 2) or represents current row?
(boolean, optional, default:false
)
Features included:
- Reading Excel files
(using eitherphpoffice/PhpSpreadsheet
oropenspout/openspout
) - Denormalization / normalization support
(usingsymfony/serializer
, from / to all supported formats) - Attributes support
- mapping via column names or header labels
(saying "Map header labelPrdctEN
to propertyproduct
") - A Symfony bundle
(for easy integration into existing apps) - CLI (command-line interface) tool
You can use your own normalizers / validators by passing your own Symfony bundle
which registers them to the Xezilaires commands via --bundle
, like so:
vendor/bin/xezilaires validate --bundle Xezilaires\\Test\\ExampleBundle\\XezilairesExampleBundle Xezilaires\\Test\\Model\\Product src/Xezilaires/Test/resources/fixtures/products.xlsx
See example bundle in src/Xezilaires/Test/ExampleBundle/
.
xezilaires
is serializex
backwards.
We added the X so the name so we can shorten it as XLS. As a side-effect, we made reading Excel files with this library cool.