Methods

» Private
- ```
initialize
```
- ```
parseActionPath
```
Constants

Segment

Extends \MailChimp\Core\Model

Manage segments and tags for a specific Mailchimp list. A segment is a section of your list that includes only those subscribers who share specific common field information. Tags are labels you create to help organize your contacts.

package	Default

Methods

__construct

__construct(array $data = NULL)

inherited

Arguments

$data

array

all

all() : \MailChimp\Response\SegmentListResponse

Get information about all available segments for a specific list.

Response

\MailChimp\Response\SegmentListResponse

api

api()

inherited

batch

batch() : mixed

Batch add/remove list members to static segment

Response

mixed

clear

clear()

inherited

config

config()

inherited

create

create() : \MailChimp\Models\Lists\Segment

Create a new segment in a specific list.

Response

\MailChimp\Models\Lists\Segment

delete

delete() : mixed

Delete a specific segment in a list.

Response

mixed

edit

edit() : \MailChimp\Models\Lists\Segment

Update a specific segment in a list.

Response

\MailChimp\Models\Lists\Segment

getAction

getAction( $name)

inherited

Arguments

$name

Returns an ActionField object specified by `$action` and `$name`

getActionField(string $action, string $name) : \MailChimp\Core\ActionField

inherited

Arguments

$action

string

Action Name

$name

string

Field Name

Response

\MailChimp\Core\ActionField

Returns an array of action fields for an action

getActionFields(string $action) : array<mixed,\MailChimp\Core\ActionField>

inherited

Arguments

$action

string

Response

array<mixed,\MailChimp\Core\ActionField>

Returns Field Information

getField(string $name) : \MailChimp\Core\Field

inherited

Arguments

$name

string

Response

\MailChimp\Core\Field

Gets all allowed fields of a Data

getFields() : array

inherited

Response

array

Return API Path

getPath(\MailChimp\Core\string $child = NULL, array $params = NULL) : string

inherited

Arguments

$child

\MailChimp\Core\string

$params

array

Response

string

Return true if field exists or false otherwise

hasField(string $name) : boolean

inherited

Arguments

$name

string

Field name

Response

boolean

initialize

initialize()

inherited

jsonSerialize

jsonSerialize()

inherited

merge

merge( $data)

inherited

Arguments

$data

own

own( $class,  $args)

inherited

Arguments

$class

$args

parseActionPath

parseActionPath( &$params)

inherited

Arguments

$params

read

read() : \MailChimp\Models\Lists\Segment

Get information about a specific segment

Response

\MailChimp\Models\Lists\Segment

reference

reference( &$field,  $name)

inherited

Arguments

$field

$name

setApi

setApi(\MailChimp\Interfaces\MailChimpInterface &$api)

inherited

Arguments

$api

\MailChimp\Interfaces\MailChimpInterface

setConfig

setConfig(\MailChimp\Interfaces\ConfigInterface &$config)

inherited

Arguments

$config

\MailChimp\Interfaces\ConfigInterface

subscriber_hash

subscriber_hash()

Properties

Path Parameters

params : array

inherited

var

Type(s)

array

API Endpoint

path : string

inherited

var

Type(s)

string

Action Fields Configurations

action : array

inherited

var

Type(s)

array

Info for all action fields

_action : array

inherited

var

Type(s)

array

Data holder for predefined fields

data : object

inherited

var

Type(s)

object

Info for unreferenced action fields

_fields : array

inherited

var

Type(s)

array

API Query builder

builder : \MailChimp\Core\Builder

inherited

var

Type(s)

\MailChimp\Core\Builder

Fields for the model

fields : array

inherited

var

Type(s)

array

Reference map for fields

_reference : array

inherited

var

Type(s)

array

_api

_api :

inherited

Type(s)

_config

_config :

inherited

Type(s)

id

id : integer

The unique id for the segment.

Type(s)

integer

name

name : string

The name of the segment.

Type(s)

string

member_count

member_count : integer

The number of active subscribers currently included in the segment.

Type(s)

integer

type

type : string

The type of segment. Static segments are now known as tags. Learn more about tags.

Possible Values:

saved
static
fuzzy

Type(s)

string

created_at

created_at : string

The date and time the segment was created in ISO 8601 format.

Type(s)

string

updated_at

updated_at : string

The date and time the segment was last updated in ISO 8601 format.

Type(s)

string

options

options : \MailChimp\Data\SegmentOptions

The conditions of the segment. Static segments (tags) and fuzzy segments don’t have conditions.

Type(s)

\MailChimp\Data\SegmentOptions

list_id

list_id : string

The list id.

Type(s)

string

_links

_links : array<mixed,\MailChimp\Data\Link>

A list of link types and descriptions for the API schema documents.

Type(s)

array<mixed,\MailChimp\Data\Link>