Overview

Namespaces

  • Ctct
    • Auth
    • Components
      • Account
      • Activities
      • Contacts
      • EmailMarketing
      • Library
      • Tracking
    • Exceptions
    • Services
    • Util
    • WebHooks

Classes

  • AccountService
  • ActivityService
  • BaseService
  • CampaignScheduleService
  • CampaignTrackingService
  • ContactService
  • ContactTrackingService
  • EmailMarketingService
  • LibraryService
  • ListService
  • Overview
  • Namespace
  • Class

Class BaseService

Super class for all services

Direct known subclasses

Ctct\Services\AccountService, Ctct\Services\ActivityService, Ctct\Services\CampaignScheduleService, Ctct\Services\CampaignTrackingService, Ctct\Services\ContactService, Ctct\Services\ContactTrackingService, Ctct\Services\EmailMarketingService, Ctct\Services\LibraryService, Ctct\Services\ListService
Abstract
Namespace: Ctct\Services
Package: Services
Author: Constant Contact
Located at Services/BaseService.php
Methods summary
public
# __construct( string $apiKey )

Constructor with the option to to supply an alternative rest client to be used

Constructor with the option to to supply an alternative rest client to be used

Parameters

$apiKey
  • Constant Contact API Key
protected GuzzleHttp\Client
# getClient( )

Get the rest client being used by the service

Get the rest client being used by the service

Returns

GuzzleHttp\Client
  • GuzzleHTTP Client implementation being used
protected
# createBaseRequest( $accessToken, $method, $baseUrl )
protected Ctct\Exceptions\CtctException
# convertException( GuzzleHttp\Exception\ClientException $exception )

Turns a ClientException into a CtctException - like magic.

Turns a ClientException into a CtctException - like magic.

Parameters

$exception
  • Guzzle ClientException

Returns

Ctct\Exceptions\CtctException
API documentation generated by ApiGen