Overview

Namespaces

  • emberlabs
    • Barcode
  • None

Classes

  • Appconfig
  • Barcode_lib
  • Config
  • Customer
  • Customer_rewards
  • Customers
  • Detailed_receivings
  • Detailed_sales
  • Dinner_table
  • Email_lib
  • Employee
  • Employees
  • Giftcard
  • Giftcards
  • Home
  • Inventory
  • Inventory_low
  • Inventory_summary
  • Item
  • Item_kit
  • Item_kit_items
  • Item_kits
  • Item_lib
  • Item_quantity
  • Item_taxes
  • Items
  • Login
  • Mailchimp_lib
  • MailchimpConnector
  • Messages
  • Module
  • MY_Lang
  • No_Access
  • Person
  • Persons
  • Receiving
  • Receiving_lib
  • Receivings
  • Report
  • Reports
  • Rewards
  • Rounding_code
  • Sale
  • Sale_lib
  • Sale_suspended
  • Sales
  • Secure_Controller
  • Sms_lib
  • Specific_customer
  • Specific_discount
  • Specific_employee
  • Stock_location
  • Summary_categories
  • Summary_customers
  • Summary_discounts
  • Summary_employees
  • Summary_items
  • Summary_payments
  • Summary_report
  • Summary_sales
  • Summary_suppliers
  • Summary_taxes
  • Supplier
  • Suppliers
  • Tax
  • Tax_lib
  • Taxes
  • Token
  • Token_customer
  • Token_invoice_count
  • Token_invoice_sequence
  • Token_lib
  • Token_quote_sequence
  • Token_suspended_invoice_count
  • Token_year_invoice_count
  • Tracking_lib

Functions

  • currency_side
  • current_language
  • current_language_code
  • dateformat_bootstrap
  • dateformat_momentjs
  • db_log_queries
  • get_customer_data_row
  • get_customer_manage_table_headers
  • get_giftcard_data_row
  • get_giftcards_manage_table_headers
  • get_item_data_row
  • get_item_kit_data_row
  • get_item_kits_manage_table_headers
  • get_items_manage_table_headers
  • get_people_manage_table_headers
  • get_person_data_row
  • get_sale_data_last_row
  • get_sale_data_row
  • get_sales_manage_payments_summary
  • get_sales_manage_table_headers
  • get_supplier_data_row
  • get_suppliers_manage_table_headers
  • get_tax_data_row
  • get_taxes_manage_table_headers
  • load_config
  • load_language_files
  • load_stats
  • parse_decimals
  • pdf_create
  • quantity_decimals
  • show_report
  • show_report_if_allowed
  • to_currency
  • to_currency_no_money
  • to_decimals
  • to_quantity_decimals
  • to_tax_decimals
  • totals_decimals
  • transform_headers
  • transform_headers_readonly
  • Overview
  • Namespace
  • Class

Class Mailchimp_lib

Mailchimp library, usable from CI code

Library with utility queries to interface Mailchimp v3 API

Inspired by the work of ThinkShout: https://github.com/thinkshout/mailchimp-api-php

Located at libraries/Mailchimp_lib.php
Methods summary
public
# __construct( array $params = array() )
public object
# getLists( array $parameters = array('fields' => 'lists.id,lists.name,lists.stats.member_count,lists.stats.merge_field_count') )

Gets information about all lists owned by the authenticated account.

Gets information about all lists owned by the authenticated account.

Parameters

$parameters

Associative array of optional request parameters. By the default it places a simple query to list name & id and count of members & merge_fields NOTE: no space between , and next word is allowed. You will not get the filter to work in full but just the first tag

Returns

object

See

http://developer.mailchimp.com/documentation/mailchimp/reference/lists/#read-get_lists
public object
# getList( string $list_id, array $parameters = array('fields' => 'id,name,stats.member_count,stats.merge_field_count') )

Gets a MailChimp list.

Gets a MailChimp list.

Parameters

$list_id
The ID of the list.
$parameters
Associative array of optional request parameters.

Returns

object

See

http://developer.mailchimp.com/documentation/mailchimp/reference/lists/#read-get_lists_list_id
public object
# getMembers( string $list_id, array $count, $offset, $parameters = array('fields' => 'members.id,members.email_address,members.unique_email_id,members.status,members.merge_fields') )

Gets information about all members of a MailChimp list.

Gets information about all members of a MailChimp list.

Parameters

$list_id
The ID of the list.
$count

$parameters Associative array of optional request parameters.

$offset
$parameters

Returns

object

See

http://developer.mailchimp.com/documentation/mailchimp/reference/lists/members/#read-get_lists_list_id_members
public object
# getMemberInfoById( string $list_id, string $md5id, array $parameters = array('fields' => 'email_address,status,merge_fields') )

Gets information about a member of a MailChimp list.

Gets information about a member of a MailChimp list.

Parameters

$list_id
The ID of the list.
$md5id
The member's email address md5 hash which is the id.
$parameters
Associative array of optional request parameters.

Returns

object

See

http://developer.mailchimp.com/documentation/mailchimp/reference/lists/members/#read-get_lists_list_id_members_subscriber_hash
public object
# getMemberInfo( string $list_id, string $email, array $parameters = array() )

Gets information about a member of a MailChimp list.

Gets information about a member of a MailChimp list.

Parameters

$list_id
The ID of the list.
$email
The member's email address.
$parameters
Associative array of optional request parameters.

Returns

object

See

http://developer.mailchimp.com/documentation/mailchimp/reference/lists/members/#read-get_lists_list_id_members_subscriber_hash
public object
# getMemberActivity( string $list_id, string $email, array $parameters = array() )

Gets activity related to a member of a MailChimp list.

Gets activity related to a member of a MailChimp list.

Parameters

$list_id
The ID of the list.
$email
The member's email address.
$parameters
Associative array of optional request parameters.

Returns

object

See

http://developer.mailchimp.com/documentation/mailchimp/reference/lists/members/activity/#read-get_lists_list_id_members_subscriber_hash_activity
public object
# addMember( string $list_id, string $email, array $first_name, $last_name, $parameters = array() )

Adds a new member to a MailChimp list.

Adds a new member to a MailChimp list.

Parameters

$list_id
The ID of the list.
$email
The email address to add.
$first_name

$parameters Associative array of optional request parameters.

$last_name
$parameters

Returns

object

See

http://developer.mailchimp.com/documentation/mailchimp/reference/lists/members/#create-post_lists_list_id_members
public object
# removeMember( string $list_id, string $email )

Removes a member from a MailChimp list.

Removes a member from a MailChimp list.

Parameters

$list_id
The ID of the list.
$email
The member's email address.

Returns

object

See

http://developer.mailchimp.com/documentation/mailchimp/reference/lists/members/#delete-delete_lists_list_id_members_subscriber_hash
public object
# updateMember( string $list_id, string $email, array $first_name, $last_name, $parameters = array() )

Updates a member of a MailChimp list.

Updates a member of a MailChimp list.

Parameters

$list_id
The ID of the list.
$email
The member's email address.
$first_name

$parameters Associative array of optional request parameters.

$last_name
$parameters

Returns

object

See

http://developer.mailchimp.com/documentation/mailchimp/reference/lists/members/#edit-patch_lists_list_id_members_subscriber_hash
public object
# addOrUpdateMember( string $list_id, string $email, array $first_name, $last_name, $status, $parameters = array() )

Adds a new or update an existing member of a MailChimp list.

Adds a new or update an existing member of a MailChimp list.

Parameters

$list_id
The ID of the list.
$email
The member's email address.
$first_name

$parameters Associative array of optional request parameters.

$last_name
$status
$parameters

Returns

object

See

http://developer.mailchimp.com/documentation/mailchimp/reference/lists/members/#edit-put_lists_list_id_members_subscriber_hash
API documentation generated by ApiGen