CoolCMS API

EmailQueue extends BaseEntity
in package
implements IdentifiableInterface uses IdentifiableTrait

AbstractYes
Tags
template
Attributes
#[MappedSuperclass]
#[TableAlias]
$alias: 'emailQueue'

Table of Contents

Interfaces

IdentifiableInterface
Entity with a simple integer primary key. Most entities have one (often via {@see \App\Core\Traits\Shared\Models\Entities\IdentifiableTrait}); texts and links with a composite key do not, which is why `getId()` is not on {@see \App\Core\Base\BaseEntity}. Code that needs the id of a generic entity asks for this interface (parameter type, template bound, `instanceof`).

Properties

$attempts  : int
$body  : string|null
$errorLog  : string|null
$files  : string|null
$from  : string
$id  : int|null
$insertDatetime  : DateTime|null
$newsletter  : TNewsletter|null
$preferred  : bool
$replyTos  : string|null
$sendDatetime  : DateTime|null
$sent  : bool
$stopped  : bool
$subject  : string|null
$to  : string
$unpreferred  : bool

Methods

__construct()  : mixed
callInitMethods()  : void
Calls `init{TraitName}()` for every used trait that defines such a method.
getAllTraits()  : array<string, string>
Returns all traits the class uses, including those used by parent classes and nested traits.
getAttempts()  : int
getBody()  : string|null
getErrorLog()  : string|null
getFiles()  : string|null
getFilesUnserialized()  : array<int, File>
getFrom()  : string
getId()  : int|null
getInsertDatetime()  : DateTime|null
getNewsletter()  : TNewsletter|null
getReplyTos()  : string|null
getReplyTosUnserialized()  : array<int, string>
getSendDatetime()  : DateTime|null
getSubject()  : string|null
getTo()  : string
incrementAttempts()  : $this
isPersisted()  : bool
isPreferred()  : bool
isSent()  : bool
isStopped()  : bool
isUnpreferred()  : bool
setAttempts()  : $this
setBody()  : $this
setErrorLog()  : $this
setFiles()  : $this
setFrom()  : $this
setId()  : $this
setInsertDatetime()  : $this
setNewsletter()  : $this
setPreferred()  : $this
setReplyTos()  : $this
setSendDatetime()  : $this
setSent()  : $this
setStopped()  : $this
setSubject()  : $this
setTo()  : $this
getTraitsRecursive()  : array<string, string>
Walks the trait list recursively and collects nested traits too.

Properties

$attempts

protected int $attempts = 0
Attributes
#[Column]
$name: 'attempts'
$type: 'integer'
$options: ['unsigned' => true, 'default' => 0]

$body

protected string|null $body = null
Attributes
#[Column]
$name: 'body'
$type: 'text'
$length: 16777215
$nullable: true

$errorLog

protected string|null $errorLog = null
Attributes
#[Column]
$name: 'error_log'
$type: 'text'
$nullable: true

$files

protected string|null $files = null
Attributes
#[Column]
$name: 'files'
$type: 'text'
$nullable: true

$from

protected string $from = ''
Attributes
#[Column]
$name: '`from`'
$type: 'string'
$length: 255

$id

protected int|null $id = null
Attributes
#[Column]
$name: 'email_id'
$type: 'bigint'
#[GeneratedValue]
$strategy: 'AUTO'
#[Id]

$insertDatetime

protected DateTime|null $insertDatetime = null
Attributes
#[Column]
$name: 'insert_datetime'
$type: 'datetime'
#[ExternalReadonly]

$preferred

protected bool $preferred = false
Attributes
#[Column]
$name: 'preferred'
$type: 'boolean'

$replyTos

protected string|null $replyTos = null
Attributes
#[Column]
$name: 'reply_tos'
$type: 'text'
$nullable: true

$sendDatetime

protected DateTime|null $sendDatetime = null
Attributes
#[Column]
$name: 'send_datetime'
$type: 'datetime'
$nullable: true
#[ExternalReadonly]

$sent

protected bool $sent = false
Attributes
#[Column]
$name: 'sent'
$type: 'boolean'

$stopped

protected bool $stopped = false
Attributes
#[Column]
$name: 'stopped'
$type: 'boolean'

$subject

protected string|null $subject = null
Attributes
#[Column]
$name: 'subject'
$type: 'string'
$length: 255
$nullable: true

$to

protected string $to = ''
Attributes
#[Column]
$name: '`to`'
$type: 'string'
$length: 255

$unpreferred

protected bool $unpreferred = true
Attributes
#[Column]
$name: 'unpreferred'
$type: 'boolean'
$insertable: false
$updatable: false

Methods

__construct()

public __construct([int|null $id = null ][, mixed $newsletter = null ][, string $to = '' ][, string $from = '' ][, string|null $subject = null ][, string|null $body = null ][, bool $sent = false ][, DateTime|null $sendDatetime = null ][, string|null $errorLog = null ][, bool $preferred = false ][, bool $stopped = false ][, int $attempts = 0 ][, bool $unpreferred = true ][, DateTime|null $insertDatetime = null ][, string|null $replyTos = null ][, string|null $files = null ]) : mixed
Parameters
$id : int|null = null
$newsletter : mixed = null
$to : string = ''
$from : string = ''
$subject : string|null = null
$body : string|null = null
$sent : bool = false
$sendDatetime : DateTime|null = null
$errorLog : string|null = null
$preferred : bool = false
$stopped : bool = false
$attempts : int = 0
$unpreferred : bool = true
$insertDatetime : DateTime|null = null
$replyTos : string|null = null
$files : string|null = null

callInitMethods()

Calls `init{TraitName}()` for every used trait that defines such a method.

public callInitMethods() : void

getAllTraits()

Returns all traits the class uses, including those used by parent classes and nested traits.

public getAllTraits() : array<string, string>
Return values
array<string, string>

getAttempts()

public getAttempts() : int
Return values
int

getBody()

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

getErrorLog()

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

getFiles()

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

getFilesUnserialized()

public getFilesUnserialized() : array<int, File>
Return values
array<int, File>

getFrom()

public getFrom() : string
Return values
string

getInsertDatetime()

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

getNewsletter()

public getNewsletter() : TNewsletter|null
Return values
TNewsletter|null

getReplyTos()

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

getReplyTosUnserialized()

public getReplyTosUnserialized() : array<int, string>
Return values
array<int, string>

getSendDatetime()

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

getSubject()

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

getTo()

public getTo() : string
Return values
string

incrementAttempts()

public incrementAttempts() : $this
Return values
$this

isPreferred()

public isPreferred() : bool
Return values
bool

isSent()

public isSent() : bool
Return values
bool

isStopped()

public isStopped() : bool
Return values
bool

isUnpreferred()

public isUnpreferred() : bool
Return values
bool

setAttempts()

public setAttempts(int $attempts) : $this
Parameters
$attempts : int
Return values
$this

setBody()

public setBody(string|null $body) : $this
Parameters
$body : string|null
Return values
$this

setErrorLog()

public setErrorLog(string|null $errorLog) : $this
Parameters
$errorLog : string|null
Return values
$this

setFiles()

public setFiles(string|null $files) : $this
Parameters
$files : string|null
Return values
$this

setFrom()

public setFrom(string $from) : $this
Parameters
$from : string
Return values
$this

setId()

public setId(int|null $id) : $this
Parameters
$id : int|null
Return values
$this

setInsertDatetime()

public setInsertDatetime(DateTime $insertDatetime) : $this
Parameters
$insertDatetime : DateTime
Return values
$this

setNewsletter()

public setNewsletter(TNewsletter|null $newsletter) : $this
Parameters
$newsletter : TNewsletter|null
Return values
$this

setPreferred()

public setPreferred(bool $preferred) : $this
Parameters
$preferred : bool
Return values
$this

setReplyTos()

public setReplyTos(string|null $replyTos) : $this
Parameters
$replyTos : string|null
Return values
$this

setSendDatetime()

public setSendDatetime(DateTime|null $sendDatetime) : $this
Parameters
$sendDatetime : DateTime|null
Return values
$this

setSent()

public setSent(bool $sent) : $this
Parameters
$sent : bool
Return values
$this

setStopped()

public setStopped(bool $stopped) : $this
Parameters
$stopped : bool
Return values
$this

setSubject()

public setSubject(string|null $subject) : $this
Parameters
$subject : string|null
Return values
$this

setTo()

public setTo(string $to) : $this
Parameters
$to : string
Return values
$this

getTraitsRecursive()

Walks the trait list recursively and collects nested traits too.

private static getTraitsRecursive(array<string, string> $traits) : array<string, string>
Parameters
$traits : array<string, string>
Return values
array<string, string>
On this page

Search results