| Server IP : 67.43.7.42 / Your IP : 216.73.216.61 Web Server : Apache System : Linux host.isabellascookies.com 2.6.32-754.35.1.el6.x86_64 #1 SMP Sat Nov 7 12:42:14 UTC 2020 x86_64 User : isabella ( 503) PHP Version : 5.5.38 Disable Function : exec,passthru,shell_exec,system MySQL : ON | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : ON Directory : /home/isabella/public_html/constant/docs/ |
Upload File : |
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<meta name="robots" content="noindex" />
<title>File Ctct/Services/BaseService.php | Appconnect PHP SDK</title>
<script type="text/javascript" src="resources/combined.js?554516056"></script>
<script type="text/javascript" src="elementlist.js?1423846706"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-Ctct.html">Ctct<span></span></a>
<ul>
<li><a href="namespace-Ctct.Auth.html">Auth</a>
</li>
<li><a href="namespace-Ctct.Components.html">Components<span></span></a>
<ul>
<li><a href="namespace-Ctct.Components.Account.html">Account</a>
</li>
<li><a href="namespace-Ctct.Components.Activities.html">Activities</a>
</li>
<li><a href="namespace-Ctct.Components.Contacts.html">Contacts</a>
</li>
<li><a href="namespace-Ctct.Components.EmailMarketing.html">EmailMarketing</a>
</li>
<li><a href="namespace-Ctct.Components.Tracking.html">Tracking</a>
</li>
</ul></li>
<li><a href="namespace-Ctct.Exceptions.html">Exceptions</a>
</li>
<li class="active"><a href="namespace-Ctct.Services.html">Services</a>
</li>
</ul></li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Ctct.Services.AccountService.html">AccountService</a></li>
<li><a href="class-Ctct.Services.ActivityService.html">ActivityService</a></li>
<li class="active"><a href="class-Ctct.Services.BaseService.html">BaseService</a></li>
<li><a href="class-Ctct.Services.CampaignScheduleService.html">CampaignScheduleService</a></li>
<li><a href="class-Ctct.Services.CampaignTrackingService.html">CampaignTrackingService</a></li>
<li><a href="class-Ctct.Services.ContactService.html">ContactService</a></li>
<li><a href="class-Ctct.Services.ContactTrackingService.html">ContactTrackingService</a></li>
<li><a href="class-Ctct.Services.EmailMarketingService.html">EmailMarketingService</a></li>
<li><a href="class-Ctct.Services.ListService.html">ListService</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-Ctct.Services.html" title="Summary of Ctct\Services"><span>Namespace</span></a>
</li>
<li>
<a href="class-Ctct.Services.BaseService.html" title="Summary of Ctct\Services\BaseService"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang"><?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a><span class="php-keyword1">namespace</span> Ctct\Services;
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a>
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-keyword1">use</span> Ctct\Util\RestClient;
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-keyword1">use</span> Ctct\Util\RestClientInterface;
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a>
</span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment">/**
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> * Super class for all services
</span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment"> *
</span></span><span id="10" class="l"><a class="l" href="#10">10: </a><span class="php-comment"> * @package Services
</span></span><span id="11" class="l"><a class="l" href="#11">11: </a><span class="php-comment"> * @author Constant Contact
</span></span><span id="12" class="l"><a class="l" href="#12">12: </a><span class="php-comment"> */</span>
</span><span id="13" class="l"><a class="l" href="#13">13: </a><span class="php-keyword1">abstract</span> <span class="php-keyword1">class</span> <a id="BaseService" href="#BaseService">BaseService</a>
</span><span id="14" class="l"><a class="l" href="#14">14: </a>{
</span><span id="15" class="l"><a class="l" href="#15">15: </a> <span class="php-comment">/**
</span></span><span id="16" class="l"><a class="l" href="#16">16: </a><span class="php-comment"> * RestClient Implementation to use for HTTP requests
</span></span><span id="17" class="l"><a class="l" href="#17">17: </a><span class="php-comment"> * @var $restClient - RestClient
</span></span><span id="18" class="l"><a class="l" href="#18">18: </a><span class="php-comment"> */</span>
</span><span id="19" class="l"><a class="l" href="#19">19: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$restClient" href="#$restClient">$restClient</a></span>;
</span><span id="20" class="l"><a class="l" href="#20">20: </a>
</span><span id="21" class="l"><a class="l" href="#21">21: </a> <span class="php-comment">/**
</span></span><span id="22" class="l"><a class="l" href="#22">22: </a><span class="php-comment"> * ApiKey for the application
</span></span><span id="23" class="l"><a class="l" href="#23">23: </a><span class="php-comment"> * @var string
</span></span><span id="24" class="l"><a class="l" href="#24">24: </a><span class="php-comment"> */</span>
</span><span id="25" class="l"><a class="l" href="#25">25: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$apiKey" href="#$apiKey">$apiKey</a></span>;
</span><span id="26" class="l"><a class="l" href="#26">26: </a>
</span><span id="27" class="l"><a class="l" href="#27">27: </a> <span class="php-comment">/**
</span></span><span id="28" class="l"><a class="l" href="#28">28: </a><span class="php-comment"> * Constructor with the option to to supply an alternative rest client to be used
</span></span><span id="29" class="l"><a class="l" href="#29">29: </a><span class="php-comment"> * @param RestClientInterface - RestClientInterface implementation to be used in the service
</span></span><span id="30" class="l"><a class="l" href="#30">30: </a><span class="php-comment"> */</span>
</span><span id="31" class="l"><a class="l" href="#31">31: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="___construct" href="#___construct">__construct</a>(<span class="php-var">$apiKey</span>, <span class="php-var">$restClient</span> = <span class="php-keyword1">null</span>)
</span><span id="32" class="l"><a class="l" href="#32">32: </a> {
</span><span id="33" class="l"><a class="l" href="#33">33: </a> <span class="php-var">$this</span>->apiKey = <span class="php-var">$apiKey</span>;
</span><span id="34" class="l"><a class="l" href="#34">34: </a>
</span><span id="35" class="l"><a class="l" href="#35">35: </a> <span class="php-keyword1">if</span> (<span class="php-keyword2">is_null</span>(<span class="php-var">$restClient</span>)) {
</span><span id="36" class="l"><a class="l" href="#36">36: </a> <span class="php-var">$this</span>->restClient = <span class="php-keyword1">new</span> RestClient();
</span><span id="37" class="l"><a class="l" href="#37">37: </a> } <span class="php-keyword1">else</span> {
</span><span id="38" class="l"><a class="l" href="#38">38: </a> <span class="php-var">$this</span>->restClient = <span class="php-var">$restClient</span>;
</span><span id="39" class="l"><a class="l" href="#39">39: </a> }
</span><span id="40" class="l"><a class="l" href="#40">40: </a> }
</span><span id="41" class="l"><a class="l" href="#41">41: </a>
</span><span id="42" class="l"><a class="l" href="#42">42: </a> <span class="php-comment">/**
</span></span><span id="43" class="l"><a class="l" href="#43">43: </a><span class="php-comment"> * Build a url from the base url and query parameters array
</span></span><span id="44" class="l"><a class="l" href="#44">44: </a><span class="php-comment"> * @return string
</span></span><span id="45" class="l"><a class="l" href="#45">45: </a><span class="php-comment"> */</span>
</span><span id="46" class="l"><a class="l" href="#46">46: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_buildUrl" href="#_buildUrl">buildUrl</a>(<span class="php-var">$url</span>, <span class="php-var">$queryParams</span> = <span class="php-keyword1">null</span>)
</span><span id="47" class="l"><a class="l" href="#47">47: </a> {
</span><span id="48" class="l"><a class="l" href="#48">48: </a> <span class="php-var">$keyArr</span> = <span class="php-keyword1">array</span>(<span class="php-quote">'api_key'</span> => <span class="php-var">$this</span>->apiKey);
</span><span id="49" class="l"><a class="l" href="#49">49: </a> <span class="php-keyword1">if</span> (<span class="php-var">$queryParams</span>) {
</span><span id="50" class="l"><a class="l" href="#50">50: </a> <span class="php-var">$params</span> = <span class="php-keyword2">array_merge</span>(<span class="php-var">$keyArr</span>, <span class="php-var">$queryParams</span>);
</span><span id="51" class="l"><a class="l" href="#51">51: </a> } <span class="php-keyword1">else</span> {
</span><span id="52" class="l"><a class="l" href="#52">52: </a> <span class="php-var">$params</span> = <span class="php-var">$keyArr</span>;
</span><span id="53" class="l"><a class="l" href="#53">53: </a> }
</span><span id="54" class="l"><a class="l" href="#54">54: </a>
</span><span id="55" class="l"><a class="l" href="#55">55: </a> <span class="php-keyword1">return</span> <span class="php-var">$url</span> . <span class="php-quote">'?'</span> . <span class="php-keyword2">http_build_query</span>(<span class="php-var">$params</span>);
</span><span id="56" class="l"><a class="l" href="#56">56: </a> }
</span><span id="57" class="l"><a class="l" href="#57">57: </a>
</span><span id="58" class="l"><a class="l" href="#58">58: </a> <span class="php-comment">/**
</span></span><span id="59" class="l"><a class="l" href="#59">59: </a><span class="php-comment"> * Get the rest client being used by the service
</span></span><span id="60" class="l"><a class="l" href="#60">60: </a><span class="php-comment"> * @return RestClientInterface - RestClientInterface implementation being used
</span></span><span id="61" class="l"><a class="l" href="#61">61: </a><span class="php-comment"> */</span>
</span><span id="62" class="l"><a class="l" href="#62">62: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getRestClient" href="#_getRestClient">getRestClient</a>()
</span><span id="63" class="l"><a class="l" href="#63">63: </a> {
</span><span id="64" class="l"><a class="l" href="#64">64: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->restClient;
</span><span id="65" class="l"><a class="l" href="#65">65: </a> }
</span><span id="66" class="l"><a class="l" href="#66">66: </a>
</span><span id="67" class="l"><a class="l" href="#67">67: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_setRestClient" href="#_setRestClient">setRestClient</a>(RestClientInterface <span class="php-var">$restClient</span>)
</span><span id="68" class="l"><a class="l" href="#68">68: </a> {
</span><span id="69" class="l"><a class="l" href="#69">69: </a> <span class="php-var">$this</span>->restClient = <span class="php-var">$restClient</span>;
</span><span id="70" class="l"><a class="l" href="#70">70: </a> }
</span><span id="71" class="l"><a class="l" href="#71">71: </a>
</span><span id="72" class="l"><a class="l" href="#72">72: </a>
</span><span id="73" class="l"><a class="l" href="#73">73: </a> <span class="php-comment">/**
</span></span><span id="74" class="l"><a class="l" href="#74">74: </a><span class="php-comment"> * Helper function to return required headers for making an http request with constant contact
</span></span><span id="75" class="l"><a class="l" href="#75">75: </a><span class="php-comment"> * @param $accessToken - OAuth2 access token to be placed into the Authorization header
</span></span><span id="76" class="l"><a class="l" href="#76">76: </a><span class="php-comment"> * @return array - authorization headers
</span></span><span id="77" class="l"><a class="l" href="#77">77: </a><span class="php-comment"> */</span>
</span><span id="78" class="l"><a class="l" href="#78">78: </a> <span class="php-keyword1">protected</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> <a id="_getHeaders" href="#_getHeaders">getHeaders</a>(<span class="php-var">$accessToken</span>)
</span><span id="79" class="l"><a class="l" href="#79">79: </a> {
</span><span id="80" class="l"><a class="l" href="#80">80: </a> <span class="php-keyword1">return</span> <span class="php-keyword1">array</span>(
</span><span id="81" class="l"><a class="l" href="#81">81: </a> <span class="php-quote">'Content-Type: application/json'</span>,
</span><span id="82" class="l"><a class="l" href="#82">82: </a> <span class="php-quote">'Accept: application/json'</span>,
</span><span id="83" class="l"><a class="l" href="#83">83: </a> <span class="php-quote">'Authorization: Bearer '</span> . <span class="php-var">$accessToken</span>
</span><span id="84" class="l"><a class="l" href="#84">84: </a> );
</span><span id="85" class="l"><a class="l" href="#85">85: </a> }
</span><span id="86" class="l"><a class="l" href="#86">86: </a>}
</span><span id="87" class="l"><a class="l" href="#87">87: </a></span></code></pre>
<div id="footer">
Appconnect PHP SDK API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>