OrderPdfService extends TcpdfFpdi
Class OrderPdfService.
Do export pdf function.
Table of Contents
| DEFAULT_PDF_FILE_NAME | ダウンロードするPDFファイルのデフォルト名 | 'nouhinsyo.pdf' |
|---|---|---|
| FONT_GOTHIC | FONT ゴシック | 'kozgopromedium' |
| FONT_SJIS | FONT 明朝 | 'kozminproregular' |
| $orderRepository | OrderRepository | |
| $shippingRepository | ShippingRepository | |
| $orderPdfRepository | OrderPdfRepository | |
| $taxRuleService | TaxRuleService | |
| $eccubeConfig | EccubeConfig | |
| $eccubeExtension | EccubeExtension | |
| $taxExtension | TaxExtension | |
| $baseInfoRepository | BaseInfo | |
| $labelCell | 購入詳細情報 ラベル配列 | array |
| $widthCell | ||
| $lastOrderId | 最後に処理した注文番号 @var string | |
| $bakFontFamily | string | |
| $bakFontStyle | string | |
| $bakFontSize | string | |
| $baseOffsetX | ||
| $baseOffsetY | ||
| $downloadFileName | ダウンロードファイル名 @var string | |
| $issueDate | 発行日 @var string | |
| __construct() | OrderPdfService constructor. | mixed |
| makePdf() | 注文情報からPDFファイルを作成する. | bool |
| outputPdf() | PDFファイルを出力する. | string|mixed |
| getPdfFileName() | PDFファイル名を取得する PDFが1枚の時は注文番号をファイル名につける. | string |
| Footer() | フッターに発行日を出力する. | mixed |
| addPdfPage() | 作成するPDFのテンプレートファイルを指定する. | mixed |
| renderShopData() | PDFに店舗情報を設定する ショップ名、ロゴ画像以外はdtb_helpに登録されたデータを使用する. | mixed |
| renderMessageData() | メッセージを設定する. | mixed |
| renderEtcData() | PDFに備考を設定数. | mixed |
| renderTitle() | タイトルをPDFに描画する. | mixed |
| renderOrderData() | 購入者情報を設定する. | mixed |
| renderOrderDetailData() | 購入商品詳細情報を設定する. | mixed |
| lfText() | PDFへのテキスト書き込み | mixed |
| setFancyTable() | Colored table. | mixed |
| setBasePosition() | 基準座標を設定する. | mixed |
| setDefaultData() | データが設定されていない場合にデフォルト値を設定する. | mixed |
| backupFont() | Font情報のバックアップ. | mixed |
| restoreFont() | Font情報の復元. | mixed |
Constants
DEFAULT_PDF_FILE_NAME
ダウンロードするPDFファイルのデフォルト名
public
mixed
$DEFAULT_PDF_FILE_NAME
= 'nouhinsyo.pdf'
FONT_GOTHIC
FONT ゴシック
public
mixed
$FONT_GOTHIC
= 'kozgopromedium'
FONT_SJIS
FONT 明朝
public
mixed
$FONT_SJIS
= 'kozminproregular'
Properties
$orderRepository
protected
OrderRepository
$orderRepository
$shippingRepository
protected
ShippingRepository
$shippingRepository
$orderPdfRepository
protected
OrderPdfRepository
$orderPdfRepository
$taxRuleService
protected
TaxRuleService
$taxRuleService
$eccubeConfig
private
EccubeConfig
$eccubeConfig
$eccubeExtension
private
EccubeExtension
$eccubeExtension
$taxExtension
private
TaxExtension
$taxExtension
$baseInfoRepository
public
BaseInfo
$baseInfoRepository
$labelCell
購入詳細情報 ラベル配列
private
array
$labelCell
= []
$widthCell
private
mixed
$widthCell
= []
$lastOrderId
最後に処理した注文番号 @var string
private
mixed
$lastOrderId
= null
$bakFontFamily
private
string
$bakFontFamily
$bakFontStyle
private
string
$bakFontStyle
$bakFontSize
private
string
$bakFontSize
$baseOffsetX
private
mixed
$baseOffsetX
= ""
$baseOffsetY
private
mixed
$baseOffsetY
= -4
$downloadFileName
ダウンロードファイル名 @var string
private
mixed
$downloadFileName
= null
$issueDate
発行日 @var string
private
mixed
$issueDate
= ''
Methods
__construct()
OrderPdfService constructor.
public
__construct(
$eccubeConfig :
EccubeConfig
, $orderRepository :
OrderRepository
, $shippingRepository :
ShippingRepository
, $taxRuleService :
TaxRuleService
, $baseInfoRepository :
BaseInfoRepository
, $eccubeExtension :
EccubeExtension
, $taxExtension :
TaxExtension
)
: mixed
Parameters
- $eccubeConfig : EccubeConfig
- $orderRepository : OrderRepository
- $shippingRepository : ShippingRepository
- $taxRuleService : TaxRuleService
- $baseInfoRepository : BaseInfoRepository
- $eccubeExtension : EccubeExtension
- $taxExtension : TaxExtension
Tags
Return values
mixedmakePdf()
注文情報からPDFファイルを作成する.
public
makePdf(
$formData :
array
)
: bool
Parameters
- $formData : array
[KEY] ids: 注文番号 issue_date: 発行日 title: タイトル message1: メッセージ1行目 message2: メッセージ2行目 message3: メッセージ3行目 note1: 備考1行目 note2: 備考2行目 note3: 備考3行目
Return values
booloutputPdf()
PDFファイルを出力する.
public
outputPdf(
)
: string|mixed
Return values
string|mixedgetPdfFileName()
PDFファイル名を取得する PDFが1枚の時は注文番号をファイル名につける.
public
getPdfFileName(
)
: string
Return values
string —ファイル名
Footer()
フッターに発行日を出力する.
public
Footer(
)
: mixed
Return values
mixedaddPdfPage()
作成するPDFのテンプレートファイルを指定する.
protected
addPdfPage(
)
: mixed
Return values
mixedrenderShopData()
PDFに店舗情報を設定する ショップ名、ロゴ画像以外はdtb_helpに登録されたデータを使用する.
protected
renderShopData(
)
: mixed
Return values
mixedrenderMessageData()
メッセージを設定する.
protected
renderMessageData(
$formData :
array
)
: mixed
Parameters
- $formData : array
Return values
mixedrenderEtcData()
PDFに備考を設定数.
protected
renderEtcData(
$formData :
array
)
: mixed
Parameters
- $formData : array
Return values
mixedrenderTitle()
タイトルをPDFに描画する.
protected
renderTitle(
$title :
string
)
: mixed
Parameters
- $title : string
Return values
mixedrenderOrderData()
購入者情報を設定する.
protected
renderOrderData(
$Shipping :
Shipping
)
: mixed
Parameters
- $Shipping : Shipping
Return values
mixedrenderOrderDetailData()
購入商品詳細情報を設定する.
protected
renderOrderDetailData(
$Shipping :
Shipping
)
: mixed
Parameters
- $Shipping : Shipping
Return values
mixedlfText()
PDFへのテキスト書き込み
protected
lfText(
$x :
int
, $y :
int
, $text :
string
, $size :
int
[, $style :
string
= '' ]
)
: mixed
Parameters
- $x : int
X座標
- $y : int
Y座標
- $text : string
テキスト
- $size : int
フォントサイズ
- $style : string = ''
フォントスタイル
Return values
mixedsetFancyTable()
Colored table.
protected
setFancyTable(
$header :
array
, $data :
array
, $w :
array
)
: mixed
TODO: 後の列の高さが大きい場合、表示が乱れる。
Parameters
- $header : array
出力するラベル名一覧
- $data : array
出力するデータ
- $w : array
出力するセル幅一覧
Return values
mixedsetBasePosition()
基準座標を設定する.
protected
setBasePosition(
[ $x :
int
= null ]
[, $y :
int
= null ]
)
: mixed
Parameters
- $x : int = null
- $y : int = null
Return values
mixedsetDefaultData()
データが設定されていない場合にデフォルト値を設定する.
protected
setDefaultData(
&$formData :
array
)
: mixed
Parameters
- $formData : array
Return values
mixedbackupFont()
Font情報のバックアップ.
protected
backupFont(
)
: mixed
Return values
mixedrestoreFont()
Font情報の復元.
protected
restoreFont(
)
: mixed