EC-CUBE4 APIドキュメント

Page extends AbstractEntity

Page

Tags
ORM\Table

(name="dtb_page", indexes={@ORM\Index (name="dtb_page_url_idx", columns={"url"})})

ORM\InheritanceType

("SINGLE_TABLE")

ORM\DiscriminatorColumn

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

ORM\HasLifecycleCallbacks

()

ORM\Entity

(repositoryClass="Eccube\Repository\PageRepository")

Table of Contents

EDIT_TYPE_USER 0
EDIT_TYPE_PREVIEW 1
EDIT_TYPE_DEFAULT 2
TRADELAW_PAGE_ID 21
AGREEMENT_PAGE_ID 19
$id int
$name string|null
$url string
$file_name string|null
$edit_type int
$author string|null
$description string|null
$keyword string|null
$create_date DateTime
$update_date DateTime
$meta_robots string|null
$meta_tags string|null
$PageLayouts Collection
$MasterPage Page
$AnnotationReader
getLayouts() mixed
__construct() Constructor mixed
setId() Set id Page
getId() Get id int
setName() Set name. Page
getName() Get name. string|null
setUrl() Set url. Page
getUrl() Get url. string
setFileName() Set fileName. Page
getFileName() Get fileName. string|null
setEditType() Set editType. Page
getEditType() Get editType. int
setAuthor() Set author. Page
getAuthor() Get author. string|null
setDescription() Set description. Page
getDescription() Get description. string|null
setKeyword() Set keyword. Page
getKeyword() Get keyword. string|null
setCreateDate() Set createDate. Page
getCreateDate() Get createDate. DateTime
setUpdateDate() Set updateDate. Page
getUpdateDate() Get updateDate. DateTime
setMetaRobots() Set metaRobots. Page
getMetaRobots() Get metaRobots. string|null
setMetaTags() Set meta_tags Page
getMetaTags() Get meta_tags string
getPageLayouts() Get pageLayoutLayout. Collection
addPageLayout() Add pageLayoutLayout Page
removePageLayout() Remove pageLayoutLayout mixed
setMasterPage() Set MasterPage. Page
getMasterPage() Get MasterPage. Page|null
getSortNo() null|int
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

EDIT_TYPE_USER

public mixed $EDIT_TYPE_USER = ""

EDIT_TYPE_PREVIEW

public mixed $EDIT_TYPE_PREVIEW = 1

EDIT_TYPE_DEFAULT

public mixed $EDIT_TYPE_DEFAULT = 2

TRADELAW_PAGE_ID

public mixed $TRADELAW_PAGE_ID = 21

AGREEMENT_PAGE_ID

public mixed $AGREEMENT_PAGE_ID = 19

Properties

$id

private int $id
Tags
ORM\Column

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

ORM\Id
ORM\GeneratedValue

(strategy="IDENTITY")

$name

private string|null $name
Tags
ORM\Column

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

$url

private string $url
Tags
ORM\Column

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

$file_name

private string|null $file_name
Tags
ORM\Column

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

$edit_type

private int $edit_type = 1
Tags
ORM\Column

(name="edit_type", type="smallint", options={"unsigned":true,"default":1})

$author

private string|null $author
Tags
ORM\Column

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

$description

private string|null $description
Tags
ORM\Column

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

$keyword

private string|null $keyword
Tags
ORM\Column

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

$meta_robots

private string|null $meta_robots
Tags
ORM\Column

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

$meta_tags

private string|null $meta_tags
Tags
ORM\Column

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

$PageLayouts

private Collection $PageLayouts
Tags
ORM\OneToMany

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

$MasterPage

private Page $MasterPage
Tags
ORM\ManyToOne

(targetEntity="Eccube\Entity\Page")

ORM\JoinColumns

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

Methods

getLayouts()

public getLayouts( ) : mixed
Return values
mixed

__construct()

Constructor

public __construct( ) : mixed
Return values
mixed

setId()

Set id

public setId( $id : mixed ) : Page
Parameters
$id : mixed
Return values
Page

getId()

Get id

public getId( ) : int
Return values
int

setName()

Set name.

public setName( [ $name : string|null = null ] ) : Page
Parameters
$name : string|null = null
Return values
Page

getName()

Get name.

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

setUrl()

Set url.

public setUrl( $url : string ) : Page
Parameters
$url : string
Return values
Page

getUrl()

Get url.

public getUrl( ) : string
Return values
string

setFileName()

Set fileName.

public setFileName( [ $fileName : string|null = null ] ) : Page
Parameters
$fileName : string|null = null
Return values
Page

getFileName()

Get fileName.

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

setEditType()

Set editType.

public setEditType( $editType : int ) : Page
Parameters
$editType : int
Return values
Page

getEditType()

Get editType.

public getEditType( ) : int
Return values
int

setAuthor()

Set author.

public setAuthor( [ $author : string|null = null ] ) : Page
Parameters
$author : string|null = null
Return values
Page

getAuthor()

Get author.

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

setDescription()

Set description.

public setDescription( [ $description : string|null = null ] ) : Page
Parameters
$description : string|null = null
Return values
Page

getDescription()

Get description.

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

setKeyword()

Set keyword.

public setKeyword( [ $keyword : string|null = null ] ) : Page
Parameters
$keyword : string|null = null
Return values
Page

getKeyword()

Get keyword.

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

setCreateDate()

Set createDate.

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

getCreateDate()

Get createDate.

public getCreateDate( ) : DateTime
Return values
DateTime

setUpdateDate()

Set updateDate.

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

getUpdateDate()

Get updateDate.

public getUpdateDate( ) : DateTime
Return values
DateTime

setMetaRobots()

Set metaRobots.

public setMetaRobots( [ $metaRobots : string|null = null ] ) : Page
Parameters
$metaRobots : string|null = null
Return values
Page

getMetaRobots()

Get metaRobots.

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

setMetaTags()

Set meta_tags

public setMetaTags( $metaTags : string ) : Page
Parameters
$metaTags : string
Return values
Page

getMetaTags()

Get meta_tags

public getMetaTags( ) : string
Return values
string

getPageLayouts()

Get pageLayoutLayout.

public getPageLayouts( ) : Collection
Return values
Collection

removePageLayout()

Remove pageLayoutLayout

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

setMasterPage()

Set MasterPage.

public setMasterPage( [ $page : Page|null = null ] ) : Page
Parameters
$page : Page|null = null
Return values
Page

getMasterPage()

Get MasterPage.

public getMasterPage( ) : Page|null
Return values
Page|null

getSortNo()

public getSortNo( $layoutId : ) : null|int
Parameters
$layoutId :
Return values
null|int

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