| Property | Type | Description | |
|---|---|---|---|
| $description | Description | ||
| $name | Name of this integration. | ||
| $options | Array of settings | ||
| $slug | Slug, used as an unique identifier for this integration. |
| Property | Type | Description | |
|---|---|---|---|
| $checkbox_name | Name attribute for the checkbox element. Will be created from slug if empty. |
| Method | Description | |
|---|---|---|
| __construct ( string $slug, array $options ) | Constructor | |
| checkbox_was_checked ( ) : boolean | Was the integration checkbox checked? | |
| get_checkbox_html ( ) : string | Get HTML for the checkbox | |
| get_data ( ) : array | Get the data for this integration request | |
| get_label_text ( ) : string | Get the text for the label element | |
| get_lists ( ) : array | Get the selected MailChimp lists | |
| get_object_link ( integer $object_id ) : string | Return a string to the admin settings page for this object (if any) | |
| get_ui_elements ( ) : array | Which UI elements should we show on the settings page for this integration? | |
| has_ui_element ( $element ) : boolean | Does integration have the given UI element? | |
| initialize ( ) | Initialize the integration | |
| is_installed ( ) : boolean | Are the required dependencies for this integration installed? | |
| output_checkbox ( ) | Outputs a checkbox | |
| print_css_reset ( ) | Print CSS reset | |
| triggered ( integer $object_id = null ) : boolean | Was integration triggered? |
| Method | Description | |
|---|---|---|
| add_hooks ( ) | Adds the hooks which are specific to this integration | |
| add_required_hooks ( ) | Adds the required hooks for core functionality, like adding checkbox reset CSS. | |
| get_api ( ) : MC4WP_API_v3 | ||
| get_checkbox_attributes ( ) : string | Get a string of attributes for the checkbox element. | |
| get_default_options ( ) : array | Return array of default options | |
| get_log ( ) : MC4WP_Debug_Log | ||
| get_request ( ) : MC4WP_Request | ||
| parse_options ( array $options ) : array | ||
| subscribe ( array $data, integer $related_object_id ) : boolean | Makes a subscription request |
| public __construct ( string $slug, array $options ) | ||
| $slug | string | |
| $options | array | |
| abstract protected add_hooks ( ) |
| protected add_required_hooks ( ) |
| public checkbox_was_checked ( ) : boolean | ||
| return | boolean | |
| protected get_checkbox_attributes ( ) : string | ||
| return | string | |
| public get_checkbox_html ( ) : string | ||
| return | string | |
| protected get_default_options ( ) : array | ||
| return | array | |
| public get_label_text ( ) : string | ||
| return | string | |
| public get_object_link ( integer $object_id ) : string | ||
| $object_id | integer | |
| return | string | |
| public get_ui_elements ( ) : array | ||
| return | array | |
| public has_ui_element ( $element ) : boolean | ||
| $element | ||
| return | boolean | |
| public is_installed ( ) : boolean | ||
| return | boolean | |
| protected parse_options ( array $options ) : array | ||
| $options | array | |
| return | array | |
| protected $checkbox_name |