EC-CUBE4 APIドキュメント

Layout extends AbstractEntity

Layout

Tags
ORM\Table

(name="dtb_layout")

ORM\InheritanceType

("SINGLE_TABLE")

ORM\DiscriminatorColumn

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

ORM\HasLifecycleCallbacks

()

ORM\Entity

(repositoryClass="Eccube\Repository\LayoutRepository")

Table of Contents

TARGET_ID_UNUSED 配置ID: 未使用 0
TARGET_ID_HEAD 1
TARGET_ID_BODY_AFTER 2
TARGET_ID_HEADER 3
TARGET_ID_CONTENTS_TOP 4
TARGET_ID_SIDE_LEFT 5
TARGET_ID_MAIN_TOP 6
TARGET_ID_MAIN_BOTTOM 7
TARGET_ID_SIDE_RIGHT 8
TARGET_ID_CONTENTS_BOTTOM 9
TARGET_ID_FOOTER 10
TARGET_ID_DRAWER 11
TARGET_ID_CLOSE_BODY_BEFORE 12
DEFAULT_LAYOUT_PREVIEW_PAGE プレビュー用レイアウト 0
DEFAULT_LAYOUT_TOP_PAGE トップページ用レイアウト 1
DEFAULT_LAYOUT_UNDERLAYER_PAGE 下層ページ用レイアウト 2
$id int
$name string
$create_date DateTime
$update_date DateTime
$BlockPositions Collection
$PageLayouts Collection
$DeviceType DeviceType
$AnnotationReader
__toString() string
isDefault() mixed
getPages() \Eccube\Entity\Page[]
getBlocks() \Eccube\Entity\Block[]
getBlockPositionsByTargetId() \Eccube\Entity\BlockPosition[]
getUnused() mixed
getHead() mixed
getBodyAfter() mixed
getHeader() mixed
getContentsTop() mixed
getSideLeft() mixed
getMainTop() mixed
getMainBottom() mixed
getSideRight() mixed
getContentsBottom() mixed
getFooter() mixed
getDrawer() mixed
getCloseBodyBefore() mixed
getColumnNum() Get ColumnNum int
__construct() Constructor mixed
getId() Get id int
setName() Set name Layout
getName() Get name string
setCreateDate() Set createDate Layout
getCreateDate() Get createDate DateTime
setUpdateDate() Set updateDate Layout
getUpdateDate() Get updateDate DateTime
addBlockPosition() Add blockPosition Layout
removeBlockPosition() Remove blockPosition mixed
getBlockPositions() Get blockPositions Collection
addPageLayout() Add pageLayoutLayout Layout
removePageLayout() Remove pageLayoutLayout mixed
getPageLayouts() Get pageLayoutLayouts Collection
setDeviceType() Set deviceType Layout
getDeviceType() Get deviceType DeviceType
isDeletable() Check layout can delete or not bool
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

TARGET_ID_UNUSED

配置ID: 未使用

public mixed $TARGET_ID_UNUSED = ""

TARGET_ID_HEAD

public mixed $TARGET_ID_HEAD = 1

TARGET_ID_BODY_AFTER

public mixed $TARGET_ID_BODY_AFTER = 2

TARGET_ID_HEADER

public mixed $TARGET_ID_HEADER = 3

TARGET_ID_CONTENTS_TOP

public mixed $TARGET_ID_CONTENTS_TOP = 4

TARGET_ID_SIDE_LEFT

public mixed $TARGET_ID_SIDE_LEFT = 5

TARGET_ID_MAIN_TOP

public mixed $TARGET_ID_MAIN_TOP = 6

TARGET_ID_MAIN_BOTTOM

public mixed $TARGET_ID_MAIN_BOTTOM = 7

TARGET_ID_SIDE_RIGHT

public mixed $TARGET_ID_SIDE_RIGHT = 8

TARGET_ID_CONTENTS_BOTTOM

public mixed $TARGET_ID_CONTENTS_BOTTOM = 9

TARGET_ID_FOOTER

public mixed $TARGET_ID_FOOTER = 10

TARGET_ID_DRAWER

public mixed $TARGET_ID_DRAWER = 11

TARGET_ID_CLOSE_BODY_BEFORE

public mixed $TARGET_ID_CLOSE_BODY_BEFORE = 12

DEFAULT_LAYOUT_PREVIEW_PAGE

プレビュー用レイアウト

public mixed $DEFAULT_LAYOUT_PREVIEW_PAGE = ""

DEFAULT_LAYOUT_TOP_PAGE

トップページ用レイアウト

public mixed $DEFAULT_LAYOUT_TOP_PAGE = 1

DEFAULT_LAYOUT_UNDERLAYER_PAGE

下層ページ用レイアウト

public mixed $DEFAULT_LAYOUT_UNDERLAYER_PAGE = 2

Properties

$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="layout_name", type="string", length=255, 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")

$BlockPositions

private Collection $BlockPositions
Tags
ORM\OneToMany

(targetEntity="Eccube\Entity\BlockPosition", mappedBy="Layout", cascade={"persist","remove"})

$PageLayouts

private Collection $PageLayouts
Tags
ORM\OneToMany

(targetEntity="Eccube\Entity\PageLayout", mappedBy="Layout", cascade={"persist","remove"})

ORM\OrderBy

({"sort_no" = "ASC"})

$DeviceType

private DeviceType $DeviceType
Tags
ORM\ManyToOne

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

ORM\JoinColumns

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

Methods

__toString()

public __toString( ) : string
Return values
string

isDefault()

public isDefault( ) : mixed
Return values
mixed

getPages()

public getPages( ) : \Eccube\Entity\Page[]
Return values
\Eccube\Entity\Page[]

getBlocks()

public getBlocks( [ $targetId : int|null = null ] ) : \Eccube\Entity\Block[]
Parameters
$targetId : int|null = null
Return values
\Eccube\Entity\Block[]

getBlockPositionsByTargetId()

public getBlockPositionsByTargetId( $targetId : int ) : \Eccube\Entity\BlockPosition[]
Parameters
$targetId : int
Return values
\Eccube\Entity\BlockPosition[]

getUnused()

public getUnused( ) : mixed
Return values
mixed

getHead()

public getHead( ) : mixed
Return values
mixed

getBodyAfter()

public getBodyAfter( ) : mixed
Return values
mixed

getHeader()

public getHeader( ) : mixed
Return values
mixed

getContentsTop()

public getContentsTop( ) : mixed
Return values
mixed

getSideLeft()

public getSideLeft( ) : mixed
Return values
mixed

getMainTop()

public getMainTop( ) : mixed
Return values
mixed

getMainBottom()

public getMainBottom( ) : mixed
Return values
mixed

getSideRight()

public getSideRight( ) : mixed
Return values
mixed

getContentsBottom()

public getContentsBottom( ) : mixed
Return values
mixed

getFooter()

public getFooter( ) : mixed
Return values
mixed

getDrawer()

public getDrawer( ) : mixed
Return values
mixed

getCloseBodyBefore()

public getCloseBodyBefore( ) : mixed
Return values
mixed

getColumnNum()

Get ColumnNum

public getColumnNum( ) : int
Return values
int

__construct()

Constructor

public __construct( ) : mixed
Return values
mixed

getId()

Get id

public getId( ) : int
Return values
int

setName()

Set name

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

getName()

Get name

public getName( ) : string
Return values
string

setCreateDate()

Set createDate

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

getCreateDate()

Get createDate

public getCreateDate( ) : DateTime
Return values
DateTime

setUpdateDate()

Set updateDate

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

getUpdateDate()

Get updateDate

public getUpdateDate( ) : DateTime
Return values
DateTime

removeBlockPosition()

Remove blockPosition

public removeBlockPosition( $blockPosition : BlockPosition ) : mixed
Parameters
$blockPosition : BlockPosition
Return values
mixed

getBlockPositions()

Get blockPositions

public getBlockPositions( ) : Collection
Return values
Collection

removePageLayout()

Remove pageLayoutLayout

public removePageLayout( $PageLayout : PageLayout ) : mixed
Parameters
$PageLayout : PageLayout
Return values
mixed

getPageLayouts()

Get pageLayoutLayouts

public getPageLayouts( ) : Collection
Return values
Collection

isDeletable()

Check layout can delete or not

public isDeletable( ) : bool
Return values
bool

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