| 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" /> <title>Class Ctct\Services\BaseService | 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 class="active"> <span>Class</span> </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> <div id="content" class="class"> <h1>Class BaseService</h1> <div class="description"> <p>Super class for all services</p> </div> <div> <h4>Direct known subclasses</h4> <a href="class-Ctct.Services.AccountService.html">Ctct\Services\AccountService</a>, <a href="class-Ctct.Services.ActivityService.html">Ctct\Services\ActivityService</a>, <a href="class-Ctct.Services.CampaignScheduleService.html">Ctct\Services\CampaignScheduleService</a>, <a href="class-Ctct.Services.CampaignTrackingService.html">Ctct\Services\CampaignTrackingService</a>, <a href="class-Ctct.Services.ContactService.html">Ctct\Services\ContactService</a>, <a href="class-Ctct.Services.ContactTrackingService.html">Ctct\Services\ContactTrackingService</a>, <a href="class-Ctct.Services.EmailMarketingService.html">Ctct\Services\EmailMarketingService</a>, <a href="class-Ctct.Services.ListService.html">Ctct\Services\ListService</a> </div> <div class="info"> <b>Abstract</b><br /> <b>Namespace:</b> <a href="namespace-Ctct.html">Ctct</a>\<a href="namespace-Ctct.Services.html">Services</a><br /> <b>Package:</b> Services<br /> <b>Author:</b> Constant Contact<br /> <b>Located at</b> <a href="source-class-Ctct.Services.BaseService.html#7-86" title="Go to source code">Ctct/Services/BaseService.php</a><br /> </div> <table class="summary" id="methods"> <caption>Methods summary</caption> <tr data-order="__construct" id="___construct"> <td class="attributes"><code> public </code> </td> <td class="name"><div> <a class="anchor" href="#___construct">#</a> <code><a href="source-class-Ctct.Services.BaseService.html#27-40" title="Go to source code">__construct</a>( <span>Ctct\Util\RestClientInterface <var>$apiKey</var></span>, <span>mixed <var>$restClient</var> = <span class="php-keyword1">null</span></span> )</code> <div class="description short"> <p>Constructor with the option to to supply an alternative rest client to be used</p> </div> <div class="description detailed hidden"> <p>Constructor with the option to to supply an alternative rest client to be used</p> <h4>Parameters</h4> <div class="list"><dl> <dt><var>$apiKey</var></dt> <dd><code>Ctct\Util\RestClientInterface</code><br>- RestClientInterface implementation to be used in the service</dd> <dt><var>$restClient</var></dt> <dd></dd> </dl></div> </div> </div></td> </tr> <tr data-order="buildUrl" id="_buildUrl"> <td class="attributes"><code> public string </code> </td> <td class="name"><div> <a class="anchor" href="#_buildUrl">#</a> <code><a href="source-class-Ctct.Services.BaseService.html#42-56" title="Go to source code">buildUrl</a>( <span>mixed <var>$url</var></span>, <span>mixed <var>$queryParams</var> = <span class="php-keyword1">null</span></span> )</code> <div class="description short"> <p>Build a url from the base url and query parameters array</p> </div> <div class="description detailed hidden"> <p>Build a url from the base url and query parameters array</p> <h4>Returns</h4> <div class="list"> <code>string</code><br /> </div> </div> </div></td> </tr> <tr data-order="getRestClient" id="_getRestClient"> <td class="attributes"><code> public Ctct\Util\RestClientInterface </code> </td> <td class="name"><div> <a class="anchor" href="#_getRestClient">#</a> <code><a href="source-class-Ctct.Services.BaseService.html#58-65" title="Go to source code">getRestClient</a>( )</code> <div class="description short"> <p>Get the rest client being used by the service</p> </div> <div class="description detailed hidden"> <p>Get the rest client being used by the service</p> <h4>Returns</h4> <div class="list"> <code>Ctct\Util\RestClientInterface</code><br>- RestClientInterface implementation being used<br /> </div> </div> </div></td> </tr> <tr data-order="setRestClient" id="_setRestClient"> <td class="attributes"><code> public </code> </td> <td class="name"><div> <a class="anchor" href="#_setRestClient">#</a> <code><a href="source-class-Ctct.Services.BaseService.html#67-70" title="Go to source code">setRestClient</a>( <span>Ctct\Util\RestClientInterface <var>$restClient</var></span> )</code> <div class="description short"> </div> <div class="description detailed hidden"> </div> </div></td> </tr> <tr data-order="getHeaders" id="_getHeaders"> <td class="attributes"><code> protected static array </code> </td> <td class="name"><div> <a class="anchor" href="#_getHeaders">#</a> <code><a href="source-class-Ctct.Services.BaseService.html#73-85" title="Go to source code">getHeaders</a>( <span>mixed <var>$accessToken</var></span> )</code> <div class="description short"> <p>Helper function to return required headers for making an http request with constant contact</p> </div> <div class="description detailed hidden"> <p>Helper function to return required headers for making an http request with constant contact</p> <h4>Parameters</h4> <div class="list"><dl> <dt><var>$accessToken</var></dt> <dd><code>mixed</code><br>$accessToken - OAuth2 access token to be placed into the Authorization header</dd> </dl></div> <h4>Returns</h4> <div class="list"> <code>array</code><br>- authorization headers<br /> </div> </div> </div></td> </tr> </table> <table class="summary" id="properties"> <caption>Properties summary</caption> <tr data-order="restClient" id="$restClient"> <td class="attributes"><code> protected mixed </code></td> <td class="name"> <a href="source-class-Ctct.Services.BaseService.html#15-19" title="Go to source code"><var>$restClient</var></a> </td> <td class="value"><code></code></td> <td class="description"><div> <a href="#$restClient" class="anchor">#</a> <div class="description short"> <p>RestClient Implementation to use for HTTP requests</p> </div> <div class="description detailed hidden"> <p>RestClient Implementation to use for HTTP requests</p> </div> </div></td> </tr> <tr data-order="apiKey" id="$apiKey"> <td class="attributes"><code> protected string </code></td> <td class="name"> <a href="source-class-Ctct.Services.BaseService.html#21-25" title="Go to source code"><var>$apiKey</var></a> </td> <td class="value"><code></code></td> <td class="description"><div> <a href="#$apiKey" class="anchor">#</a> <div class="description short"> <p>ApiKey for the application</p> </div> <div class="description detailed hidden"> <p>ApiKey for the application</p> </div> </div></td> </tr> </table> </div> <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>