PHP Class Pimcore\Document\Newsletter\AddressSourceAdapter\DefaultAdapter

Inheritance: implements Pimcore\Document\Newsletter\AddressSourceAdapterInterface
Show file Open project: pimcore/pimcore

Protected Properties

Property Type Description
$class string
$condition string
$elementsTotal integer
$list Pimcore\Model\Object\Listing
$personas int[]

Public Methods

Method Description
__construct ( $params ) IAddressSourceAdapter constructor.
getMailAddressesForBatchSending ( ) : SendingParamContainer[] returns array of email addresses for batch sending
getParamsForSingleSending ( $limit, $offset ) : SendingParamContainer[] returns array of params to be set on mail for single sending
getParamsForTestSending ( string $emailAddress ) : SendingParamContainer returns params to be set on mail for test sending
getTotalRecordCount ( ) : integer returns total number of newsletter recipients

Protected Methods

Method Description
getListing ( ) : Listing

Method Details

__construct() public method

IAddressSourceAdapter constructor.
public __construct ( $params )
$params

getListing() protected method

protected getListing ( ) : Listing
return Pimcore\Model\Object\Listing

getMailAddressesForBatchSending() public method

returns array of email addresses for batch sending
public getMailAddressesForBatchSending ( ) : SendingParamContainer[]
return Pimcore\Document\Newsletter\SendingParamContainer[]

getParamsForSingleSending() public method

returns array of params to be set on mail for single sending
public getParamsForSingleSending ( $limit, $offset ) : SendingParamContainer[]
$limit
$offset
return Pimcore\Document\Newsletter\SendingParamContainer[]

getParamsForTestSending() public method

returns params to be set on mail for test sending
public getParamsForTestSending ( string $emailAddress ) : SendingParamContainer
$emailAddress string
return Pimcore\Document\Newsletter\SendingParamContainer

getTotalRecordCount() public method

returns total number of newsletter recipients
public getTotalRecordCount ( ) : integer
return integer

Property Details

$class protected property

protected string $class
return string

$condition protected property

protected string $condition
return string

$elementsTotal protected property

protected int $elementsTotal
return integer

$list protected property

protected Listing,Pimcore\Model\Object $list
return Pimcore\Model\Object\Listing

$personas protected property

protected int[] $personas
return int[]