printform-xls : Класс-обертка для заполнения форм в формате XLS (PHPExcel)

Назначение класса CPrintFormXls - генерация XLS-файлов с пользовательскими данными на основе подготовленных шаблонов. На листы выходного файла формата MS Excel (и на весь файл) может поставлена парольная защита.
Собственно для чтения исходного XLS файла шаблона, занесения в него пользовательксих данных и сохранения результата используется известный набор классов PHPExcel (дистрибутив PHPExcel необходимо самостоятельно скачать с сайта разработчиков (codeplex.com) и установить на свой WEB-сервер).

• Автоматическая конвертация исходных "текстовых" значений в кодировку UTF-8 (требуемую форматом XLS).
  Достаточно указать characet set исходных данных.
• Поддержка пользовательских функций для преобразования отдельных данных к нужному виду, перед занесением в XLS.
• Поддержка значений формата "Дата" (date): строковые значения в форматах 'ДД.ММ.ГГГГ' или 'ГГГГ-ММ-ДД' автоматически преобразуются к "внутреннему" числовому формату данных в Excel. Можно указывать свой выходной формат дат (типа 'dd/mm/yyyy').
• Поддержка XLS файлов с несколькими листами.
• Парольная защита листов и всего XLS файла от изменения, (насколько это поддерживается в PHPExcel).
• Список заполняемых ячеек - "полей" с их позициями на листах, а также другие параметры работы, задаются в XML-файле конфигурации (заполняется вручную)

Пример : Создаем XLS файл из шаблона и своих данных

require_once('PHPExcel.php');
require_once('PHPExcel/IOFactory.php');
require_once('PHPExcel/Reader/Excel5.php'); # или другой файл, если нужен вывод в Excel 2007 и т.п.

<?xml version="1.0" encoding="UTF-8"?>
<printdef>
  <version>1.0</version>
  <description>sample format for testing</description>
  <dateformat>dd/mm/yyyy</dateformat>
  <stringcharset>WINDOWS-1251</stringcharset>
  <templatefile>config-test.xls</templatefile>
  <sheets>
   <sheet offset="0">
    <field name="last_name" col="3" row="5" type="string" convert="AddBraces" />
    <field name="first_name" col="3" row="7" type="string"/>
    <field name="birthdate" col="3" row="9" type="date"/>
    <field name="address" col="3" row="11" type="string"/>
    <field name="resident" col="3" row="13" type="bool"/>
    <field name="resident" col="5" row="15" type="bool-invert"/>
   </sheet>
  </sheets>
</printdef>

require_once('PHPExcel.php'); // We use PHPExcel classes !
require_once('PHPExcel/IOFactory.php');
require_once('PHPExcel/Reader/Excel5.php');
require_once('printform-xls.php');

$excel = new CPrintFormXls(array(
   'configfile' => 'cfg-test.xml'
  ,'outname' => 'myfile-test.xls'
  ,'resident' => 1
));

# наши данные :
$data = array(
   'last_name'=>'Smirnoff'
  ,'first_name' => 'Ivan'
  ,'birthdate'  => '1970-04-18'
  ,'address'     =>'Russia, Moscow, Usacheva street, 33-999'
  ,'resident'   => 1
);

$excel->AddData($data); // XLS заполнится этими данными данными
$ok = $excel->Render(); // генерирует и выводит файл

if(!$ok) echo $excel->GetErrorMessage(); // что-то пошло не так ? Вывести последнюю ошибку
exit;

// наша ф-ция для данных last_name
function AddBraces($param) {
    return "[ $param ]";
}

CPrintFormXls : список методов

<?xml version="1.0" encoding="UTF-8"?>
<printdef>
  <version>1.0</version> /* версия формата */
  <description>sample format for testing</description> /* не сипользуется, просто для информации */
  <dateformat>dd/mm/yyyy</dateformat>         /* формат вывода даты в конечном XLS файле, по умолчанию - 'dd/mm/yyyy' */
  <stringcharset>WINDOWS-1251</stringcharset>   /* кодировка строчных исходных данных */
  <templatefile>config-test.xls</templatefile>  /* путь/имя файла шаблона XLS */
  <protectsheets>1</protectsheets> /* включить защиту листов */
  <protectpassword>mypassword</protectpassword> /* пароль для листов */
  <sheets> /* Задание заполняемых полей данных */
   <sheet offset="0"> /* offset - 0-based номер листа в файле шаблона */
    /* Атрибуты: "name" - имя поля; "col" номер колонки (0-based); "row" - номер строки (1-based) */
    <field name="last_name" col="3" row="5" type="string" convert="AddBraces" />
    <field name="birthday" col="3" row="11" type="date"/>
    /* etc... */
   </sheet>
  </sheets>
</printdef>

Примеры использования

$excel = new CPrintFormXls(array(
   'configfile' => 'cfg-test.xml'
  ,'outname' => 'myfile-test.xls'
));

$data = array(
   'last_name'=>'Smirnoff'
  ,'first_name' => 'Ivan'
# ...
);
$excel->AddData($data);

$excel =>ProtectSheets(true,'mypassword'); // включаем защиту листов паролем

$ok = $excel->Render();

$excel = new CPrintFormXls(array(
   'configfile' => 'cfg-test.xml'
  ,'outname' => 'myfile-test.pdf' // Set correct output file extension
  ,'outfmt' => 'pdf' // set output format to PDF
));

$data = array(
   'last_name'=>'Smirnoff'
  ,'first_name' => 'Ivan'
# ...
);
$excel->AddData($data);
$ok = $excel->Render();

$excel = new CPrintFormXls(array(
   'configfile' => 'cfg-test.xml'
  ,'outname' => 'myfile-test.xls'
));
# ...

$xlsobj = $excel->GetXlsObject();
$xlsobj->getSheet(0)->setCellValueByColumnAndRow(3, 17, 'This text inserted outside class !');

$excel->AddData($data);
$ok = $excel->Render();

Ссылки

• Классы PHPExcel

История

1.01.005 (13.07.2010)

• Запрос нового функционала: метод LoadConfig() кроме имени XML-файла конфигурации может принимать XML-содержимое для парсинга (должна быть строка содержащая well formed XML)

1.00.004 (07.07.2010)

• Первый релиз