11ya/excelbundle

This is a Symfony2 Bundle helps you to read and write Excel files (including pdf, xlsx, odt), thanks to the PHPExcel library

Thursday, June 20, 2013
by 11ya
Repository
1 Watchers
0 Stars
138 Installations

PHP
0 Dependents
0 Suggesters
116 Forks
0 Open issues
7 Versions
4 % Grown

The README.md

Symfony2 Excel bundle

This bundle permits you to create an easily modifiable excel object. This is just a dependency injection that links, _(*1)

3 Objects:, _(*2)

The container in this bundle,, _(*3)
The StreamWrapper in the n3bStreamresponse, _(*4)
A Writer., _(*5)

You could create your own writer extending n3b\Bundle\Util\HttpFoundation\StreamResponse\StreamWriterInterface or you could use the great PHPExcel library. With PHPExcel you can create xls, ods, pdf and more., _(*6)

You have to know that csv is faster so I encourage you to use the built-in function for csv: http://it.php.net/manual-lookup.php?pattern=csv&lang=en&scope=quickref, _(*7)

Migration

In order to follow the naming convention https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md all the liuggio namespaces are migrated to Liuggio., _(*8)

This master is up-to-date to the symfony/symfony master actually on 2.1, _(*9)

INSTALLATION with COMPOSER

1 Add to composer.json to the require key, _(*10)

    "require" : {
        "liuggio/excelbundle": ">=1.0.4",
    }

2 Register the bundle in app/AppKernel.php, _(*11)

``` php $bundles = array( // ... new Liuggio\ExcelBundle\LiuggioExcelBundle(), );, _(*12)


## INSTALLATION with deps file

1  Add to the following to your `deps` file, then run `php bin/vendors install`

``` yaml
[PHPExcel]
    git=http://github.com/PHPOffice/PHPExcel.git
    target=/phpexcel
    version=origin/master

[n3bStreamresponse]
    git=git://github.com/liuggio/Symfony2-StreamResponse.git
    target=n3b/src/n3b/Bundle/Util/HttpFoundation/StreamResponse

[LiuggioExcelBundle]
    git=https://github.com/liuggio/ExcelBundle.git
    target=/bundles/Liuggio/ExcelBundle

2 Register the namespaces and prefixes in app/autoload.php:, _(*13)

``` php $loader->registerNamespaces(array( // ... 'n3b\Bundle\Util\HttpFoundation\StreamResponse' => DIR.'/../vendor/n3b/src', 'Liuggio' => DIR.'/../vendor/bundles', )); $loader->registerPrefixes(array( // ... 'PHPExcel' => DIR.'/../vendor/phpexcel/Classes', ));, _(*14)



3 Enable the bundle in `app/AppKernel.php`

``` php
    $bundles = array(
        // ...
        new Liuggio\ExcelBundle\LiuggioExcelBundle(),
    );

AVAILABLE SERVICES

If you want to write, _(*15)

``` php // create MS Excel5 $excelService = $this->get('xls.service_xls5'); // create pdf $this->get('xls.service_pdf'); // create MS Excel 2007 $this->get('xls.service_xls2007');, _(*16)



If you want to read xls

``` php
    $excelObj = $this->get('xls.load_xls5')->load($filename);

USAGE

Create a controller in your bundle, _(*17)

``` php, _(*18)

namespace YOURNAME\YOURBUNDLE\Controller;, _(*19)

use Symfony\Bundle\FrameworkBundle\Controller\Controller;, _(*20)

class DefaultController extends Controller {, _(*21)

public function indexAction($name)
{
    // ask the service for a Excel5
    $excelService = $this->get('xls.service_xls5');
    // or $this->get('xls.service_pdf');
    // or create your own is easy just modify services.yml


    // create the object see http://phpexcel.codeplex.com documentation
    $excelService->excelObj->getProperties()->setCreator("Maarten Balliauw")
                        ->setLastModifiedBy("Maarten Balliauw")
                        ->setTitle("Office 2005 XLSX Test Document")
                        ->setSubject("Office 2005 XLSX Test Document")
                        ->setDescription("Test document for Office 2005 XLSX, generated using PHP classes.")
                        ->setKeywords("office 2005 openxml php")
                        ->setCategory("Test result file");
    $excelService->excelObj->setActiveSheetIndex(0)
                ->setCellValue('A1', 'Hello')
                ->setCellValue('B2', 'world!');
    $excelService->excelObj->getActiveSheet()->setTitle('Simple');
    // Set active sheet index to the first sheet, so Excel opens this as the first sheet
    $excelService->excelObj->setActiveSheetIndex(0);

    //create the response
    $response = $excelService->getResponse();
    $response->headers->set('Content-Type', 'text/vnd.ms-excel; charset=utf-8');
    $response->headers->set('Content-Disposition', 'attachment;filename=stdream2.xls');

    // If you are using a https connection, you have to set those two headers for compatibility with IE <9
    $response->headers->set('Pragma', 'public');
    $response->headers->set('Cache-Control', 'maxage=1');
    return $response;        
}

}, _(*22)


With the right writer (e.g. PHPExcel_Writer_Excel5) you could also write the output to a file:
``` php

    public function indexAction($name)
    {
        $excelService = $this->get('xls.service_xls5'); 

        //...create php excel object

        $excelService->getStreamWriter()->write( $filename );
    }