PHP Класс MC4WP_Integration

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

Открытые свойства

Свойство Тип Описание
$description Description
$name Name of this integration.
$options Array of settings
$slug Slug, used as an unique identifier for this integration.

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

Свойство Тип Описание
$checkbox_name Name attribute for the checkbox element. Will be created from slug if empty.

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

Метод Описание
__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?

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

Метод Описание
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

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

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

Constructor
public __construct ( string $slug, array $options )
$slug string
$options array

add_hooks() абстрактный защищенный Метод

Adds the hooks which are specific to this integration
abstract protected add_hooks ( )

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

Adds the required hooks for core functionality, like adding checkbox reset CSS.
protected add_required_hooks ( )

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

Was the integration checkbox checked?
public checkbox_was_checked ( ) : boolean
Результат boolean

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

protected get_api ( ) : MC4WP_API_v3
Результат MC4WP_API_v3

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

Get a string of attributes for the checkbox element.
protected get_checkbox_attributes ( ) : string
Результат string

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

Get HTML for the checkbox
public get_checkbox_html ( ) : string
Результат string

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

By default, this will return a combination of all $_GET and $_POST parameters. Override this method if you need data from somewhere else. This data should contain the value of the checkbox (required) and the lists to which should be subscribed (optional)
См. также: MC4WP_Integration::$checkbox_name
См. также: MC4WP_Integration::get_lists
См. также: MC4WP_Integration::checkbox_was_checked
public get_data ( ) : array
Результат array

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

Return array of default options
protected get_default_options ( ) : array
Результат array

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

Get the text for the label element
public get_label_text ( ) : string
Результат string

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

Get the selected MailChimp lists
public get_lists ( ) : array
Результат array Array of List ID's

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

protected get_log ( ) : MC4WP_Debug_Log
Результат MC4WP_Debug_Log

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

protected get_request ( ) : MC4WP_Request
Результат MC4WP_Request

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

Which UI elements should we show on the settings page for this integration?
public get_ui_elements ( ) : array
Результат array

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

Does integration have the given UI element?
public has_ui_element ( $element ) : boolean
$element
Результат boolean

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

Initialize the integration
public initialize ( )

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

Are the required dependencies for this integration installed?
public is_installed ( ) : boolean
Результат boolean

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

Outputs a checkbox
public output_checkbox ( )

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

protected parse_options ( array $options ) : array
$options array
Результат array

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

Print CSS reset
public print_css_reset ( )

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

Makes a subscription request
protected subscribe ( array $data, integer $related_object_id ) : boolean
$data array
$related_object_id integer
Результат boolean

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

Will always return true when integration is implicit. Otherwise, will check value of checkbox.
public triggered ( integer $object_id = null ) : boolean
$object_id integer Useful when overriding method. (optional)
Результат boolean

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

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

Name attribute for the checkbox element. Will be created from slug if empty.
protected $checkbox_name

$description публичное свойство

Description
public $description

$name публичное свойство

Name of this integration.
public $name

$options публичное свойство

Array of settings
public $options

$slug публичное свойство

Slug, used as an unique identifier for this integration.
public $slug