Files
sean 0e8a8b3028
Some checks failed
deploy-testing / deploy (push) Has been cancelled
Initial testing snapshot
2026-11-17 16:15:01 -05:00

106 lines
2.1 KiB
PHP

<?php
/**
* Represents a Merge Field in Mailchimp
*
* @since 4.0
* @access public
*/
class MC4WP_MailChimp_Merge_Field
{
/**
* @var string
*/
public $name;
/**
* @var string
*/
public $field_type;
/**
* @var string
*/
public $tag;
/**
* @var bool Is this a required field for the list it belongs to?
*/
public $required = false;
/**
* @var array
*/
public $choices = array();
/**
* @var bool Is this field public? As in, should it show on forms?
*/
public $public = true;
/**
* @var string Default value for the field.
*/
public $default_value = '';
/**
* @param string $name
* @param string $field_type
* @param string $tag
* @param bool $required
* @param array $choices
*/
public function __construct($name, $field_type, $tag, $required = false, $choices = array())
{
$this->name = $name;
$this->field_type = $field_type;
$this->tag = strtoupper($tag);
$this->required = $required;
$this->choices = $choices;
}
/**
* @param string $name
*
* @return string
*/
public function __get($name)
{
// for backwards compatibility with v3.x, channel these properties to their new names
if ($name === 'default') {
return $this->default_value;
}
}
/**
* Creates our local object from Mailchimp API data.
*
* @param object $data
*
* @return MC4WP_MailChimp_Merge_Field
*/
public static function from_data($data)
{
$instance = new self($data->name, $data->type, $data->tag, $data->required);
if (! empty($data->options->choices)) {
$instance->choices = $data->options->choices;
}
$optional = array(
'public',
'default_value'
);
foreach ($optional as $key) {
if (isset($data->$key)) {
$instance->$key = $data->$key;
}
}
return $instance;
}
}