EC-CUBE4 APIドキュメント

Payment extends AbstractEntity

Payment

Tags
ORM\Table

(name="dtb_payment")

ORM\InheritanceType

("SINGLE_TABLE")

ORM\DiscriminatorColumn

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

ORM\HasLifecycleCallbacks

()

ORM\Entity

(repositoryClass="Eccube\Repository\PaymentRepository")

Table of Contents

$id int
$method string|null
$charge string|null
$rule_max string|null
$sort_no int|null
$fixed bool
$payment_image string|null
$rule_min string|null
$method_class string|null
$visible int
$create_date DateTime
$update_date DateTime
$PaymentOptions Collection
$Creator Member
$AnnotationReader
__toString() string
__construct() Constructor mixed
getId() Get id. int
setMethod() Set method. Payment
getMethod() Get method. string|null
setCharge() Set charge. Payment
getCharge() Get charge. string|null
setRuleMax() Set ruleMax. Payment
getRuleMax() Get ruleMax. string|null
setSortNo() Set sortNo. Payment
getSortNo() Get sortNo. int|null
setFixed() Set fixed. Payment
isFixed() Get fixed. bool
setPaymentImage() Set paymentImage. Payment
getPaymentImage() Get paymentImage. string|null
setRuleMin() Set ruleMin. Payment
getRuleMin() Get ruleMin. string|null
setMethodClass() Set methodClass. Payment
getMethodClass() Get methodClass. string|null
isVisible() int
setVisible() Payment
setCreateDate() Set createDate. Payment
getCreateDate() Get createDate. DateTime
setUpdateDate() Set updateDate. Payment
getUpdateDate() Get updateDate. DateTime
addPaymentOption() Add paymentOption. Payment
removePaymentOption() Remove paymentOption. bool
getPaymentOptions() Get paymentOptions. Collection
setCreator() Set creator. Payment
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")

$method

private string|null $method
Tags
ORM\Column

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

$charge

private string|null $charge = ""
Tags
ORM\Column

(name="charge", type="decimal", precision=12, scale=2, nullable=true, options={"unsigned":true,"default":0})

$rule_max

private string|null $rule_max
Tags
ORM\Column

(name="rule_max", type="decimal", precision=12, scale=2, nullable=true, options={"unsigned":true})

$sort_no

private int|null $sort_no
Tags
ORM\Column

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

$fixed

private bool $fixed = true
Tags
ORM\Column

(name="fixed", type="boolean", options={"default":true})

$payment_image

private string|null $payment_image
Tags
ORM\Column

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

$rule_min

private string|null $rule_min
Tags
ORM\Column

(name="rule_min", type="decimal", precision=12, scale=2, nullable=true, options={"unsigned":true})

$method_class

private string|null $method_class
Tags
ORM\Column

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

$visible

private int $visible
Tags
ORM\Column

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

$PaymentOptions

private Collection $PaymentOptions
Tags
ORM\OneToMany

(targetEntity="Eccube\Entity\PaymentOption", mappedBy="Payment")

$Creator

private Member $Creator
Tags
ORM\ManyToOne

(targetEntity="Eccube\Entity\Member")

ORM\JoinColumns

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

Methods

__toString()

public __toString( ) : string
Return values
string

__construct()

Constructor

public __construct( ) : mixed
Return values
mixed

getId()

Get id.

public getId( ) : int
Return values
int

setMethod()

Set method.

public setMethod( [ $method : string|null = null ] ) : Payment
Parameters
$method : string|null = null
Return values
Payment

getMethod()

Get method.

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

setCharge()

Set charge.

public setCharge( [ $charge : string|null = null ] ) : Payment
Parameters
$charge : string|null = null
Return values
Payment

getCharge()

Get charge.

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

setRuleMax()

Set ruleMax.

public setRuleMax( [ $ruleMax : string|null = null ] ) : Payment
Parameters
$ruleMax : string|null = null
Return values
Payment

getRuleMax()

Get ruleMax.

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

setSortNo()

Set sortNo.

public setSortNo( [ $sortNo : int|null = null ] ) : Payment
Parameters
$sortNo : int|null = null
Return values
Payment

getSortNo()

Get sortNo.

public getSortNo( ) : int|null
Return values
int|null

setFixed()

Set fixed.

public setFixed( $fixed : bool ) : Payment
Parameters
$fixed : bool
Return values
Payment

isFixed()

Get fixed.

public isFixed( ) : bool
Return values
bool

setPaymentImage()

Set paymentImage.

public setPaymentImage( [ $paymentImage : string|null = null ] ) : Payment
Parameters
$paymentImage : string|null = null
Return values
Payment

getPaymentImage()

Get paymentImage.

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

setRuleMin()

Set ruleMin.

public setRuleMin( [ $ruleMin : string|null = null ] ) : Payment
Parameters
$ruleMin : string|null = null
Return values
Payment

getRuleMin()

Get ruleMin.

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

setMethodClass()

Set methodClass.

public setMethodClass( [ $methodClass : string|null = null ] ) : Payment
Parameters
$methodClass : string|null = null
Return values
Payment

getMethodClass()

Get methodClass.

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

isVisible()

public isVisible( ) : int
Return values
int

setVisible()

public setVisible( $visible : bool ) : Payment
Parameters
$visible : bool
Return values
Payment

setCreateDate()

Set createDate.

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

getCreateDate()

Get createDate.

public getCreateDate( ) : DateTime
Return values
DateTime

setUpdateDate()

Set updateDate.

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

getUpdateDate()

Get updateDate.

public getUpdateDate( ) : DateTime
Return values
DateTime

removePaymentOption()

Remove paymentOption.

public removePaymentOption( $paymentOption : PaymentOption ) : bool
Parameters
$paymentOption : PaymentOption
Return values
bool —

TRUE if this collection contained the specified element, FALSE otherwise.

getPaymentOptions()

Get paymentOptions.

public getPaymentOptions( ) : Collection
Return values
Collection

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