EC-CUBE4 APIドキュメント

Order extends AbstractEntity implements PurchaseInterface, ItemHolderInterface Uses NameTrait, PointTrait

Order

Tags
ORM\Table

(name="dtb_order", indexes={ @ORM\Index(name="dtb_order_email_idx", columns={"email"}), @ORM\Index(name="dtb_order_order_date_idx", columns={"order_date"}), @ORM\Index(name="dtb_order_payment_date_idx", columns={"payment_date"}), @ORM\Index(name="dtb_order_update_date_idx", columns={"update_date"}), @ORM\Index(name="dtb_order_order_no_idx", columns={"order_no"}) }, uniqueConstraints={ @ORM\UniqueConstraint(name="dtb_order_pre_order_id_idx", columns={"pre_order_id"}) })

ORM\InheritanceType

("SINGLE_TABLE")

ORM\DiscriminatorColumn

(name="discriminator_type", type="string", length=255)

ORM\HasLifecycleCallbacks

()

ORM\Entity

(repositoryClass="Eccube\Repository\OrderRepository")

Table of Contents

$id int
$pre_order_id string|null
$order_no string|null
$message string|null
$name01 string|null
$name02 string|null
$kana01 string|null
$kana02 string|null
$company_name string|null
$email string|null
$phone_number string|null
$postal_code string|null
$addr01 string|null
$addr02 string|null
$birth DateTime|null
$subtotal string
$discount string
$delivery_fee_total string
$charge string
$tax string
$total string
$payment_total string
$payment_method string|null
$note string|null
$create_date DateTime
$update_date DateTime
$order_date DateTime|null
$payment_date DateTime|null
$currency_code string|null
$complete_message 注文完了画面に表示するメッセージ string|null
$complete_mail_message 注文完了メールに表示するメッセージ string|null
$OrderItems Collection|\Eccube\Entity\OrderItem[]
$Shippings Collection|\Eccube\Entity\Shipping[]
$MailHistories Collection
$Customer Customer
$Country Country
$Pref Pref
$Sex Sex
$Job Job
$Payment Payment
$DeviceType DeviceType
$CustomerOrderStatus OrderStatusより先にプロパティを定義しておかないとセットされなくなる CustomerOrderStatus
$OrderStatusColor OrderStatusより先にプロパティを定義しておかないとセットされなくなる OrderStatusColor
$OrderStatus OrderStatus
$add_point string
$use_point string
$AnnotationReader
getTaxableItems() 課税対象の明細を返す. array
getTaxableTotal() 課税対象の明細の合計金額を返す. mixed
getTaxableTotalByTaxRate() 課税対象の明細の合計金額を、税率ごとに集計する. array
getTaxableDiscountItems() 課税対象の値引き明細を返す. array
getTaxableDiscount() 課税対象の値引き金額合計を返す. mixed
getTaxFreeDiscountItems() 非課税・不課税の値引き明細を返す. array
isMultiple() 複数配送かどうかの判定を行う. bool
findShipping() 対象となるお届け先情報を取得 Shipping|null
getSaleTypes() この注文の保持する販売種別を取得します. \Eccube\Entity\Master\SaleType[]
getMergedProductOrderItems() 同じ規格の商品の個数をまとめた受注明細を取得 \Eccube\Entity\OrderItem[]
getTotalPrice() 合計金額を計算 string
__construct() Constructor mixed
__clone() Clone mixed
getId() Get id. int
setPreOrderId() Set preOrderId. Order
getPreOrderId() Get preOrderId. string|null
setOrderNo() Set orderNo Order
getOrderNo() Get orderNo string|null
setMessage() Set message. Order
getMessage() Get message. string|null
setName01() Set name01. Order
getName01() Get name01. string|null
setName02() Set name02. Order
getName02() Get name02. string|null
setKana01() Set kana01. Order
getKana01() Get kana01. string|null
setKana02() Set kana02. Order
getKana02() Get kana02. string|null
setCompanyName() Set companyName. Order
getCompanyName() Get companyName. string|null
setEmail() Set email. Order
getEmail() Get email. string|null
setPhoneNumber() Set phone_number. Order
getPhoneNumber() Get phone_number. string|null
setPostalCode() Set postal_code. Order
getPostalCode() Get postal_code. string|null
setAddr01() Set addr01. Order
getAddr01() Get addr01. string|null
setAddr02() Set addr02. Order
getAddr02() Get addr02. string|null
setBirth() Set birth. Order
getBirth() Get birth. DateTime|null
setSubtotal() Set subtotal. Order
getSubtotal() Get subtotal. string
setDiscount() Set discount. Order
getDiscount() Get discount. string
setDeliveryFeeTotal() Set deliveryFeeTotal. Order
getDeliveryFeeTotal() Get deliveryFeeTotal. string
setCharge() Set charge. Order
getCharge() Get charge. string
setTax() Set tax. Order
getTax() Get tax. string
setTotal() Set total. Order
getTotal() Get total. string
setPaymentTotal() Set paymentTotal. Order
getPaymentTotal() Get paymentTotal. string
setPaymentMethod() Set paymentMethod. Order
getPaymentMethod() Get paymentMethod. string|null
setNote() Set note. Order
getNote() Get note. string|null
setCreateDate() Set createDate. Order
getCreateDate() Get createDate. DateTime
setUpdateDate() Set updateDate. Order
getUpdateDate() Get updateDate. DateTime
setOrderDate() Set orderDate. Order
getOrderDate() Get orderDate. DateTime|null
setPaymentDate() Set paymentDate. Order
getPaymentDate() Get paymentDate. DateTime|null
getCurrencyCode() Get currencyCode. string
setCurrencyCode() Set currencyCode. $this
getCompleteMessage() null|string
setCompleteMessage() $this
appendCompleteMessage() $this
getCompleteMailMessage() null|string
setCompleteMailMessage() mixed
appendCompleteMailMessage() mixed
getProductOrderItems() 商品の受注明細を取得 \Eccube\Entity\OrderItem[]
addOrderItem() Add orderItem. Order
removeOrderItem() Remove orderItem. bool
getOrderItems() Get orderItems. Collection|\Eccube\Entity\OrderItem[]
getItems() Sorted to getOrderItems() ItemCollection
addShipping() Add shipping. Order
removeShipping() Remove shipping. bool
getShippings() Get shippings. Collection|\Eccube\Entity\Shipping[]
addMailHistory() Add mailHistory. Order
removeMailHistory() Remove mailHistory. bool
getMailHistories() Get mailHistories. Collection
setCustomer() Set customer. Order
getCustomer() Get customer. Customer|null
setCountry() Set country. Order
getCountry() Get country. Country|null
setPref() Set pref. Order
getPref() Get pref. Pref|null
setSex() Set sex. Order
getSex() Get sex. Sex|null
setJob() Set job. Order
getJob() Get job. Job|null
setPayment() Set payment. Order
getPayment() Get payment. Payment|null
setDeviceType() Set deviceType. Order
getDeviceType() Get deviceType. DeviceType|null
setCustomerOrderStatus() Set customerOrderStatus. Order
getCustomerOrderStatus() Get customerOrderStatus. CustomerOrderStatus|null
setOrderStatusColor() Set orderStatusColor. Order
getOrderStatusColor() Get orderStatusColor. OrderStatusColor|null
setOrderStatus() Set orderStatus. Order
getOrderStatus() Get orderStatus. OrderStatus|null
addItem() mixed
getQuantity() 個数の合計を返します。 mixed
getFullName() mixed
getFullNameKana() mixed
setAddPoint() Set addPoint Order
getAddPoint() Get addPoint string
setUsePoint() Set usePoint Order
getUsePoint() Get usePoint string
offsetExists() mixed
offsetSet() mixed
offsetGet() mixed
offsetUnset() mixed
setPropertiesFromArray() 引数の連想配列を元にプロパティを設定します. mixed
toArray() Convert to associative array. array
toNormalizedArray() Convert to associative array, and normalize to association properties. array
toJSON() Convert to JSON. string
toXML() Convert to XML. string
copyProperties() コピー元のオブジェクトのフィールド名を指定して、同名のフィールドに値をコピー AbstractEntity
setAnnotationReader() Set AnnotationReader. AbstractEntity
getAnnotationReader() Get AnnotationReader. Reader
getEntityIdentifierAsArray() Convert to Entity of Identity value to associative array. array

Properties

$id

private int $id
Tags
ORM\Column

(name="id", type="integer", options={"unsigned":true})

ORM\Id
ORM\GeneratedValue

(strategy="IDENTITY")

$pre_order_id

private string|null $pre_order_id
Tags
ORM\Column

(name="pre_order_id", type="string", length=255, nullable=true)

$order_no

private string|null $order_no
Tags
ORM\Column

(name="order_no", type="string", length=255, nullable=true)

$message

private string|null $message
Tags
ORM\Column

(name="message", type="string", length=4000, nullable=true)

$name01

private string|null $name01
Tags
ORM\Column

(name="name01", type="string", length=255)

$name02

private string|null $name02
Tags
ORM\Column

(name="name02", type="string", length=255)

$kana01

private string|null $kana01
Tags
ORM\Column

(name="kana01", type="string", length=255, nullable=true)

$kana02

private string|null $kana02
Tags
ORM\Column

(name="kana02", type="string", length=255, nullable=true)

$company_name

private string|null $company_name
Tags
ORM\Column

(name="company_name", type="string", length=255, nullable=true)

$email

private string|null $email
Tags
ORM\Column

(name="email", type="string", length=255, nullable=true)

$phone_number

private string|null $phone_number
Tags
ORM\Column

(name="phone_number", type="string", length=14, nullable=true)

$postal_code

private string|null $postal_code
Tags
ORM\Column

(name="postal_code", type="string", length=8, nullable=true)

$addr01

private string|null $addr01
Tags
ORM\Column

(name="addr01", type="string", length=255, nullable=true)

$addr02

private string|null $addr02
Tags
ORM\Column

(name="addr02", type="string", length=255, nullable=true)

$birth

private DateTime|null $birth
Tags
ORM\Column

(name="birth", type="datetimetz", nullable=true)

$subtotal

private string $subtotal = ""
Tags
ORM\Column

(name="subtotal", type="decimal", precision=12, scale=2, options={"unsigned":true,"default":0})

$discount

private string $discount = ""
Tags
ORM\Column

(name="discount", type="decimal", precision=12, scale=2, options={"unsigned":true,"default":0})

$delivery_fee_total

private string $delivery_fee_total = ""
Tags
ORM\Column

(name="delivery_fee_total", type="decimal", precision=12, scale=2, options={"unsigned":true,"default":0})

$charge

private string $charge = ""
Tags
ORM\Column

(name="charge", type="decimal", precision=12, scale=2, options={"unsigned":true,"default":0})

$tax

private string $tax = ""
Tags
ORM\Column

(name="tax", type="decimal", precision=12, scale=2, options={"unsigned":true,"default":0})

deprecated

明細ごとに集計した税額と差異が発生する場合があるため非推奨

$total

private string $total = ""
Tags
ORM\Column

(name="total", type="decimal", precision=12, scale=2, options={"unsigned":true,"default":0})

$payment_total

private string $payment_total = ""
Tags
ORM\Column

(name="payment_total", type="decimal", precision=12, scale=2, options={"unsigned":true,"default":0})

$payment_method

private string|null $payment_method
Tags
ORM\Column

(name="payment_method", type="string", length=255, nullable=true)

$note

private string|null $note
Tags
ORM\Column

(name="note", type="string", length=4000, nullable=true)

$create_date

private DateTime $create_date
Tags
ORM\Column

(name="create_date", type="datetimetz")

$update_date

private DateTime $update_date
Tags
ORM\Column

(name="update_date", type="datetimetz")

$order_date

private DateTime|null $order_date
Tags
ORM\Column

(name="order_date", type="datetimetz", nullable=true)

$payment_date

private DateTime|null $payment_date
Tags
ORM\Column

(name="payment_date", type="datetimetz", nullable=true)

$currency_code

private string|null $currency_code
Tags
ORM\Column

(name="currency_code", type="string", nullable=true)

$complete_message

注文完了画面に表示するメッセージ

private string|null $complete_message
プラグインから注文完了時にメッセージを表示したい場合, このフィールドにセットすることで, 注文完了画面で表示されます。 複数のプラグインから利用されるため, appendCompleteMesssage()で追加してください. 表示する際にHTMLは利用可能です。
Tags
ORM\Column

(name="complete_message", type="text", nullable=true)

$complete_mail_message

注文完了メールに表示するメッセージ

private string|null $complete_mail_message
プラグインから注文完了メールにメッセージを表示したい場合, このフィールドにセットすることで, 注文完了メールで表示されます。 複数のプラグインから利用されるため, appendCompleteMailMesssage()で追加してください.
Tags
ORM\Column

(name="complete_mail_message", type="text", nullable=true)

$OrderItems

private Collection|\Eccube\Entity\OrderItem[] $OrderItems
Tags
ORM\OneToMany

(targetEntity="Eccube\Entity\OrderItem", mappedBy="Order", cascade={"persist","remove"})

$Shippings

private Collection|\Eccube\Entity\Shipping[] $Shippings
Tags
ORM\OneToMany

(targetEntity="Eccube\Entity\Shipping", mappedBy="Order", cascade={"persist","remove"})

$MailHistories

private Collection $MailHistories
Tags
ORM\OneToMany

(targetEntity="Eccube\Entity\MailHistory", mappedBy="Order", cascade={"remove"})

ORM\OrderBy

({ "send_date"="DESC" })

$Customer

private Customer $Customer
Tags
ORM\ManyToOne

(targetEntity="Eccube\Entity\Customer", inversedBy="Orders")

ORM\JoinColumns

({ @ORM\JoinColumn(name="customer_id", referencedColumnName="id") })

$Country

private Country $Country
Tags
ORM\ManyToOne

(targetEntity="Eccube\Entity\Master\Country")

ORM\JoinColumns

({ @ORM\JoinColumn(name="country_id", referencedColumnName="id") })

$Pref

private Pref $Pref
Tags
ORM\ManyToOne

(targetEntity="Eccube\Entity\Master\Pref")

ORM\JoinColumns

({ @ORM\JoinColumn(name="pref_id", referencedColumnName="id") })

$Sex

private Sex $Sex
Tags
ORM\ManyToOne

(targetEntity="Eccube\Entity\Master\Sex")

ORM\JoinColumns

({ @ORM\JoinColumn(name="sex_id", referencedColumnName="id") })

$Job

private Job $Job
Tags
ORM\ManyToOne

(targetEntity="Eccube\Entity\Master\Job")

ORM\JoinColumns

({ @ORM\JoinColumn(name="job_id", referencedColumnName="id") })

$Payment

private Payment $Payment
Tags
ORM\ManyToOne

(targetEntity="Eccube\Entity\Payment")

ORM\JoinColumns

({ @ORM\JoinColumn(name="payment_id", referencedColumnName="id") })

$DeviceType

private DeviceType $DeviceType
Tags
ORM\ManyToOne

(targetEntity="Eccube\Entity\Master\DeviceType")

ORM\JoinColumns

({ @ORM\JoinColumn(name="device_type_id", referencedColumnName="id") })

$CustomerOrderStatus

OrderStatusより先にプロパティを定義しておかないとセットされなくなる

private CustomerOrderStatus $CustomerOrderStatus
Tags
ORM\ManyToOne

(targetEntity="Eccube\Entity\Master\CustomerOrderStatus")

ORM\JoinColumns

({ @ORM\JoinColumn(name="order_status_id", referencedColumnName="id") })

$OrderStatusColor

OrderStatusより先にプロパティを定義しておかないとセットされなくなる

private OrderStatusColor $OrderStatusColor
Tags
ORM\ManyToOne

(targetEntity="Eccube\Entity\Master\OrderStatusColor")

ORM\JoinColumns

({ @ORM\JoinColumn(name="order_status_id", referencedColumnName="id") })

$OrderStatus

private OrderStatus $OrderStatus
Tags
ORM\ManyToOne

(targetEntity="Eccube\Entity\Master\OrderStatus")

ORM\JoinColumns

({ @ORM\JoinColumn(name="order_status_id", referencedColumnName="id") })

$add_point

private string $add_point = '0'
Tags
ORM\Column

(name="add_point", type="decimal", precision=12, scale=0, options={"unsigned":true,"default":0})

$use_point

private string $use_point = '0'
Tags
ORM\Column

(name="use_point", type="decimal", precision=12, scale=0, options={"unsigned":true,"default":0})

Methods

getTaxableItems()

課税対象の明細を返す.

public getTaxableItems( ) : array
Return values
array

getTaxableTotal()

課税対象の明細の合計金額を返す.

public getTaxableTotal( ) : mixed

商品合計 + 送料 + 手数料 + 値引き(課税).

Return values
mixed

getTaxableTotalByTaxRate()

課税対象の明細の合計金額を、税率ごとに集計する.

public getTaxableTotalByTaxRate( ) : array
Return values
array

getTaxableDiscountItems()

課税対象の値引き明細を返す.

public getTaxableDiscountItems( ) : array
Return values
array

getTaxableDiscount()

課税対象の値引き金額合計を返す.

public getTaxableDiscount( ) : mixed
Return values
mixed

getTaxFreeDiscountItems()

非課税・不課税の値引き明細を返す.

public getTaxFreeDiscountItems( ) : array
Return values
array

isMultiple()

複数配送かどうかの判定を行う.

public isMultiple( ) : bool
Return values
bool

findShipping()

対象となるお届け先情報を取得

public findShipping( $shippingId : int ) : Shipping|null
Parameters
$shippingId : int
Return values
Shipping|null

getSaleTypes()

この注文の保持する販売種別を取得します.

public getSaleTypes( ) : \Eccube\Entity\Master\SaleType[]
Return values
\Eccube\Entity\Master\SaleType[] —

一意な販売種別の配列

getMergedProductOrderItems()

同じ規格の商品の個数をまとめた受注明細を取得

public getMergedProductOrderItems( ) : \Eccube\Entity\OrderItem[]
Return values
\Eccube\Entity\OrderItem[]

getTotalPrice()

合計金額を計算

public getTotalPrice( ) : string
Tags
deprecated
Return values
string

__construct()

Constructor

public __construct( [ $orderStatus : OrderStatus = null ] ) : mixed
Parameters
$orderStatus : OrderStatus = null
Return values
mixed

__clone()

Clone

public __clone( ) : mixed
Return values
mixed

getId()

Get id.

public getId( ) : int
Return values
int

setPreOrderId()

Set preOrderId.

public setPreOrderId( [ $preOrderId : string|null = null ] ) : Order
Parameters
$preOrderId : string|null = null
Return values
Order

getPreOrderId()

Get preOrderId.

public getPreOrderId( ) : string|null
Return values
string|null

setOrderNo()

Set orderNo

public setOrderNo( [ $orderNo : string|null = null ] ) : Order
Parameters
$orderNo : string|null = null
Return values
Order

getOrderNo()

Get orderNo

public getOrderNo( ) : string|null
Return values
string|null

setMessage()

Set message.

public setMessage( [ $message : string|null = null ] ) : Order
Parameters
$message : string|null = null
Return values
Order

getMessage()

Get message.

public getMessage( ) : string|null
Return values
string|null

setName01()

Set name01.

public setName01( [ $name01 : string|null = null ] ) : Order
Parameters
$name01 : string|null = null
Return values
Order

getName01()

Get name01.

public getName01( ) : string|null
Return values
string|null

setName02()

Set name02.

public setName02( [ $name02 : string|null = null ] ) : Order
Parameters
$name02 : string|null = null
Return values
Order

getName02()

Get name02.

public getName02( ) : string|null
Return values
string|null

setKana01()

Set kana01.

public setKana01( [ $kana01 : string|null = null ] ) : Order
Parameters
$kana01 : string|null = null
Return values
Order

getKana01()

Get kana01.

public getKana01( ) : string|null
Return values
string|null

setKana02()

Set kana02.

public setKana02( [ $kana02 : string|null = null ] ) : Order
Parameters
$kana02 : string|null = null
Return values
Order

getKana02()

Get kana02.

public getKana02( ) : string|null
Return values
string|null

setCompanyName()

Set companyName.

public setCompanyName( [ $companyName : string|null = null ] ) : Order
Parameters
$companyName : string|null = null
Return values
Order

getCompanyName()

Get companyName.

public getCompanyName( ) : string|null
Return values
string|null

setEmail()

Set email.

public setEmail( [ $email : string|null = null ] ) : Order
Parameters
$email : string|null = null
Return values
Order

getEmail()

Get email.

public getEmail( ) : string|null
Return values
string|null

setPhoneNumber()

Set phone_number.

public setPhoneNumber( [ $phone_number : string|null = null ] ) : Order
Parameters
$phone_number : string|null = null
Return values
Order

getPhoneNumber()

Get phone_number.

public getPhoneNumber( ) : string|null
Return values
string|null

setPostalCode()

Set postal_code.

public setPostalCode( [ $postal_code : string|null = null ] ) : Order
Parameters
$postal_code : string|null = null
Return values
Order

getPostalCode()

Get postal_code.

public getPostalCode( ) : string|null
Return values
string|null

setAddr01()

Set addr01.

public setAddr01( [ $addr01 : string|null = null ] ) : Order
Parameters
$addr01 : string|null = null
Return values
Order

getAddr01()

Get addr01.

public getAddr01( ) : string|null
Return values
string|null

setAddr02()

Set addr02.

public setAddr02( [ $addr02 : string|null = null ] ) : Order
Parameters
$addr02 : string|null = null
Return values
Order

getAddr02()

Get addr02.

public getAddr02( ) : string|null
Return values
string|null

setBirth()

Set birth.

public setBirth( [ $birth : DateTime|null = null ] ) : Order
Parameters
$birth : DateTime|null = null
Return values
Order

getBirth()

Get birth.

public getBirth( ) : DateTime|null
Return values
DateTime|null

setSubtotal()

Set subtotal.

public setSubtotal( $subtotal : string ) : Order
Parameters
$subtotal : string
Return values
Order

getSubtotal()

Get subtotal.

public getSubtotal( ) : string
Return values
string

setDiscount()

Set discount.

public setDiscount( $discount : string ) : Order
Parameters
$discount : string
Return values
Order

getDiscount()

Get discount.

public getDiscount( ) : string
Tags
deprecated
4.0.3

から値引きは課税値引きと 非課税・不課税の値引きの2種に分かれる. 課税値引きについてはgetTaxableDiscountを利用してください.

Return values
string

setDeliveryFeeTotal()

Set deliveryFeeTotal.

public setDeliveryFeeTotal( $deliveryFeeTotal : string ) : Order
Parameters
$deliveryFeeTotal : string
Return values
Order

getDeliveryFeeTotal()

Get deliveryFeeTotal.

public getDeliveryFeeTotal( ) : string
Return values
string

setCharge()

Set charge.

public setCharge( $charge : string ) : Order
Parameters
$charge : string
Return values
Order

getCharge()

Get charge.

public getCharge( ) : string
Return values
string

setTax()

Set tax.

public setTax( $tax : string ) : Order
Parameters
$tax : string
Tags
deprecated

明細ごとに集計した税額と差異が発生する場合があるため非推奨

Return values
Order

getTax()

Get tax.

public getTax( ) : string
Tags
deprecated

明細ごとに集計した税額と差異が発生する場合があるため非推奨

Return values
string

setTotal()

Set total.

public setTotal( $total : string ) : Order
Parameters
$total : string
Return values
Order

getTotal()

Get total.

public getTotal( ) : string
Return values
string

setPaymentTotal()

Set paymentTotal.

public setPaymentTotal( $paymentTotal : string ) : Order
Parameters
$paymentTotal : string
Return values
Order

getPaymentTotal()

Get paymentTotal.

public getPaymentTotal( ) : string
Return values
string

setPaymentMethod()

Set paymentMethod.

public setPaymentMethod( [ $paymentMethod : string|null = null ] ) : Order
Parameters
$paymentMethod : string|null = null
Return values
Order

getPaymentMethod()

Get paymentMethod.

public getPaymentMethod( ) : string|null
Return values
string|null

setNote()

Set note.

public setNote( [ $note : string|null = null ] ) : Order
Parameters
$note : string|null = null
Return values
Order

getNote()

Get note.

public getNote( ) : string|null
Return values
string|null

setCreateDate()

Set createDate.

public setCreateDate( $createDate : DateTime ) : Order
Parameters
$createDate : DateTime
Return values
Order

getCreateDate()

Get createDate.

public getCreateDate( ) : DateTime
Return values
DateTime

setUpdateDate()

Set updateDate.

public setUpdateDate( $updateDate : DateTime ) : Order
Parameters
$updateDate : DateTime
Return values
Order

getUpdateDate()

Get updateDate.

public getUpdateDate( ) : DateTime
Return values
DateTime

setOrderDate()

Set orderDate.

public setOrderDate( [ $orderDate : DateTime|null = null ] ) : Order
Parameters
$orderDate : DateTime|null = null
Return values
Order

getOrderDate()

Get orderDate.

public getOrderDate( ) : DateTime|null
Return values
DateTime|null

setPaymentDate()

Set paymentDate.

public setPaymentDate( [ $paymentDate : DateTime|null = null ] ) : Order
Parameters
$paymentDate : DateTime|null = null
Return values
Order

getPaymentDate()

Get paymentDate.

public getPaymentDate( ) : DateTime|null
Return values
DateTime|null

getCurrencyCode()

Get currencyCode.

public getCurrencyCode( ) : string
Return values
string

setCurrencyCode()

Set currencyCode.

public setCurrencyCode( [ $currencyCode : string|null = null ] ) : $this
Parameters
$currencyCode : string|null = null
Return values
$this

getCompleteMessage()

public getCompleteMessage( ) : null|string
Return values
null|string

setCompleteMessage()

public setCompleteMessage( [ $complete_message : null|string = null ] ) : $this
Parameters
$complete_message : null|string = null
Return values
$this

appendCompleteMessage()

public appendCompleteMessage( [ $complete_message : null|string = null ] ) : $this
Parameters
$complete_message : null|string = null
Return values
$this

getCompleteMailMessage()

public getCompleteMailMessage( ) : null|string
Return values
null|string

setCompleteMailMessage()

public setCompleteMailMessage( [ $complete_mail_message : null|string = null ] ) : mixed
Parameters
$complete_mail_message : null|string = null
Return values
mixed

appendCompleteMailMessage()

public appendCompleteMailMessage( [ $complete_mail_message : null|string = null ] ) : mixed
Parameters
$complete_mail_message : null|string = null
Return values
mixed

getProductOrderItems()

商品の受注明細を取得

public getProductOrderItems( ) : \Eccube\Entity\OrderItem[]
Return values
\Eccube\Entity\OrderItem[]

removeOrderItem()

Remove orderItem.

public removeOrderItem( $OrderItem : OrderItem ) : bool
Parameters
$OrderItem : OrderItem
Return values
bool —

TRUE if this collection contained the specified element, FALSE otherwise.

getOrderItems()

Get orderItems.

public getOrderItems( ) : Collection|\Eccube\Entity\OrderItem[]
Return values
Collection|\Eccube\Entity\OrderItem[]

removeShipping()

Remove shipping.

public removeShipping( $Shipping : Shipping ) : bool
Parameters
$Shipping : Shipping
Return values
bool —

TRUE if this collection contained the specified element, FALSE otherwise.

getShippings()

Get shippings.

public getShippings( ) : Collection|\Eccube\Entity\Shipping[]
Return values
Collection|\Eccube\Entity\Shipping[]

removeMailHistory()

Remove mailHistory.

public removeMailHistory( $mailHistory : MailHistory ) : bool
Parameters
$mailHistory : MailHistory
Return values
bool —

TRUE if this collection contained the specified element, FALSE otherwise.

getMailHistories()

Get mailHistories.

public getMailHistories( ) : Collection
Return values
Collection

setCustomer()

Set customer.

public setCustomer( [ $customer : Customer|null = null ] ) : Order
Parameters
$customer : Customer|null = null
Return values
Order

setCountry()

Set country.

public setCountry( [ $country : Country|null = null ] ) : Order
Parameters
$country : Country|null = null
Return values
Order

setPref()

Set pref.

public setPref( [ $pref : Pref|null = null ] ) : Order
Parameters
$pref : Pref|null = null
Return values
Order

getPref()

Get pref.

public getPref( ) : Pref|null
Return values
Pref|null

setSex()

Set sex.

public setSex( [ $sex : Sex|null = null ] ) : Order
Parameters
$sex : Sex|null = null
Return values
Order

getSex()

Get sex.

public getSex( ) : Sex|null
Return values
Sex|null

setJob()

Set job.

public setJob( [ $job : Job|null = null ] ) : Order
Parameters
$job : Job|null = null
Return values
Order

getJob()

Get job.

public getJob( ) : Job|null
Return values
Job|null

setPayment()

Set payment.

public setPayment( [ $payment : Payment|null = null ] ) : Order
Parameters
$payment : Payment|null = null
Return values
Order

setOrderStatus()

Set orderStatus.

public setOrderStatus( [ $orderStatus : OrderStatus|null|object = null ] ) : Order
Parameters
$orderStatus : OrderStatus|null|object = null
Return values
Order

getQuantity()

個数の合計を返します。

public getQuantity( ) : mixed
Return values
mixed

getFullName()

public getFullName( ) : mixed
Return values
mixed

getFullNameKana()

public getFullNameKana( ) : mixed
Return values
mixed

setAddPoint()

Set addPoint

public setAddPoint( $addPoint : string ) : Order
Parameters
$addPoint : string
Return values
Order

getAddPoint()

Get addPoint

public getAddPoint( ) : string
Return values
string

setUsePoint()

Set usePoint

public setUsePoint( $usePoint : string ) : Order
Parameters
$usePoint : string
Return values
Order

getUsePoint()

Get usePoint

public getUsePoint( ) : string
Return values
string

offsetExists()

public offsetExists( $offset : mixed ) : mixed
Parameters
$offset : mixed
Return values
mixed

offsetSet()

public offsetSet( $offset : mixed , $value : mixed ) : mixed
Parameters
$offset : mixed
$value : mixed
Return values
mixed

offsetGet()

public offsetGet( $offset : mixed ) : mixed
Parameters
$offset : mixed
Return values
mixed

offsetUnset()

public offsetUnset( $offset : mixed ) : mixed
Parameters
$offset : mixed
Return values
mixed

setPropertiesFromArray()

引数の連想配列を元にプロパティを設定します.

public setPropertiesFromArray( $arrProps : array [, $excludeAttribute : string[] = [] ] [, $parentClass : ReflectionClass = null ] ) : mixed

DBから取り出した連想配列を, プロパティへ設定する際に使用します.

Parameters
$arrProps : array

プロパティの情報を格納した連想配列

$excludeAttribute : string[] = []

除外したいフィールド名の配列

$parentClass : ReflectionClass = null

親のクラス. 本メソッドの内部的に使用します.

Return values
mixed

toArray()

Convert to associative array.

public toArray( [ $excludeAttribute : array = ['__initializer__', '__cloner__', '__isInitialized__', 'AnnotationReader'] ] [, $parentClass : ReflectionClass = null ] ) : array

Symfony Serializer Component is expensive, and hard to implementation. Use for encoder only.

Parameters
$excludeAttribute : array = ['__initializer__', '__cloner__', '__isInitialized__', 'AnnotationReader']

Array of field names to exclusion.

$parentClass : ReflectionClass = null

parent class. Use internally of this method..

Return values
array

toNormalizedArray()

Convert to associative array, and normalize to association properties.

public toNormalizedArray( [ $excludeAttribute : array = ['__initializer__', '__cloner__', '__isInitialized__', 'AnnotationReader'] ] ) : array

The type conversion such as:

  • Datetime :: W3C datetime format string
  • AbstractEntity :: associative array such as [id => value]
  • PersistentCollection :: associative array of [[id => value], [id => value], ...]
Parameters
$excludeAttribute : array = ['__initializer__', '__cloner__', '__isInitialized__', 'AnnotationReader']

Array of field names to exclusion.

Return values
array

toJSON()

Convert to JSON.

public toJSON( [ $excludeAttribute : array = ['__initializer__', '__cloner__', '__isInitialized__', 'AnnotationReader'] ] ) : string
Parameters
$excludeAttribute : array = ['__initializer__', '__cloner__', '__isInitialized__', 'AnnotationReader']

Array of field names to exclusion.

Return values
string

toXML()

Convert to XML.

public toXML( [ $excludeAttribute : array = ['__initializer__', '__cloner__', '__isInitialized__', 'AnnotationReader'] ] ) : string
Parameters
$excludeAttribute : array = ['__initializer__', '__cloner__', '__isInitialized__', 'AnnotationReader']

Array of field names to exclusion.

Return values
string

copyProperties()

コピー元のオブジェクトのフィールド名を指定して、同名のフィールドに値をコピー

public copyProperties( $srcObject : object [, $excludeAttribute : string[] = [] ] ) : AbstractEntity
Parameters
$srcObject : object

コピー元のオブジェクト

$excludeAttribute : string[] = []

除外したいフィールド名の配列

Return values
AbstractEntity

getAnnotationReader()

Get AnnotationReader.

public getAnnotationReader( ) : Reader
Return values
Reader

getEntityIdentifierAsArray()

Convert to Entity of Identity value to associative array.

public getEntityIdentifierAsArray( $Entity : AbstractEntity ) : array
Parameters
$Entity : AbstractEntity
Return values
array —

associative array of [[id => value], [id => value], ...]

Search results