Docs For Class SGL_Emailer_Queue

Description

Base class for all containers.

author: Dmitri Lakachauskis <lakiboy83@gmail.com>
abstract:

Located in /SGL/Emailer/Queue/Container.php (line 9)

Direct descendents

Class	Description
SGL_Emailer_Queue_Container_Db	PEAR::DB container for SGL_Emailer_Queue.

Variable Summary

DB_Result $_preloadResult

Method Summary

SGL_Emailer_Queue_Container factory (string $containerName)

object fetch ()

void identifyEmail (object $email)

void increaseAttemptCount (integer $id)

boolean isPreloaded ()

void markAsSent (integer $id)

void preload ([integer $limit = null], [integer $attempts = null], [string $deliveryDate = null], [array $aParams = null])

void push (string $headers, string $recipient, string $body, string $subject, string $dateToSend, integer $groupId, integer $batchId, integer $userId)

void remove (integer $emailId)

Variables

DB_Result $_preloadResult = null (line 16)

Stores current result set pointer.

access: protected

Methods

factory (line 25)

Returns container.

access: public

SGL_Emailer_Queue_Container factory (string $containerName)

string $containerName

fetch (line 142)

Gets next email from preload queue.

access: public

object fetch ()

identifyEmail (line 121)

Retuns email identification string.

access: public

void identifyEmail (object $email)

object $email

Redefined in descendants as:

SGL_Emailer_Queue_Container_Db::identifyEmail() : Retuns email ID.

increaseAttemptCount (line 109)

Increses attempt count.

access: public

void increaseAttemptCount (integer $id)

integer $id

Redefined in descendants as:

SGL_Emailer_Queue_Container_Db::increaseAttemptCount() : Increses attempt count.

isPreloaded (line 131)

Checks if queue is preloaded.

access: public

boolean isPreloaded ()

markAsSent (line 97)

Marks email as sent.

access: public

void markAsSent (integer $id)

integer $id

Redefined in descendants as:

SGL_Emailer_Queue_Container_Db::markAsSent() : Marks email as sent.

preload (line 84)

Preloads emails from queue.

access: public

void preload ([integer $limit = null], [integer $attempts = null], [string $deliveryDate = null], [array $aParams = null])

integer $limit
integer $attempts
string $deliveryDate
array $aParams

Redefined in descendants as:

SGL_Emailer_Queue_Container_Db::preload() : Preloads emails from database.

push (line 56)

Puts email to queue.

access: public

void push (string $headers, string $recipient, string $body, string $subject, string $dateToSend, integer $groupId, integer $batchId, integer $userId)

string $headers
string $recipient
string $body
string $subject
string $dateToSend
integer $groupId
integer $batchId
integer $userId

Redefined in descendants as:

SGL_Emailer_Queue_Container_Db::push() : Put new email to database.

remove (line 69)

Removes email from queue.

access: public

void remove (integer $emailId)

integer $emailId

Redefined in descendants as:

SGL_Emailer_Queue_Container_Db::remove() : Removes email from database.