Xport

KO | EN

gitlite — search

#javascript #hacktoberfest #ai #typescript #llm #linux #nodejs #java #cli #vue #pytorch #ios #openai #open-source

(★ 19)

Import/Export library for PHP

Xport Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Xport

[![Build Status](https://travis-ci.org/myclabs/Xport.png?branch=master)](https://travis-ci.org/myclabs/Xport) [![Coverage Status](https://coveralls.io/repos/myclabs/Xport/badge.png?branch=master)](https://coveralls.io/r/myclabs/Xport?branch=master) [![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/myclabs/Xport/badges/quality-score.png?s=1fdfacd6513a9c0dab300a417c1642d885b41274)](https://scrutinizer-ci.com/g/myclabs/Xport/)

Xport is an import/export library for PHP.

It is targeted to support the following formats:

- Excel (xlsx and xls)
- OpenOffice (ods - to be implemented)
- PDF (to be implemented)
- XML (to be implemented)

It provides an object model for different formats (spreadsheet, document, XML…) and a language based on YAML and Twig to map your data (arrays, objects, …) onto the model.

## Spreadsheet

### Simple example

Simple mapping file (YAML file):

```yaml
sheets:
    # An empty sheet named "Home"
  - label: "Home"

# Another sheet named "Contacts"
  - label: "Contacts"

content:
    # Containing one table with 2 columns
      - type: VerticalTable
        columns:
          - "Name"
          - "Phone Number"
        lines:
          - foreach: "contacts as contact"
            do :
              - cells:
                - "{{ contact.name }}"
                - "{{ contact.phoneNumber }}"
```

Usage:

```php
$modelBuilder = new SpreadsheetModelBuilder();
$export = new PHPExcelExporter();

$modelBuilder->bind('contacts', $contacts);

$export->export($modelBuilder->build('mapping.yml'), 'myFile.xslx');
```

The table will be filled with each item in the array `$contacts`.

The `path` configuration is a [PropertyAccess](http://symfony.com/doc/master/components/property_access/index.html) path, e.g. the `contact.phoneNumber` path can resolve to `$contact->getPhoneNumber()` or `$contact->phoneNumber`.

### Dynamic example

You can use the `foreach` expression to generate dynamic content.

You can also use [Twig](http://twig.sensiolabs.org/) templating language.

Here is an example:

```yaml
# Create one sheet per company
sheets:
  - foreach: companies as i => company
    do:
      - label: "{{ i + 1 }} - {{ company.name }}" # Twig expression, will result in (for example): "1 - My Company"
```

```php
$modelBuilder = new SpreadsheetModelBuilder();
$export = new PHPExcelExporter();

$modelBuilder->bind('companies', $companies);

$export->export($modelBuilder->build(new YamlMappingReader('mapping.yml')), 'myFile.xslx');
```

Here is a more complete example:

```yaml
sheets:

# Create one sheet per company
  - foreach: companies as company
    do:

- label: "{{ company.name }}"
        content:
            # One content(VerticalTable) per product, each, followed by an empty line

- foreach: company.products as product
            do:

- type: VerticalTable
                label: product.label
                columns:
                  - "Product"
                  - "Price"
                  - "Salesman"
                # One line per sale, each, preceded by an empty line
                lines:
                  - foreach: product.getSalesList() as sale
                    do:
                      -
                      - cells:
                          - "{{ product.name }}"
                          - "{{ sale.price }}"
                          - "{{ sale.salesman.name }}"

- type: EmptyLine
```

### Functions

Functions can be used in Twig expressions, and are defined as such:

```php
$modelBuilder = new SpreadsheetModelBuilder();
$export = new PHPExcelExporter();

$modelBuilder->bindFunction('up', function($str) {
    return strtoupper($str);
});

$export->export($modelBuilder->build(new YamlMappingReader('mapping.yml')), 'myFile.xslx');
```

### File format

You can choose which file format to use through PHPExcel writers:

```php
// ...
$export->export($spreadsheet, 'myFile.xslx', new PHPExcel_Writer_Excel2007());
```

Writers available:

- Excel 2007 (.xlsx): `PHPExcel_Writer_Excel2007`
- Excel classic (.xls): `PHPExcel_Writer_Excel5`
- CSV (.csv): `PHPExcel_Writer_CSV`

Xport

Xport Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Xport

Xport Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README