EC-CUBE4 APIドキュメント

BaseInfo extends AbstractEntity

BaseInfo

Tags
ORM\Table

(name="dtb_base_info")

ORM\InheritanceType

("SINGLE_TABLE")

ORM\DiscriminatorColumn

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

ORM\HasLifecycleCallbacks

()

ORM\Entity

(repositoryClass="Eccube\Repository\BaseInfoRepository")

ORM\Cache

(usage="NONSTRICT_READ_WRITE")

Table of Contents

$id int
$company_name string|null
$company_kana string|null
$postal_code string|null
$addr01 string|null
$addr02 string|null
$phone_number string|null
$business_hour string|null
$email01 string|null
$email02 string|null
$email03 string|null
$email04 string|null
$shop_name string|null
$shop_kana string|null
$shop_name_eng string|null
$update_date DateTime
$good_traded string|null
$message string|null
$delivery_free_amount string|null
$delivery_free_quantity int|null
$option_mypage_order_status_display bool
$option_nostock_hidden bool
$option_favorite_product bool
$option_product_delivery_fee bool
$option_product_tax_rule bool
$option_customer_activate bool
$option_remember_me bool
$authentication_key string|null
$php_path string|null
$option_point bool
$basic_point_rate string
$point_conversion_rate string
$Country Country
$Pref Pref
$AnnotationReader
getId() Get id. int
setCompanyName() Set companyName. BaseInfo
getCompanyName() Get companyName. string|null
setCompanyKana() Set companyKana. BaseInfo
getCompanyKana() Get companyKana. string|null
setPostalCode() Set postal_code. BaseInfo
getPostalCode() Get postal_code. string|null
setAddr01() Set addr01. BaseInfo
getAddr01() Get addr01. string|null
setAddr02() Set addr02. BaseInfo
getAddr02() Get addr02. string|null
setPhoneNumber() Set phone_number. BaseInfo
getPhoneNumber() Get phone_number. string|null
setBusinessHour() Set businessHour. BaseInfo
getBusinessHour() Get businessHour. string|null
setEmail01() Set email01. BaseInfo
getEmail01() Get email01. string|null
setEmail02() Set email02. BaseInfo
getEmail02() Get email02. string|null
setEmail03() Set email03. BaseInfo
getEmail03() Get email03. string|null
setEmail04() Set email04. BaseInfo
getEmail04() Get email04. string|null
setShopName() Set shopName. BaseInfo
getShopName() Get shopName. string|null
setShopKana() Set shopKana. BaseInfo
getShopKana() Get shopKana. string|null
setShopNameEng() Set shopNameEng. BaseInfo
getShopNameEng() Get shopNameEng. string|null
setUpdateDate() Set updateDate. BaseInfo
getUpdateDate() Get updateDate. DateTime
setGoodTraded() Set goodTraded. BaseInfo
getGoodTraded() Get goodTraded. string|null
setMessage() Set message. BaseInfo
getMessage() Get message. string|null
setDeliveryFreeAmount() Set deliveryFreeAmount. BaseInfo
getDeliveryFreeAmount() Get deliveryFreeAmount. string|null
setDeliveryFreeQuantity() Set deliveryFreeQuantity. BaseInfo
getDeliveryFreeQuantity() Get deliveryFreeQuantity. int|null
setOptionMypageOrderStatusDisplay() Set optionMypageOrderStatusDisplay. BaseInfo
isOptionMypageOrderStatusDisplay() Get optionMypageOrderStatusDisplay. bool
setOptionNostockHidden() Set optionNostockHidden. BaseInfo
isOptionNostockHidden() Get optionNostockHidden. bool
setOptionFavoriteProduct() Set optionFavoriteProduct. BaseInfo
isOptionFavoriteProduct() Get optionFavoriteProduct. bool
setOptionProductDeliveryFee() Set optionProductDeliveryFee. BaseInfo
isOptionProductDeliveryFee() Get optionProductDeliveryFee. bool
setOptionProductTaxRule() Set optionProductTaxRule. BaseInfo
isOptionProductTaxRule() Get optionProductTaxRule. bool
setOptionCustomerActivate() Set optionCustomerActivate. BaseInfo
isOptionCustomerActivate() Get optionCustomerActivate. bool
setOptionRememberMe() Set optionRememberMe. BaseInfo
isOptionRememberMe() Get optionRememberMe. bool
setAuthenticationKey() Set authenticationKey. BaseInfo
getAuthenticationKey() Get authenticationKey. string|null
setCountry() Set country. BaseInfo
getCountry() Get country. Country|null
setPref() Set pref. BaseInfo
getPref() Get pref. Pref|null
setOptionPoint() Set optionPoint BaseInfo
isOptionPoint() Get optionPoint bool
setPointConversionRate() Set pointConversionRate BaseInfo
getPointConversionRate() Get pointConversionRate string
setBasicPointRate() Set basicPointRate BaseInfo
getBasicPointRate() Get basicPointRate string
getPhpPath() null|string
setPhpPath() $this
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")

$company_name

private string|null $company_name
Tags
ORM\Column

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

$company_kana

private string|null $company_kana
Tags
ORM\Column

(name="company_kana", type="string", length=255, 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)

$phone_number

private string|null $phone_number
Tags
ORM\Column

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

$business_hour

private string|null $business_hour
Tags
ORM\Column

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

$email01

private string|null $email01
Tags
ORM\Column

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

$email02

private string|null $email02
Tags
ORM\Column

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

$email03

private string|null $email03
Tags
ORM\Column

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

$email04

private string|null $email04
Tags
ORM\Column

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

$shop_name

private string|null $shop_name
Tags
ORM\Column

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

$shop_kana

private string|null $shop_kana
Tags
ORM\Column

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

$shop_name_eng

private string|null $shop_name_eng
Tags
ORM\Column

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

$update_date

private DateTime $update_date
Tags
ORM\Column

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

$good_traded

private string|null $good_traded
Tags
ORM\Column

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

$message

private string|null $message
Tags
ORM\Column

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

$delivery_free_amount

private string|null $delivery_free_amount
Tags
ORM\Column

(name="delivery_free_amount", type="decimal", precision=12, scale=2, nullable=true, options={"unsigned":true})

$delivery_free_quantity

private int|null $delivery_free_quantity
Tags
ORM\Column

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

$option_mypage_order_status_display

private bool $option_mypage_order_status_display = true
Tags
ORM\Column

(name="option_mypage_order_status_display", type="boolean", options={"default":true})

$option_nostock_hidden

private bool $option_nostock_hidden = false
Tags
ORM\Column

(name="option_nostock_hidden", type="boolean", options={"default":false})

$option_favorite_product

private bool $option_favorite_product = true
Tags
ORM\Column

(name="option_favorite_product", type="boolean", options={"default":true})

$option_product_delivery_fee

private bool $option_product_delivery_fee = false
Tags
ORM\Column

(name="option_product_delivery_fee", type="boolean", options={"default":false})

$option_product_tax_rule

private bool $option_product_tax_rule = false
Tags
ORM\Column

(name="option_product_tax_rule", type="boolean", options={"default":false})

$option_customer_activate

private bool $option_customer_activate = true
Tags
ORM\Column

(name="option_customer_activate", type="boolean", options={"default":true})

$option_remember_me

private bool $option_remember_me = true
Tags
ORM\Column

(name="option_remember_me", type="boolean", options={"default":true})

$authentication_key

private string|null $authentication_key
Tags
ORM\Column

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

$php_path

private string|null $php_path
Tags
deprecated

使用していないため、削除予定

ORM\Column

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

$option_point

private bool $option_point = true
Tags
ORM\Column

(name="option_point", type="boolean", options={"default":true})

$basic_point_rate

private string $basic_point_rate = '1'
Tags
ORM\Column

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

$point_conversion_rate

private string $point_conversion_rate = '1'
Tags
ORM\Column

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

$Country

private Country $Country
Tags
ORM\ManyToOne

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

ORM\JoinColumns

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

ORM\Cache

(usage="NONSTRICT_READ_WRITE")

$Pref

private Pref $Pref
Tags
ORM\ManyToOne

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

ORM\JoinColumns

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

ORM\Cache

(usage="NONSTRICT_READ_WRITE")

Methods

getId()

Get id.

public getId( ) : int
Return values
int

setCompanyName()

Set companyName.

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

getCompanyName()

Get companyName.

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

setCompanyKana()

Set companyKana.

public setCompanyKana( [ $companyKana : string|null = null ] ) : BaseInfo
Parameters
$companyKana : string|null = null
Return values
BaseInfo

getCompanyKana()

Get companyKana.

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

setPostalCode()

Set postal_code.

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

getPostalCode()

Get postal_code.

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

setAddr01()

Set addr01.

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

getAddr01()

Get addr01.

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

setAddr02()

Set addr02.

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

getAddr02()

Get addr02.

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

setPhoneNumber()

Set phone_number.

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

getPhoneNumber()

Get phone_number.

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

setBusinessHour()

Set businessHour.

public setBusinessHour( [ $businessHour : string|null = null ] ) : BaseInfo
Parameters
$businessHour : string|null = null
Return values
BaseInfo

getBusinessHour()

Get businessHour.

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

setEmail01()

Set email01.

public setEmail01( [ $email01 : string|null = null ] ) : BaseInfo
Parameters
$email01 : string|null = null
Return values
BaseInfo

getEmail01()

Get email01.

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

setEmail02()

Set email02.

public setEmail02( [ $email02 : string|null = null ] ) : BaseInfo
Parameters
$email02 : string|null = null
Return values
BaseInfo

getEmail02()

Get email02.

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

setEmail03()

Set email03.

public setEmail03( [ $email03 : string|null = null ] ) : BaseInfo
Parameters
$email03 : string|null = null
Return values
BaseInfo

getEmail03()

Get email03.

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

setEmail04()

Set email04.

public setEmail04( [ $email04 : string|null = null ] ) : BaseInfo
Parameters
$email04 : string|null = null
Return values
BaseInfo

getEmail04()

Get email04.

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

setShopName()

Set shopName.

public setShopName( [ $shopName : string|null = null ] ) : BaseInfo
Parameters
$shopName : string|null = null
Return values
BaseInfo

getShopName()

Get shopName.

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

setShopKana()

Set shopKana.

public setShopKana( [ $shopKana : string|null = null ] ) : BaseInfo
Parameters
$shopKana : string|null = null
Return values
BaseInfo

getShopKana()

Get shopKana.

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

setShopNameEng()

Set shopNameEng.

public setShopNameEng( [ $shopNameEng : string|null = null ] ) : BaseInfo
Parameters
$shopNameEng : string|null = null
Return values
BaseInfo

getShopNameEng()

Get shopNameEng.

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

setUpdateDate()

Set updateDate.

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

getUpdateDate()

Get updateDate.

public getUpdateDate( ) : DateTime
Return values
DateTime

setGoodTraded()

Set goodTraded.

public setGoodTraded( [ $goodTraded : string|null = null ] ) : BaseInfo
Parameters
$goodTraded : string|null = null
Return values
BaseInfo

getGoodTraded()

Get goodTraded.

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

setMessage()

Set message.

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

getMessage()

Get message.

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

setDeliveryFreeAmount()

Set deliveryFreeAmount.

public setDeliveryFreeAmount( [ $deliveryFreeAmount : string|null = null ] ) : BaseInfo
Parameters
$deliveryFreeAmount : string|null = null
Return values
BaseInfo

getDeliveryFreeAmount()

Get deliveryFreeAmount.

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

setDeliveryFreeQuantity()

Set deliveryFreeQuantity.

public setDeliveryFreeQuantity( [ $deliveryFreeQuantity : int|null = null ] ) : BaseInfo
Parameters
$deliveryFreeQuantity : int|null = null
Return values
BaseInfo

getDeliveryFreeQuantity()

Get deliveryFreeQuantity.

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

setOptionMypageOrderStatusDisplay()

Set optionMypageOrderStatusDisplay.

public setOptionMypageOrderStatusDisplay( $optionMypageOrderStatusDisplay : bool ) : BaseInfo
Parameters
$optionMypageOrderStatusDisplay : bool
Return values
BaseInfo

isOptionMypageOrderStatusDisplay()

Get optionMypageOrderStatusDisplay.

public isOptionMypageOrderStatusDisplay( ) : bool
Return values
bool

setOptionNostockHidden()

Set optionNostockHidden.

public setOptionNostockHidden( $optionNostockHidden : int ) : BaseInfo
Parameters
$optionNostockHidden : int
Return values
BaseInfo

isOptionNostockHidden()

Get optionNostockHidden.

public isOptionNostockHidden( ) : bool
Return values
bool

setOptionFavoriteProduct()

Set optionFavoriteProduct.

public setOptionFavoriteProduct( $optionFavoriteProduct : bool ) : BaseInfo
Parameters
$optionFavoriteProduct : bool
Return values
BaseInfo

isOptionFavoriteProduct()

Get optionFavoriteProduct.

public isOptionFavoriteProduct( ) : bool
Return values
bool

setOptionProductDeliveryFee()

Set optionProductDeliveryFee.

public setOptionProductDeliveryFee( $optionProductDeliveryFee : bool ) : BaseInfo
Parameters
$optionProductDeliveryFee : bool
Return values
BaseInfo

isOptionProductDeliveryFee()

Get optionProductDeliveryFee.

public isOptionProductDeliveryFee( ) : bool
Return values
bool

setOptionProductTaxRule()

Set optionProductTaxRule.

public setOptionProductTaxRule( $optionProductTaxRule : bool ) : BaseInfo
Parameters
$optionProductTaxRule : bool
Return values
BaseInfo

isOptionProductTaxRule()

Get optionProductTaxRule.

public isOptionProductTaxRule( ) : bool
Return values
bool

setOptionCustomerActivate()

Set optionCustomerActivate.

public setOptionCustomerActivate( $optionCustomerActivate : bool ) : BaseInfo
Parameters
$optionCustomerActivate : bool
Return values
BaseInfo

isOptionCustomerActivate()

Get optionCustomerActivate.

public isOptionCustomerActivate( ) : bool
Return values
bool

setOptionRememberMe()

Set optionRememberMe.

public setOptionRememberMe( $optionRememberMe : bool ) : BaseInfo
Parameters
$optionRememberMe : bool
Return values
BaseInfo

isOptionRememberMe()

Get optionRememberMe.

public isOptionRememberMe( ) : bool
Return values
bool

setAuthenticationKey()

Set authenticationKey.

public setAuthenticationKey( [ $authenticationKey : string|null = null ] ) : BaseInfo
Parameters
$authenticationKey : string|null = null
Return values
BaseInfo

getAuthenticationKey()

Get authenticationKey.

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

setOptionPoint()

Set optionPoint

public setOptionPoint( $optionPoint : bool ) : BaseInfo
Parameters
$optionPoint : bool
Return values
BaseInfo

isOptionPoint()

Get optionPoint

public isOptionPoint( ) : bool
Return values
bool

setPointConversionRate()

Set pointConversionRate

public setPointConversionRate( $pointConversionRate : string ) : BaseInfo
Parameters
$pointConversionRate : string
Return values
BaseInfo

getPointConversionRate()

Get pointConversionRate

public getPointConversionRate( ) : string
Return values
string

setBasicPointRate()

Set basicPointRate

public setBasicPointRate( $basicPointRate : string ) : BaseInfo
Parameters
$basicPointRate : string
Return values
BaseInfo

getBasicPointRate()

Get basicPointRate

public getBasicPointRate( ) : string
Return values
string

getPhpPath()

public getPhpPath( ) : null|string
Tags
deprecated

使用していないため、削除予定

Return values
null|string

setPhpPath()

public setPhpPath( $php_path : null|string ) : $this
Parameters
$php_path : null|string
Tags
deprecated

使用していないため、削除予定

Return values
$this

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