PHP Класс Pimcore\Tool\Newsletter

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство	Тип	Описание
$class	Pimcore\Model\Object\ClassDefinition

Открытые методы

Метод	Описание
__construct ( null $classId = null )
addNoteOnObject ( $object, $title )
checkParams ( array $params ) : boolean
confirm ( string $token ) : boolean
getClass ( ) : ClassDefinition
getObjectByToken ( $token ) : boolean
isEmailExists ( array $params ) : boolean	Checks if e-mail address already exists in the database.
prepareMail ( Newsletter $newsletterDocument, SendingParamContainer $sendingContainer = null, string \| null $hostUrl = null ) : Mail
sendConfirmationMail ( $object, $mailDocument, array $params = [] )
sendMail ( Pimcore\Model\Tool\Newsletter\Config $newsletter, Concrete $object, $emailAddress = null, $hostUrl = null )
sendNewsletterDocumentBasedMail ( Mail $mail, SendingParamContainer $sendingContainer )
setClass ( ClassDefinition $class )
subscribe ( $params ) : mixed
unsubscribe ( $object ) : boolean
unsubscribeByEmail ( string $email ) : boolean
unsubscribeByToken ( string $token ) : boolean

Защищенные методы

Метод	Описание
getClassName ( ) : string
obfuscateEmail ( $email )

Описание методов

__construct() публичный Метод

public __construct ( null $classId = null )
$classId	null

addNoteOnObject() публичный Метод

public addNoteOnObject ( $object, $title )
$object
$title

checkParams() публичный Метод

public checkParams ( array $params ) : boolean
$params	array
Результат	boolean

confirm() публичный Метод

public confirm ( string $token ) : boolean
$token	string
Результат	boolean

getClass() публичный Метод

public getClass ( ) : ClassDefinition
Результат	Pimcore\Model\Object\ClassDefinition

getClassName() защищенный Метод

protected getClassName ( ) : string
Результат	string

getObjectByToken() публичный Метод

public getObjectByToken ( $token ) : boolean
$token
Результат	boolean

isEmailExists() публичный Метод

Checks if e-mail address already exists in the database.

public isEmailExists ( array $params ) : boolean
$params	array
Результат	boolean

obfuscateEmail() защищенный статический Метод

protected static obfuscateEmail ( $email )

prepareMail() публичный статический Метод

public static prepareMail ( Newsletter $newsletterDocument, SendingParamContainer $sendingContainer = null, string \| null $hostUrl = null ) : Mail
$newsletterDocument	Pimcore\Model\Document\Newsletter
$sendingContainer	Pimcore\Document\Newsletter\SendingParamContainer
$hostUrl	string \| null
Результат	Pimcore\Mail

sendConfirmationMail() публичный Метод

public sendConfirmationMail ( $object, $mailDocument, array $params = [] )
$object
$mailDocument
$params	array

sendMail() публичный статический Метод

public static sendMail ( Pimcore\Model\Tool\Newsletter\Config $newsletter, Concrete $object, $emailAddress = null, $hostUrl = null )
$newsletter	Pimcore\Model\Tool\Newsletter\Config
$object	Pimcore\Model\Object\Concrete

sendNewsletterDocumentBasedMail() публичный статический Метод

public static sendNewsletterDocumentBasedMail ( Mail $mail, SendingParamContainer $sendingContainer )
$mail	Pimcore\Mail
$sendingContainer	Pimcore\Document\Newsletter\SendingParamContainer

setClass() публичный Метод

public setClass ( ClassDefinition $class )
$class	Pimcore\Model\Object\ClassDefinition

unsubscribe() публичный Метод

public unsubscribe ( $object ) : boolean
$object
Результат	boolean

unsubscribeByEmail() публичный Метод

public unsubscribeByEmail ( string $email ) : boolean
$email	string
Результат	boolean

unsubscribeByToken() публичный Метод

public unsubscribeByToken ( string $token ) : boolean
$token	string
Результат	boolean

Описание свойств

$class защищенное свойство

protected ClassDefinition,Pimcore\Model\Object $class
Результат	Pimcore\Model\Object\ClassDefinition