EC-CUBE4 APIドキュメント

MailHistory extends AbstractEntity

MailHistory

Tags
ORM\Table

(name="dtb_mail_history")

ORM\InheritanceType

("SINGLE_TABLE")

ORM\DiscriminatorColumn

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

ORM\HasLifecycleCallbacks

()

ORM\Entity

(repositoryClass="Eccube\Repository\MailHistoryRepository")

Table of Contents

$id int
$send_date DateTime|null
$mail_subject string|null
$mail_body string|null
$mail_html_body string|null
$Order Order
$Creator Member
$AnnotationReader
__toString() string
getId() Get id. int
setSendDate() Set sendDate. MailHistory
getSendDate() Get sendDate. DateTime|null
setMailSubject() Set mailSubject. MailHistory
getMailSubject() Get mailSubject. string|null
setMailBody() Set mailBody. MailHistory
getMailBody() Get mailBody. string|null
setMailHtmlBody() Set mailHtmlBody. MailHistory
getMailHtmlBody() Get mailHtmlBody. string|null
setOrder() Set order. MailHistory
getOrder() Get order. Order|null
setCreator() Set creator. MailHistory
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")

$send_date

private DateTime|null $send_date
Tags
ORM\Column

(name="send_date", type="datetimetz", nullable=true)

$mail_subject

private string|null $mail_subject
Tags
ORM\Column

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

$mail_body

private string|null $mail_body
Tags
ORM\Column

(name="mail_body", type="text", nullable=true)

$mail_html_body

private string|null $mail_html_body
Tags
ORM\Column

(name="mail_html_body", type="text", nullable=true)

$Order

private Order $Order
Tags
ORM\ManyToOne

(targetEntity="Eccube\Entity\Order", inversedBy="MailHistories")

ORM\JoinColumns

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

$Creator

private Member $Creator
Tags
ORM\ManyToOne

(targetEntity="Eccube\Entity\Member")

ORM\JoinColumns

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

Methods

__toString()

public __toString( ) : string
Return values
string

getId()

Get id.

public getId( ) : int
Return values
int

setSendDate()

Set sendDate.

public setSendDate( [ $sendDate : DateTime|null = null ] ) : MailHistory
Parameters
$sendDate : DateTime|null = null
Return values
MailHistory

getSendDate()

Get sendDate.

public getSendDate( ) : DateTime|null
Return values
DateTime|null

setMailSubject()

Set mailSubject.

public setMailSubject( [ $mailSubject : string|null = null ] ) : MailHistory
Parameters
$mailSubject : string|null = null
Return values
MailHistory

getMailSubject()

Get mailSubject.

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

setMailBody()

Set mailBody.

public setMailBody( [ $mailBody : string|null = null ] ) : MailHistory
Parameters
$mailBody : string|null = null
Return values
MailHistory

getMailBody()

Get mailBody.

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

setMailHtmlBody()

Set mailHtmlBody.

public setMailHtmlBody( [ $mailHtmlBody : string|null = null ] ) : MailHistory
Parameters
$mailHtmlBody : string|null = null
Return values
MailHistory

getMailHtmlBody()

Get mailHtmlBody.

public getMailHtmlBody( ) : string|null
Return values
string|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