EC-CUBE4 APIドキュメント

Product extends AbstractEntity

Product

Tags
ORM\Table

(name="dtb_product")

ORM\InheritanceType

("SINGLE_TABLE")

ORM\DiscriminatorColumn

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

ORM\HasLifecycleCallbacks

()

ORM\Entity

(repositoryClass="Eccube\Repository\ProductRepository")

Table of Contents

$_calc
$stockFinds
$stocks
$stockUnlimiteds
$price01
$price02
$price01IncTaxs
$price02IncTaxs
$codes
$classCategories1
$classCategories2
$className1
$className2
$id int
$name string
$note string|null
$description_list string|null
$description_detail string|null
$search_word string|null
$free_area string|null
$create_date DateTime
$update_date DateTime
$ProductCategories Collection
$ProductClasses Collection
$ProductImage Collection
$ProductTag Collection
$CustomerFavoriteProducts Collection
$Creator Member
$Status ProductStatus
$AnnotationReader
__toString() string
_calc() mixed
isEnable() Is Enable bool
getClassName1() Get ClassName1 string
getClassName2() Get ClassName2 string
getClassCategories1() Get getClassCategories1 array
getClassCategories1AsFlip() mixed
getClassCategories2() Get getClassCategories2 array
getClassCategories2AsFlip() mixed
getStockFind() Get StockFind bool
getStockMin() Get Stock min int
getStockMax() Get Stock max int
getStockUnlimitedMin() Get StockUnlimited min int
getStockUnlimitedMax() Get StockUnlimited max int
getPrice01Min() Get Price01 min int
getPrice01Max() Get Price01 max int
getPrice02Min() Get Price02 min int
getPrice02Max() Get Price02 max int
getPrice01IncTaxMin() Get Price01IncTax min int
getPrice01IncTaxMax() Get Price01IncTax max int
getPrice02IncTaxMin() Get Price02IncTax min int
getPrice02IncTaxMax() Get Price02IncTax max int
getCodeMin() Get Product_code min int
getCodeMax() Get Product_code max int
getMainListImage() mixed
getMainFileName() mixed
hasProductClass() mixed
__construct() Constructor mixed
__clone() mixed
copy() mixed
getId() Get id. int
setName() Set name. Product
getName() Get name. string
setNote() Set note. Product
getNote() Get note. string|null
setDescriptionList() Set descriptionList. Product
getDescriptionList() Get descriptionList. string|null
setDescriptionDetail() Set descriptionDetail. Product
getDescriptionDetail() Get descriptionDetail. string|null
setSearchWord() Set searchWord. Product
getSearchWord() Get searchWord. string|null
setFreeArea() Set freeArea. Product
getFreeArea() Get freeArea. string|null
setCreateDate() Set createDate. Product
getCreateDate() Get createDate. DateTime
setUpdateDate() Set updateDate. Product
getUpdateDate() Get updateDate. DateTime
addProductCategory() Add productCategory. Product
removeProductCategory() Remove productCategory. bool
getProductCategories() Get productCategories. Collection
addProductClass() Add productClass. Product
removeProductClass() Remove productClass. bool
getProductClasses() Get productClasses. Collection
addProductImage() Add productImage. Product
removeProductImage() Remove productImage. bool
getProductImage() Get productImage. Collection
addProductTag() Add productTag. Product
removeProductTag() Remove productTag. bool
getProductTag() Get productTag. Collection
getTags() Get Tag フロント側タグsort_no順の配列を作成する mixed
addCustomerFavoriteProduct() Add customerFavoriteProduct. Product
removeCustomerFavoriteProduct() Remove customerFavoriteProduct. bool
getCustomerFavoriteProducts() Get customerFavoriteProducts. Collection
setCreator() Set creator. Product
getCreator() Get creator. Member|null
setStatus() Set status. Product
getStatus() Get status. ProductStatus|null
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

$stockFinds

private mixed $stockFinds = []

$stockUnlimiteds

private mixed $stockUnlimiteds = []

$price01

private mixed $price01 = []

$price02

private mixed $price02 = []

$price01IncTaxs

private mixed $price01IncTaxs = []

$price02IncTaxs

private mixed $price02IncTaxs = []

$classCategories1

private mixed $classCategories1 = []

$classCategories2

private mixed $classCategories2 = []

$className1

private mixed $className1

$className2

private mixed $className2

$id

private int $id
Tags
ORM\Column

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

ORM\Id
ORM\GeneratedValue

(strategy="IDENTITY")

$name

private string $name
Tags
ORM\Column

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

$note

private string|null $note
Tags
ORM\Column

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

$description_list

private string|null $description_list
Tags
ORM\Column

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

$description_detail

private string|null $description_detail
Tags
ORM\Column

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

$search_word

private string|null $search_word
Tags
ORM\Column

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

$free_area

private string|null $free_area
Tags
ORM\Column

(name="free_area", type="text", 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")

$ProductCategories

private Collection $ProductCategories
Tags
ORM\OneToMany

(targetEntity="Eccube\Entity\ProductCategory", mappedBy="Product", cascade={"persist","remove"})

$ProductClasses

private Collection $ProductClasses
Tags
ORM\OneToMany

(targetEntity="Eccube\Entity\ProductClass", mappedBy="Product", cascade={"persist","remove"})

$ProductImage

private Collection $ProductImage
Tags
ORM\OneToMany

(targetEntity="Eccube\Entity\ProductImage", mappedBy="Product", cascade={"remove"})

ORM\OrderBy

({ "sort_no"="ASC" })

$ProductTag

private Collection $ProductTag
Tags
ORM\OneToMany

(targetEntity="Eccube\Entity\ProductTag", mappedBy="Product", cascade={"remove"})

$CustomerFavoriteProducts

private Collection $CustomerFavoriteProducts
Tags
ORM\OneToMany

(targetEntity="Eccube\Entity\CustomerFavoriteProduct", mappedBy="Product")

$Creator

private Member $Creator
Tags
ORM\ManyToOne

(targetEntity="Eccube\Entity\Member")

ORM\JoinColumns

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

$Status

private ProductStatus $Status
Tags
ORM\ManyToOne

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

ORM\JoinColumns

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

Methods

__toString()

public __toString( ) : string
Return values
string

_calc()

public _calc( ) : mixed
Return values
mixed

isEnable()

Is Enable

public isEnable( ) : bool
Tags
deprecated
Return values
bool

getClassName1()

Get ClassName1

public getClassName1( ) : string
Return values
string

getClassName2()

Get ClassName2

public getClassName2( ) : string
Return values
string

getClassCategories1()

Get getClassCategories1

public getClassCategories1( ) : array
Return values
array

getClassCategories1AsFlip()

public getClassCategories1AsFlip( ) : mixed
Return values
mixed

getClassCategories2()

Get getClassCategories2

public getClassCategories2( $class_category1 : mixed ) : array
Parameters
$class_category1 : mixed
Return values
array

getClassCategories2AsFlip()

public getClassCategories2AsFlip( $class_category1 : mixed ) : mixed
Parameters
$class_category1 : mixed
Return values
mixed

getStockFind()

Get StockFind

public getStockFind( ) : bool
Return values
bool

getStockMin()

Get Stock min

public getStockMin( ) : int
Return values
int

getStockMax()

Get Stock max

public getStockMax( ) : int
Return values
int

getStockUnlimitedMin()

Get StockUnlimited min

public getStockUnlimitedMin( ) : int
Return values
int

getStockUnlimitedMax()

Get StockUnlimited max

public getStockUnlimitedMax( ) : int
Return values
int

getPrice01Min()

Get Price01 min

public getPrice01Min( ) : int
Return values
int

getPrice01Max()

Get Price01 max

public getPrice01Max( ) : int
Return values
int

getPrice02Min()

Get Price02 min

public getPrice02Min( ) : int
Return values
int

getPrice02Max()

Get Price02 max

public getPrice02Max( ) : int
Return values
int

getPrice01IncTaxMin()

Get Price01IncTax min

public getPrice01IncTaxMin( ) : int
Return values
int

getPrice01IncTaxMax()

Get Price01IncTax max

public getPrice01IncTaxMax( ) : int
Return values
int

getPrice02IncTaxMin()

Get Price02IncTax min

public getPrice02IncTaxMin( ) : int
Return values
int

getPrice02IncTaxMax()

Get Price02IncTax max

public getPrice02IncTaxMax( ) : int
Return values
int

getCodeMin()

Get Product_code min

public getCodeMin( ) : int
Return values
int

getCodeMax()

Get Product_code max

public getCodeMax( ) : int
Return values
int

getMainListImage()

public getMainListImage( ) : mixed
Return values
mixed

getMainFileName()

public getMainFileName( ) : mixed
Return values
mixed

hasProductClass()

public hasProductClass( ) : mixed
Return values
mixed

__construct()

Constructor

public __construct( ) : mixed
Return values
mixed

__clone()

public __clone( ) : mixed
Return values
mixed

copy()

public copy( ) : mixed
Return values
mixed

getId()

Get id.

public getId( ) : int
Return values
int

setName()

Set name.

public setName( $name : string ) : Product
Parameters
$name : string
Return values
Product

getName()

Get name.

public getName( ) : string
Return values
string

setNote()

Set note.

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

getNote()

Get note.

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

setDescriptionList()

Set descriptionList.

public setDescriptionList( [ $descriptionList : string|null = null ] ) : Product
Parameters
$descriptionList : string|null = null
Return values
Product

getDescriptionList()

Get descriptionList.

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

setDescriptionDetail()

Set descriptionDetail.

public setDescriptionDetail( [ $descriptionDetail : string|null = null ] ) : Product
Parameters
$descriptionDetail : string|null = null
Return values
Product

getDescriptionDetail()

Get descriptionDetail.

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

setSearchWord()

Set searchWord.

public setSearchWord( [ $searchWord : string|null = null ] ) : Product
Parameters
$searchWord : string|null = null
Return values
Product

getSearchWord()

Get searchWord.

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

setFreeArea()

Set freeArea.

public setFreeArea( [ $freeArea : string|null = null ] ) : Product
Parameters
$freeArea : string|null = null
Return values
Product

getFreeArea()

Get freeArea.

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

setCreateDate()

Set createDate.

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

getCreateDate()

Get createDate.

public getCreateDate( ) : DateTime
Return values
DateTime

setUpdateDate()

Set updateDate.

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

getUpdateDate()

Get updateDate.

public getUpdateDate( ) : DateTime
Return values
DateTime

removeProductCategory()

Remove productCategory.

public removeProductCategory( $productCategory : ProductCategory ) : bool
Parameters
$productCategory : ProductCategory
Return values
bool —

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

getProductCategories()

Get productCategories.

public getProductCategories( ) : Collection
Return values
Collection

removeProductClass()

Remove productClass.

public removeProductClass( $productClass : ProductClass ) : bool
Parameters
$productClass : ProductClass
Return values
bool —

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

getProductClasses()

Get productClasses.

public getProductClasses( ) : Collection
Return values
Collection

removeProductImage()

Remove productImage.

public removeProductImage( $productImage : ProductImage ) : bool
Parameters
$productImage : ProductImage
Return values
bool —

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

getProductImage()

Get productImage.

public getProductImage( ) : Collection
Return values
Collection

removeProductTag()

Remove productTag.

public removeProductTag( $productTag : ProductTag ) : bool
Parameters
$productTag : ProductTag
Return values
bool —

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

getProductTag()

Get productTag.

public getProductTag( ) : Collection
Return values
Collection

getTags()

Get Tag フロント側タグsort_no順の配列を作成する

public getTags( ) : mixed
Return values
mixed

removeCustomerFavoriteProduct()

Remove customerFavoriteProduct.

public removeCustomerFavoriteProduct( $customerFavoriteProduct : CustomerFavoriteProduct ) : bool
Parameters
$customerFavoriteProduct : CustomerFavoriteProduct
Return values
bool —

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

getCustomerFavoriteProducts()

Get customerFavoriteProducts.

public getCustomerFavoriteProducts( ) : Collection
Return values
Collection

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