How to use PHPExcel external library with Yii

Trying to learn and help some other programmers to find their solutions on the Yii Forum (I think is a superb way to learn the framework), I was facing one challenge with an external library that a fellow programmer wanted to use -quite good indeed: PHPExcel. And what is PHPExcel?

PHPExcel - OpenXML - Create Excel2007 documents in PHP - Spreadsheet engine
Project providing a set of classes for the PHP programming language, which allow you to write to and read from different file formats, like Excel 2007, PDF, HTML, ... This project is built around Microsoft's OpenXML standard and PHP. Checkout the [Features](http://phpexcel.codeplex.com/wikipage?title=Features) this class set provides, such as setting spreadsheet meta data (author, title, description, ...), multiple worksheets, different fonts and font styles, cell borders, fills, gradients, adding images to your spreadsheet and much, much more!

The Challenge

The fellow programmer (Jack Fiallos) had a problem of using the libraries within Yii. He was surprised that he could easily use the libraries outside of the framework but not within the framework itself. At first we didn't think about it but suddenly we thought about the autoloading features of Yii and looked into the guts of PHPExcel to find out what was causing the problems.

We were right, PHPExcel has an autoloading feature itself that when a classes is called (i.e. PHPExcel_Shared_ZipStreamWrapper) the first part of the name is actually reflecting the folder's path where the class is located (i.e. PHPExcel_Shared_ZipStreamWrapper = PHPExcel/Shared_ZipStreamWrapper.php). Please review the following code (extracted from PHPExcel_Autoloader class):

public static function Load($pObjectName){
    if ((class_exists($pObjectName)) || (strpos($pObjectName, 'PHPExcel') === False)) {
       return false;
    }
    // this is the code that shows what I am saying
    $pObjectFilePath =  PHPEXCEL_ROOT.
       str_replace('_',DIRECTORY_SEPARATOR,$pObjectName).'.php';

    if ((file_exists($pObjectFilePath) === false) 
       || (is_readable($pObjectFilePath) === false)) {
		return false;
     }
     require($pObjectFilePath);
}	//	function Load()

First Solution: disabling Yii's Autoload

The workaround to this problem (at least the one I know) is by making use of the spl_autoload_register and spl_autoload_unregister PHP's functions. The following code shows how we got the library working -I assume that you have downloaded the PHPExcel files, unzipped its contents and place them into a phpexcel folder within your application's protected/extensions folder:

// 
// VERY DUMMY TEST CONTROLLER
// FOR THE SAKE OF THE EXAMPLE
// TEST IT AS http : / / <yourapplicationurl> / index.php ? r=test/test

class TestController extends Controller{

     // no layouts here
     public $layout = '';
	
     public function actionTest()
     {
     //
     // get a reference to the path of PHPExcel classes	
     $phpExcelPath = Yii::getPathOfAlias('ext.phpexcel.Classes');
     
     // Turn off our amazing library autoload 
      spl_autoload_unregister(array('YiiBase','autoload'));        

     //
     // making use of our reference, include the main class
     // when we do this, phpExcel has its own autoload registration
     // procedure (PHPExcel_Autoloader::Register();)
    include($phpExcelPath . DIRECTORY_SEPARATOR . 'PHPExcel.php');

     // Create new PHPExcel object
     $objPHPExcel = new PHPExcel();

     // Set properties
     $objPHPExcel->getProperties()->setCreator("Maarten Balliauw")
	->setLastModifiedBy("Maarten Balliauw")
	->setTitle("PDF Test Document")
	->setSubject("PDF Test Document")
	->setDescription("Test document for PDF, generated using PHP classes.")
	->setKeywords("pdf php")
	->setCategory("Test result file");


     // Add some data
     $objPHPExcel->setActiveSheetIndex(0)
            ->setCellValue('A1', 'Hello')
            ->setCellValue('B2', 'world!')
            ->setCellValue('C1', 'Hello')
            ->setCellValue('D2', 'world!');

      // Miscellaneous glyphs, UTF-8
     $objPHPExcel->setActiveSheetIndex(0)
            ->setCellValue('A4', 'Miscellaneous glyphs')
            ->setCellValue('A5', 'éàèùâêîôûëïüÿäöüç');

      // Rename sheet
      $objPHPExcel->getActiveSheet()->setTitle('Simple');

      // Set active sheet index to the first sheet, 
      // so Excel opens this as the first sheet
     $objPHPExcel->setActiveSheetIndex(0);

      // Redirect output to a client’s web browser (Excel2007)
      header('Content-Type: application/pdf');
      header('Content-Disposition: attachment;filename="01simple.pdf"');
      header('Cache-Control: max-age=0');

      $objWriter = PHPExcel_IOFactory::createWriter($objPHPExcel, 'PDF');
      $objWriter->save('php://output');
      Yii::app()->end();
       
       // 
       // Once we have finished using the library, give back the 
       // power to Yii... 
       spl_autoload_register(array('YiiBase','autoload'));
       }
}

Second solution: patching PhpExcel

The previous solution has an annoying consequence: one can't easily mix Yii's classes within a code that uses PHPExcel. Fortunately, there is a solution with no such side effect.

In "Classes/PHPExcel/Autoloader.php", replace the line

return spl_autoload_register(array('PHPExcel_Autoloader', 'Load'));

with:

return spl_autoload_register(array('PHPExcel_Autoloader', 'Load'), true, true);

See the documentation of spl_autoload_register for a description of these parameters.

Final Words

This post is using PHPExcel external library as an example, but this procedure should be taken into account when we encounter a problem like this. Whenever you find a library that you wish to include in your Yii application, check out its autoloading functions first.

27 1
26 followers
Viewed: 107 649 times
Version: 1.1
Category: How-tos
Written by: Antonio Ramirez
Last updated by: cgsmith
Created on: Nov 5, 2010
Last updated: 4 years ago
Update Article

Revisions

View all history

Related Articles