class Log extends AbstractModel (View source)

Properties

protected AbstractDao $dao from AbstractModel
int $id EmailLog Id
int $documentId Id of the email document or null if no document was given
array $params Parameters passed for replacement
int $modificationDate Modification date as timestamp
string $requestUri The request URI from were the email was sent
string $from The "from" email address
string $replyTo Contains the reply to email addresses (multiple recipients are separated by a ",")
string $to The "to" recipients (multiple recipients are separated by a ",")
string $cc The carbon copy recipients (multiple recipients are separated by a ",")
string $bcc The blind carbon copy recipients (multiple recipients are separated by a ",")
int $emailLogExistsHtml Contains 1 if a html logfile exists and 0 if no html logfile exists
int $emailLogExistsText Contains 1 if a text logfile exists and 0 if no text logfile exists
int $sentDate Contains the timestamp when the email was sent
string $bodyHtml Contains the rendered html content of the email
string $bodyText Contains the rendered text content of the email
string $subject Contains the rendered subject of the email

Methods

Dao
getDao()

No description

setDao($dao)

No description

getResource() deprecated

No description

initDao(null $key = null, bool $forceDetection = false)

No description

static string|null
locateDaoClass(string $modelClass)

No description

$this
setValues(array $data = [])

No description

$this
setValue($key, $value)

No description

array
__sleep()

No description

mixed
__call($method, $args)

No description

__clone()

No description

array
getObjectVars()

returns object values without the dao

array
__debugInfo()

No description

void
beginTransaction()

No description

void
commit()

No description

void
rollBack()

No description

void
configure()

No description

array
getValidTableColumns(string $table, bool $cache)

No description

void
resetValidTableColumnsCache(string $table)

No description

$this
setDocumentId($id)

No description

$this
setRequestUri($requestUri)

No description

string
getRequestUri()

Returns the request uri

int
getId()

Returns the email log id

$this
setId($id)

No description

$this
setSubject($subject)

No description

string
getSubject()

Returns the subject

static Log|null
getById(int $id)

Returns the EmailLog entry by the given id

int|null
getDocumentId()

Returns the email document id

$this
setParams($params)

No description

string
getParams()

Returns the dynamic parameter

$this
setModificationDate(int $modificationDate)

Sets the modification date

int
getModificationDate()

Returns the modification date

$this
setSentDate(int $sentDate)

Sets the sent date and time

int
getSentDate()

Returns the sent date and time as unix timestamp

setEmailLogExistsHtml()

Checks if a html log file exits and sets $this->emailLogExistsHtml to 0 or 1

int
getEmailLogExistsHtml()

Returns 1 if a html email log file exists and 0 if no html log file exists

setEmailLogExistsText()

Checks if a text log file exits and sets $this->emailLogExistsText to 0 or 1

int
getEmailLogExistsText()

Returns 1 if a text email log file exists and 0 if no text log file exists

string
getHtmlLog()

Returns the content of the html log file

string
getTextLog()

Returns the content of the text log file

delete()

Removes the log file entry from the db and removes the log files on the system

$this
setCreationDate(int $creationDate)

Sets the creation date (unix timestamp)

int
getCreationDate()

Returns the creation date as unix timestamp

save()

Saves the email log entry (forwards to $this->update())

update()

Updates and save the email log entry to the db and the file-system

$this
setTo($to)

No description

string
getTo()

Returns the "to" recipients

array
getToAsArray()

Returns the "to" recipients as array

$this
setCc($cc)

No description

string
getCc()

Returns the carbon copy recipients

array
getCcAsArray()

Returns the carbon copy recipients as array

$this
setBcc($bcc)

No description

string
getBcc()

Returns the blind carbon copy recipients

array
getBccAsArray()

Returns the blind carbon copy recipients as array

$this
setFrom($from)

No description

string
getFrom()

Returns the "from" email address

$this
setReplyTo($replyTo)

No description

string
getReplyTo()

Returns the "replyTo" email address

array
getReplyToAsArray()

Returns the "replyTo" email addresses as array

$this
setBodyHtml($html)

No description

string
getBodyHtml()

returns the html content of the email

$this
setBodyText($text)

No description

string
getBodyText()

Returns the text version of the email

array
buildArray($data)

Helper to get the recipients as array

Details

Dao getDao()

Return Value

Dao

AbstractModel setDao($dao)

Parameters

$dao

Return Value

AbstractModel

AbstractDao getResource() deprecated

deprecated

Return Value

AbstractDao

initDao(null $key = null, bool $forceDetection = false)

Parameters

null $key
bool $forceDetection

Exceptions

Exception

static string|null locateDaoClass(string $modelClass)

Parameters

string $modelClass

Return Value

string|null

$this setValues(array $data = [])

Parameters

array $data

Return Value

$this

$this setValue($key, $value)

Parameters

$key
$value

Return Value

$this

array __sleep()

Return Value

array

mixed __call($method, $args)

Parameters

$method
$args

Return Value

mixed

Exceptions

Exception

__clone()

array getObjectVars()

returns object values without the dao

Return Value

array

array __debugInfo()

Return Value

array

void beginTransaction()

Return Value

void

void commit()

Return Value

void

void rollBack()

Return Value

void

void configure()

Return Value

void

array getValidTableColumns(string $table, bool $cache)

Parameters

string $table
bool $cache

Return Value

array

void resetValidTableColumnsCache(string $table)

Parameters

string $table

Return Value

void

$this setDocumentId($id)

Parameters

$id

Return Value

$this

$this setRequestUri($requestUri)

Parameters

$requestUri

Return Value

$this

string getRequestUri()

Returns the request uri

Return Value

string

int getId()

Returns the email log id

Return Value

int

$this setId($id)

Parameters

$id

Return Value

$this

$this setSubject($subject)

Parameters

$subject

Return Value

$this

string getSubject()

Returns the subject

Return Value

string

static Log|null getById(int $id)

Returns the EmailLog entry by the given id

Parameters

int $id

Return Value

Log|null

int|null getDocumentId()

Returns the email document id

Return Value

int|null

$this setParams($params)

Parameters

$params

Return Value

$this

string getParams()

Returns the dynamic parameter

Return Value

string

$this setModificationDate(int $modificationDate)

Sets the modification date

Parameters

int $modificationDate

Return Value

$this

int getModificationDate()

Returns the modification date

Return Value

int
  • Timestamp

$this setSentDate(int $sentDate)

Sets the sent date and time

Parameters

int $sentDate
  • Timestamp

Return Value

$this

int getSentDate()

Returns the sent date and time as unix timestamp

Return Value

int

setEmailLogExistsHtml()

Checks if a html log file exits and sets $this->emailLogExistsHtml to 0 or 1

int getEmailLogExistsHtml()

Returns 1 if a html email log file exists and 0 if no html log file exists

Return Value

int
  • 0 or 1

setEmailLogExistsText()

Checks if a text log file exits and sets $this->emailLogExistsText to 0 or 1

int getEmailLogExistsText()

Returns 1 if a text email log file exists and 0 if no text log file exists

Return Value

int
  • 0 or 1

string getHtmlLog()

Returns the content of the html log file

Return Value

string | false

string getTextLog()

Returns the content of the text log file

Return Value

string | false

delete()

Removes the log file entry from the db and removes the log files on the system

$this setCreationDate(int $creationDate)

Sets the creation date (unix timestamp)

Parameters

int $creationDate

Return Value

$this

int getCreationDate()

Returns the creation date as unix timestamp

Return Value

int

save()

Saves the email log entry (forwards to $this->update())

protected update()

Updates and save the email log entry to the db and the file-system

$this setTo($to)

Parameters

$to

Return Value

$this

string getTo()

Returns the "to" recipients

Return Value

string

array getToAsArray()

Returns the "to" recipients as array

Return Value

array

$this setCc($cc)

Parameters

$cc

Return Value

$this

string getCc()

Returns the carbon copy recipients

Return Value

string

array getCcAsArray()

Returns the carbon copy recipients as array

Return Value

array

$this setBcc($bcc)

Parameters

$bcc

Return Value

$this

string getBcc()

Returns the blind carbon copy recipients

Return Value

string

array getBccAsArray()

Returns the blind carbon copy recipients as array

Return Value

array

$this setFrom($from)

Parameters

$from

Return Value

$this

string getFrom()

Returns the "from" email address

Return Value

string

$this setReplyTo($replyTo)

Parameters

$replyTo

Return Value

$this

string getReplyTo()

Returns the "replyTo" email address

Return Value

string

array getReplyToAsArray()

Returns the "replyTo" email addresses as array

Return Value

array

$this setBodyHtml($html)

Parameters

$html

Return Value

$this

string getBodyHtml()

returns the html content of the email

Return Value

string | null

$this setBodyText($text)

Parameters

$text

Return Value

$this

string getBodyText()

Returns the text version of the email

Return Value

string

protected array buildArray($data)

Helper to get the recipients as array

Parameters

$data

Return Value

array