ldc-crm-client/docs/client-api/classes/LDC-LDCCRM-WordPress-WPCrm.html
Jérémy Munsch 23fdfca0be
Tests OK
2023-10-05 12:16:43 +02:00

2278 lines
111 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>CRM V4</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=Open+Sans:wght@100;200;300;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/template.js"></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 V4</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 -three 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" class="">LDC</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/ldc-ldccrm.html" class="">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" class="">LDCCrmClient</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="packages/LDCCrmClient-exceptions.html" class="">exceptions</a>
</li>
<li>
<a href="packages/LDCCrmClient-models.html" class="">models</a>
</li>
<li>
<a href="packages/LDCCrmClient-transport.html" class="">transport</a>
</li>
<li>
<a href="packages/LDCCrmClient-utilities.html" class="">utilities</a>
</li>
<li>
<a href="packages/LDCCrmClient-Wordpress.html" class="">Wordpress</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/None.html" class="">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 -nine phpdocumentor-content">
<section>
<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">
WPCrm
<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>
</h2>
<div class="phpdocumentor-label-line">
</div>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/WordPress/WPCrm.php"><a href="files/src-wordpress-wpcrm.html"><abbr title="src/WordPress/WPCrm.php">WPCrm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">46</span>
</aside>
<p class="phpdocumentor-summary">Class de gestion des users en session avec Wordpress</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#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="toc">
Table of Contents
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<h4 id="toc-properties">
Properties
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#property_api">$api</a>
<span>
&nbsp;: <a href="classes/LDC-LDCCRM-CrmApiV4.html"><abbr title="\LDC\LDCCRM\CrmApiV4">CrmApiV4</abbr></a>|null </span>
</dt>
<dd>The user object</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#property_user">$user</a>
<span>
&nbsp;: <a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html"><abbr title="\LDC\LDCCRM\WordPress\WPCrmUser">WPCrmUser</abbr></a>|null </span>
</dt>
<dd>The user object</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#property_sessionDestroyed">$sessionDestroyed</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>The session live status</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#property_sessionKey">$sessionKey</a>
<span>
&nbsp;: string|null </span>
</dt>
<dd>The session key name</dd>
</dl>
<h4 id="toc-methods">
Methods
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_activateUser">activateUser()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Toggle the current user optin value
on the current user and the crm</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_check">check()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Check if the user is logged in.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_deleteUser">deleteUser()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Delete current customer from
the local database and the crm</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_forceLogin">forceLogin()</a>
<span>
&nbsp;: <abbr title="\LDCCRM\WPCrmUser">WPCrmUser</abbr>|null </span>
</dt>
<dd>Manually login a user
If self::$user is already set.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_getNewUser">getNewUser()</a>
<span>
&nbsp;: <a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html"><abbr title="\LDC\LDCCRM\WordPress\WPCrmUser">WPCrmUser</abbr></a> </span>
</dt>
<dd>Generate a new user</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_getUser">getUser()</a>
<span>
&nbsp;: <a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html"><abbr title="\LDC\LDCCRM\WordPress\WPCrmUser">WPCrmUser</abbr></a>|null </span>
</dt>
<dd>Get the current user
return null if the user is not logged in</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_getUserFromApi">getUserFromApi()</a>
<span>
&nbsp;: <abbr title="\LDC\LDCCRM\Wordpress\WPCrmUser">WPCrmUser</abbr>|false </span>
</dt>
<dd>Get the current user
return api response code if an error occurs</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_getUserFromTable">getUserFromTable()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt;|null </span>
</dt>
<dd>Get a customer from table</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_getUserFromTableByEmail">getUserFromTableByEmail()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt;|null </span>
</dt>
<dd>Get a customer from table by an email</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_getUserFromTableByUuid">getUserFromTableByUuid()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt;|null </span>
</dt>
<dd>Get a customer from table by an email</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_login">login()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Try to login with CRM API
A session will be started if credentials are valid.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_logout">logout()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Destroy the customer from session
and therefore logout</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_saveUser">saveUser()</a>
<span>
&nbsp;: 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-WPCrm.html#method_setSingleOptin">setSingleOptin()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Set the single optin status for an email
on the crm</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_toggleUserOptin">toggleUserOptin()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Toggle the current user optin value
on the current user and the crm</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_unsetActiveUser">unsetActiveUser()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Remove active user
to prevent WPCrm::check to return true</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_bootSessionIfNeeded">bootSessionIfNeeded()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Boot the php session if needed</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_deleteUserFromTable">deleteUserFromTable()</a>
<span>
&nbsp;: int </span>
</dt>
<dd>Save or update the user to the table</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_getCustomer">getCustomer()</a>
<span>
&nbsp;: <a href="classes/LDC-LDCCRM-Models-Customer.html"><abbr title="\LDC\LDCCRM\Models\Customer">Customer</abbr></a>|null </span>
</dt>
<dd>Get all customer infos</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_getWpDb">getWpDb()</a>
<span>
&nbsp;: object </span>
</dt>
<dd>Get WP &#039;pdo instance&#039;</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_initLdcApi">initLdcApi()</a>
<span>
&nbsp;: <a href="classes/LDC-LDCCRM-CrmApiV4.html"><abbr title="\LDC\LDCCRM\CrmApiV4">CrmApiV4</abbr></a> </span>
</dt>
<dd>Get the initialized API object</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_loginUserWithApi">loginUserWithApi()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Check customer credentials using the CRM.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_makeApiV4Call">makeApiV4Call()</a>
<span>
&nbsp;: mixed|false </span>
</dt>
<dd>Make a call using apiV4</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_query">query()</a>
<span>
&nbsp;: int|bool </span>
</dt>
<dd>Query in DB</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_saveOrUpdateUserToTable">saveOrUpdateUserToTable()</a>
<span>
&nbsp;: int </span>
</dt>
<dd>Save or update the user to the table</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_setUser">setUser()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Create a user
stores it to the session
and finally saves it to the database if it does not exists</dd>
</dl>
<section class="phpdocumentor-properties">
<h3 class="phpdocumentor-elements__header" id="properties">
Properties
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="
phpdocumentor-element
-property
-protected
-static "
>
<h4 class="phpdocumentor-element__name" id="property_api">
$api
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#property_api" 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/WPCrm.php"><a href="files/src-wordpress-wpcrm.html"><abbr title="src/WordPress/WPCrm.php">WPCrm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">67</span>
</aside>
<p class="phpdocumentor-summary">The user object</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type"><a href="classes/LDC-LDCCRM-CrmApiV4.html"><abbr title="\LDC\LDCCRM\CrmApiV4">CrmApiV4</abbr></a>|null</span>
<span class="phpdocumentor-signature__name">$api</span>
= <span class="phpdocumentor-signature__default-value">null</span></code>
</article>
<article
class="
phpdocumentor-element
-property
-protected
-static "
>
<h4 class="phpdocumentor-element__name" id="property_user">
$user
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#property_user" 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/WPCrm.php"><a href="files/src-wordpress-wpcrm.html"><abbr title="src/WordPress/WPCrm.php">WPCrm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">74</span>
</aside>
<p class="phpdocumentor-summary">The user object</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type"><a href="classes/LDC-LDCCRM-WordPress-WPCrmUser.html"><abbr title="\LDC\LDCCRM\WordPress\WPCrmUser">WPCrmUser</abbr></a>|null</span>
<span class="phpdocumentor-signature__name">$user</span>
= <span class="phpdocumentor-signature__default-value">null</span></code>
</article>
<article
class="
phpdocumentor-element
-property
-private
-static "
>
<h4 class="phpdocumentor-element__name" id="property_sessionDestroyed">
$sessionDestroyed
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#property_sessionDestroyed" 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/WPCrm.php"><a href="files/src-wordpress-wpcrm.html"><abbr title="src/WordPress/WPCrm.php">WPCrm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">60</span>
</aside>
<p class="phpdocumentor-summary">The session live status</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">bool</span>
<span class="phpdocumentor-signature__name">$sessionDestroyed</span>
= <span class="phpdocumentor-signature__default-value">false</span></code>
</article>
<article
class="
phpdocumentor-element
-property
-private
-static "
>
<h4 class="phpdocumentor-element__name" id="property_sessionKey">
$sessionKey
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#property_sessionKey" 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/WPCrm.php"><a href="files/src-wordpress-wpcrm.html"><abbr title="src/WordPress/WPCrm.php">WPCrm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">53</span>
</aside>
<p class="phpdocumentor-summary">The session key name</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">string|null</span>
<span class="phpdocumentor-signature__name">$sessionKey</span>
= <span class="phpdocumentor-signature__default-value">null</span></code>
</article>
</section>
<section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods">
Methods
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_activateUser">
activateUser()
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_activateUser" 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/WPCrm.php"><a href="files/src-wordpress-wpcrm.html"><abbr title="src/WordPress/WPCrm.php">WPCrm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">314</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__static">static</span> <span class="phpdocumentor-signature__name">activateUser</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_activateUser#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>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
&mdash;
<section class="phpdocumentor-description"><p>True if the operation succeeded.</p>
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_check">
check()
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_check" 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/WPCrm.php"><a href="files/src-wordpress-wpcrm.html"><abbr title="src/WordPress/WPCrm.php">WPCrm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">181</span>
</aside>
<p class="phpdocumentor-summary">Check if the user is logged in.</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">check</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>This means he has an active valid session.</p>
</section>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_deleteUser">
deleteUser()
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_deleteUser" 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/WPCrm.php"><a href="files/src-wordpress-wpcrm.html"><abbr title="src/WordPress/WPCrm.php">WPCrm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">229</span>
</aside>
<p class="phpdocumentor-summary">Delete current customer from
the local database and the crm</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">deleteUser</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_deleteUser#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-CrmException.html"><abbr title="\LDC\LDCCRM\Exceptions\CrmException">CrmException</abbr></a></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>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">phpcs:ignore</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Squiz.Commenting.FunctionCommentThrowTag.WrongNumber</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
&mdash;
<section class="phpdocumentor-description"><p>true if the operation succeeded</p>
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_forceLogin">
forceLogin()
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_forceLogin" 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/WPCrm.php"><a href="files/src-wordpress-wpcrm.html"><abbr title="src/WordPress/WPCrm.php">WPCrm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">94</span>
</aside>
<p class="phpdocumentor-summary">Manually login a user
If self::$user is already set.</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">forceLogin</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\LDCCRM\WPCrmUser">WPCrmUser</abbr>|null</span></code>
<div class="phpdocumentor-label-line">
</div>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><abbr title="\LDCCRM\WPCrmUser">WPCrmUser</abbr>|null</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_getNewUser">
getNewUser()
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_getNewUser" 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/WPCrm.php"><a href="files/src-wordpress-wpcrm.html"><abbr title="src/WordPress/WPCrm.php">WPCrm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">334</span>
</aside>
<p class="phpdocumentor-summary">Generate a new user</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">getNewUser</span><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>
<div class="phpdocumentor-label-line">
</div>
<section>
<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>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_getUser">
getUser()
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_getUser" 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/WPCrm.php"><a href="files/src-wordpress-wpcrm.html"><abbr title="src/WordPress/WPCrm.php">WPCrm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">82</span>
</aside>
<p class="phpdocumentor-summary">Get the current user
return null if the user is not logged in</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">getUser</span><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>|null</span></code>
<div class="phpdocumentor-label-line">
</div>
<section>
<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>|null</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_getUserFromApi">
getUserFromApi()
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_getUserFromApi" 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/WPCrm.php"><a href="files/src-wordpress-wpcrm.html"><abbr title="src/WordPress/WPCrm.php">WPCrm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">114</span>
</aside>
<p class="phpdocumentor-summary">Get the current user
return api response code if an error occurs</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">getUserFromApi</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$identification</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\LDC\LDCCRM\Wordpress\WPCrmUser">WPCrmUser</abbr>|false</span></code>
<div class="phpdocumentor-label-line">
</div>
<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">$identification</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The customer hashcode or email.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_getUserFromApi#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-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.</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">phpcs:ignore</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Squiz.Commenting.FunctionCommentThrowTag.WrongNumber</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><abbr title="\LDC\LDCCRM\Wordpress\WPCrmUser">WPCrmUser</abbr>|false</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_getUserFromTable">
getUserFromTable()
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_getUserFromTable" 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/WPCrm.php"><a href="files/src-wordpress-wpcrm.html"><abbr title="src/WordPress/WPCrm.php">WPCrm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">503</span>
</aside>
<p class="phpdocumentor-summary">Get a customer from table</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">getUserFromTable</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$hashcode</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|null</span></code>
<div class="phpdocumentor-label-line">
</div>
<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>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The customer hashcode.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|null</span>
&mdash;
<section class="phpdocumentor-description"><p>Database query result in format specified by $output or null on failure.</p>
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_getUserFromTableByEmail">
getUserFromTableByEmail()
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_getUserFromTableByEmail" 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/WPCrm.php"><a href="files/src-wordpress-wpcrm.html"><abbr title="src/WordPress/WPCrm.php">WPCrm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">523</span>
</aside>
<p class="phpdocumentor-summary">Get a customer from table by an email</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">getUserFromTableByEmail</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$email</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|null</span></code>
<div class="phpdocumentor-label-line">
</div>
<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">$email</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The customer email.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|null</span>
&mdash;
<section class="phpdocumentor-description"><p>Database query result in format specified by $output or null on failure.</p>
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_getUserFromTableByUuid">
getUserFromTableByUuid()
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_getUserFromTableByUuid" 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/WPCrm.php"><a href="files/src-wordpress-wpcrm.html"><abbr title="src/WordPress/WPCrm.php">WPCrm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">543</span>
</aside>
<p class="phpdocumentor-summary">Get a customer from table by an email</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">getUserFromTableByUuid</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$uuid</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|null</span></code>
<div class="phpdocumentor-label-line">
</div>
<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">$uuid</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The customer transaction uuid.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|null</span>
&mdash;
<section class="phpdocumentor-description"><p>Database query result in format specified by $output or null on failure.</p>
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_login">
login()
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_login" 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/WPCrm.php"><a href="files/src-wordpress-wpcrm.html"><abbr title="src/WordPress/WPCrm.php">WPCrm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">148</span>
</aside>
<p class="phpdocumentor-summary">Try to login with CRM API
A session will be started if credentials are valid.</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">login</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$email</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$password</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<div class="phpdocumentor-label-line">
</div>
<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">$email</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The customer email.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$password</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The customer password.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_login#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-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 : - authFailed, If credentials are not valid.
- customerNotActivated, If the account is not activated.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_logout">
logout()
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_logout" 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/WPCrm.php"><a href="files/src-wordpress-wpcrm.html"><abbr title="src/WordPress/WPCrm.php">WPCrm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">167</span>
</aside>
<p class="phpdocumentor-summary">Destroy the customer from session
and therefore logout</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">logout</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<div class="phpdocumentor-label-line">
</div>
</article>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_saveUser">
saveUser()
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_saveUser" 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/WPCrm.php"><a href="files/src-wordpress-wpcrm.html"><abbr title="src/WordPress/WPCrm.php">WPCrm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">198</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__static">static</span> <span class="phpdocumentor-signature__name">saveUser</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_saveUser#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-CrmException.html"><abbr title="\LDC\LDCCRM\Exceptions\CrmException">CrmException</abbr></a></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>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">phpcs:ignore</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Squiz.Commenting.FunctionCommentThrowTag.WrongNumber</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
&mdash;
<section class="phpdocumentor-description"><p>true if the operation succeeded false otherwise</p>
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_setSingleOptin">
setSingleOptin()
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_setSingleOptin" 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/WPCrm.php"><a href="files/src-wordpress-wpcrm.html"><abbr title="src/WordPress/WPCrm.php">WPCrm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">296</span>
</aside>
<p class="phpdocumentor-summary">Set the single optin status for an email
on the crm</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">setSingleOptin</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$email</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$opt_in</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<div class="phpdocumentor-label-line">
</div>
<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">$email</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$opt_in</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_setSingleOptin#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 field email 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 : - singleOptinCustomerExists, If a customer exists with this email.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
&mdash;
<section class="phpdocumentor-description"><p>true if the operation succeeded false otherwise</p>
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_toggleUserOptin">
toggleUserOptin()
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_toggleUserOptin" 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/WPCrm.php"><a href="files/src-wordpress-wpcrm.html"><abbr title="src/WordPress/WPCrm.php">WPCrm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">261</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__static">static</span> <span class="phpdocumentor-signature__name">toggleUserOptin</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_toggleUserOptin#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-CrmException.html"><abbr title="\LDC\LDCCRM\Exceptions\CrmException">CrmException</abbr></a></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>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">phpcs:ignore</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Squiz.Commenting.FunctionCommentThrowTag.WrongNumber</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
&mdash;
<section class="phpdocumentor-description"><p>true if the operation succeeded</p>
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_unsetActiveUser">
unsetActiveUser()
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_unsetActiveUser" 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/WPCrm.php"><a href="files/src-wordpress-wpcrm.html"><abbr title="src/WordPress/WPCrm.php">WPCrm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">346</span>
</aside>
<p class="phpdocumentor-summary">Remove active user
to prevent WPCrm::check to return true</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">unsetActiveUser</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<div class="phpdocumentor-label-line">
</div>
</article>
<article
class="phpdocumentor-element
-method
-private
-static "
>
<h4 class="phpdocumentor-element__name" id="method_bootSessionIfNeeded">
bootSessionIfNeeded()
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_bootSessionIfNeeded" 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/WPCrm.php"><a href="files/src-wordpress-wpcrm.html"><abbr title="src/WordPress/WPCrm.php">WPCrm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">463</span>
</aside>
<p class="phpdocumentor-summary">Boot the php session if needed</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">bootSessionIfNeeded</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<div class="phpdocumentor-label-line">
</div>
</article>
<article
class="phpdocumentor-element
-method
-private
-static "
>
<h4 class="phpdocumentor-element__name" id="method_deleteUserFromTable">
deleteUserFromTable()
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_deleteUserFromTable" 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/WPCrm.php"><a href="files/src-wordpress-wpcrm.html"><abbr title="src/WordPress/WPCrm.php">WPCrm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">588</span>
</aside>
<p class="phpdocumentor-summary">Save or update the user to the table</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">deleteUserFromTable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
<div class="phpdocumentor-label-line">
</div>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">int</span>
&mdash;
<section class="phpdocumentor-description"><p>The number of row removed from the table.</p>
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
-private
-static "
>
<h4 class="phpdocumentor-element__name" id="method_getCustomer">
getCustomer()
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_getCustomer" 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/WPCrm.php"><a href="files/src-wordpress-wpcrm.html"><abbr title="src/WordPress/WPCrm.php">WPCrm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">379</span>
</aside>
<p class="phpdocumentor-summary">Get all customer infos</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">getCustomer</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/LDC-LDCCRM-Models-Customer.html"><abbr title="\LDC\LDCCRM\Models\Customer">Customer</abbr></a>|null</span></code>
<div class="phpdocumentor-label-line">
</div>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/LDC-LDCCRM-Models-Customer.html"><abbr title="\LDC\LDCCRM\Models\Customer">Customer</abbr></a>|null</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-private
-static "
>
<h4 class="phpdocumentor-element__name" id="method_getWpDb">
getWpDb()
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_getWpDb" 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/WPCrm.php"><a href="files/src-wordpress-wpcrm.html"><abbr title="src/WordPress/WPCrm.php">WPCrm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">619</span>
</aside>
<p class="phpdocumentor-summary">Get WP &#039;pdo instance&#039;</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">getWpDb</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">object</span></code>
<div class="phpdocumentor-label-line">
</div>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">object</span>
&mdash;
<section class="phpdocumentor-description"><p>The $wpdb variable</p>
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
-private
-static "
>
<h4 class="phpdocumentor-element__name" id="method_initLdcApi">
initLdcApi()
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_initLdcApi" 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/WPCrm.php"><a href="files/src-wordpress-wpcrm.html"><abbr title="src/WordPress/WPCrm.php">WPCrm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">416</span>
</aside>
<p class="phpdocumentor-summary">Get the initialized API object</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">initLdcApi</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/LDC-LDCCRM-CrmApiV4.html"><abbr title="\LDC\LDCCRM\CrmApiV4">CrmApiV4</abbr></a></span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_initLdcApi#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="\ErrorException">ErrorException</abbr></span>
<section class="phpdocumentor-description"><p>If php does not have extension curl.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/LDC-LDCCRM-CrmApiV4.html"><abbr title="\LDC\LDCCRM\CrmApiV4">CrmApiV4</abbr></a></span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-private
-static "
>
<h4 class="phpdocumentor-element__name" id="method_loginUserWithApi">
loginUserWithApi()
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_loginUserWithApi" 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/WPCrm.php"><a href="files/src-wordpress-wpcrm.html"><abbr title="src/WordPress/WPCrm.php">WPCrm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">365</span>
</aside>
<p class="phpdocumentor-summary">Check customer credentials using the CRM.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">loginUserWithApi</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$email</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$password</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<div class="phpdocumentor-label-line">
</div>
<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">$email</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The customer email.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$password</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The customer password.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_loginUserWithApi#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-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 : - authFailed, If credentials are not valid.
- customerNotActivated, If the account is not activated.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-private
-static "
>
<h4 class="phpdocumentor-element__name" id="method_makeApiV4Call">
makeApiV4Call()
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_makeApiV4Call" 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/WPCrm.php"><a href="files/src-wordpress-wpcrm.html"><abbr title="src/WordPress/WPCrm.php">WPCrm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">439</span>
</aside>
<p class="phpdocumentor-summary">Make a call using apiV4</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">makeApiV4Call</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">object|string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$obj</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$method</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$arguments</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed|false</span></code>
<div class="phpdocumentor-label-line">
</div>
<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">$obj</span>
: <span class="phpdocumentor-signature__argument__return-type">object|string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>An object or a class name.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$method</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The method to call.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$arguments</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Arguments to pass.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_makeApiV4Call#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-ApiErrorException.html"><abbr title="\LDC\LDCCRM\Exceptions\ApiErrorException">ApiErrorException</abbr></a></span>
<section class="phpdocumentor-description"><p>If any of this exception is thrown.</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 a critical error occured.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed|false</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-private
-static "
>
<h4 class="phpdocumentor-element__name" id="method_query">
query()
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_query" 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/WPCrm.php"><a href="files/src-wordpress-wpcrm.html"><abbr title="src/WordPress/WPCrm.php">WPCrm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">607</span>
</aside>
<p class="phpdocumentor-summary">Query in DB</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">query</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$query</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$params</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int|bool</span></code>
<div class="phpdocumentor-label-line">
</div>
<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">$query</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>La request avec les variables en points d'interrogation.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Les paramètres des la requète.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">int|bool</span>
&mdash;
<section class="phpdocumentor-description"><p>Boolean true for CREATE, ALTER, TRUNCATE and DROP queries.
Number of rows affected/selected for all other queries. Boolean false on error.</p>
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
-private
-static "
>
<h4 class="phpdocumentor-element__name" id="method_saveOrUpdateUserToTable">
saveOrUpdateUserToTable()
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_saveOrUpdateUserToTable" 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/WPCrm.php"><a href="files/src-wordpress-wpcrm.html"><abbr title="src/WordPress/WPCrm.php">WPCrm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">561</span>
</aside>
<p class="phpdocumentor-summary">Save or update the user to the table</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">saveOrUpdateUserToTable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
<div class="phpdocumentor-label-line">
</div>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">int</span>
&mdash;
<section class="phpdocumentor-description"><p>The number of row affected on the table.</p>
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
-private
-static "
>
<h4 class="phpdocumentor-element__name" id="method_setUser">
setUser()
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_setUser" 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/WPCrm.php"><a href="files/src-wordpress-wpcrm.html"><abbr title="src/WordPress/WPCrm.php">WPCrm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">401</span>
</aside>
<p class="phpdocumentor-summary">Create a user
stores it to the session
and finally saves it to the database if it does not exists</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">setUser</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>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$customer</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<div class="phpdocumentor-label-line">
</div>
<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">
</dd>
</dl>
</article>
</section>
<div class="phpdocumentor-modal" id="source-view">
<div class="phpdocumentor-modal-bg" data-exit-button></div>
<div class="phpdocumentor-modal-container">
<div class="phpdocumentor-modal-content">
<pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/WordPress/WPCrm.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
</div>
<button data-exit-button class="phpdocumentor-modal__close">&times;</button>
</div>
</div>
<script type="text/javascript">
(function () {
function loadExternalCodeSnippet(el, url, line) {
Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
const language = 'php';
const 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) {
return;
}
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
return;
}
if (xhr.status === 404) {
code.textContent = '✖ Error: File could not be found';
return;
}
if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
return;
}
code.textContent = '✖ Error: An unknown error occurred';
};
xhr.send(null);
});
}
const modalButtons = document.querySelectorAll("[data-modal]");
const openedAsLocalFile = window.location.protocol === 'file:';
if (modalButtons.length > 0 && openedAsLocalFile) {
console.warn(
'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
'browsers block XHR requests when a page is opened this way'
);
}
modalButtons.forEach(function (trigger) {
if (openedAsLocalFile) {
trigger.setAttribute("hidden", "hidden");
}
trigger.addEventListener("click", function (event) {
event.preventDefault();
const modal = document.getElementById(trigger.dataset.modal);
if (!modal) {
console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
return;
}
modal.classList.add("phpdocumentor-modal__open");
loadExternalCodeSnippet(modal, trigger.dataset.src || null, 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>
<section class="phpdocumentor-on-this-page__sidebar">
<section class="phpdocumentor-on-this-page__content">
<strong class="phpdocumentor-on-this-page__title">On this page</strong>
<ul class="phpdocumentor-list -clean">
<li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
<li>
<ul class="phpdocumentor-list -clean">
<li><a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#toc-properties">Properties</a></li>
<li><a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#toc-methods">Methods</a></li>
</ul>
</li>
<li class="phpdocumentor-on-this-page-section__title">Properties</li>
<li>
<ul class="phpdocumentor-list -clean">
<li><a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#property_api">$api<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html"></li>
<li><a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#property_user">$user<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html"></li>
<li><a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#property_sessionDestroyed">$sessionDestroyed<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html"></li>
<li><a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#property_sessionKey">$sessionKey<a href="classes/LDC-LDCCRM-WordPress-WPCrm.html"></li>
</ul>
</li>
<li class="phpdocumentor-on-this-page-section__title">Methods</li>
<li>
<ul class="phpdocumentor-list -clean">
<li><a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_activateUser">activateUser()</a></li>
<li><a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_check">check()</a></li>
<li><a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_deleteUser">deleteUser()</a></li>
<li><a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_forceLogin">forceLogin()</a></li>
<li><a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_getNewUser">getNewUser()</a></li>
<li><a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_getUser">getUser()</a></li>
<li><a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_getUserFromApi">getUserFromApi()</a></li>
<li><a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_getUserFromTable">getUserFromTable()</a></li>
<li><a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_getUserFromTableByEmail">getUserFromTableByEmail()</a></li>
<li><a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_getUserFromTableByUuid">getUserFromTableByUuid()</a></li>
<li><a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_login">login()</a></li>
<li><a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_logout">logout()</a></li>
<li><a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_saveUser">saveUser()</a></li>
<li><a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_setSingleOptin">setSingleOptin()</a></li>
<li><a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_toggleUserOptin">toggleUserOptin()</a></li>
<li><a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_unsetActiveUser">unsetActiveUser()</a></li>
<li><a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_bootSessionIfNeeded">bootSessionIfNeeded()</a></li>
<li><a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_deleteUserFromTable">deleteUserFromTable()</a></li>
<li><a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_getCustomer">getCustomer()</a></li>
<li><a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_getWpDb">getWpDb()</a></li>
<li><a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_initLdcApi">initLdcApi()</a></li>
<li><a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_loginUserWithApi">loginUserWithApi()</a></li>
<li><a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_makeApiV4Call">makeApiV4Call()</a></li>
<li><a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_query">query()</a></li>
<li><a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_saveOrUpdateUserToTable">saveOrUpdateUserToTable()</a></li>
<li><a href="classes/LDC-LDCCRM-WordPress-WPCrm.html#method_setUser">setUser()</a></li>
</ul>
</li>
</ul>
</section>
</section>
</div>
<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>
<a href="classes/LDC-LDCCRM-WordPress-WPCrm.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>