| 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/Auth/CtctOAuth2.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 class="active"><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><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 class="active"><a href="class-Ctct.Auth.CtctOAuth2.html">CtctOAuth2</a></li>
<li><a href="class-Ctct.Auth.SessionDataStore.html">SessionDataStore</a></li>
</ul>
<h3>Interfaces</h3>
<ul>
<li><a href="class-Ctct.Auth.CtctDataStore.html">CtctDataStore</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.Auth.html" title="Summary of Ctct\Auth"><span>Namespace</span></a>
</li>
<li>
<a href="class-Ctct.Auth.CtctOAuth2.html" title="Summary of Ctct\Auth\CtctOAuth2"><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\Auth;
</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\Config;
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-keyword1">use</span> Ctct\Util\RestClient;
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-keyword1">use</span> Ctct\Exceptions\OAuth2Exception;
</span><span id="7" class="l"><a class="l" href="#7"> 7: </a>
</span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment">/**
</span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment"> * Class that implements necessary functionality to obtain an access token from a user
</span></span><span id="10" class="l"><a class="l" href="#10">10: </a><span class="php-comment"> *
</span></span><span id="11" class="l"><a class="l" href="#11">11: </a><span class="php-comment"> * @package Auth
</span></span><span id="12" class="l"><a class="l" href="#12">12: </a><span class="php-comment"> * @author Constant Contact
</span></span><span id="13" class="l"><a class="l" href="#13">13: </a><span class="php-comment"> */</span>
</span><span id="14" class="l"><a class="l" href="#14">14: </a><span class="php-keyword1">class</span> <a id="CtctOAuth2" href="#CtctOAuth2">CtctOAuth2</a>
</span><span id="15" class="l"><a class="l" href="#15">15: </a>{
</span><span id="16" class="l"><a class="l" href="#16">16: </a> <span class="php-keyword1">public</span> <span class="php-var"><a id="$clientId" href="#$clientId">$clientId</a></span>;
</span><span id="17" class="l"><a class="l" href="#17">17: </a> <span class="php-keyword1">public</span> <span class="php-var"><a id="$clientSecret" href="#$clientSecret">$clientSecret</a></span>;
</span><span id="18" class="l"><a class="l" href="#18">18: </a> <span class="php-keyword1">public</span> <span class="php-var"><a id="$redirectUri" href="#$redirectUri">$redirectUri</a></span>;
</span><span id="19" class="l"><a class="l" href="#19">19: </a> <span class="php-keyword1">public</span> <span class="php-var"><a id="$props" href="#$props">$props</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-keyword1">public</span> <span class="php-keyword1">function</span> <a id="___construct" href="#___construct">__construct</a>(<span class="php-var">$clientId</span>, <span class="php-var">$clientSecret</span>, <span class="php-var">$redirectUri</span>, <span class="php-var">$restClient</span> = <span class="php-keyword1">null</span>)
</span><span id="22" class="l"><a class="l" href="#22">22: </a> {
</span><span id="23" class="l"><a class="l" href="#23">23: </a> <span class="php-var">$this</span>->clientId = <span class="php-var">$clientId</span>;
</span><span id="24" class="l"><a class="l" href="#24">24: </a> <span class="php-var">$this</span>->clientSecret = <span class="php-var">$clientSecret</span>;
</span><span id="25" class="l"><a class="l" href="#25">25: </a> <span class="php-var">$this</span>->redirectUri = <span class="php-var">$redirectUri</span>;
</span><span id="26" class="l"><a class="l" href="#26">26: </a> <span class="php-var">$this</span>->restClient = (<span class="php-var">$restClient</span>) ? <span class="php-var">$restClient</span> : <span class="php-keyword1">new</span> RestClient();
</span><span id="27" class="l"><a class="l" href="#27">27: </a> }
</span><span id="28" class="l"><a class="l" href="#28">28: </a>
</span><span id="29" class="l"><a class="l" href="#29">29: </a> <span class="php-comment">/**
</span></span><span id="30" class="l"><a class="l" href="#30">30: </a><span class="php-comment"> * Get the URL at which the user can authenticate and authorize the requesting application
</span></span><span id="31" class="l"><a class="l" href="#31">31: </a><span class="php-comment"> * @param boolean $server - Whether or not to use OAuth2 server flow, alternative is client flow
</span></span><span id="32" class="l"><a class="l" href="#32">32: </a><span class="php-comment"> * @param string $state - An optional value used by the client to maintain state between the request and callback.
</span></span><span id="33" class="l"><a class="l" href="#33">33: </a><span class="php-comment"> * @return string $url - The url to send a user to, to grant access to their account
</span></span><span id="34" class="l"><a class="l" href="#34">34: </a><span class="php-comment"> */</span>
</span><span id="35" class="l"><a class="l" href="#35">35: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getAuthorizationUrl" href="#_getAuthorizationUrl">getAuthorizationUrl</a>(<span class="php-var">$server</span> = <span class="php-keyword1">true</span>, <span class="php-var">$state</span> = <span class="php-keyword1">null</span>)
</span><span id="36" class="l"><a class="l" href="#36">36: </a> {
</span><span id="37" class="l"><a class="l" href="#37">37: </a> <span class="php-var">$responseType</span> = (<span class="php-var">$server</span>) ? Config::get(<span class="php-quote">'auth.response_type_code'</span>) : Config::get(<span class="php-quote">"auth.response_type_token"</span>);
</span><span id="38" class="l"><a class="l" href="#38">38: </a> <span class="php-var">$params</span> = <span class="php-keyword1">array</span>(
</span><span id="39" class="l"><a class="l" href="#39">39: </a> <span class="php-quote">'response_type'</span> => <span class="php-var">$responseType</span>,
</span><span id="40" class="l"><a class="l" href="#40">40: </a> <span class="php-quote">'client_id'</span> => <span class="php-var">$this</span>->clientId,
</span><span id="41" class="l"><a class="l" href="#41">41: </a> <span class="php-quote">'redirect_uri'</span> => <span class="php-var">$this</span>->redirectUri
</span><span id="42" class="l"><a class="l" href="#42">42: </a> );
</span><span id="43" class="l"><a class="l" href="#43">43: </a>
</span><span id="44" class="l"><a class="l" href="#44">44: </a> <span class="php-comment">// add the state param if it was provided</span>
</span><span id="45" class="l"><a class="l" href="#45">45: </a> <span class="php-keyword1">if</span> (<span class="php-var">$state</span> != <span class="php-keyword1">null</span>) {
</span><span id="46" class="l"><a class="l" href="#46">46: </a> <span class="php-var">$params</span>[<span class="php-quote">'state'</span>] = <span class="php-var">$state</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><span id="49" class="l"><a class="l" href="#49">49: </a> <span class="php-var">$url</span> = Config::get(<span class="php-quote">'auth.base_url'</span>) . Config::get(<span class="php-quote">'auth.authorization_endpoint'</span>);
</span><span id="50" class="l"><a class="l" href="#50">50: </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="51" class="l"><a class="l" href="#51">51: </a> }
</span><span id="52" class="l"><a class="l" href="#52">52: </a>
</span><span id="53" class="l"><a class="l" href="#53">53: </a> <span class="php-comment">/**
</span></span><span id="54" class="l"><a class="l" href="#54">54: </a><span class="php-comment"> * Obtain an access token
</span></span><span id="55" class="l"><a class="l" href="#55">55: </a><span class="php-comment"> * @param string $code - code returned from Constant Contact after a user has granted access to their account
</span></span><span id="56" class="l"><a class="l" href="#56">56: </a><span class="php-comment"> * @return array
</span></span><span id="57" class="l"><a class="l" href="#57">57: </a><span class="php-comment"> * @throws \Ctct\Exception\OAuth2Exception
</span></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-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getAccessToken" href="#_getAccessToken">getAccessToken</a>(<span class="php-var">$code</span>)
</span><span id="60" class="l"><a class="l" href="#60">60: </a> {
</span><span id="61" class="l"><a class="l" href="#61">61: </a> <span class="php-var">$params</span> = <span class="php-keyword1">array</span>(
</span><span id="62" class="l"><a class="l" href="#62">62: </a> <span class="php-quote">'grant_type'</span> => Config::get(<span class="php-quote">'auth.authorization_code_grant_type'</span>),
</span><span id="63" class="l"><a class="l" href="#63">63: </a> <span class="php-quote">'client_id'</span> => <span class="php-var">$this</span>->clientId,
</span><span id="64" class="l"><a class="l" href="#64">64: </a> <span class="php-quote">'client_secret'</span> => <span class="php-var">$this</span>->clientSecret,
</span><span id="65" class="l"><a class="l" href="#65">65: </a> <span class="php-quote">'code'</span> => <span class="php-var">$code</span>,
</span><span id="66" class="l"><a class="l" href="#66">66: </a> <span class="php-quote">'redirect_uri'</span> => <span class="php-var">$this</span>->redirectUri
</span><span id="67" class="l"><a class="l" href="#67">67: </a> );
</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">$url</span> = Config::get(<span class="php-quote">'auth.base_url'</span>) . Config::get(<span class="php-quote">'auth.token_endpoint'</span>) . <span class="php-quote">'?'</span> . <span class="php-keyword2">http_build_query</span>(<span class="php-var">$params</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 class="php-var">$response</span> = <span class="php-var">$this</span>->restClient->post(<span class="php-var">$url</span>);
</span><span id="72" class="l"><a class="l" href="#72">72: </a> <span class="php-var">$resposeBody</span> = <span class="php-keyword2">json_decode</span>(<span class="php-var">$response</span>->body, <span class="php-keyword1">true</span>);
</span><span id="73" class="l"><a class="l" href="#73">73: </a>
</span><span id="74" class="l"><a class="l" href="#74">74: </a> <span class="php-keyword1">if</span> (<span class="php-keyword2">array_key_exists</span>(<span class="php-quote">'error'</span>, <span class="php-var">$resposeBody</span>)) {
</span><span id="75" class="l"><a class="l" href="#75">75: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> OAuth2Exception(<span class="php-var">$resposeBody</span>[<span class="php-quote">'error'</span>] . <span class="php-quote">': '</span> . <span class="php-var">$resposeBody</span>[<span class="php-quote">'error_description'</span>]);
</span><span id="76" class="l"><a class="l" href="#76">76: </a> }
</span><span id="77" class="l"><a class="l" href="#77">77: </a>
</span><span id="78" class="l"><a class="l" href="#78">78: </a> <span class="php-keyword1">return</span> <span class="php-var">$resposeBody</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><span id="81" class="l"><a class="l" href="#81">81: </a> <span class="php-comment">/**
</span></span><span id="82" class="l"><a class="l" href="#82">82: </a><span class="php-comment"> * Get an information about an access token
</span></span><span id="83" class="l"><a class="l" href="#83">83: </a><span class="php-comment"> * @param string $accessToken - Constant Contact OAuth2 access token
</span></span><span id="84" class="l"><a class="l" href="#84">84: </a><span class="php-comment"> * @return array
</span></span><span id="85" class="l"><a class="l" href="#85">85: </a><span class="php-comment"> * @throws \Ctct\Exception\CtctException
</span></span><span id="86" class="l"><a class="l" href="#86">86: </a><span class="php-comment"> */</span>
</span><span id="87" class="l"><a class="l" href="#87">87: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getTokenInfo" href="#_getTokenInfo">getTokenInfo</a>(<span class="php-var">$accessToken</span>)
</span><span id="88" class="l"><a class="l" href="#88">88: </a> {
</span><span id="89" class="l"><a class="l" href="#89">89: </a> <span class="php-var">$restClient</span> = <span class="php-keyword1">new</span> RestClient();
</span><span id="90" class="l"><a class="l" href="#90">90: </a> <span class="php-var">$url</span> = Config::get(<span class="php-quote">'auth.base_url'</span>) . Config::get(<span class="php-quote">'auth.token_info'</span>);
</span><span id="91" class="l"><a class="l" href="#91">91: </a> <span class="php-var">$response</span> = <span class="php-var">$this</span>->restClient->post(<span class="php-var">$url</span>, <span class="php-keyword1">array</span>(), <span class="php-quote">"access_token="</span>.<span class="php-var">$accessToken</span>);
</span><span id="92" class="l"><a class="l" href="#92">92: </a> <span class="php-keyword1">return</span> <span class="php-keyword2">json_decode</span>(<span class="php-var">$response</span>->body, <span class="php-keyword1">true</span>);
</span><span id="93" class="l"><a class="l" href="#93">93: </a> }
</span><span id="94" class="l"><a class="l" href="#94">94: </a>}
</span><span id="95" class="l"><a class="l" href="#95">95: </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>