EC-CUBE4 APIドキュメント

OrderItem extends AbstractEntity implements ItemInterface Uses PointRateTrait

OrderItem

Tags
ORM\Table

(name="dtb_order_item")

ORM\InheritanceType

("SINGLE_TABLE")

ORM\DiscriminatorColumn

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

ORM\HasLifecycleCallbacks

()

ORM\Entity

(repositoryClass="Eccube\Repository\OrderItemRepository")

Table of Contents

$id int
$product_name string
$product_code string|null
$class_name1 string|null
$class_name2 string|null
$class_category_name1 string|null
$class_category_name2 string|null
$price string
$quantity string
$tax string
$tax_rate string
$tax_adjust string
$tax_rule_id int|null
$currency_code string|null
$processor_name string|null
$Order Order
$Product Product
$ProductClass ProductClass
$Shipping Shipping
$RoundingType RoundingType
$TaxType TaxType
$TaxDisplayType TaxDisplayType
$OrderItemType OrderItemType
$point_rate string
$AnnotationReader
getPriceIncTax() Get price IncTax string
getTotalPrice() int
getOrderItemTypeId() int
isProduct() 商品明細かどうか. bool
isDeliveryFee() 送料明細かどうか. bool
isCharge() 手数料明細かどうか. bool
isDiscount() 値引き明細かどうか. bool
isTax() 税額明細かどうか. bool
isPoint() ポイント明細かどうか. bool
getId() Get id. int
setProductName() Set productName. OrderItem
getProductName() Get productName. string
setProductCode() Set productCode. OrderItem
getProductCode() Get productCode. string|null
setClassName1() Set className1. OrderItem
getClassName1() Get className1. string|null
setClassName2() Set className2. OrderItem
getClassName2() Get className2. string|null
setClassCategoryName1() Set classCategoryName1. OrderItem
getClassCategoryName1() Get classCategoryName1. string|null
setClassCategoryName2() Set classCategoryName2. OrderItem
getClassCategoryName2() Get classCategoryName2. string|null
setPrice() Set price. OrderItem
getPrice() Get price. string
setQuantity() Set quantity. OrderItem
getQuantity() Get quantity. string
getTax() string
setTax() $this
setTaxRate() Set taxRate. OrderItem
getTaxRate() Get taxRate. string
setTaxAdjust() Set taxAdjust. OrderItem
getTaxAdjust() Get taxAdjust. string
setTaxRuleId() Set taxRuleId. OrderItem
getTaxRuleId() Get taxRuleId. int|null
getCurrencyCode() Get currencyCode. string
setCurrencyCode() Set currencyCode. OrderItem
getProcessorName() Get processorName. string
setProcessorName() Set processorName. $this
setOrder() Set order. OrderItem
getOrder() Get order. Order|null
getOrderId() mixed
setProduct() Set product. OrderItem
getProduct() Get product. Product|null
setProductClass() Set productClass. OrderItem
getProductClass() Get productClass. ProductClass|null
setShipping() Set shipping. OrderItem
getShipping() Get shipping. Shipping|null
getRoundingType() RoundingType
setRoundingType() mixed
setTaxType() Set taxType OrderItem
getTaxType() Get taxType TaxType
setTaxDisplayType() Set taxDisplayType OrderItem
getTaxDisplayType() Get taxDisplayType TaxDisplayType
setOrderItemType() Set orderItemType OrderItem
getOrderItemType() Get orderItemType OrderItemType
setPointRate() Set pointRate OrderItem
getPointRate() Get pointRate 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")

$product_name

private string $product_name
Tags
ORM\Column

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

$product_code

private string|null $product_code
Tags
ORM\Column

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

$class_name1

private string|null $class_name1
Tags
ORM\Column

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

$class_name2

private string|null $class_name2
Tags
ORM\Column

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

$class_category_name1

private string|null $class_category_name1
Tags
ORM\Column

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

$class_category_name2

private string|null $class_category_name2
Tags
ORM\Column

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

$price

private string $price = ""
Tags
ORM\Column

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

$quantity

private string $quantity = ""
Tags
ORM\Column

(name="quantity", type="decimal", precision=10, scale=0, options={"default":0})

$tax

private string $tax = ""
Tags
ORM\Column

(name="tax", type="decimal", precision=10, scale=0, options={"default":0})

$tax_rate

private string $tax_rate = ""
Tags
ORM\Column

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

$tax_adjust

private string $tax_adjust = ""
Tags
ORM\Column

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

$tax_rule_id

private int|null $tax_rule_id
Tags
ORM\Column

(name="tax_rule_id", type="smallint", nullable=true, options={"unsigned":true})

$currency_code

private string|null $currency_code
Tags
ORM\Column

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

$processor_name

private string|null $processor_name
Tags
ORM\Column

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

$Order

private Order $Order
Tags
ORM\ManyToOne

(targetEntity="Eccube\Entity\Order", inversedBy="OrderItems")

ORM\JoinColumns

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

$Product

private Product $Product
Tags
ORM\ManyToOne

(targetEntity="Eccube\Entity\Product")

ORM\JoinColumns

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

$ProductClass

private ProductClass $ProductClass
Tags
ORM\ManyToOne

(targetEntity="Eccube\Entity\ProductClass")

ORM\JoinColumns

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

$Shipping

private Shipping $Shipping
Tags
ORM\ManyToOne

(targetEntity="Eccube\Entity\Shipping", inversedBy="OrderItems")

ORM\JoinColumns

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

$RoundingType

private RoundingType $RoundingType
Tags
ORM\ManyToOne

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

ORM\JoinColumns

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

$TaxType

private TaxType $TaxType
Tags
ORM\ManyToOne

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

ORM\JoinColumns

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

$TaxDisplayType

private TaxDisplayType $TaxDisplayType
Tags
ORM\ManyToOne

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

ORM\JoinColumns

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

$OrderItemType

private OrderItemType $OrderItemType
Tags
ORM\ManyToOne

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

ORM\JoinColumns

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

$point_rate

private string $point_rate
Tags
ORM\Column

(name="point_rate", type="decimal", precision=10, scale=0, options={"unsigned":true}, nullable=true)

Methods

getPriceIncTax()

Get price IncTax

public getPriceIncTax( ) : string
Return values
string

getTotalPrice()

public getTotalPrice( ) : int
Return values
int

getOrderItemTypeId()

public getOrderItemTypeId( ) : int
Return values
int

isProduct()

商品明細かどうか.

public isProduct( ) : bool
Return values
bool —

商品明細の場合 true

isDeliveryFee()

送料明細かどうか.

public isDeliveryFee( ) : bool
Return values
bool —

送料明細の場合 true

isCharge()

手数料明細かどうか.

public isCharge( ) : bool
Return values
bool —

手数料明細の場合 true

isDiscount()

値引き明細かどうか.

public isDiscount( ) : bool
Return values
bool —

値引き明細の場合 true

isTax()

税額明細かどうか.

public isTax( ) : bool
Return values
bool —

税額明細の場合 true

isPoint()

ポイント明細かどうか.

public isPoint( ) : bool
Return values
bool —

ポイント明細の場合 true

getId()

Get id.

public getId( ) : int
Return values
int

setProductName()

Set productName.

public setProductName( $productName : string ) : OrderItem
Parameters
$productName : string
Return values
OrderItem

getProductName()

Get productName.

public getProductName( ) : string
Return values
string

setProductCode()

Set productCode.

public setProductCode( [ $productCode : string|null = null ] ) : OrderItem
Parameters
$productCode : string|null = null
Return values
OrderItem

getProductCode()

Get productCode.

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

setClassName1()

Set className1.

public setClassName1( [ $className1 : string|null = null ] ) : OrderItem
Parameters
$className1 : string|null = null
Return values
OrderItem

getClassName1()

Get className1.

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

setClassName2()

Set className2.

public setClassName2( [ $className2 : string|null = null ] ) : OrderItem
Parameters
$className2 : string|null = null
Return values
OrderItem

getClassName2()

Get className2.

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

setClassCategoryName1()

Set classCategoryName1.

public setClassCategoryName1( [ $classCategoryName1 : string|null = null ] ) : OrderItem
Parameters
$classCategoryName1 : string|null = null
Return values
OrderItem

getClassCategoryName1()

Get classCategoryName1.

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

setClassCategoryName2()

Set classCategoryName2.

public setClassCategoryName2( [ $classCategoryName2 : string|null = null ] ) : OrderItem
Parameters
$classCategoryName2 : string|null = null
Return values
OrderItem

getClassCategoryName2()

Get classCategoryName2.

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

getPrice()

Get price.

public getPrice( ) : string
Return values
string

setQuantity()

Set quantity.

public setQuantity( $quantity : string ) : OrderItem
Parameters
$quantity : string
Return values
OrderItem

getQuantity()

Get quantity.

public getQuantity( ) : string
Return values
string

getTax()

public getTax( ) : string
Return values
string

setTax()

public setTax( $tax : string ) : $this
Parameters
$tax : string
Return values
$this

getTaxRate()

Get taxRate.

public getTaxRate( ) : string
Return values
string

setTaxAdjust()

Set taxAdjust.

public setTaxAdjust( $tax_adjust : string ) : OrderItem
Parameters
$tax_adjust : string
Return values
OrderItem

getTaxAdjust()

Get taxAdjust.

public getTaxAdjust( ) : string
Return values
string

setTaxRuleId()

Set taxRuleId.

public setTaxRuleId( [ $taxRuleId : int|null = null ] ) : OrderItem
Parameters
$taxRuleId : int|null = null
Tags
deprecated

税率設定は受注作成時に決定するため廃止予定

Return values
OrderItem

getTaxRuleId()

Get taxRuleId.

public getTaxRuleId( ) : int|null
Tags
deprecated

税率設定は受注作成時に決定するため廃止予定

Return values
int|null

getCurrencyCode()

Get currencyCode.

public getCurrencyCode( ) : string
Return values
string

setCurrencyCode()

Set currencyCode.

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

getProcessorName()

Get processorName.

public getProcessorName( ) : string
Return values
string

setProcessorName()

Set processorName.

public setProcessorName( [ $processorName : string|null = null ] ) : $this
Parameters
$processorName : string|null = null
Return values
$this

getOrderId()

public getOrderId( ) : mixed
Return values
mixed

getPointRate()

Get pointRate

public getPointRate( ) : 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