PHP 클래스 Pimcore\Tool\Newsletter

파일 보기 프로젝트 열기: pimcore/pimcore 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$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

subscribe() 공개 메소드

public subscribe ( $params ) : mixed
$params
리턴 mixed

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