EC-CUBE4 APIドキュメント

Plugin extends AbstractEntity

Plugin

Tags
ORM\Table

(name="dtb_plugin")

ORM\InheritanceType

("SINGLE_TABLE")

ORM\DiscriminatorColumn

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

ORM\HasLifecycleCallbacks

()

ORM\Entity

(repositoryClass="Eccube\Repository\PluginRepository")

Table of Contents

$id int
$name string
$code string
$enabled bool
$version string
$source string
$initialized bool
$create_date DateTime
$update_date DateTime
$AnnotationReader
getId() Get id. int
setName() Set name. Plugin
getName() Get name. string
setCode() Set code. Plugin
getCode() Get code. string
setEnabled() Set enabled. Plugin
isEnabled() Get enabled. bool
setVersion() Set version. Plugin
getVersion() Get version. string
setSource() Set source. Plugin
getSource() Get source. string
isInitialized() Get initialized. bool
setInitialized() Set initialized. Plugin
setCreateDate() Set createDate. Plugin
getCreateDate() Get createDate. DateTime
setUpdateDate() Set updateDate. Plugin
getUpdateDate() Get updateDate. DateTime
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")

$name

private string $name
Tags
ORM\Column

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

$code

private string $code
Tags
ORM\Column

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

$enabled

private bool $enabled = false
Tags
ORM\Column

(name="enabled", type="boolean", options={"default":false})

$version

private string $version
Tags
ORM\Column

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

$source

private string $source
Tags
ORM\Column

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

$initialized

private bool $initialized = false
Tags
ORM\Column

(name="initialized", type="boolean", options={"default":false})

$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")

Methods

getId()

Get id.

public getId( ) : int
Return values
int

setName()

Set name.

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

getName()

Get name.

public getName( ) : string
Return values
string

setCode()

Set code.

public setCode( $code : string ) : Plugin
Parameters
$code : string
Return values
Plugin

getCode()

Get code.

public getCode( ) : string
Return values
string

setEnabled()

Set enabled.

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

isEnabled()

Get enabled.

public isEnabled( ) : bool
Return values
bool

setVersion()

Set version.

public setVersion( $version : string ) : Plugin
Parameters
$version : string
Return values
Plugin

getVersion()

Get version.

public getVersion( ) : string
Return values
string

setSource()

Set source.

public setSource( $source : string ) : Plugin
Parameters
$source : string
Return values
Plugin

getSource()

Get source.

public getSource( ) : string
Return values
string

isInitialized()

Get initialized.

public isInitialized( ) : bool
Return values
bool

setInitialized()

Set initialized.

public setInitialized( $initialized : bool ) : Plugin
Parameters
$initialized : bool
Return values
Plugin

setCreateDate()

Set createDate.

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

getCreateDate()

Get createDate.

public getCreateDate( ) : DateTime
Return values
DateTime

setUpdateDate()

Set updateDate.

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

getUpdateDate()

Get updateDate.

public getUpdateDate( ) : DateTime
Return values
DateTime

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