Jérémy Munsch
f36447854b
This removes api authentication with token in favor of signature method. Refactored code and clean up. It add more unit test plus code coverage in test/coverage. - Added : mardown documentation. - Changed : model Stats::getQuestionStats to pass question as route parameter - Changed : now requests need to have a signature generated with a private key (crm password) using hmac sha256 wrapping url, method and parameters - Changed : now timestamp will timeout if request is slower than "timestampTimeout", this means crm will reject the request - Changed : throw ValidationException s instead of TypeErrors - Changed : timestamp has to be send in request with a DateTime format, it also has to a UTC value - Fixed : Change WPCRM dynamic session key, this could prevent spoofing session in some cases. - Fixed : closure validation - Fixed : model mutator not catching reflectionException - Fixed : really send json request using Guzzle internal lib methods. - Removed : Api AUTH system with api token - Removed : ApiError::needAuth - Removed : composer vlucas/dotenv, .env file is not handled any more. - Removed : LoginException - Removed : memcached dependency - Removed : need of memcached - Removed : unused service provider - Removed : WpCrm::forceLogin - Removed : WpCrm::sendArcadiaMailDefault - Removed : WpCrm::sendArcadiaMailGame - Updated : PHPCS rules, phpcs fixes and refactored code
185 lines
9.4 KiB
HTML
185 lines
9.4 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>CRM V2</title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<base href="../">
|
|
<link rel="icon" href="images/favicon.ico"/>
|
|
<link rel="stylesheet" href="css/normalize.css">
|
|
<link rel="stylesheet" href="css/base.css">
|
|
<link rel="preconnect" href="https://fonts.gstatic.com">
|
|
<link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
|
|
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
|
|
<link rel="stylesheet" href="css/template.css">
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
|
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
|
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
|
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
|
|
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
|
|
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
|
|
<script src="js/search.js"></script>
|
|
<script defer src="js/searchIndex.js"></script>
|
|
</head>
|
|
<body id="top">
|
|
<header class="phpdocumentor-header phpdocumentor-section">
|
|
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">CRM V2</a></h1>
|
|
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
|
|
<label class="phpdocumentor-header__menu-icon" for="menu-button">
|
|
<i class="fas fa-bars"></i>
|
|
</label>
|
|
<section data-search-form class="phpdocumentor-search">
|
|
<label>
|
|
<span class="visually-hidden">Search for</span>
|
|
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
|
|
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
|
|
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
|
|
</svg>
|
|
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
|
|
</label>
|
|
</section>
|
|
|
|
<nav class="phpdocumentor-topnav">
|
|
<ul class="phpdocumentor-topnav__menu">
|
|
</ul>
|
|
</nav>
|
|
</header>
|
|
|
|
<main class="phpdocumentor">
|
|
<div class="phpdocumentor-section">
|
|
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
|
|
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
|
|
Menu
|
|
</label>
|
|
<aside class="phpdocumentor-column -four phpdocumentor-sidebar">
|
|
<section class="phpdocumentor-sidebar__category">
|
|
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
|
|
<h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/ldc.html">LDC</a></h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="namespaces/ldc-ldccrm.html">LDCCRM</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
</section>
|
|
<section class="phpdocumentor-sidebar__category">
|
|
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
|
|
<h4 class="phpdocumentor-sidebar__root-namespace"><a href="packages/LDCCrmClient.html">LDCCrmClient</a></h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="packages/LDCCrmClient-enums.html">enums</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="packages/LDCCrmClient-exceptions.html">exceptions</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="packages/LDCCrmClient-models.html">models</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="packages/LDCCrmClient-transport.html">transport</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="packages/LDCCrmClient-utilities.html">utilities</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="packages/LDCCrmClient-Wordpress.html">Wordpress</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace"><a href="packages/None.html">None</a></h4>
|
|
|
|
</section>
|
|
|
|
<section class="phpdocumentor-sidebar__category">
|
|
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
|
|
</section>
|
|
|
|
<section class="phpdocumentor-sidebar__category">
|
|
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
|
|
</section>
|
|
</aside>
|
|
|
|
<div class="phpdocumentor-column -eight phpdocumentor-content">
|
|
<ul class="phpdocumentor-breadcrumbs">
|
|
<li class="phpdocumentor-breadcrumb"><a href="namespaces/ldc.html">LDC</a></li>
|
|
<li class="phpdocumentor-breadcrumb"><a href="namespaces/ldc-ldccrm.html">LDCCRM</a></li>
|
|
</ul>
|
|
|
|
<article class="phpdocumentor-element -namespace">
|
|
<h2 class="phpdocumentor-content__title">Models</h2>
|
|
|
|
|
|
|
|
<h3 id="interfaces_class_traits">
|
|
Interfaces, Classes and Traits
|
|
<a href="#interfaces_class_traits" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h3>
|
|
|
|
<dl class="phpdocumentor-table-of-contents">
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LDC-LDCCRM-Models-Answer.html"><abbr title="\LDC\LDCCRM\Models\Answer">Answer</abbr></a></dt>
|
|
<dd>This class represents an answer
|
|
It has a method to submit answers</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LDC-LDCCRM-Models-ArcadiaMailDefault.html"><abbr title="\LDC\LDCCRM\Models\ArcadiaMailDefault">ArcadiaMailDefault</abbr></a></dt>
|
|
<dd>This class represents the customer info with
|
|
the account validation status</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LDC-LDCCRM-Models-ArcadiaMailGame.html"><abbr title="\LDC\LDCCRM\Models\ArcadiaMailGame">ArcadiaMailGame</abbr></a></dt>
|
|
<dd>This class represents the customer info with
|
|
the account validation status</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LDC-LDCCRM-Models-Customer.html"><abbr title="\LDC\LDCCRM\Models\Customer">Customer</abbr></a></dt>
|
|
<dd>This class represents the customer info with
|
|
the account validation status. You can use it as
|
|
a standalone class but beware of catching exceptions</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LDC-LDCCRM-Models-Question.html"><abbr title="\LDC\LDCCRM\Models\Question">Question</abbr></a></dt>
|
|
<dd>This class represents a question
|
|
It has some static methods to retrieve questions and answers</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LDC-LDCCRM-Models-SingleOptin.html"><abbr title="\LDC\LDCCRM\Models\SingleOptin">SingleOptin</abbr></a></dt>
|
|
<dd>This class allows to handle single optins</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LDC-LDCCRM-Models-Stats.html"><abbr title="\LDC\LDCCRM\Models\Stats">Stats</abbr></a></dt>
|
|
<dd>This class is used to get stats from CRM</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
|
|
<section class="phpdocumentor-search-results__dialog">
|
|
<header class="phpdocumentor-search-results__header">
|
|
<h2 class="phpdocumentor-search-results__title">Search results</h2>
|
|
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
|
|
</header>
|
|
<section class="phpdocumentor-search-results__body">
|
|
<ul class="phpdocumentor-search-results__entries"></ul>
|
|
</section>
|
|
</section>
|
|
</section>
|
|
</div>
|
|
</div>
|
|
<a href="namespaces/ldc-ldccrm-models.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
|
|
|
|
</main>
|
|
|
|
<script>
|
|
cssVars({});
|
|
</script>
|
|
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
|
|
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
|
|
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
|
|
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
|
|
</body>
|
|
</html>
|