Class EmailRepository

Handles the database operations that concern the email records of the database. It provides a layer for more complicated methods that use the writer, reader and deleter.

EmailRepository implements EmailRepositoryInterface

Package: Email\Repository
Category: System
Located at Services/System/Email/Repositories/EmailRepository.inc.php

Methods summary


				
				 public 
				
				

				__construct( EmailWriterInterface $writer, EmailReaderInterface $reader, EmailDeleterInterface $deleter )

Class Constructor


				
				 public 
				
				

				write( EmailInterface $email )

Writes an email record into the database.


				
				 public 
				
				

				getById( IdType $id )
				

				: EmailInterface

Returns an email record by ID.

Parameters

$id: Database ID of the record to be returned.

Returns

EmailInterface
Returns the email object that matches the ID.

Throws

UnexpectedValueException
If record does not exist.

Implementation of

EmailRepositoryInterface::getById()


				
				 public 
				
				

				findById( IdType $id )
				

				: EmailInterface|null

Find email by ID

This method will try to find the email record that matches provided ID and will return NULL on when the record does not exist.

Parameters

$id: Email record id to be found.

Returns

EmailInterface|null
Returns email object or null on failure.

Implementation of

EmailRepositoryInterface::findById()


				
				 public 
				
				

				getPending( void )
				

				: EmailCollection

Returns a collection of pending emails.


				
				 public 
				
				

				getSent( void )
				

				: EmailCollection

Returns a collection of sent emails.


				
				 public 
				
				

				getAll( void )
				

				: EmailCollection

Returns all email records from the database.


				
				 public 
				
				

				delete( EmailInterface $email )

Removes all information of an email record from the database.

This method will remove ALL the email information, from the tables that contain information about the specified email.

Parameters

$email: Contains the email information.

Implementation of

EmailRepositoryInterface::delete()


				
				 public 
				
				

				filter( string $p_keyword, array $limit = array(), array $order = array() )
				

				: EmailCollection

Filter email records with provided keyword string.

Parameters

$p_keyword: String to be used for filtering the email records.
$limit: (optional) Array that contains LIMIT and OFFSET value e.g. array( 'limit' => 10, 'offset' => 5 )
$order: (optional) Contains arrays with column, direction pairs e.g. array( 'column' => 'direction' )

Returns

EmailCollection
Returns a collection containing the email records.

Implementation of

EmailRepositoryInterface::filter()


				
				 public 
				
				

				getRecordCount( string $p_filterKeyword = '' )
				

				: integer

Get the current count of the email records in the database.

Parameters

$p_filterKeyword: (optional) If provided the records will be filtered.

Returns

integer
Returns the row number of the email table.

Implementation of

EmailRepositoryInterface::getRecordCount()


				
				 public 
				
				

				deleteEmailsByEmailAddress( CustomerEmail $email )

Removes all emails from the data base that have the given email address as sender or recipient.


				
				 public 
				
				

				getEmailsByEmailAddress( CustomerEmail $email )
				

				: EmailCollection

Gets all emails from the data base that have the given email address as sender or recipient.

Properties summary


				
				protected  
				

				
					$writer
				

				: EmailWriterInterface

E-Mail writer.


				
				protected  
				

				
					$reader
				

				: EmailReaderInterface

E-Mail reader.


				
				protected  
				

				
					$deleter
				

				: EmailDeleterInterface

E-Mail deleter.