Class SGL_Emailer_Queue_Container_Db

Description
Description | Vars (details) | Methods (details)

PEAR::DB container for SGL_Emailer_Queue.

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

SGL_Emailer_Queue_Container
   |
   --SGL_Emailer_Queue_Container_Db
Variable Summary
Description | Vars (details) | Methods (details)
DB_Common $_dbh
Method Summary
Description | Vars (details) | Methods (details)
SGL_Emailer_Queue_Container_Db SGL_Emailer_Queue_Container_Db ()
integer identifyEmail (object $email)
DB_OK increaseAttemptCount (unknown_type $emailId)
DB_OK markAsSent (integer $emailId)
void preload ([integer $limit = null], [integer $attempts = null], [string $dateToSent = null], [array $aParams = null])
DB_OK push (string $headers, string $recipient, string $body, string $subject, string $dateToSend, string $groupId, integer $batchId, integer $userId)
DB_OK remove (integer $emailId)
Variables
Description | Vars (details) | Methods (details)
DB_Common $_dbh (line 16)

PEAR_DB ref.

  • access: private

Inherited Variables

Inherited from SGL_Emailer_Queue_Container

SGL_Emailer_Queue_Container::$_preloadResult
Methods
Description | Vars (details) Methods (details)
Constructor SGL_Emailer_Queue_Container_Db (line 23)

Constructor.

  • access: public
SGL_Emailer_Queue_Container_Db SGL_Emailer_Queue_Container_Db ()
identifyEmail (line 166)

Retuns email ID.

  • access: public
integer identifyEmail (object $email)
  • object $email
Redefinition of:
SGL_Emailer_Queue_Container::identifyEmail()
Retuns email identification string.
increaseAttemptCount (line 100)

Increses attempt count.

  • access: public
DB_OK increaseAttemptCount (unknown_type $emailId)
  • unknown_type $emailId
Redefinition of:
SGL_Emailer_Queue_Container::increaseAttemptCount()
Increses attempt count.
markAsSent (line 85)

Marks email as sent.

  • access: public
DB_OK markAsSent (integer $emailId)
  • integer $emailId
Redefinition of:
SGL_Emailer_Queue_Container::markAsSent()
Marks email as sent.
preload (line 118)

Preloads emails from database.

  • access: public
void preload ([integer $limit = null], [integer $attempts = null], [string $dateToSent = null], [array $aParams = null])
  • integer $limit
  • integer $attempts
  • string $dateToSent
  • array $aParams
Redefinition of:
SGL_Emailer_Queue_Container::preload()
Preloads emails from queue.
push (line 42)

Put new email to database.

  • access: public
DB_OK push (string $headers, string $recipient, string $body, string $subject, string $dateToSend, string $groupId, integer $batchId, integer $userId)
  • string $headers
  • string $recipient
  • string $body
  • string $subject
  • string $dateToSend
  • string $groupId
  • integer $batchId
  • integer $userId
Redefinition of:
SGL_Emailer_Queue_Container::push()
Puts email to queue.
remove (line 70)

Removes email from database.

  • access: public
DB_OK remove (integer $emailId)
  • integer $emailId
Redefinition of:
SGL_Emailer_Queue_Container::remove()
Removes email from queue.

Inherited Methods

Inherited From SGL_Emailer_Queue_Container

SGL_Emailer_Queue_Container::factory()
SGL_Emailer_Queue_Container::fetch()
SGL_Emailer_Queue_Container::identifyEmail()
SGL_Emailer_Queue_Container::increaseAttemptCount()
SGL_Emailer_Queue_Container::isPreloaded()
SGL_Emailer_Queue_Container::markAsSent()
SGL_Emailer_Queue_Container::preload()
SGL_Emailer_Queue_Container::push()
SGL_Emailer_Queue_Container::remove()

Documentation generated on Tue, 23 Feb 2010 18:14:29 +0000 by phpDocumentor 1.4.3