\Vision6SubscribeField
Class Vision6SubscribeField
This field is decoupled and can be used independently in any form
- Author: Reece Alexander <reece@steadlane.com.au>
Synopsis
class Vision6SubscribeField
extends CheckboxField
{
- // members
- protected $listId;
- protected $emailFieldName;
- protected bool $gracefulReject = false;
- // methods
- public array getAttributes()
- public $this setListId()
- public $this setEmailFieldName()
- public $this setGracefulReject()
- public bool validate()
Hierarchy
Extends
- CheckboxField
Members
protected
- $emailFieldName — string
- $gracefulReject — bool
- $listId — int
Methods
public
- getAttributes()
- setEmailFieldName() — Sets the field name that should be holding the email address, this field can be hidden but must exist
- setGracefulReject() — If the email address is already subscribed, the user will be returned to the form with an error message, to gracefully allow subscriptions to fail (where could be semantically desired) set this to true
- setListId() — Set the list ID that the email will be subscribed too
- validate()