ProMailerForms class

Copyright 2019 by Ryan Cramer

This is a commercial module, do not distribute.

HOOKABLE PUBLIC API METHODS

HOOKABLE INTERNAL API METHODS

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the ProMailerForms class also inherits all the methods and properties of: ProMailerTypeManager and Wire.

Show class?     Show args?       Only hookable?    

Common

NameReturnSummary 
ProMailerForms::checkConfirmEmail()
ProMailerSubscriber bool null

Check if current request is for a subscribe confirmation and confirm email when applicable

ProMailerForms::getSubscribePage()
Page NullPage

Get the ProMailer page that handles subscribe and unsubscribe

ProMailerForms::getSubscribeUrl()
string

Get URL to subscribe to given list

ProMailerForms::getUnsubscribeField(ProMailerList $list)
Field null

Get the Field that has a non-zero value if user is unsubscribed from a pages list

ProMailerForms::getUnsubscribeUrl(ProMailerSubscriber $subscriber)
string

Return URL to an unsubscribe form

ProMailerForms::install()
None 
ProMailerForms::processSubscribe($listId, array $options)
arrayProcess subscribe form, called automatically by renderSubscribeForm().
ProMailerForms::renderConfirmEmail($type)
stringFallback method to render confirm email if content not provided to confirm().
ProMailerForms::renderSubscribeForm()
string

@param array $options

 
ProMailerForms::renderUnsubscribeForm()
string

@param array $options

 
ProMailerForms::sendConfirmEmail(ProMailerSubscriber $subscriber)
bool

Send confirmation email to subscriber

ProMailerForms::subscribe()
string

Render, process and email-confirm a subscription

ProMailerForms::table()
None 
ProMailerForms::typeName()
None 
ProMailerForms::uninstall()
None 
ProMailerForms::unsubscribe()
string

Render or process an un-subscribe form at URL clicked from an email

ProMailerForms::wrapOutput(string $out)
string

Wrap given output

Properties

NameReturnSummary 
ProMailerForms::subscribeOptions array 
ProMailerForms::subscribePage Page 
ProMailerForms::subscribeUrl string 
ProMailerForms::unsubscribeOptions array 

Additional methods and properties

In addition to the methods and properties above, ProMailerForms also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.252