EC-CUBE4 APIドキュメント

CsvType extends AbstractMasterEntity

CsvType

Tags
ORM\Table

(name="mtb_csv_type")

ORM\InheritanceType

("SINGLE_TABLE")

ORM\DiscriminatorColumn

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

ORM\HasLifecycleCallbacks

()

ORM\Entity

(repositoryClass="Eccube\Repository\Master\CsvTypeRepository")

ORM\Cache

(usage="NONSTRICT_READ_WRITE")

Table of Contents

CSV_TYPE_PRODUCT 1
CSV_TYPE_CUSTOMER 2
CSV_TYPE_ORDER 3
CSV_TYPE_SHIPPING 4
CSV_TYPE_CATEGORY 5
$id int
$name string
$sort_no int
$AnnotationReader
__toString() string
setId() Set id. $this
getId() Get id. int
setName() Set name. $this
getName() Get name. string
setSortNo() Set sortNo. $this
getSortNo() Get sortNo. int
__get() mixed
__set() mixed
__callStatic() mixed
getConstantValue() 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

CSV_TYPE_PRODUCT

public int $CSV_TYPE_PRODUCT = 1

CSV_TYPE_CUSTOMER

public int $CSV_TYPE_CUSTOMER = 2

CSV_TYPE_ORDER

public int $CSV_TYPE_ORDER = 3

CSV_TYPE_SHIPPING

public int $CSV_TYPE_SHIPPING = 4

CSV_TYPE_CATEGORY

public int $CSV_TYPE_CATEGORY = 5

Properties

$id

protected int $id
Tags
ORM\Column

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

ORM\Id
ORM\GeneratedValue

(strategy="NONE")

$sort_no

protected int $sort_no
Tags
ORM\Column

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

Methods

setId()

Set id.

public setId( $id : int ) : $this
Parameters
$id : int
Return values
$this

setName()

Set name.

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

setSortNo()

Set sortNo.

public setSortNo( $sortNo : int ) : $this
Parameters
$sortNo : int
Return values
$this

__get()

public __get( $name : mixed ) : mixed
Parameters
$name : mixed
Return values
mixed

__set()

public __set( $name : mixed , $value : mixed ) : mixed
Parameters
$name : mixed
$value : mixed
Return values
mixed

__callStatic()

public static __callStatic( $name : mixed , $arguments : mixed ) : mixed
Parameters
$name : mixed
$arguments : mixed
Return values
mixed

getConstantValue()

protected static getConstantValue( $name : mixed ) : mixed
Parameters
$name : 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