EC-CUBE4 APIドキュメント

Shipping extends AbstractEntity Uses NameTrait

Shipping

Tags
ORM\Table

(name="dtb_shipping")

ORM\InheritanceType

("SINGLE_TABLE")

ORM\DiscriminatorColumn

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

ORM\HasLifecycleCallbacks

()

ORM\Entity

(repositoryClass="Eccube\Repository\ShippingRepository")

Table of Contents

SHIPPING_MAIL_UNSENT 出荷メール未送信 1
SHIPPING_MAIL_SENT 出荷メール送信済 2
$id int
$name01 string
$name02 string
$kana01 string
$kana02 string
$company_name string|null
$phone_number string|null
$postal_code string|null
$addr01 string|null
$addr02 string|null
$shipping_delivery_name string|null
$time_id int
$shipping_delivery_time string|null
$shipping_delivery_date お届け予定日/お届け希望日 DateTime|null
$shipping_date 出荷日 DateTime|null
$tracking_number string
$note string
$sort_no int|null
$create_date DateTime
$update_date DateTime
$mail_send_date DateTime
$Order Order
$OrderItems Collection
$Country Country
$Pref Pref
$Delivery Delivery
$ProductClassOfTemp ProductClass
$Creator Member
$AnnotationReader
getShippingMultipleDefaultName() mixed
__construct() Constructor mixed
setFromCustomerAddress() CustomerAddress から個人情報を設定. Shipping
clearCustomerAddress() 個人情報をクリア. Shipping
getId() Get id. int
setName01() Set name01. Shipping
getName01() Get name01. string
setName02() Set name02. Shipping
getName02() Get name02. string
setKana01() Set kana01. Shipping
getKana01() Get kana01. string
setKana02() Set kana02. Shipping
getKana02() Get kana02. string
setCompanyName() Set companyName. Shipping
getCompanyName() Get companyName. string|null
setPhoneNumber() Set phone_number. Shipping
getPhoneNumber() Get phone_number. string|null
setPostalCode() Set postal_code. Shipping
getPostalCode() Get postal_code. string|null
setAddr01() Set addr01. Shipping
getAddr01() Get addr01. string|null
setAddr02() Set addr02. Shipping
getAddr02() Get addr02. string|null
setShippingDeliveryName() Set shippingDeliveryName. Shipping
getShippingDeliveryName() Get shippingDeliveryName. string|null
setShippingDeliveryTime() Set shippingDeliveryTime. Shipping
getShippingDeliveryTime() Get shippingDeliveryTime. string|null
setShippingDeliveryDate() Set shippingDeliveryDate. Shipping
getShippingDeliveryDate() Get shippingDeliveryDate. DateTime|null
setShippingDate() Set shippingDate. Shipping
getShippingDate() Get shippingDate. DateTime|null
setSortNo() Set sortNo. Shipping
getSortNo() Get sortNo. int|null
setCreateDate() Set createDate. Shipping
getCreateDate() Get createDate. DateTime
setUpdateDate() Set updateDate. Shipping
getUpdateDate() Get updateDate. DateTime
setMailSendDate() Set mailSendDate. Shipping
getMailSendDate() Get mailSendDate. DateTime
addOrderItem() Add orderItem. Shipping
removeOrderItem() Remove orderItem. bool
getOrderItems() Get orderItems. Collection
getProductOrderItems() 商品の受注明細を取得 \Eccube\Entity\OrderItem[]
setCountry() Set country. Shipping
getCountry() Get country. Country|null
setPref() Set pref. Shipping
getPref() Get pref. Pref|null
setDelivery() Set delivery. Shipping
getDelivery() Get delivery. Delivery|null
getProductClassOfTemp() Product class of shipment item (temp) ProductClass
setProductClassOfTemp() Product class of shipment item (temp) $this
setOrder() Set order. $this
getOrder() Get order. Order
setTrackingNumber() Set trackingNumber Shipping
getTrackingNumber() Get trackingNumber string
setNote() Set note. Shipping
getNote() Get note. string|null
isShipped() 出荷済みの場合はtrue, 未出荷の場合はfalseを返す bool
setTimeId() Set timeId Shipping
getTimeId() Get timeId int
setCreator() Set creator. Shipping
getCreator() Get creator. Member|null
getFullName() mixed
getFullNameKana() mixed
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

Constants

SHIPPING_MAIL_UNSENT

出荷メール未送信

public mixed $SHIPPING_MAIL_UNSENT = 1

SHIPPING_MAIL_SENT

出荷メール送信済

public mixed $SHIPPING_MAIL_SENT = 2

Properties

$id

private int $id
Tags
ORM\Column

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

ORM\Id
ORM\GeneratedValue

(strategy="IDENTITY")

$name01

private string $name01
Tags
ORM\Column

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

$name02

private string $name02
Tags
ORM\Column

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

$kana01

private string $kana01
Tags
ORM\Column

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

$kana02

private string $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)

$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)

$shipping_delivery_name

private string|null $shipping_delivery_name
Tags
ORM\Column

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

$time_id

private int $time_id
Tags
ORM\Column

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

$shipping_delivery_time

private string|null $shipping_delivery_time
Tags
ORM\Column

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

$shipping_delivery_date

お届け予定日/お届け希望日

private DateTime|null $shipping_delivery_date
Tags
ORM\Column

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

$shipping_date

出荷日

private DateTime|null $shipping_date
Tags
ORM\Column

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

$tracking_number

private string $tracking_number
Tags
ORM\Column

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

$note

private string $note
Tags
ORM\Column

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

$sort_no

private int|null $sort_no
Tags
ORM\Column

(name="sort_no", type="smallint", nullable=true, options={"unsigned":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")

$mail_send_date

private DateTime $mail_send_date
Tags
ORM\Column

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

$Order

private Order $Order
Tags
ORM\ManyToOne

(targetEntity="Eccube\Entity\Order", inversedBy="Shippings", cascade={"persist"})

ORM\JoinColumns

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

$OrderItems

private Collection $OrderItems
Tags
ORM\OneToMany

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

$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") })

$Delivery

private Delivery $Delivery
Tags
ORM\ManyToOne

(targetEntity="Eccube\Entity\Delivery")

ORM\JoinColumns

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

$Creator

private Member $Creator
Tags
ORM\ManyToOne

(targetEntity="Eccube\Entity\Member")

ORM\JoinColumns

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

Methods

getShippingMultipleDefaultName()

public getShippingMultipleDefaultName( ) : mixed
Return values
mixed

__construct()

Constructor

public __construct( ) : mixed
Return values
mixed

getId()

Get id.

public getId( ) : int
Return values
int

setName01()

Set name01.

public setName01( $name01 : string ) : Shipping
Parameters
$name01 : string
Return values
Shipping

getName01()

Get name01.

public getName01( ) : string
Return values
string

setName02()

Set name02.

public setName02( $name02 : string ) : Shipping
Parameters
$name02 : string
Return values
Shipping

getName02()

Get name02.

public getName02( ) : string
Return values
string

setKana01()

Set kana01.

public setKana01( $kana01 : string ) : Shipping
Parameters
$kana01 : string
Return values
Shipping

getKana01()

Get kana01.

public getKana01( ) : string
Return values
string

setKana02()

Set kana02.

public setKana02( $kana02 : string ) : Shipping
Parameters
$kana02 : string
Return values
Shipping

getKana02()

Get kana02.

public getKana02( ) : string
Return values
string

setCompanyName()

Set companyName.

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

getCompanyName()

Get companyName.

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

setPhoneNumber()

Set phone_number.

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

getPhoneNumber()

Get phone_number.

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

setPostalCode()

Set postal_code.

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

getPostalCode()

Get postal_code.

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

setAddr01()

Set addr01.

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

getAddr01()

Get addr01.

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

setAddr02()

Set addr02.

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

getAddr02()

Get addr02.

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

setShippingDeliveryName()

Set shippingDeliveryName.

public setShippingDeliveryName( [ $shippingDeliveryName : string|null = null ] ) : Shipping
Parameters
$shippingDeliveryName : string|null = null
Return values
Shipping

getShippingDeliveryName()

Get shippingDeliveryName.

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

setShippingDeliveryTime()

Set shippingDeliveryTime.

public setShippingDeliveryTime( [ $shippingDeliveryTime : string|null = null ] ) : Shipping
Parameters
$shippingDeliveryTime : string|null = null
Return values
Shipping

getShippingDeliveryTime()

Get shippingDeliveryTime.

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

setShippingDeliveryDate()

Set shippingDeliveryDate.

public setShippingDeliveryDate( [ $shippingDeliveryDate : DateTime|null = null ] ) : Shipping
Parameters
$shippingDeliveryDate : DateTime|null = null
Return values
Shipping

getShippingDeliveryDate()

Get shippingDeliveryDate.

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

setShippingDate()

Set shippingDate.

public setShippingDate( [ $shippingDate : DateTime|null = null ] ) : Shipping
Parameters
$shippingDate : DateTime|null = null
Return values
Shipping

getShippingDate()

Get shippingDate.

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

setSortNo()

Set sortNo.

public setSortNo( [ $sortNo : int|null = null ] ) : Shipping
Parameters
$sortNo : int|null = null
Return values
Shipping

getSortNo()

Get sortNo.

public getSortNo( ) : int|null
Return values
int|null

setCreateDate()

Set createDate.

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

getCreateDate()

Get createDate.

public getCreateDate( ) : DateTime
Return values
DateTime

setUpdateDate()

Set updateDate.

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

getUpdateDate()

Get updateDate.

public getUpdateDate( ) : DateTime
Return values
DateTime

setMailSendDate()

Set mailSendDate.

public setMailSendDate( $mailSendDate : DateTime ) : Shipping
Parameters
$mailSendDate : DateTime
Return values
Shipping

getMailSendDate()

Get mailSendDate.

public getMailSendDate( ) : DateTime
Return values
DateTime

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
Return values
Collection

getProductOrderItems()

商品の受注明細を取得

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

setProductClassOfTemp()

Product class of shipment item (temp)

public setProductClassOfTemp( $ProductClassOfTemp : ProductClass ) : $this
Parameters
$ProductClassOfTemp : ProductClass
Return values
$this

setOrder()

Set order.

public setOrder( $Order : Order ) : $this
Parameters
$Order : Order
Return values
$this

setTrackingNumber()

Set trackingNumber

public setTrackingNumber( $trackingNumber : string ) : Shipping
Parameters
$trackingNumber : string
Return values
Shipping

getTrackingNumber()

Get trackingNumber

public getTrackingNumber( ) : string
Return values
string

setNote()

Set note.

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

getNote()

Get note.

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

isShipped()

出荷済みの場合はtrue, 未出荷の場合はfalseを返す

public isShipped( ) : bool
Return values
bool

getTimeId()

Get timeId

public getTimeId( ) : int
Return values
int

getFullName()

public getFullName( ) : mixed
Return values
mixed

getFullNameKana()

public getFullNameKana( ) : mixed
Return values
mixed

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