EC-CUBE4 APIドキュメント

BlockPosition extends AbstractEntity

BlockPosition

Tags
ORM\Table

(name="dtb_block_position")

ORM\InheritanceType

("SINGLE_TABLE")

ORM\DiscriminatorColumn

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

ORM\HasLifecycleCallbacks

()

ORM\Entity

(repositoryClass="Eccube\Repository\BlockPositionRepository")

Table of Contents

$section int
$block_id int
$layout_id int
$block_row int|null
$Block Block
$Layout Layout
$AnnotationReader
setSection() Set section. BlockPosition
getSection() Get section. int
setBlockId() Set blockId. BlockPosition
getBlockId() Get blockId. int
setLayoutId() Set layoutId. BlockPosition
getLayoutId() Get layoutId. int
setBlockRow() Set blockRow. BlockPosition
getBlockRow() Get blockRow. int|null
setBlock() Set block. BlockPosition
getBlock() Get block. Block|null
setLayout() Set layout. BlockPosition
getLayout() Get Layout. Layout|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

$section

private int $section
Tags
ORM\Column

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

ORM\Id
ORM\GeneratedValue

(strategy="NONE")

$block_id

private int $block_id
Tags
ORM\Column

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

ORM\Id
ORM\GeneratedValue

(strategy="NONE")

$layout_id

private int $layout_id
Tags
ORM\Column

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

ORM\Id
ORM\GeneratedValue

(strategy="NONE")

$block_row

private int|null $block_row
Tags
ORM\Column

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

$Block

private Block $Block
Tags
ORM\ManyToOne

(targetEntity="Eccube\Entity\Block", inversedBy="BlockPositions")

ORM\JoinColumns

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

$Layout

private Layout $Layout
Tags
ORM\ManyToOne

(targetEntity="Eccube\Entity\Layout", inversedBy="BlockPositions")

ORM\JoinColumns

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

Methods

getSection()

Get section.

public getSection( ) : int
Return values
int

getBlockId()

Get blockId.

public getBlockId( ) : int
Return values
int

getLayoutId()

Get layoutId.

public getLayoutId( ) : int
Return values
int

getBlockRow()

Get blockRow.

public getBlockRow( ) : int|null
Return values
int|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