EC-CUBE4 APIドキュメント

Csv extends AbstractEntity

Csv

Tags
ORM\Table

(name="dtb_csv")

ORM\InheritanceType

("SINGLE_TABLE")

ORM\DiscriminatorColumn

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

ORM\HasLifecycleCallbacks

()

ORM\Entity

(repositoryClass="Eccube\Repository\CsvRepository")

Table of Contents

$id int
$entity_name string
$field_name string
$reference_field_name string|null
$disp_name string
$sort_no int
$enabled bool
$create_date DateTime
$update_date DateTime
$CsvType CsvType
$Creator Member
$AnnotationReader
getId() Get id. int
setEntityName() Set entityName. Csv
getEntityName() Get entityName. string
setFieldName() Set fieldName. Csv
getFieldName() Get fieldName. string
setReferenceFieldName() Set referenceFieldName. Csv
getReferenceFieldName() Get referenceFieldName. string|null
setDispName() Set dispName. Csv
getDispName() Get dispName. string
setSortNo() Set sortNo. Csv
getSortNo() Get sortNo. int
setEnabled() Set enabled. Csv
isEnabled() Get enabled. bool
setCreateDate() Set createDate. Csv
getCreateDate() Get createDate. DateTime
setUpdateDate() Set updateDate. Csv
getUpdateDate() Get updateDate. DateTime
setCsvType() Set csvType. Csv
getCsvType() Get csvType. CsvType|null
setCreator() Set creator. Csv
getCreator() Get creator. Member|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

$id

private int $id
Tags
ORM\Column

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

ORM\Id
ORM\GeneratedValue

(strategy="IDENTITY")

$entity_name

private string $entity_name
Tags
ORM\Column

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

$field_name

private string $field_name
Tags
ORM\Column

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

$reference_field_name

private string|null $reference_field_name
Tags
ORM\Column

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

$disp_name

private string $disp_name
Tags
ORM\Column

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

$sort_no

private int $sort_no
Tags
ORM\Column

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

$enabled

private bool $enabled = true
Tags
ORM\Column

(name="enabled", 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")

$CsvType

private CsvType $CsvType
Tags
ORM\ManyToOne

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

ORM\JoinColumns

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

$Creator

private Member $Creator
Tags
ORM\ManyToOne

(targetEntity="Eccube\Entity\Member")

ORM\JoinColumns

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

Methods

getId()

Get id.

public getId( ) : int
Return values
int

setEntityName()

Set entityName.

public setEntityName( $entityName : string ) : Csv
Parameters
$entityName : string
Return values
Csv

getEntityName()

Get entityName.

public getEntityName( ) : string
Return values
string

setFieldName()

Set fieldName.

public setFieldName( $fieldName : string ) : Csv
Parameters
$fieldName : string
Return values
Csv

getFieldName()

Get fieldName.

public getFieldName( ) : string
Return values
string

setReferenceFieldName()

Set referenceFieldName.

public setReferenceFieldName( [ $referenceFieldName : string|null = null ] ) : Csv
Parameters
$referenceFieldName : string|null = null
Return values
Csv

getReferenceFieldName()

Get referenceFieldName.

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

setDispName()

Set dispName.

public setDispName( $dispName : string ) : Csv
Parameters
$dispName : string
Return values
Csv

getDispName()

Get dispName.

public getDispName( ) : string
Return values
string

setSortNo()

Set sortNo.

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

getSortNo()

Get sortNo.

public getSortNo( ) : int
Return values
int

setEnabled()

Set enabled.

public setEnabled( $enabled : bool ) : Csv
Parameters
$enabled : bool
Return values
Csv

isEnabled()

Get enabled.

public isEnabled( ) : bool
Return values
bool

setCreateDate()

Set createDate.

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

getCreateDate()

Get createDate.

public getCreateDate( ) : DateTime
Return values
DateTime

setUpdateDate()

Set updateDate.

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

getUpdateDate()

Get updateDate.

public getUpdateDate( ) : DateTime
Return values
DateTime

setCsvType()

Set csvType.

public setCsvType( [ $csvType : CsvType|null = null ] ) : Csv
Parameters
$csvType : CsvType|null = null
Return values
Csv

setCreator()

Set creator.

public setCreator( [ $creator : Member|null = null ] ) : Csv
Parameters
$creator : Member|null = null
Return values
Csv

getCreator()

Get creator.

public getCreator( ) : Member|null
Return values
Member|null

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