EC-CUBE4 APIドキュメント

Delivery extends AbstractEntity

Delivery

Tags
ORM\Table

(name="dtb_delivery")

ORM\InheritanceType

("SINGLE_TABLE")

ORM\DiscriminatorColumn

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

ORM\HasLifecycleCallbacks

()

ORM\Entity

(repositoryClass="Eccube\Repository\DeliveryRepository")

Table of Contents

$id int
$name string|null
$service_name string|null
$description string|null
$confirm_url string|null
$sort_no int|null
$visible bool
$create_date DateTime
$update_date DateTime
$PaymentOptions Collection
$DeliveryFees Collection
$DeliveryTimes Collection
$Creator Member
$SaleType SaleType
$AnnotationReader
__toString() string
__construct() Constructor mixed
getId() Get id. int
setName() Set name. Delivery
getName() Get name. string|null
setServiceName() Set serviceName. Delivery
getServiceName() Get serviceName. string|null
setDescription() Set description. Delivery
getDescription() Get description. string|null
setConfirmUrl() Set confirmUrl. Delivery
getConfirmUrl() Get confirmUrl. string|null
setSortNo() Set sortNo. Delivery
getSortNo() Get sortNo. int|null
setCreateDate() Set createDate. Delivery
getCreateDate() Get createDate. DateTime
setUpdateDate() Set updateDate. Delivery
getUpdateDate() Get updateDate. DateTime
addPaymentOption() Add paymentOption. Delivery
removePaymentOption() Remove paymentOption. bool
getPaymentOptions() Get paymentOptions. Collection
addDeliveryFee() Add deliveryFee. Delivery
removeDeliveryFee() Remove deliveryFee. bool
getDeliveryFees() Get deliveryFees. Collection
addDeliveryTime() Add deliveryTime. Delivery
removeDeliveryTime() Remove deliveryTime. bool
getDeliveryTimes() Get deliveryTimes. Collection
setCreator() Set creator. Delivery
getCreator() Get creator. Member|null
setSaleType() Set saleType. Delivery
getSaleType() Get saleType. SaleType|null
setVisible() Set visible Delivery
isVisible() Is the visibility visible? bool
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")

$name

private string|null $name
Tags
ORM\Column

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

$service_name

private string|null $service_name
Tags
ORM\Column

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

$description

private string|null $description
Tags
ORM\Column

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

$confirm_url

private string|null $confirm_url
Tags
ORM\Column

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

$sort_no

private int|null $sort_no
Tags
ORM\Column

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

$visible

private bool $visible = true
Tags
ORM\Column

(name="visible", type="boolean", options={"default":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")

$PaymentOptions

private Collection $PaymentOptions
Tags
ORM\OneToMany

(targetEntity="Eccube\Entity\PaymentOption", mappedBy="Delivery", cascade={"persist","remove"})

$DeliveryFees

private Collection $DeliveryFees
Tags
ORM\OneToMany

(targetEntity="Eccube\Entity\DeliveryFee", mappedBy="Delivery", cascade={"persist","remove"})

$DeliveryTimes

private Collection $DeliveryTimes
Tags
ORM\OneToMany

(targetEntity="Eccube\Entity\DeliveryTime", mappedBy="Delivery", cascade={"persist","remove"})

ORM\OrderBy

({ "sort_no"="ASC" })

$Creator

private Member $Creator
Tags
ORM\ManyToOne

(targetEntity="Eccube\Entity\Member")

ORM\JoinColumns

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

$SaleType

private SaleType $SaleType
Tags
ORM\ManyToOne

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

ORM\JoinColumns

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

Methods

__toString()

public __toString( ) : string
Return values
string

__construct()

Constructor

public __construct( ) : mixed
Return values
mixed

getId()

Get id.

public getId( ) : int
Return values
int

setName()

Set name.

public setName( [ $name : string|null = null ] ) : Delivery
Parameters
$name : string|null = null
Return values
Delivery

getName()

Get name.

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

setServiceName()

Set serviceName.

public setServiceName( [ $serviceName : string|null = null ] ) : Delivery
Parameters
$serviceName : string|null = null
Return values
Delivery

getServiceName()

Get serviceName.

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

setDescription()

Set description.

public setDescription( [ $description : string|null = null ] ) : Delivery
Parameters
$description : string|null = null
Return values
Delivery

getDescription()

Get description.

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

setConfirmUrl()

Set confirmUrl.

public setConfirmUrl( [ $confirmUrl : string|null = null ] ) : Delivery
Parameters
$confirmUrl : string|null = null
Return values
Delivery

getConfirmUrl()

Get confirmUrl.

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

setSortNo()

Set sortNo.

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

getSortNo()

Get sortNo.

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

setCreateDate()

Set createDate.

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

getCreateDate()

Get createDate.

public getCreateDate( ) : DateTime
Return values
DateTime

setUpdateDate()

Set updateDate.

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

getUpdateDate()

Get updateDate.

public getUpdateDate( ) : DateTime
Return values
DateTime

removePaymentOption()

Remove paymentOption.

public removePaymentOption( $paymentOption : PaymentOption ) : bool
Parameters
$paymentOption : PaymentOption
Return values
bool —

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

getPaymentOptions()

Get paymentOptions.

public getPaymentOptions( ) : Collection
Return values
Collection

removeDeliveryFee()

Remove deliveryFee.

public removeDeliveryFee( $deliveryFee : DeliveryFee ) : bool
Parameters
$deliveryFee : DeliveryFee
Return values
bool —

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

getDeliveryFees()

Get deliveryFees.

public getDeliveryFees( ) : Collection
Return values
Collection

removeDeliveryTime()

Remove deliveryTime.

public removeDeliveryTime( $deliveryTime : DeliveryTime ) : bool
Parameters
$deliveryTime : DeliveryTime
Return values
bool —

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

getDeliveryTimes()

Get deliveryTimes.

public getDeliveryTimes( ) : Collection
Return values
Collection

setVisible()

Set visible

public setVisible( $visible : bool ) : Delivery
Parameters
$visible : bool
Return values
Delivery

isVisible()

Is the visibility visible?

public isVisible( ) : bool
Return values
bool

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