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
1801 lines
78 KiB
HTML
1801 lines
78 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>
|
|
<li class="phpdocumentor-breadcrumb"><a href="namespaces/ldc-ldccrm-wordpress.html">WordPress</a></li>
|
|
</ul>
|
|
|
|
<article class="phpdocumentor-element -class">
|
|
<h2 class="phpdocumentor-content__title">
|
|
WPCrmUser
|
|
|
|
|
|
<div class="phpdocumentor-element__package">
|
|
in package
|
|
<ul class="phpdocumentor-breadcrumbs">
|
|
<li class="phpdocumentor-breadcrumb"><a href="packages/LDCCrmClient.html">LDCCrmClient</a></li>
|
|
<li class="phpdocumentor-breadcrumb"><a href="packages/LDCCrmClient-Wordpress.html">Wordpress</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<span class="phpdocumentor-element__implements">
|
|
implements
|
|
<abbr title="\JsonSerializable">JsonSerializable</abbr> </span>
|
|
|
|
</h2>
|
|
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/WordPress/WPCrmUser.php"><a href="files/src-wordpress-wpcrmuser.html"><abbr title="src/WordPress/WPCrmUser.php">WPCrmUser.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">69</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Class de gestion des users en session avec Wordpress (ce truc immonde)</p>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">category</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>API</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">subpackage</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>Wordpress</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">author</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>Jérémy Munsch <a href="mailto:jeremy.munsch@ldc.fr">jeremy.munsch@ldc.fr</a></p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">license</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>MIT https://opensource.org/licenses/MIT</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">link</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<a class="phpdocumentor-tag-link" href="/"> / </a>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<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 -interface"><abbr title="\JsonSerializable">JsonSerializable</abbr></dt>
|
|
<dd></dd>
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<h3 id="toc">
|
|
Table of Contents
|
|
<a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h3>
|
|
|
|
<dl class="phpdocumentor-table-of-contents">
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_address">$address</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_address2">$address2</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_birth_date">$birth_date</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_city">$city</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_country">$country</a>
|
|
<span>
|
|
: <a href="classes/LDC-LDCCRM-Enums-Country.html"><abbr title="\LDC\LDCCRM\Enums\Country">Country</abbr></a> </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_email">$email</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_firstname">$firstname</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_hashcode">$hashcode</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_last_connection">$last_connection</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_lastname">$lastname</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_opt_in">$opt_in</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_password">$password</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_phone">$phone</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_postcode">$postcode</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_status">$status</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_uuidToken">$uuidToken</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_info">$info</a>
|
|
<span>
|
|
: <a href="classes/LDC-LDCCRM-Models-Customer.html"><abbr title="\LDC\LDCCRM\Models\Customer">Customer</abbr></a> </span>
|
|
</dt>
|
|
<dd>The CRM customer info (the api response)</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_pemail">$pemail</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>The CRM customer email</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_phashcode">$phashcode</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>The CRM hashcode (UUID)</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_uuidToken">$uuidToken</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>The CRM customer temp uuidToken to validate transactions</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#method___construct">__construct()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd>WPCrmUser construct</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#method___get">__get()</a>
|
|
<span>
|
|
: bool|string|<a href="classes/LDC-LDCCRM-Enums-Country.html"><abbr title="\LDC\LDCCRM\Enums\Country">Country</abbr></a>|null </span>
|
|
</dt>
|
|
<dd>Generic accessor</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#method___set">__set()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Generic mutator</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#method_activate">activate()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Activate the account in the crm</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#method_delete">delete()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Delete current customer to
|
|
the local database and on crm</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#method_jsonSerialize">jsonSerialize()</a>
|
|
<span>
|
|
: array<string|int, mixed> </span>
|
|
</dt>
|
|
<dd>Serialize this object to an array</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#method_parseFromJson">parseFromJson()</a>
|
|
<span>
|
|
: <a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html"><abbr title="\LDC\LDCCRM\WordPress\WPCrmUser">WPCrmUser</abbr></a> </span>
|
|
</dt>
|
|
<dd>Generate a user from session data</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#method_save">save()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Save current customer to
|
|
the local database and on crm</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#method_setInfo">setInfo()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Set the customer info
|
|
with api response</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#method_toggleOptin">toggleOptin()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Toggle the current user optin value
|
|
on the current user and the crm</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-properties">
|
|
<h3 class="phpdocumentor-elements__header" id="properties">
|
|
Properties
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h3>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_address">
|
|
$address
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_address" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/WordPress/WPCrmUser.php"><a href="files/src-wordpress-wpcrmuser.html"><abbr title="src/WordPress/WPCrmUser.php">WPCrmUser.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$address</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"><p>The account address (street number, name, build, flat number)</p>
|
|
</section>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_address2">
|
|
$address2
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_address2" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/WordPress/WPCrmUser.php"><a href="files/src-wordpress-wpcrmuser.html"><abbr title="src/WordPress/WPCrmUser.php">WPCrmUser.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$address2</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"><p>— The account phone (address complement)</p>
|
|
</section>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_birth_date">
|
|
$birth_date
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_birth_date" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/WordPress/WPCrmUser.php"><a href="files/src-wordpress-wpcrmuser.html"><abbr title="src/WordPress/WPCrmUser.php">WPCrmUser.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$birth_date</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"><p>— The account birth date 'yyyy-mm-dd'</p>
|
|
</section>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_city">
|
|
$city
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_city" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/WordPress/WPCrmUser.php"><a href="files/src-wordpress-wpcrmuser.html"><abbr title="src/WordPress/WPCrmUser.php">WPCrmUser.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$city</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"><p>— The account city name</p>
|
|
</section>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_country">
|
|
$country
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_country" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/WordPress/WPCrmUser.php"><a href="files/src-wordpress-wpcrmuser.html"><abbr title="src/WordPress/WPCrmUser.php">WPCrmUser.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type"><a href="classes/LDC-LDCCRM-Enums-Country.html"><abbr title="\LDC\LDCCRM\Enums\Country">Country</abbr></a></span>
|
|
<span class="phpdocumentor-signature__name">$country</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"><p>— The account country residence</p>
|
|
</section>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_email">
|
|
$email
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_email" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/WordPress/WPCrmUser.php"><a href="files/src-wordpress-wpcrmuser.html"><abbr title="src/WordPress/WPCrmUser.php">WPCrmUser.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$email</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"><p>— Must be a rfc valid email on a valid domain name</p>
|
|
</section>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_firstname">
|
|
$firstname
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_firstname" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/WordPress/WPCrmUser.php"><a href="files/src-wordpress-wpcrmuser.html"><abbr title="src/WordPress/WPCrmUser.php">WPCrmUser.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$firstname</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"><p>— The account first name</p>
|
|
</section>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_hashcode">
|
|
$hashcode
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_hashcode" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/WordPress/WPCrmUser.php"><a href="files/src-wordpress-wpcrmuser.html"><abbr title="src/WordPress/WPCrmUser.php">WPCrmUser.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$hashcode</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"><p>— The crm hashcode this is a readonly field</p>
|
|
</section>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_last_connection">
|
|
$last_connection
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_last_connection" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/WordPress/WPCrmUser.php"><a href="files/src-wordpress-wpcrmuser.html"><abbr title="src/WordPress/WPCrmUser.php">WPCrmUser.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$last_connection</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"><p>the last time user was connected 'yyyy-mm-dd HH:ii:ss'</p>
|
|
</section>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_lastname">
|
|
$lastname
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_lastname" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/WordPress/WPCrmUser.php"><a href="files/src-wordpress-wpcrmuser.html"><abbr title="src/WordPress/WPCrmUser.php">WPCrmUser.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$lastname</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"><p>— The account last name</p>
|
|
</section>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_opt_in">
|
|
$opt_in
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_opt_in" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/WordPress/WPCrmUser.php"><a href="files/src-wordpress-wpcrmuser.html"><abbr title="src/WordPress/WPCrmUser.php">WPCrmUser.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">bool</span>
|
|
<span class="phpdocumentor-signature__name">$opt_in</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"><p>— true if the account is opt in</p>
|
|
</section>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_password">
|
|
$password
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_password" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/WordPress/WPCrmUser.php"><a href="files/src-wordpress-wpcrmuser.html"><abbr title="src/WordPress/WPCrmUser.php">WPCrmUser.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$password</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"><p>Required only on create,
|
|
must have upper and lowers chars,
|
|
at least 1 number,
|
|
at leat 1 upper char,
|
|
at least 1 lower char and
|
|
at leat 1 special char</p>
|
|
</section>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_phone">
|
|
$phone
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_phone" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/WordPress/WPCrmUser.php"><a href="files/src-wordpress-wpcrmuser.html"><abbr title="src/WordPress/WPCrmUser.php">WPCrmUser.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$phone</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"><p>— The account phone</p>
|
|
</section>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_postcode">
|
|
$postcode
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_postcode" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/WordPress/WPCrmUser.php"><a href="files/src-wordpress-wpcrmuser.html"><abbr title="src/WordPress/WPCrmUser.php">WPCrmUser.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$postcode</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"><p>— The account city postcode</p>
|
|
</section>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_status">
|
|
$status
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_status" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/WordPress/WPCrmUser.php"><a href="files/src-wordpress-wpcrmuser.html"><abbr title="src/WordPress/WPCrmUser.php">WPCrmUser.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">bool</span>
|
|
<span class="phpdocumentor-signature__name">$status</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"><p>— true if the account is activated</p>
|
|
</section>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_uuidToken">
|
|
$uuidToken
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_uuidToken" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/WordPress/WPCrmUser.php"><a href="files/src-wordpress-wpcrmuser.html"><abbr title="src/WordPress/WPCrmUser.php">WPCrmUser.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$uuidToken</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"><p>— A local transaction token for this user</p>
|
|
</section>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_info">
|
|
$info
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_info" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/WordPress/WPCrmUser.php"><a href="files/src-wordpress-wpcrmuser.html"><abbr title="src/WordPress/WPCrmUser.php">WPCrmUser.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">90</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">The CRM customer info (the api response)</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__type"><a href="classes/LDC-LDCCRM-Models-Customer.html"><abbr title="\LDC\LDCCRM\Models\Customer">Customer</abbr></a></span>
|
|
<span class="phpdocumentor-signature__name">$info</span>
|
|
= <span class="phpdocumentor-signature__default-value">null</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_pemail">
|
|
$pemail
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_pemail" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/WordPress/WPCrmUser.php"><a href="files/src-wordpress-wpcrmuser.html"><abbr title="src/WordPress/WPCrmUser.php">WPCrmUser.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">83</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">The CRM customer email</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$pemail</span>
|
|
= <span class="phpdocumentor-signature__default-value">null</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_phashcode">
|
|
$phashcode
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_phashcode" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/WordPress/WPCrmUser.php"><a href="files/src-wordpress-wpcrmuser.html"><abbr title="src/WordPress/WPCrmUser.php">WPCrmUser.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">76</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">The CRM hashcode (UUID)</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$phashcode</span>
|
|
= <span class="phpdocumentor-signature__default-value">null</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_uuidToken">
|
|
$uuidToken
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_uuidToken" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/WordPress/WPCrmUser.php"><a href="files/src-wordpress-wpcrmuser.html"><abbr title="src/WordPress/WPCrmUser.php">WPCrmUser.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">97</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">The CRM customer temp uuidToken to validate transactions</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$uuidToken</span>
|
|
= <span class="phpdocumentor-signature__default-value">null</span></code>
|
|
|
|
|
|
<section class="phpdocumentor-description"><p>UUID</p>
|
|
</section>
|
|
|
|
|
|
|
|
</article>
|
|
</section>
|
|
|
|
<section class="phpdocumentor-methods">
|
|
<h3 class="phpdocumentor-elements__header" id="methods">
|
|
Methods
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h3>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method___construct">
|
|
__construct()
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/WordPress/WPCrmUser.php"><a href="files/src-wordpress-wpcrmuser.html"><abbr title="src/WordPress/WPCrmUser.php">WPCrmUser.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">105</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">WPCrmUser construct</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$hashcode</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$email</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$hashcode</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>The customer hashcode (UUID).</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$email</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>The customer email.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">mixed</span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method___get">
|
|
__get()
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#method___get" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/WordPress/WPCrmUser.php"><a href="files/src-wordpress-wpcrmuser.html"><abbr title="src/WordPress/WPCrmUser.php">WPCrmUser.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">118</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Generic accessor</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">__get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$prop</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool|string|<a href="classes/LDC-LDCCRM-Enums-Country.html"><abbr title="\LDC\LDCCRM\Enums\Country">Country</abbr></a>|null</span></code>
|
|
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$prop</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>The prop to get.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool|string|<a href="classes/LDC-LDCCRM-Enums-Country.html"><abbr title="\LDC\LDCCRM\Enums\Country">Country</abbr></a>|null</span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method___set">
|
|
__set()
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#method___set" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/WordPress/WPCrmUser.php"><a href="files/src-wordpress-wpcrmuser.html"><abbr title="src/WordPress/WPCrmUser.php">WPCrmUser.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">141</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Generic mutator</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">__set</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$prop</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
|
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$prop</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>The property to assign.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$value</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>The value to set.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">void</span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_activate">
|
|
activate()
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#method_activate" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/WordPress/WPCrmUser.php"><a href="files/src-wordpress-wpcrmuser.html"><abbr title="src/WordPress/WPCrmUser.php">WPCrmUser.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">267</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Activate the account in the crm</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">activate</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">throws</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/LDC-LDCCRM-Exceptions-ValidationException.html"><abbr title="\LDC\LDCCRM\Exceptions\ValidationException">ValidationException</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"><p>If a customer's hashcode could not be validated.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">throws</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/LDC-LDCCRM-Exceptions-CrmException.html"><abbr title="\LDC\LDCCRM\Exceptions\CrmException">CrmException</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"><p>If an error occurs on server side or on getting response.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">throws</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/LDC-LDCCRM-Exceptions-ApiErrorException.html"><abbr title="\LDC\LDCCRM\Exceptions\ApiErrorException">ApiErrorException</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"><p>If any error or \LDC\LDCCRM\Enums\ApiError occurs.
|
|
Possibles are : - modelNotFound, If this customer hashcode could not be found.
|
|
- customerAlreadyActive, It the customer is already activated.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>true if succeeded</p>
|
|
</section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_delete">
|
|
delete()
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#method_delete" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/WordPress/WPCrmUser.php"><a href="files/src-wordpress-wpcrmuser.html"><abbr title="src/WordPress/WPCrmUser.php">WPCrmUser.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">238</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Delete current customer to
|
|
the local database and on crm</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">delete</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">throws</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><abbr title="\LDC\LDCCRM\WordPress\LDC\LDCCRM\Exceptions\CrmException">CrmException</abbr></span>
|
|
|
|
<section class="phpdocumentor-description"><p>If a critical error occured.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">throws</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/LDC-LDCCRM-Exceptions-ApiErrorException.html"><abbr title="\LDC\LDCCRM\Exceptions\ApiErrorException">ApiErrorException</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"><p>If any error or \LDC\LDCCRM\Enums\ApiError occurs.
|
|
Possibles are : - modelNotFound, If this customer hashcode could not be found.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>true if the operation succeeded false otherwise</p>
|
|
</section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_jsonSerialize">
|
|
jsonSerialize()
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#method_jsonSerialize" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/WordPress/WPCrmUser.php"><a href="files/src-wordpress-wpcrmuser.html"><abbr title="src/WordPress/WPCrmUser.php">WPCrmUser.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">206</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Serialize this object to an array</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">jsonSerialize</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
|
|
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_parseFromJson">
|
|
parseFromJson()
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#method_parseFromJson" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/WordPress/WPCrmUser.php"><a href="files/src-wordpress-wpcrmuser.html"><abbr title="src/WordPress/WPCrmUser.php">WPCrmUser.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">184</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Generate a user from session data</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">parseFromJson</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$string</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html"><abbr title="\LDC\LDCCRM\WordPress\WPCrmUser">WPCrmUser</abbr></a></span></code>
|
|
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$string</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>The json data stored in session.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">throws</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/LDC-LDCCRM-Exceptions-WpCrmInvalidJsonUserInfo.html"><abbr title="\LDC\LDCCRM\Exceptions\WpCrmInvalidJsonUserInfo">WpCrmInvalidJsonUserInfo</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"><p>If the json string does no
|
|
contain the needed information.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type"><a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html"><abbr title="\LDC\LDCCRM\WordPress\WPCrmUser">WPCrmUser</abbr></a></span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_save">
|
|
save()
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#method_save" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/WordPress/WPCrmUser.php"><a href="files/src-wordpress-wpcrmuser.html"><abbr title="src/WordPress/WPCrmUser.php">WPCrmUser.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">224</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Save current customer to
|
|
the local database and on crm</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">save</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">throws</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><abbr title="\LDC\LDCCRM\WordPress\LDC\LDCCRM\Exceptions\CrmException">CrmException</abbr></span>
|
|
|
|
<section class="phpdocumentor-description"><p>If a critical error occured.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">throws</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/LDC-LDCCRM-Exceptions-ApiErrorException.html"><abbr title="\LDC\LDCCRM\Exceptions\ApiErrorException">ApiErrorException</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"><p>If any error or \LDC\LDCCRM\Enums\ApiError occurs.
|
|
Possibles are : - validationFailed, If provided data is wrong(CRM side).
|
|
- modelNotFound, If this customer hashcode could not be found.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>true if the operation succeeded false otherwise</p>
|
|
</section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_setInfo">
|
|
setInfo()
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#method_setInfo" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/WordPress/WPCrmUser.php"><a href="files/src-wordpress-wpcrmuser.html"><abbr title="src/WordPress/WPCrmUser.php">WPCrmUser.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">168</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Set the customer info
|
|
with api response</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">setInfo</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/LDC-LDCCRM-Models-Customer.html"><abbr title="\LDC\LDCCRM\Models\Customer">Customer</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$customer</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
|
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$customer</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/LDC-LDCCRM-Models-Customer.html"><abbr title="\LDC\LDCCRM\Models\Customer">Customer</abbr></a></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>The Api object reponse (user).</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">void</span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_toggleOptin">
|
|
toggleOptin()
|
|
<a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html#method_toggleOptin" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/WordPress/WPCrmUser.php"><a href="files/src-wordpress-wpcrmuser.html"><abbr title="src/WordPress/WPCrmUser.php">WPCrmUser.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">252</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Toggle the current user optin value
|
|
on the current user and the crm</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">toggleOptin</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">throws</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><abbr title="\LDC\LDCCRM\WordPress\LDC\LDCCRM\Exceptions\CrmException">CrmException</abbr></span>
|
|
|
|
<section class="phpdocumentor-description"><p>If a critical error occured.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">throws</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/LDC-LDCCRM-Exceptions-ApiErrorException.html"><abbr title="\LDC\LDCCRM\Exceptions\ApiErrorException">ApiErrorException</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"><p>If any error or \LDC\LDCCRM\Enums\ApiError occurs.
|
|
Possibles are : - modelNotFound, If this customer hashcode could not be found.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>true if the operation succeeded</p>
|
|
</section>
|
|
|
|
|
|
</article>
|
|
</section>
|
|
|
|
|
|
<script type="text/javascript">
|
|
function loadExternalCodeSnippets(line) {
|
|
Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
|
|
var src = pre.getAttribute('data-src').replace( /\\/g, '/');
|
|
var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
|
|
var language = 'php';
|
|
|
|
var code = document.createElement('code');
|
|
code.className = 'language-' + language;
|
|
|
|
pre.textContent = '';
|
|
|
|
pre.setAttribute('data-line', line)
|
|
code.textContent = 'Loading…';
|
|
|
|
pre.appendChild(code);
|
|
|
|
var xhr = new XMLHttpRequest();
|
|
|
|
xhr.open('GET', src, true);
|
|
|
|
xhr.onreadystatechange = function () {
|
|
if (xhr.readyState == 4) {
|
|
|
|
if (xhr.status < 400 && xhr.responseText) {
|
|
code.textContent = xhr.responseText;
|
|
|
|
Prism.highlightElement(code);
|
|
}
|
|
else if (xhr.status >= 400) {
|
|
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
|
|
}
|
|
else {
|
|
code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
|
|
}
|
|
}
|
|
};
|
|
|
|
xhr.send(null);
|
|
});
|
|
}
|
|
|
|
var modals = document.querySelectorAll("[data-modal]");
|
|
|
|
modals.forEach(function (trigger) {
|
|
trigger.addEventListener("click", function (event) {
|
|
//event.preventDefault();
|
|
const modal = document.getElementById(trigger.dataset.modal);
|
|
modal.classList.add("phpdocumentor-modal__open");
|
|
loadExternalCodeSnippets(trigger.dataset.line)
|
|
const exits = modal.querySelectorAll("[data-exit-button]");
|
|
exits.forEach(function (exit) {
|
|
exit.addEventListener("click", function (event) {
|
|
event.preventDefault();
|
|
modal.classList.remove("phpdocumentor-modal__open");
|
|
});
|
|
});
|
|
});
|
|
});
|
|
</script>
|
|
|
|
</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="classes/LDC-LDCCRM-WordPress-WPCrmUser.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>
|