-
今回は PhpSpreadsheet で行う「ワークシート」の 「セルのスタイル設定」 について説明したいと思います。
■セルの文字配置、前景色、背景色の設定
セルの文字配置、前景色、背景色等の設定は、ワークシートオブジェクトからスタイルオブジェクトを取得し、 そのスタイルオブジェクトから更に各指定用のオブジェクトを取得し、各値を設定します。
「文字配置・右寄せ」の設定は、スタイルオブジェクトからアライメントオブジェクトを取得し setHorizontal() メソッドを使用して行います。
「前景色」の設定は、スタイルオブジェクトからフォントオブジェクトを取得し、更にフォントオブジェクトから色オブジェクトを取得し setARGB() メソッドを使用して行います。
「背景色」の設定のためにまずは、セルの枠の設定を行います。 スタイルオブジェクトからボーダーオブジェクトを取得し、更にボーダーTop(Bottom,Left,Right)オブジェクトから個別ボーダーオブジェクトを取得し setBorderStyle() メソッドを使用して行います。
「背景色」の設定は、スタイルオブジェクトからフィルオブジェクトを取得し setFillType() メソッドで塗りつぶしのタイプを設定し、 フィルオブジェクトから色オブジェクトを取得し setARGB() メソッドを使用して行います。
<?php // ライブラリ読込 require '../vendor/autoload.php'; use PhpOffice\PhpSpreadsheet\Spreadsheet; use PhpOffice\PhpSpreadsheet\Style; use PhpOffice\PhpSpreadsheet\Style\Color; use PhpOffice\PhpSpreadsheet\Style\Alignment; use PhpOffice\PhpSpreadsheet\Style\Border; use PhpOffice\PhpSpreadsheet\Style\Fill; use PhpOffice\PhpSpreadsheet\Writer\Xlsx; // Spreadsheetオブジェクト生成 $objSpreadsheet = new Spreadsheet(); // ワークシートオブジェクト $objSheet = $objSpreadsheet->getActiveSheet(); // スタイルオブジェクト取得([B2]セル) $objStyle = $objSheet->getStyle('B2'); // フォアグランド(前景)色を「白色」に設定 $objStyle->getFont()->getColor()->setARGB(Color::COLOR_WHITE); // 水平アライメントを「右寄せ」に設定 $objStyle->getAlignment()->setHorizontal(Alignment::HORIZONTAL_RIGHT); //$objStyle->getAlignment()->setHorizontal(Alignment::HORIZONTAL_LEFT); // ボーダーオブジェクト取得([B2]セル) $objBorders = $objStyle->getBorders(); // ボーダー全て(Top, Bottom, Left, Right)を「細い線:BORDER_THICK」に設定 $objBorders->getTop()->setBorderStyle(Border::BORDER_THICK); $objBorders->getBottom()->setBorderStyle(Border::BORDER_THICK); $objBorders->getLeft()->setBorderStyle(Border::BORDER_THICK); $objBorders->getRight()->setBorderStyle(Border::BORDER_THICK); // フィルオブジェクト取得([B2]セル) $objFill = $objStyle->getFill(); // 背景のタイプを「塗つぶし」に設定 $objFill->setFillType(Fill::FILL_SOLID); // 背景色を「赤」に設定 $objFill->getStartColor()->setARGB('FFFF0000'); // [B2]セルに文字列設定 $objSheet->setCellValue('B2', 'ABCDEF'); // [test6-1.xlsx]:Excel2007形式で保存する $objWriter = new Xlsx($objSpreadsheet); $objWriter->save('test6-1.xlsx'); exit(); ?>出力されたエクセルファイルを見てみると以下の様になります。
アライメントの定数は以下の様に「Alignmentクラス」に宣言されています。// Horizontal alignment styles const HORIZONTAL_GENERAL = 'general'; // 標準 const HORIZONTAL_LEFT = 'left'; // 左詰め const HORIZONTAL_RIGHT = 'right'; // 右詰め const HORIZONTAL_CENTER = 'center'; // 中央揃え const HORIZONTAL_CENTER_CONTINUOUS = 'centerContinuous'; // 選択範囲内で中央 const HORIZONTAL_JUSTIFY = 'justify'; // 均等割り付け const HORIZONTAL_FILL = 'fill'; // const HORIZONTAL_DISTRIBUTED = 'distributed'; // Excel2007 only // Vertical alignment styles const VERTICAL_BOTTOM = 'bottom'; // 下詰め const VERTICAL_TOP = 'top'; // 上詰め const VERTICAL_CENTER = 'center'; // 中央揃え const VERTICAL_JUSTIFY = 'justify'; // 均等割り付け const VERTICAL_DISTRIBUTED = 'distributed'; // Excel2007 only
ボーダーの定数は以下の様に「Borderクラス」に宣言されています。
// Border style const BORDER_NONE = 'none'; const BORDER_DASHDOT = 'dashDot'; const BORDER_DASHDOTDOT = 'dashDotDot'; const BORDER_DASHED = 'dashed'; const BORDER_DOTTED = 'dotted'; const BORDER_DOUBLE = 'double'; const BORDER_HAIR = 'hair'; const BORDER_MEDIUM = 'medium'; const BORDER_MEDIUMDASHDOT = 'mediumDashDot'; const BORDER_MEDIUMDASHDOTDOT = 'mediumDashDotDot'; const BORDER_MEDIUMDASHED = 'mediumDashed'; const BORDER_SLANTDASHDOT = 'slantDashDot'; const BORDER_THICK = 'thick'; const BORDER_THIN = 'thin';
フィルの定数は以下の様に「Fillクラス」に宣言されています。
// Fill types const FILL_NONE = 'none'; const FILL_SOLID = 'solid'; const FILL_GRADIENT_LINEAR = 'linear'; const FILL_GRADIENT_PATH = 'path'; const FILL_PATTERN_DARKDOWN = 'darkDown'; const FILL_PATTERN_DARKGRAY = 'darkGray'; const FILL_PATTERN_DARKGRID = 'darkGrid'; const FILL_PATTERN_DARKHORIZONTAL = 'darkHorizontal'; const FILL_PATTERN_DARKTRELLIS = 'darkTrellis'; const FILL_PATTERN_DARKUP = 'darkUp'; const FILL_PATTERN_DARKVERTICAL = 'darkVertical'; const FILL_PATTERN_GRAY0625 = 'gray0625'; const FILL_PATTERN_GRAY125 = 'gray125'; const FILL_PATTERN_LIGHTDOWN = 'lightDown'; const FILL_PATTERN_LIGHTGRAY = 'lightGray'; const FILL_PATTERN_LIGHTGRID = 'lightGrid'; const FILL_PATTERN_LIGHTHORIZONTAL = 'lightHorizontal'; const FILL_PATTERN_LIGHTTRELLIS = 'lightTrellis'; const FILL_PATTERN_LIGHTUP = 'lightUp'; const FILL_PATTERN_LIGHTVERTICAL = 'lightVertical'; const FILL_PATTERN_MEDIUMGRAY = 'mediumGray';
■セルの指定に範囲を設定
ワークシートオブジェクトからスタイルオブジェクトを取得する getStyle() メソッドで セルの範囲を示す引数を渡すことで、複数のセルに対するスタイルオブジェクトが取得できます。
このスタイルオブジェクトを使って、各種のメソッドを使うことでセル範囲のスタイルを一括で設定できます。
<?php // ライブラリ読込 require '../vendor/autoload.php'; use PhpOffice\PhpSpreadsheet\Spreadsheet; use PhpOffice\PhpSpreadsheet\Style; use PhpOffice\PhpSpreadsheet\Style\Fill; use PhpOffice\PhpSpreadsheet\Writer\Xlsx; // Spreadsheetオブジェクト生成 $objSpreadsheet = new Spreadsheet(); // ワークシートオブジェクト $objSheet = $objSpreadsheet->getActiveSheet(); // スタイルオブジェクト取得([B2~C6の範囲]セル) $objStyle = $objSheet->getStyle('B2:C6'); // フィルオブジェクト取得([B2]セル) $objFill = $objStyle->getFill(); // 背景のタイプを「塗つぶし」に設定 $objFill->setFillType(Fill::FILL_SOLID); // 背景色を「赤」に設定 $objFill->getStartColor()->setARGB('FFFF0000'); // [test6-2.xlsx]:Excel2007形式で保存する $objWriter = new Xlsx($objSpreadsheet); $objWriter->save('test6-2.xlsx'); exit(); ?>出力されたエクセルファイルを見てみると以下の様になります。
■セルのスタイル設定を配列値で設定
PHPExcel ライブラリとは異なりワークシートオブジェクトから取得したスタイルオブジェクトからさらに フォント、アライメント 、フィル 、ボーダ 各オブジェクトを取得します。
その後、それらのオブジェクトの applyFromArray() メソッドで設定するスタイルを array() で与えることが出来ます。<?php // ライブラリ読込 require '../vendor/autoload.php'; use PhpOffice\PhpSpreadsheet\Spreadsheet; use PhpOffice\PhpSpreadsheet\Style; use PhpOffice\PhpSpreadsheet\Style\Alignment; use PhpOffice\PhpSpreadsheet\Style\Border; use PhpOffice\PhpSpreadsheet\Style\Fill; use PhpOffice\PhpSpreadsheet\Style\Font; use PhpOffice\PhpSpreadsheet\Writer\Xlsx; // Spreadsheetオブジェクト生成 $objSpreadsheet = new Spreadsheet(); // ワークシートオブジェクト $objSheet = $objSpreadsheet->getActiveSheet(); // 全部のスタイルの定義 $arrStyle = array( 'font' => array( 'name' => 'Arial', 'bold' => TRUE, 'italic' => FALSE, 'underline' => Font::UNDERLINE_DOUBLE, 'strikethrough' => FALSE, 'color' => array( 'rgb' => '808080' ) ), 'alignment' => array( 'horizontal' => Alignment::HORIZONTAL_RIGHT, ), 'borders' => array( 'top' => array( 'style' => Border::BORDER_THIN, ), 'bottom' => array( 'style' => Border::BORDER_THIN, ), 'left' => array( 'style' => Border::BORDER_THIN, ), 'right' => array( 'style' => Border::BORDER_THIN, ), ), 'fill' => array( 'fillType' => Fill::FILL_SOLID, // 'rotation' => 0, 'startColor' => array( 'argb' => 'FFA0A0A0', ), // 'endColor' => array( // 'argb' => 'FFFFFFFF', // ), ), ); // スタイルオブジェクト取得([B2]セル) $objStyle = $objSheet->getStyle('B2'); // スタイルの設定([B2]セル) $objStyle->getFont()->applyFromArray($arrStyle['font']); $objStyle->getAlignment()->applyFromArray($arrStyle['alignment']); $objStyle->getBorders()->applyFromArray($arrStyle['borders']); $objStyle->getFill()->applyFromArray($arrStyle['fill']); // スタイルオブジェクト取得([C4:D6]セル) $objStyle = $objSheet->getStyle('C4:D6'); // スタイルの設定([C4:D6]セル) $objStyle->getFont()->applyFromArray($arrStyle['font']); $objStyle->getAlignment()->applyFromArray($arrStyle['alignment']); $objStyle->getBorders()->applyFromArray($arrStyle['borders']); $objStyle->getFill()->applyFromArray($arrStyle['fill']); // [test6-3.xlsx]:Excel2007形式で保存する $objWriter = new Xlsx($objSpreadsheet); $objWriter->save('test6-3.xlsx'); exit(); ?>出力されたエクセルファイルを見てみると以下の様になります。
PR -
今回は PhpSpreadsheet で行う「ワークシート」の「紙の大きさ」や「ページ設定」について説明したいと思います。
■ワークシートの紙の方向と大きさの設定
紙の方向と大きさの設定は、ワークシートの PageSetup オブジェクトの setOrientation() , setPaperSize() メソッドを使用して行うことができます。
<?php // ライブラリ読込 require '../vendor/autoload.php'; use PhpOffice\PhpSpreadsheet\Spreadsheet; use PhpOffice\PhpSpreadsheet\Worksheet\PageSetup; use PhpOffice\PhpSpreadsheet\Writer\Xlsx; // Spreadsheetオブジェクト生成 $objSpreadsheet = new Spreadsheet(); // ワークシートオブジェクト $objSheet = $objSpreadsheet->getActiveSheet(); // PageSetupオブジェクト $objPageSetup = $objSheet->getPageSetup(); // 紙の向き設定[ランドスケープ:横向き] $objPageSetup->setOrientation(PageSetup::ORIENTATION_LANDSCAPE); // 紙の大きさ設定[A4] $objPageSetup->setPaperSize(PageSetup::PAPERSIZE_A4); // [A1]セルに文字列設定 $objSheet->setCellValue('A1', 'ABCDEFG'); // [test4-1.xlsx]:Excel2007形式で保存する $objWriter = new Xlsx($objSpreadsheet); $objWriter->save('test4-1.xlsx'); ?>setOrientation() の引数は以下の様に「PageSetupクラス」に定義されています。
// Page orientation const ORIENTATION_DEFAULT = 'default'; // デフォルト const ORIENTATION_LANDSCAPE = 'landscape'; // ランドスケープ:横向き const ORIENTATION_PORTRAIT = 'portrait'; // ポートレート :縦向き
紙の向きの設定は「ORIENTATION_LANDSCAPE」、「ORIENTATION_PORTRAIT」のどちらかに必ず設定した方がいいと思います。 私の所では「ORIENTATION_DEFAULT」にして保存した場合に、エクセルで開いてみたら、「ポートレート」になっていましたが、 デフォルトが本当に「ポートレート」かは保証できませんので。
setPaperSize() の引数は以下の様に「PageSetupクラス」に定義されています。// Paper size const PAPERSIZE_LETTER = 1; const PAPERSIZE_LETTER_SMALL = 2; const PAPERSIZE_TABLOID = 3; const PAPERSIZE_LEDGER = 4; const PAPERSIZE_LEGAL = 5; const PAPERSIZE_STATEMENT = 6; const PAPERSIZE_EXECUTIVE = 7; const PAPERSIZE_A3 = 8; const PAPERSIZE_A4 = 9; const PAPERSIZE_A4_SMALL = 10; const PAPERSIZE_A5 = 11; const PAPERSIZE_B4 = 12; const PAPERSIZE_B5 = 13; const PAPERSIZE_FOLIO = 14; const PAPERSIZE_QUARTO = 15; // まだ他にあります
上記のソースを実行してエクセルの「印刷」で開いてみました。
■ワークシートのページ設定(スケーリング)
PhpSpreadsheet のページ設定スケーリングメソッドは、図の様に、[ページ設定]ダイアログのスケーリング設定オプションを直接設定できます。
メソッド 初期値 有効メソッド呼出 備考 setFitToPage false setScale 100 setFitToPage(false) setFitToWidth 1 setFitToPage(true) 0:FitToWidth をしない setFitToHeight 1 setFitToPage(true) 0:FitToHeight をしない <?php // ライブラリ読込 require '../vendor/autoload.php'; use PhpOffice\PhpSpreadsheet\Spreadsheet; use PhpOffice\PhpSpreadsheet\Worksheet\PageSetup; use PhpOffice\PhpSpreadsheet\Writer\Xlsx; // Spreadsheetオブジェクト生成 $objSpreadsheet = new Spreadsheet(); // ワークシートオブジェクト $objSheet = $objSpreadsheet->getActiveSheet(); // PageSetupオブジェクト $objPageSetup = $objSheet->getPageSetup(); // FitToPageを有効設定 $objPageSetup->setFitToPage(true); // FitToWidth:1 $objPageSetup->setFitToWidth(1); // FitToHeight:0 $objPageSetup->setFitToHeight(0); // [A1]セルに文字列設定 $objSheet->setCellValue('A1', 'ABCDEFG'); // [test4-2.xlsx]:Excel2007形式で保存する $objWriter = new Xlsx($objSpreadsheet); $objWriter->save('test4-2.xlsx'); exit(); ?>出力されたエクセルファイルを見てみると以下の様になります。
(エクセルの「印刷」ページを開いて、「設定」の所の一番下の「ページ設定」リンクをクリックします。)■ワークシートのページ設定(余白)
PhpSpreadsheet のページ設定の余白設定メソッドは、図の様に、[ページ設定]ダイアログの余白設定オプションを直接設定できます。
これらのメソッドはワークシートオブジェクトから PageMarginsオブジェクト を取得し呼出します。<?php // ライブラリ読込 require '../vendor/autoload.php'; use PhpOffice\PhpSpreadsheet\Spreadsheet; use PhpOffice\PhpSpreadsheet\Worksheet\PageMargins; use PhpOffice\PhpSpreadsheet\Writer\Xlsx; // Spreadsheetオブジェクト生成 $objSpreadsheet = new Spreadsheet(); // ワークシートオブジェクト $objSheet = $objSpreadsheet->getActiveSheet(); // PageMarginsオブジェクト $objPageMargins = $objSheet->getPageMargins(); // Top 設定 $objPageMargins->setTop(1); // Right 設定 $objPageMargins->setRight(0.75); // Left 設定 $objPageMargins->setLeft(0.75); // Bottom 設定 $objPageMargins->setBottom(1); // [A1]セルに文字列設定 $objSheet->setCellValue('A1', 'ABCDEFG'); // [test4-3.xlsx]:Excel2007形式で保存する $objWriter = new Xlsx($objSpreadsheet); $objWriter->save('test4-3.xlsx'); exit(); ?>出力されたエクセルファイルを見てみると以下の様になります。
(エクセルの「印刷」ページを開いて、「設定」の所の一番下の「ページ設定」リンクをクリックします。)
※設定値の単位がインチなので以下の計算となる
Top(1) : 1.00×2.54cm=2.540cm⇒2.5
Right(0.75) : 0.75×2.54cm=1.905cm⇒1.9
-
今回は PhpSpreadsheet の「ワークシート」の 「セル」へのアクセス を行・列指定で行う方法について説明したいと思います。
以下の記事では、エクセルの行・列指定("A1","B2"など)によるアクセスについて説明しましたが、 今回は行・列指定指定の部分が、行と列指定に分けて行う方法です。
⇒PHP PhpSpreadsheet エクセルのワークシートのセルへのアクセスについて
- 行・列指定によるセル値の設定(setCellValueByColumnAndRow())
- 行・列指定によるセル値の設定(日付・時刻設定)
- 行・列指定によるセル値の設定(先行ゼロ付きの数値設定)
- 行・列指定によるセル値の設定(配列データの設定)
■行・列指定によるセル値の設定
行・列指定によるセル値の設定は、ワークシートの setCellValueByColumnAndRow() メソッドを使用して行うことができます。
または、getCellByColumnAndRow() メソッドでセルオブジェクトを取得してから、セルオブジェクトの setValue() メソッドを呼び出すこともできます。
<?php // ライブラリ読込 require '../vendor/autoload.php'; use PhpOffice\PhpSpreadsheet\Spreadsheet; use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet; use PhpOffice\PhpSpreadsheet\Writer\Xlsx; // Spreadsheetオブジェクト生成 $objSpreadsheet = new Spreadsheet(); // シート設定 $objSheet = $objSpreadsheet->getActiveSheet(); // [A1]セルに文字列設定 $objSheet->setCellValueByColumnAndRow(1, 1, 'ABCDEFG'); // [B2]セルに数値設定 $objSheet->setCellValueByColumnAndRow(2, 2, 123.56); // [C3]セルにBoolean値設定 $objSheet->setCellValueByColumnAndRow(3, 3, TRUE); // [A4]セルに書式設定 $objSheet->setCellValueByColumnAndRow(5, 1, '=IF(C3, CONCATENATE(A1, " ", B2), CONCATENATE(B2, " ", A1))'); // [B8]セルに getCellByColumnAndRow() でセルを取得し、setValue() で文字列設定 $objSheet->getCellByColumnAndRow(2, 8)->setValue('test 行列指定によるセルオブジェクト取得'); // [test3-3-1.xlsx]:Excel2007形式で保存する $objWriter = new Xlsx($objSpreadsheet); $objWriter->save('test3-3-1.xlsx'); exit(); ?>setCellValueByColumnAndRow() メソッドは setCellValue($pCoordinate , ...) メソッドの $pCoordinate(エクセル座標文字列:"A1"等) の部分を 列番号と行番号に置き換えたメソッドです。
(ライブラリの内部では行番号と列番号からエクセル座標文字列に変換して処理しています)
尚、行番号は「1」から始まり、列番号も「1」から始まります。(1 ⇒ "A", 2 ⇒ "B", 3 ⇒ "C", ... に対応)
PHPExcel では列番号は「0」から始まりましたが PhpSpreadsheet では「1」からになりました。
出力されたエクセルファイルを見てみると以下の様になります。■行・列指定によるセル値の設定(日付・時刻設定)
日付および時刻の値は、エクセル内では(単純な浮動小数点値)のタイムスタンプとして保持され、数値フォーマットマスクを使用して、その値が表示されます。
よって、セルに日付を保存する場合は、正しい エクセルタイムスタンプ を計算し、数値形式マスクを設定する必要があります。
「PHP PhpSpreadsheet エクセルのワークシートのセルへのアクセスについて」 の記事の使用メソッドを行・列指定に変更します。
setCellValue() メソッドは setCellValueByColumnAndRow() メソッドを使用します。
また、getStyle() メソッドは getStyleByColumnAndRow() メソッドを使用します。<?php // ライブラリ読込 require '../vendor/autoload.php'; use PhpOffice\PhpSpreadsheet\Spreadsheet; use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet; use PhpOffice\PhpSpreadsheet\Shared\Date; use PhpOffice\PhpSpreadsheet\Style\NumberFormat; use PhpOffice\PhpSpreadsheet\Writer\Xlsx; // Spreadsheetオブジェクト生成 $objSpreadsheet = new Spreadsheet(); // シート設定 $objSheet = $objSpreadsheet->getActiveSheet(); // システム時刻取得 $dateTimeNow = time(); // エクセルタイムスタンプ値に変換 $excelDateValue = Date::PHPToExcel($dateTimeNow); // [A1]セルにエクセルタイムスタンプ値設定 $objSheet->setCellValueByColumnAndRow(1, 1, $excelDateValue); // [A1]セルの数値フォーマットに日付時刻の設定(yyyy-mm-dd) $objSheet->getStyleByColumnAndRow(1, 1)->getNumberFormat()->setFormatCode( NumberFormat::FORMAT_DATE_YYYYMMDD2 ); // [A2]セルにエクセルタイムスタンプ値設定 $objSheet->setCellValueByColumnAndRow(1, 2, $excelDateValue); // [A2]セルの数値フォーマットに日付時刻の設定(yy/mm/dd;@) $objSheet->getStyleByColumnAndRow(1, 2)->getNumberFormat()->setFormatCode( NumberFormat::FORMAT_DATE_YYYYMMDDSLASH ); // [test3-3-2.xlsx]:Excel2007形式で保存する $objWriter = new Xlsx($objSpreadsheet); $objWriter->save('test3-3-2.xlsx'); exit(); ?>出力されたエクセルファイルを見てみると以下の様になります。
PhpOffice\PhpSpreadsheet\Style\NumberFormat は以下の様に定数が宣言されています。const FORMAT_GENERAL = 'General'; const FORMAT_TEXT = '@'; const FORMAT_NUMBER = '0'; const FORMAT_NUMBER_00 = '0.00'; const FORMAT_NUMBER_COMMA_SEPARATED1 = '#,##0.00'; const FORMAT_NUMBER_COMMA_SEPARATED2 = '#,##0.00_-'; const FORMAT_PERCENTAGE = '0%'; const FORMAT_PERCENTAGE_00 = '0.00%'; const FORMAT_DATE_YYYYMMDD2 = 'yyyy-mm-dd'; const FORMAT_DATE_YYYYMMDD = 'yy-mm-dd'; const FORMAT_DATE_DDMMYYYY = 'dd/mm/yy'; const FORMAT_DATE_DMYSLASH = 'd/m/yy'; const FORMAT_DATE_DMYMINUS = 'd-m-yy'; const FORMAT_DATE_DMMINUS = 'd-m'; const FORMAT_DATE_MYMINUS = 'm-yy'; const FORMAT_DATE_XLSX14 = 'mm-dd-yy'; const FORMAT_DATE_XLSX15 = 'd-mmm-yy'; const FORMAT_DATE_XLSX16 = 'd-mmm'; const FORMAT_DATE_XLSX17 = 'mmm-yy'; const FORMAT_DATE_XLSX22 = 'm/d/yy h:mm'; const FORMAT_DATE_DATETIME = 'd/m/yy h:mm'; const FORMAT_DATE_TIME1 = 'h:mm AM/PM'; const FORMAT_DATE_TIME2 = 'h:mm:ss AM/PM'; const FORMAT_DATE_TIME3 = 'h:mm'; const FORMAT_DATE_TIME4 = 'h:mm:ss'; const FORMAT_DATE_TIME5 = 'mm:ss'; const FORMAT_DATE_TIME6 = 'h:mm:ss'; const FORMAT_DATE_TIME7 = 'i:s.S'; const FORMAT_DATE_TIME8 = 'h:mm:ss;@'; const FORMAT_DATE_YYYYMMDDSLASH = 'yy/mm/dd;@'; const FORMAT_CURRENCY_USD_SIMPLE = '"$"#,##0.00_-'; const FORMAT_CURRENCY_USD = '$#,##0_-'; const FORMAT_CURRENCY_EUR_SIMPLE = '#,##0.00_-"€"'; const FORMAT_CURRENCY_EUR = '#,##0_-"€"'; const FORMAT_ACCOUNTING_USD = '_("$"* #,##0.00_);_("$"* \(#,##0.00\);_("$"* "-"??_);_(@_)'; const FORMAT_ACCOUNTING_EUR = '_("€"* #,##0.00_);_("€"* \(#,##0.00\);_("€"* "-"??_);_(@_)';■行・列指定によるセル値の設定(先行ゼロ付きの数値設定)
数値には先行ゼロがないため、先行ゼロのある数値(電話番号など)を設定しようとすると、値が数値にキャストされるため、これらは通常失われます。 そのため「09088881234」は 「9088881234」と表示されます。
PhpSpreadsheet にこの動作をさせない様な方法は2つあります。
1つは、数値に変換されないように、データ型を文字列として明示的に設定する方法です。
2つ目は、数値書式マスクを使用して、先行ゼロ付きの値を表示する方法です。
「PHP PhpSpreadsheet エクセルのワークシートのセルへのアクセスについて」 の記事の使用メソッドを行・列指定に変更します。
setCellValueExplicit() メソッドは setCellValueExplicitByColumnAndRow() メソッドを使用します。
また、getStyle() メソッドは getStyleByColumnAndRow() メソッドを使用します。<?php // ライブラリ読込 require '../vendor/autoload.php'; use PhpOffice\PhpSpreadsheet\Spreadsheet; use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet; use PhpOffice\PhpSpreadsheet\Cell\DataType; use PhpOffice\PhpSpreadsheet\Writer\Xlsx; // Spreadsheetオブジェクト生成 $objSpreadsheet = new Spreadsheet(); // シート設定 $objSheet = $objSpreadsheet->getActiveSheet(); // [A1]セルにゼロが先頭に有る数値文字列を、文字列として設定 $objSheet->setCellValueExplicitByColumnAndRow( 1, 1, "09088881234", DataType::TYPE_STRING ); // [A2]セルに数値設定 $objSheet->setCellValueByColumnAndRow(1, 2, 9088881234); // [A2]セルの数値フォーマットに "00000000000" の設定 $objSheet->getStyleByColumnAndRow(1, 2)->getNumberFormat()->setFormatCode( '00000000000' ); // [A3]セルに数値設定 $objSheet->setCellValueByColumnAndRow(1, 3, 9088881234); // [A3]セルの数値フォーマットに "0000-000-0000" の設定 $objSheet->getStyleByColumnAndRow(1, 3)->getNumberFormat()->setFormatCode( '0000-000-0000' ); // [test3-3-3.xlsx]:Excel2007形式で保存する $objWriter = new Xlsx($objSpreadsheet); $objWriter->save('test3-3-3.xlsx'); exit(); ?>出力されたエクセルファイルを見てみると以下の様になります。
■行・列指定によるセル値の設定(配列データの設定)
ワークシートの fromArray メソッドに配列データを渡すことにより、1回の呼び出しでセル範囲に設定することができます。
fromArray メソッドに対応する行・列指定のメソッドが無いため、エクセル座標文字列を PhpOffice\PhpSpreadsheet\Cell\Coordinate::stringFromColumnIndex() メソッドで作成します。<?php // ライブラリ読込 require '../vendor/autoload.php'; use PhpOffice\PhpSpreadsheet\Spreadsheet; use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet; use PhpOffice\PhpSpreadsheet\Cell\Coordinate; use PhpOffice\PhpSpreadsheet\Writer\Xlsx; // Spreadsheetオブジェクト生成 $objSpreadsheet = new Spreadsheet(); // シート設定 $objSheet = $objSpreadsheet->getActiveSheet(); // 配列データ $arrData = array( array(NULL, 2018, 2019, 2020), array('Q1', 10, 20, 25), array('Q2', 26, 33, 26), array('Q3', 32, 41, 59), array('Q4', 20, 12, 0), ); // 列と行が指定されたとする $intColumn = 1; $intRow = 2; // [A2]セルの座標値計算 // 列の文字列変換:「0」⇒"A" $strCoordinate = Coordinate::stringFromColumnIndex($intColumn); // 行の文字列を付加 $strCoordinate = $strCoordinate.$intRow; // [A2]セルにから配列データ設定 $objSheet->fromArray( $arrData, // 配列データ NULL, // 配列データの中でセルに設定しないNULL値の指定 $strCoordinate // 左上座標(デフォルト:"A1") ); // [test3-3-4.xlsx]:Excel2007形式で保存する $objWriter = new Xlsx($objSpreadsheet); $objWriter->save('test3-3-4.xlsx'); exit(); ?>出力されたエクセルファイル[test3-3-4.xlsx]を見てみると以下の様になります。
-
今回は PhpSpreadsheet で行う「ワークシート」の 「セル」への漢字(全角文字)の設定 について説明したいと思います。
■ワークシートの「セル」への漢字(全角文字)の設定の簡単なプログラム(エラー発生)
ワークシートの setCellValue() メソッドで全角文字列を指定すれば問題無いであろうとも思って、以下の様なソースを実行しました。
<?php // ライブラリ読込 require '../vendor/autoload.php'; use PhpOffice\PhpSpreadsheet\Spreadsheet; use PhpOffice\PhpSpreadsheet\Writer\Xlsx; // Spreadsheetオブジェクト生成 $objSpreadsheet = new Spreadsheet(); // ワークシートオブジェクト $objSheet = $objSpreadsheet->getActiveSheet(); // [A1]セルに文字列設定 $objSheet->setCellValue('A1', 'あいうえお漢字全角ABCDE'); // [test5-1.xlsx]:Excel2007形式で保存する $objWriter = new Xlsx($objSpreadsheet); $objWriter->save('test5-1.xlsx'); exit(); ?>しかし、実際のエクセルファイル[test5-1.xlsx]を開くと以下の様な表示になります。 全角文字列がうまく反映していない様です。
■エラー発生したソースの文字コードの確認
上記のソースの文字コードを確認したら Shift-JIS コードになっていました。 これを UTF-8 に変更しプログラムを実行後、エクセルファイル(「test5-2.xlsx」としました)を開いてみると正しく文字が設定されました。
■ワークシートのデフォルトスタイルを使用したフォント設定
ワークシートの全てのセルに同じスタイルを設定したい場合に、デフォルトスタイルを設定します。
Spreadsheetオブジェクト のデフォルトスタイルを取得し(getDefaultStyle()メソッド)、 さらにそのスタイルからフォントオブジェクト取得します(getFont()メソッド)。
フォントオブジェクトの setName() メソッドでフォント名を設定し、 setSize() メソッドでフォントサイズを設定します。
セルの縦位置の設定には、デフォルトスタイルからアライメントオブジェクトを取得し setVertical() メソッドでセルの縦方向の設定をします。<?php // ライブラリ読込 require '../vendor/autoload.php'; use PhpOffice\PhpSpreadsheet\Spreadsheet; use PhpOffice\PhpSpreadsheet\Writer\Xlsx; use PhpOffice\PhpSpreadsheet\Style\Alignment; // Spreadsheetオブジェクト生成 $objSpreadsheet = new Spreadsheet(); // ワークシートオブジェクト $objSheet = $objSpreadsheet->getActiveSheet(); // デフォルトスタイルオブジェクト取得 $objDefaultStyle = $objSpreadsheet->getDefaultStyle(); // フォントオブジェクト取得 $objFont = $objDefaultStyle->getFont(); // フォント名設定 $objFont->setName('MS Pゴシック'); // フォントサイズ設定 $objFont->setSize(12); // アライメントオブジェクトでセルの縦方向の設定 $objDefaultStyle->getAlignment()->setVertical(Alignment::VERTICAL_CENTER); // [A1]セルに文字列設定 $objSheet->setCellValue('A1', 'あいうえお漢字全角ABCDE'); // [A2]セルに[A1]と同じ文字列設定 $objSheet->setCellValue('A2', 'あいうえお漢字全角ABCDE'); // [A3]セルに数値設定 $objSheet->setCellValue('A3', '123456789'); // [test5-3.xlsx]:Excel2007形式で保存する $objWriter = new Xlsx($objSpreadsheet); $objWriter->save('test5-3.xlsx'); exit(); ?>出力されたエクセルファイルを見てみると以下の様になります。
これは余談ですが、上記のソースでオブジェクトを変数で受けて処理していますが、以下の様に一気に書いてしまっても問題はありません。<?php // ライブラリ読込 require '../vendor/autoload.php'; use PhpOffice\PhpSpreadsheet\Spreadsheet; use PhpOffice\PhpSpreadsheet\Writer\Xlsx; use PhpOffice\PhpSpreadsheet\Style\Alignment; // Spreadsheetオブジェクト生成 $objSpreadsheet = new Spreadsheet(); // ワークシートオブジェクト $objSheet = $objSpreadsheet->getActiveSheet(); // フォント名設定 $objSpreadsheet->getDefaultStyle()->getFont()->setName('MS Pゴシック'); // フォントサイズ設定 $objSpreadsheet->getDefaultStyle()->getFont()->setSize(12); // アライメントオブジェクトでセルの縦方向の設定 $objSpreadsheet->getDefaultStyle()->getAlignment()->setVertical(Alignment::VERTICAL_CENTER); // [A1]セルに文字列設定 $objSheet->setCellValue('A1', 'あいうえお漢字全角ABCDE'); // [A2]セルに[A1]と同じ文字列設定 $objSheet->setCellValue('A2', 'あいうえお漢字全角ABCDE'); // [A3]セルに数値設定 $objSheet->setCellValue('A3', '123456789'); // [test5-3.xlsx]:Excel2007形式で保存する $objWriter = new Xlsx($objSpreadsheet); $objWriter->save('test5-3.xlsx'); exit(); ?>
-
今回は PhpSpreadsheet で行う「ワークシート」の 「セル」へのアクセス について説明したいと思います。
■座標によるセル値の設定
座標によるセル値の設定は、ワークシートの setCellValue() メソッドを使用して行うことができます。
または、セルオブジェクトを取得してから、セルオブジェクトの setValue() メソッドを呼び出すこともできます。
以下のページと内容は同じですので、参照して下さい。
⇒PHP PhpSpreadsheet エクセルファイル出力の方法について<?php // ライブラリ読込 require '../vendor/autoload.php'; use PhpOffice\PhpSpreadsheet\Spreadsheet; use PhpOffice\PhpSpreadsheet\Writer\Xlsx; // Spreadsheetオブジェクト生成 $objSpreadsheet = new Spreadsheet(); // シート設定 $objSheet = $objSpreadsheet->getActiveSheet(); // [A1]セルに文字列設定 $objSheet->setCellValue('A1', 'Spreadsheet'); // [A2]セルに数値設定 $objSheet->setCellValue('A2', 123.56); // [A3]セルにBOOLEAN設定 $objSheet->setCellValue('A3', TRUE); // [A4]セルに書式設定 $objSheet->setCellValue('A4', '=IF(A3, CONCATENATE(A1, " ", A2), CONCATENATE(A2, " ", A1))'); // [A8]セルに getCell() でセルを取得し、setValue() で文字列設定 $objSheet->getCell('A8')->setValue('test data'); // XLSX形式オブジェクト生成 $objWriter = new Xlsx($objSpreadsheet); // ファイル書込み $objWriter->save('test.xlsx'); exit(); ?>エクセルは以下の7個のデータ型をサポートしています。
- string:文字列
- number:数値
- boolean:ブール値
- null :ヌル
- formula:数式
- error :エラー
- Inline(or rich-text)string:インライン、リッチテキスト
基本的には、ワークシートの setCellValue() メソッドまたは、セルの setValue() メソッドを呼び出すと、 Spreadsheet は PHP のnull、ブール値、浮動小数点数、または整数に対応する適切なデータ型を使用します。
メソッドに渡される文字列データは最も適切なデータ型にキャストされます。 数値文字列は数値にキャストされ ”=” で始まる文字列は数式に変換されます。 数値ではない文字列、または ”=” で始まっていない文字列は、文字列値として扱われます。
これらの「変換」はセルの「値バインダー」によって処理され、カスタムの「値バインダー」を記述して、これらの「変換」の動作を変更できます。
尚 PhpSpreadsheet は各種の形式の文字列を、適切な数値や datetimestamp値 に変換し、セルに設定します。
日付の様に見える値を含む文字列は、Excelのシリアル化されたdatetimestamp値に変換され、対応するマスクが適用されます。
以下のソースに例を示します。<?php // ライブラリ読込 require '../vendor/autoload.php'; use PhpOffice\PhpSpreadsheet\Spreadsheet; use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet; use PhpOffice\PhpSpreadsheet\Writer\Xlsx; // Spreadsheetオブジェクト生成 $objSpreadsheet = new Spreadsheet(); // シート設定 $objSheet = $objSpreadsheet->getActiveSheet(); // [A1]セルに数値文字列設定 $objSheet->setCellValue('A1', '1234.56'); // [A2]セルに数式文字列設定 $objSheet->setCellValue('A2', '=A1*100'); // [A3]セルに日付文字列設定 $objSheet->setCellValue('A3', '2020/05/10'); // [A4]セルに文字列設定 $objSheet->setCellValue('A4', 'ABCD123'); // [test3-1.xlsx]:XLSX形式オブジェクト生成 $objWriter = new Xlsx($objSpreadsheet); // ファイル書込み $objWriter->save('test3-1.xlsx'); exit(); ?>■座標によるセル値の設定(日付・時刻設定)
日付および時刻の値は、エクセル内では(単純な浮動小数点値)のタイムスタンプとして保持され、数値フォーマットマスクを使用して、その値が表示されます。
よって、セルに日付を保存する場合は、正しい エクセルタイムスタンプ を計算し、数値形式マスクを設定する必要があります。
<?php // ライブラリ読込 require '../vendor/autoload.php'; use PhpOffice\PhpSpreadsheet\Spreadsheet; use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet; use PhpOffice\PhpSpreadsheet\Shared\Date; use PhpOffice\PhpSpreadsheet\Style\NumberFormat; use PhpOffice\PhpSpreadsheet\Writer\Xlsx; // Spreadsheetオブジェクト生成 $objSpreadsheet = new Spreadsheet(); // シート設定 $objSheet = $objSpreadsheet->getActiveSheet(); // システム時刻取得 $dateTimeNow = time(); // エクセルタイムスタンプ値に変換 $excelDateValue = Date::PHPToExcel($dateTimeNow); // [A1]セルにエクセルタイムスタンプ値設定 $objSheet->setCellValue('A1', $excelDateValue); // [A1]セルの数値フォーマットに日付時刻の設定(yyyy-mm-dd) $objSheet->getStyle('A1')->getNumberFormat()->setFormatCode(NumberFormat::FORMAT_DATE_YYYYMMDD2); // [A2]セルにエクセルタイムスタンプ値設定 $objSheet->setCellValue('A2', $excelDateValue); // [A2]セルの数値フォーマットに日付時刻の設定(yy/mm/dd;@) $objSheet->getStyle('A2')->getNumberFormat()->setFormatCode(NumberFormat::FORMAT_DATE_YYYYMMDDSLASH); // [test3-2.xlsx]:XLSX形式オブジェクト生成 $objWriter = new Xlsx($objSpreadsheet); // ファイル書込み $objWriter->save('test3-2.xlsx'); exit(); ?>出力されたエクセルファイルを見てみると以下の様になります。
PhpOffice\PhpSpreadsheet\Style\NumberFormat は以下の様に定数が宣言されています。const FORMAT_GENERAL = 'General'; const FORMAT_TEXT = '@'; const FORMAT_NUMBER = '0'; const FORMAT_NUMBER_00 = '0.00'; const FORMAT_NUMBER_COMMA_SEPARATED1 = '#,##0.00'; const FORMAT_NUMBER_COMMA_SEPARATED2 = '#,##0.00_-'; const FORMAT_PERCENTAGE = '0%'; const FORMAT_PERCENTAGE_00 = '0.00%'; const FORMAT_DATE_YYYYMMDD2 = 'yyyy-mm-dd'; const FORMAT_DATE_YYYYMMDD = 'yy-mm-dd'; const FORMAT_DATE_DDMMYYYY = 'dd/mm/yy'; const FORMAT_DATE_DMYSLASH = 'd/m/yy'; const FORMAT_DATE_DMYMINUS = 'd-m-yy'; const FORMAT_DATE_DMMINUS = 'd-m'; const FORMAT_DATE_MYMINUS = 'm-yy'; const FORMAT_DATE_XLSX14 = 'mm-dd-yy'; const FORMAT_DATE_XLSX15 = 'd-mmm-yy'; const FORMAT_DATE_XLSX16 = 'd-mmm'; const FORMAT_DATE_XLSX17 = 'mmm-yy'; const FORMAT_DATE_XLSX22 = 'm/d/yy h:mm'; const FORMAT_DATE_DATETIME = 'd/m/yy h:mm'; const FORMAT_DATE_TIME1 = 'h:mm AM/PM'; const FORMAT_DATE_TIME2 = 'h:mm:ss AM/PM'; const FORMAT_DATE_TIME3 = 'h:mm'; const FORMAT_DATE_TIME4 = 'h:mm:ss'; const FORMAT_DATE_TIME5 = 'mm:ss'; const FORMAT_DATE_TIME6 = 'h:mm:ss'; const FORMAT_DATE_TIME7 = 'i:s.S'; const FORMAT_DATE_TIME8 = 'h:mm:ss;@'; const FORMAT_DATE_YYYYMMDDSLASH = 'yy/mm/dd;@'; const FORMAT_CURRENCY_USD_SIMPLE = '"$"#,##0.00_-'; const FORMAT_CURRENCY_USD = '$#,##0_-'; const FORMAT_CURRENCY_EUR_SIMPLE = '#,##0.00_-"€"'; const FORMAT_CURRENCY_EUR = '#,##0_-"€"'; const FORMAT_ACCOUNTING_USD = '_("$"* #,##0.00_);_("$"* \(#,##0.00\);_("$"* "-"??_);_(@_)'; const FORMAT_ACCOUNTING_EUR = '_("€"* #,##0.00_);_("€"* \(#,##0.00\);_("€"* "-"??_);_(@_)';■座標によるセル値の設定(先行ゼロ付きの数値設定)
数値には先行ゼロがないため、先行ゼロのある数値(電話番号など)を設定しようとすると、値が数値にキャストされるため、これらは通常失われます。 そのため「09088881234」は 「9088881234」と表示されます。
PhpSpreadsheet にこの動作をさせない様な方法は2つあります。
1つは、数値に変換されないように、データ型を文字列として明示的に設定する方法です。
2つ目は、数値書式マスクを使用して、先行ゼロ付きの値を表示する方法です。<?php // ライブラリ読込 require '../vendor/autoload.php'; use PhpOffice\PhpSpreadsheet\Spreadsheet; use PhpOffice\PhpSpreadsheet\Cell\DataType; use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet; use PhpOffice\PhpSpreadsheet\Writer\Xlsx; // Spreadsheetオブジェクト生成 $objSpreadsheet = new Spreadsheet(); // シート設定 $objSheet = $objSpreadsheet->getActiveSheet(); // [A1]セルにゼロが先頭に有る数値文字列を、文字列として設定 $objSheet->setCellValueExplicit('A1', "09088881234", DataType::TYPE_STRING); // [A2]セルに数値設定 $objSheet->setCellValue('A2', 9088881234); // [A2]セルの数値フォーマットに "00000000000" の設定 $objSheet->getStyle('A2')->getNumberFormat()->setFormatCode('00000000000'); // [A3]セルに数値設定 $objSheet->setCellValue('A3', 9088881234); // [A3]セルの数値フォーマットに "0000-000-0000" の設定 $objSheet->getStyle('A3')->getNumberFormat()->setFormatCode('0000-000-0000'); // [test3-3.xlsx]:XLSX形式オブジェクト生成 $objWriter = new Xlsx($objSpreadsheet); // ファイル書込み $objWriter->save('test3-3.xlsx'); exit(); ?>出力されたエクセルファイルを見てみると以下の様になります。
■座標によるセル値の設定(配列データの設定)
ワークシートの fromArray メソッドに配列データを渡すことにより、1回の呼び出しでセル範囲に設定することができます。
<?php // ライブラリ読込 require '../vendor/autoload.php'; use PhpOffice\PhpSpreadsheet\Spreadsheet; use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet; use PhpOffice\PhpSpreadsheet\Writer\Xlsx; // Spreadsheetオブジェクト生成 $objSpreadsheet = new Spreadsheet(); // シート設定 $objSheet = $objSpreadsheet->getActiveSheet(); // 配列データ $arrData = array( array(NULL, 2018, 2019, 2020), array('Q1', 10, 20, 25), array('Q2', 26, 33, 26), array('Q3', 32, 41, 59), array('Q4', 20, 12, 0), ); // [A2]セルにから配列データ設定 $objSheet->fromArray( $arrData, // 配列データ NULL, // 配列データの中でセルに設定しないNULL値の指定 'A2' // 左上座標(デフォルト:"A1") ); // [test3-4.xlsx]:XLSX形式オブジェクト生成 $objWriter = new Xlsx($objSpreadsheet); // ファイル書込み $objWriter->save('test3-4.xlsx'); exit(); ?>出力されたエクセルファイル[test3-4.xlsx]を見てみると以下の様になります。
fromArray メソッドに2次元配列を渡すと、一連の行と列として扱われますが、1次元配列は単一の行として扱われます。
先ずは、横方向の1次元配列の設定を行い、その後で縦方向の設定を行います。<?php // ライブラリ読込 require '../vendor/autoload.php'; use PhpOffice\PhpSpreadsheet\Spreadsheet; use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet; use PhpOffice\PhpSpreadsheet\Writer\Xlsx; // Spreadsheetオブジェクト生成 $objSpreadsheet = new Spreadsheet(); // シート設定 $objSheet = $objSpreadsheet->getActiveSheet(); // 横方向の配列データ $arrX = array('Value-1', 'Value-2', 'Value-3', 'Value-4'); $objSheet->fromArray( $arrX, // 配列データ NULL, // 配列データの中でセルに設定しないNULL値の指定 'A1' // 左上座標(デフォルト:"A1") ); // 縦方向の配列データ $arrY = array_chunk($arrX, 1); $objSheet->fromArray( $arrY, // 配列データ NULL, // 配列データの中でセルに設定しないNULL値の指定 'A3' // 左上座標(デフォルト:"A3") ); // [test3-5.xlsx]:XLSX形式オブジェクト生成 $objWriter = new Xlsx($objSpreadsheet); // ファイル書込み $objWriter->save('test3-5.xlsx'); exit(); ?>出力されたエクセルファイル[test3-5.xlsx]を見てみると以下の様になります。