2021-08-09 09:18:46 +02:00
|
|
|
<!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">
|
2021-12-19 13:43:26 +01:00
|
|
|
<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>
|
|
|
|
|
|
2021-08-09 09:18:46 +02:00
|
|
|
</section>
|
2021-12-19 13:43:26 +01:00
|
|
|
<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>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
</section>
|
2021-12-19 13:43:26 +01:00
|
|
|
|
2021-08-09 09:18:46 +02:00
|
|
|
<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-models.html">Models</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<article class="phpdocumentor-element -class">
|
|
|
|
|
<h2 class="phpdocumentor-content__title">
|
|
|
|
|
Customer
|
|
|
|
|
|
|
|
|
|
<span class="phpdocumentor-element__extends">
|
|
|
|
|
extends <abbr title="\LDC\LDCCRM\Models\CrmClientModel">CrmClientModel</abbr>
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
<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-models.html">models</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</h2>
|
|
|
|
|
|
|
|
|
|
<aside class="phpdocumentor-element-found-in">
|
|
|
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.php</abbr></a></abbr>
|
|
|
|
|
:
|
2021-12-19 13:43:26 +01:00
|
|
|
<span class="phpdocumentor-element-found-in__line">47</span>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
|
|
|
|
<p class="phpdocumentor-summary">This class represents the customer info with
|
|
|
|
|
the account validation status. You can use it as
|
|
|
|
|
a standalone class but beware of catching exceptions</p>
|
|
|
|
|
|
2021-12-19 13:43:26 +01:00
|
|
|
<section class="phpdocumentor-description"><p>Be warned that on server side data is normalized</p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li>firstname and lastname are 'capitalized'</li>
|
|
|
|
|
<li>fields are trimmed</li>
|
|
|
|
|
<li>non numeric chars are removed from postcode</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
<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">example</span>
|
|
|
|
|
</dt>
|
|
|
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-description"><p>examples/CustomerExample.php</p>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
<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 Models</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>models</p>
|
|
|
|
|
</section>
|
|
|
|
|
|
2021-12-19 13:43:26 +01:00
|
|
|
</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>
|
|
|
|
|
|
2021-08-09 09:18:46 +02:00
|
|
|
</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-Models-Customer.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-Models-Customer.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-Models-Customer.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-Models-Customer.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-Models-Customer.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-Models-Customer.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-Models-Customer.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-Models-Customer.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-Models-Customer.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-Models-Customer.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-Models-Customer.html#property_opt_in">$opt_in</a>
|
|
|
|
|
<span>
|
|
|
|
|
: bool </span>
|
|
|
|
|
</dt>
|
2021-08-11 17:36:59 +02:00
|
|
|
<dd></dd>
|
|
|
|
|
|
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.html#property_password">$password</a>
|
|
|
|
|
<span>
|
|
|
|
|
: string </span>
|
|
|
|
|
</dt>
|
2021-08-09 09:18:46 +02:00
|
|
|
<dd></dd>
|
|
|
|
|
|
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.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-Models-Customer.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-Models-Customer.html#property_status">$status</a>
|
|
|
|
|
<span>
|
|
|
|
|
: bool </span>
|
|
|
|
|
</dt>
|
|
|
|
|
<dd></dd>
|
|
|
|
|
|
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.html#property_invisibleFields">$invisibleFields</a>
|
|
|
|
|
<span>
|
|
|
|
|
: array<string|int, mixed> </span>
|
|
|
|
|
</dt>
|
|
|
|
|
<dd>The crm customer fields
|
|
|
|
|
the should not be visible</dd>
|
|
|
|
|
|
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.html#property_modelFields">$modelFields</a>
|
|
|
|
|
<span>
|
|
|
|
|
: array<string|int, mixed> </span>
|
|
|
|
|
</dt>
|
|
|
|
|
<dd>The crm customer fields</dd>
|
|
|
|
|
|
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.html#property_validation">$validation</a>
|
|
|
|
|
<span>
|
|
|
|
|
: array<string|int, mixed> </span>
|
|
|
|
|
</dt>
|
|
|
|
|
<dd>Validation rules</dd>
|
|
|
|
|
|
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.html#property_address">$address</a>
|
|
|
|
|
<span>
|
|
|
|
|
: string </span>
|
|
|
|
|
</dt>
|
|
|
|
|
<dd>The user address (street number, name, etc)</dd>
|
|
|
|
|
|
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.html#property_address2">$address2</a>
|
|
|
|
|
<span>
|
|
|
|
|
: string </span>
|
|
|
|
|
</dt>
|
|
|
|
|
<dd>The user address 2nd part (street number, name, more, etc)</dd>
|
|
|
|
|
|
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.html#property_birth_date">$birth_date</a>
|
|
|
|
|
<span>
|
|
|
|
|
: string </span>
|
|
|
|
|
</dt>
|
|
|
|
|
<dd>Birth date</dd>
|
|
|
|
|
|
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.html#property_city">$city</a>
|
|
|
|
|
<span>
|
|
|
|
|
: string </span>
|
|
|
|
|
</dt>
|
|
|
|
|
<dd>The user address city</dd>
|
|
|
|
|
|
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.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>The user address postcode</dd>
|
|
|
|
|
|
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.html#property_email">$email</a>
|
|
|
|
|
<span>
|
|
|
|
|
: string </span>
|
|
|
|
|
</dt>
|
|
|
|
|
<dd>An RFC Valid Email</dd>
|
|
|
|
|
|
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.html#property_firstname">$firstname</a>
|
|
|
|
|
<span>
|
|
|
|
|
: string </span>
|
|
|
|
|
</dt>
|
|
|
|
|
<dd>First name</dd>
|
|
|
|
|
|
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.html#property_hashcode">$hashcode</a>
|
|
|
|
|
<span>
|
|
|
|
|
: string </span>
|
|
|
|
|
</dt>
|
|
|
|
|
<dd>The user hashcode, this is link with the customer and the brand it is related to
|
|
|
|
|
It is used to identify the customer itself.</dd>
|
|
|
|
|
|
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.html#property_last_connection">$last_connection</a>
|
|
|
|
|
<span>
|
|
|
|
|
: string </span>
|
|
|
|
|
</dt>
|
|
|
|
|
<dd>The last time the account was connected</dd>
|
|
|
|
|
|
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.html#property_lastname">$lastname</a>
|
|
|
|
|
<span>
|
|
|
|
|
: string </span>
|
|
|
|
|
</dt>
|
|
|
|
|
<dd>Last name</dd>
|
|
|
|
|
|
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.html#property_opt_in">$opt_in</a>
|
|
|
|
|
<span>
|
|
|
|
|
: bool </span>
|
|
|
|
|
</dt>
|
|
|
|
|
<dd>The user optin choice</dd>
|
|
|
|
|
|
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.html#property_password">$password</a>
|
|
|
|
|
<span>
|
|
|
|
|
: string </span>
|
|
|
|
|
</dt>
|
|
|
|
|
<dd>The user password
|
|
|
|
|
This is set only when creating a user
|
|
|
|
|
Otherwise it has to be set to null</dd>
|
|
|
|
|
|
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.html#property_phone">$phone</a>
|
|
|
|
|
<span>
|
|
|
|
|
: string </span>
|
|
|
|
|
</dt>
|
|
|
|
|
<dd>The user phone</dd>
|
|
|
|
|
|
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.html#property_postcode">$postcode</a>
|
|
|
|
|
<span>
|
|
|
|
|
: string </span>
|
|
|
|
|
</dt>
|
|
|
|
|
<dd>The user address postcode</dd>
|
|
|
|
|
|
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.html#property_status">$status</a>
|
|
|
|
|
<span>
|
|
|
|
|
: bool </span>
|
|
|
|
|
</dt>
|
|
|
|
|
<dd>Is the account activated ?</dd>
|
|
|
|
|
|
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.html#method___construct">__construct()</a>
|
|
|
|
|
<span>
|
|
|
|
|
: mixed </span>
|
|
|
|
|
</dt>
|
2021-12-19 13:43:26 +01:00
|
|
|
<dd>Customer</dd>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.html#method___get">__get()</a>
|
|
|
|
|
<span>
|
2021-12-19 13:43:26 +01:00
|
|
|
: mixed|null </span>
|
2021-08-09 09:18:46 +02:00
|
|
|
</dt>
|
2021-12-19 13:43:26 +01:00
|
|
|
<dd>Generic accessor</dd>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.html#method___set">__set()</a>
|
|
|
|
|
<span>
|
2021-12-19 13:43:26 +01:00
|
|
|
: void </span>
|
2021-08-09 09:18:46 +02:00
|
|
|
</dt>
|
2021-12-19 13:43:26 +01:00
|
|
|
<dd>Set prop on the model.</dd>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.html#method_activate">activate()</a>
|
|
|
|
|
<span>
|
|
|
|
|
: bool </span>
|
|
|
|
|
</dt>
|
2021-12-19 13:43:26 +01:00
|
|
|
<dd>Active the customer on CRM.</dd>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.html#method_delete">delete()</a>
|
|
|
|
|
<span>
|
|
|
|
|
: bool </span>
|
|
|
|
|
</dt>
|
2021-12-19 13:43:26 +01:00
|
|
|
<dd>Removes the customer from CRM.</dd>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.html#method_fill">fill()</a>
|
|
|
|
|
<span>
|
|
|
|
|
: void </span>
|
|
|
|
|
</dt>
|
2021-12-19 13:43:26 +01:00
|
|
|
<dd>Fill values into model using validation rules.</dd>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.html#method_find">find()</a>
|
|
|
|
|
<span>
|
|
|
|
|
: self|null </span>
|
|
|
|
|
</dt>
|
|
|
|
|
<dd>Find a customer using its hashcode in the crm</dd>
|
|
|
|
|
|
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.html#method_findWithEmail">findWithEmail()</a>
|
|
|
|
|
<span>
|
|
|
|
|
: self|null </span>
|
|
|
|
|
</dt>
|
|
|
|
|
<dd>Find a customer using its email in the crm
|
|
|
|
|
This is an alias of Customer::find()</dd>
|
|
|
|
|
|
2021-09-14 14:23:31 +02:00
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.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-Models-Customer.html#method_login">login()</a>
|
|
|
|
|
<span>
|
|
|
|
|
: bool </span>
|
|
|
|
|
</dt>
|
|
|
|
|
<dd>Test customer credentials</dd>
|
|
|
|
|
|
2021-08-09 09:18:46 +02:00
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.html#method_save">save()</a>
|
|
|
|
|
<span>
|
|
|
|
|
: bool </span>
|
|
|
|
|
</dt>
|
2021-12-19 13:43:26 +01:00
|
|
|
<dd>Save the customer on CRM.</dd>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.html#method_toggleOptin">toggleOptin()</a>
|
|
|
|
|
<span>
|
|
|
|
|
: bool </span>
|
|
|
|
|
</dt>
|
|
|
|
|
<dd>Toggle the account optin value in the crm</dd>
|
|
|
|
|
|
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.html#method_validateAllValues">validateAllValues()</a>
|
|
|
|
|
<span>
|
|
|
|
|
: array<string|int, mixed> </span>
|
|
|
|
|
</dt>
|
|
|
|
|
<dd>Validate all model properties</dd>
|
|
|
|
|
|
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.html#method_store">store()</a>
|
|
|
|
|
<span>
|
|
|
|
|
: bool </span>
|
|
|
|
|
</dt>
|
2021-12-19 13:43:26 +01:00
|
|
|
<dd>Calls api store customer method</dd>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.html#method_update">update()</a>
|
|
|
|
|
<span>
|
|
|
|
|
: bool </span>
|
|
|
|
|
</dt>
|
2021-12-19 13:43:26 +01:00
|
|
|
<dd>Calls api update customer method</dd>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-properties">
|
|
|
|
|
<h3 class="phpdocumentor-elements__header" id="properties">
|
|
|
|
|
Properties
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.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-Models-Customer.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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.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-Models-Customer.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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.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-Models-Customer.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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.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-Models-Customer.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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.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-Models-Customer.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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.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-Models-Customer.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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.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-Models-Customer.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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.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-Models-Customer.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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.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-Models-Customer.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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.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-Models-Customer.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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.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-Models-Customer.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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.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>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2021-08-11 17:36:59 +02:00
|
|
|
</article>
|
|
|
|
|
<article
|
|
|
|
|
class="
|
|
|
|
|
phpdocumentor-element
|
|
|
|
|
-property
|
|
|
|
|
-public
|
|
|
|
|
"
|
|
|
|
|
>
|
|
|
|
|
<h4 class="phpdocumentor-element__name" id="property_password">
|
|
|
|
|
$password
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.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>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2021-08-09 09:18:46 +02:00
|
|
|
</article>
|
|
|
|
|
<article
|
|
|
|
|
class="
|
|
|
|
|
phpdocumentor-element
|
|
|
|
|
-property
|
|
|
|
|
-public
|
|
|
|
|
"
|
|
|
|
|
>
|
|
|
|
|
<h4 class="phpdocumentor-element__name" id="property_phone">
|
|
|
|
|
$phone
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.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-Models-Customer.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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.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-Models-Customer.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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.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
|
|
|
|
|
-protected
|
|
|
|
|
"
|
|
|
|
|
>
|
|
|
|
|
<h4 class="phpdocumentor-element__name" id="property_invisibleFields">
|
|
|
|
|
$invisibleFields
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.html#property_invisibleFields" 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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.php</abbr></a></abbr>
|
|
|
|
|
:
|
2021-12-19 13:43:26 +01:00
|
|
|
<span class="phpdocumentor-element-found-in__line">255</span>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
|
|
|
|
<p class="phpdocumentor-summary">The crm customer fields
|
|
|
|
|
the should not be visible</p>
|
|
|
|
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
|
|
|
<span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
|
|
|
|
<span class="phpdocumentor-signature__name">$invisibleFields</span>
|
|
|
|
|
= <span class="phpdocumentor-signature__default-value">['password']</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
|
|
|
<article
|
|
|
|
|
class="
|
|
|
|
|
phpdocumentor-element
|
|
|
|
|
-property
|
|
|
|
|
-protected
|
|
|
|
|
"
|
|
|
|
|
>
|
|
|
|
|
<h4 class="phpdocumentor-element__name" id="property_modelFields">
|
|
|
|
|
$modelFields
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.html#property_modelFields" 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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.php</abbr></a></abbr>
|
|
|
|
|
:
|
2021-12-19 13:43:26 +01:00
|
|
|
<span class="phpdocumentor-element-found-in__line">242</span>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
|
|
|
|
<p class="phpdocumentor-summary">The crm customer fields</p>
|
|
|
|
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
|
|
|
<span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
|
|
|
|
<span class="phpdocumentor-signature__name">$modelFields</span>
|
|
|
|
|
= <span class="phpdocumentor-signature__default-value">['hashcode', 'email', 'firstname', 'password', 'lastname', 'birth_date', 'phone', 'address', 'address2', 'city', 'postcode', 'country', 'opt_in', 'status', 'last_connection']</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
|
|
|
<article
|
|
|
|
|
class="
|
|
|
|
|
phpdocumentor-element
|
|
|
|
|
-property
|
|
|
|
|
-protected
|
|
|
|
|
-static "
|
|
|
|
|
>
|
|
|
|
|
<h4 class="phpdocumentor-element__name" id="property_validation">
|
|
|
|
|
$validation
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.html#property_validation" 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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.php</abbr></a></abbr>
|
|
|
|
|
:
|
2021-12-19 13:43:26 +01:00
|
|
|
<span class="phpdocumentor-element-found-in__line">264</span>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
|
|
|
|
<p class="phpdocumentor-summary">Validation rules</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">array<string|int, mixed></span>
|
|
|
|
|
<span class="phpdocumentor-signature__name">$validation</span>
|
2021-12-19 13:43:26 +01:00
|
|
|
= <span class="phpdocumentor-signature__default-value">['hashcode' => 'required|uuid', 'email' => 'required|email', 'firstname' => 'required|string|min:1|max:255', 'lastname' => 'required|string|min:1|max:255', 'password' => 'required|min:8|max:255|mixedCase|containDigit|containSymbol', 'birth_date' => 'required|date_format:Y-m-d', 'phone' => 'sometimes|nullable|string|max:255', 'address' => 'sometimes|string|max:255', 'address2' => 'sometimes|string|max:255', 'city' => 'sometimes|string|min:2|max:255', 'postcode' => 'sometimes|string|max:255', 'country' => ['sometimes'], 'opt_in' => 'required|bool', 'status' => 'required|bool', 'last_connection' => 'sometimes|date']</span></code>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
|
|
|
<article
|
|
|
|
|
class="
|
|
|
|
|
phpdocumentor-element
|
|
|
|
|
-property
|
|
|
|
|
-private
|
|
|
|
|
"
|
|
|
|
|
>
|
|
|
|
|
<h4 class="phpdocumentor-element__name" id="property_address">
|
|
|
|
|
$address
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.php</abbr></a></abbr>
|
|
|
|
|
:
|
2021-12-19 13:43:26 +01:00
|
|
|
<span class="phpdocumentor-element-found-in__line">153</span>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
|
|
|
|
<p class="phpdocumentor-summary">The user address (street number, name, etc)</p>
|
|
|
|
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
|
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
|
|
|
<span class="phpdocumentor-signature__name">$address</span>
|
|
|
|
|
= <span class="phpdocumentor-signature__default-value">null</span></code>
|
|
|
|
|
|
2021-09-14 14:23:31 +02:00
|
|
|
<section class="phpdocumentor-description"><p>Validate: sometimes,string</p>
|
|
|
|
|
<p>Min length NA
|
2021-08-09 09:18:46 +02:00
|
|
|
Max length 255
|
|
|
|
|
Field Type varchar</p>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
|
|
|
<article
|
|
|
|
|
class="
|
|
|
|
|
phpdocumentor-element
|
|
|
|
|
-property
|
|
|
|
|
-private
|
|
|
|
|
"
|
|
|
|
|
>
|
|
|
|
|
<h4 class="phpdocumentor-element__name" id="property_address2">
|
|
|
|
|
$address2
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.php</abbr></a></abbr>
|
|
|
|
|
:
|
2021-12-19 13:43:26 +01:00
|
|
|
<span class="phpdocumentor-element-found-in__line">166</span>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
|
|
|
|
<p class="phpdocumentor-summary">The user address 2nd part (street number, name, more, etc)</p>
|
|
|
|
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
|
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
|
|
|
<span class="phpdocumentor-signature__name">$address2</span>
|
|
|
|
|
= <span class="phpdocumentor-signature__default-value">null</span></code>
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-description"><p>Validate: sometimes,string</p>
|
2021-09-14 14:23:31 +02:00
|
|
|
<p>Min length NA
|
2021-08-09 09:18:46 +02:00
|
|
|
Max length 255
|
|
|
|
|
Field Type varchar</p>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
|
|
|
<article
|
|
|
|
|
class="
|
|
|
|
|
phpdocumentor-element
|
|
|
|
|
-property
|
|
|
|
|
-private
|
|
|
|
|
"
|
|
|
|
|
>
|
|
|
|
|
<h4 class="phpdocumentor-element__name" id="property_birth_date">
|
|
|
|
|
$birth_date
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.php</abbr></a></abbr>
|
|
|
|
|
:
|
2021-12-19 13:43:26 +01:00
|
|
|
<span class="phpdocumentor-element-found-in__line">126</span>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
|
|
|
|
<p class="phpdocumentor-summary">Birth date</p>
|
|
|
|
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
|
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
|
|
|
<span class="phpdocumentor-signature__name">$birth_date</span>
|
|
|
|
|
= <span class="phpdocumentor-signature__default-value">null</span></code>
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-description"><p>Validate: date_format:Y-m-d</p>
|
|
|
|
|
<p>Required
|
|
|
|
|
Field Type Date</p>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
|
|
|
<article
|
|
|
|
|
class="
|
|
|
|
|
phpdocumentor-element
|
|
|
|
|
-property
|
|
|
|
|
-private
|
|
|
|
|
"
|
|
|
|
|
>
|
|
|
|
|
<h4 class="phpdocumentor-element__name" id="property_city">
|
|
|
|
|
$city
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.php</abbr></a></abbr>
|
|
|
|
|
:
|
2021-12-19 13:43:26 +01:00
|
|
|
<span class="phpdocumentor-element-found-in__line">179</span>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
|
|
|
|
<p class="phpdocumentor-summary">The user address city</p>
|
|
|
|
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
|
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
|
|
|
<span class="phpdocumentor-signature__name">$city</span>
|
|
|
|
|
= <span class="phpdocumentor-signature__default-value">null</span></code>
|
|
|
|
|
|
2021-09-14 14:23:31 +02:00
|
|
|
<section class="phpdocumentor-description"><p>Validate: sometimes,string</p>
|
|
|
|
|
<p>Min length NA
|
2021-08-09 09:18:46 +02:00
|
|
|
Max length 255
|
|
|
|
|
Field Type varchar</p>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
|
|
|
<article
|
|
|
|
|
class="
|
|
|
|
|
phpdocumentor-element
|
|
|
|
|
-property
|
|
|
|
|
-private
|
|
|
|
|
"
|
|
|
|
|
>
|
|
|
|
|
<h4 class="phpdocumentor-element__name" id="property_country">
|
|
|
|
|
$country
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.php</abbr></a></abbr>
|
|
|
|
|
:
|
2021-12-19 13:43:26 +01:00
|
|
|
<span class="phpdocumentor-element-found-in__line">205</span>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
|
|
|
|
<p class="phpdocumentor-summary">The user address postcode</p>
|
|
|
|
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
|
|
<span class="phpdocumentor-signature__visibility">private</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>
|
|
|
|
|
= <span class="phpdocumentor-signature__default-value">null</span></code>
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-description"><p>Validate: sometimes, in Country::toValues()</p>
|
|
|
|
|
<p>Required
|
2021-12-19 13:43:26 +01:00
|
|
|
Field Type tinyInt</p>
|
2021-08-09 09:18:46 +02:00
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
|
|
|
<article
|
|
|
|
|
class="
|
|
|
|
|
phpdocumentor-element
|
|
|
|
|
-property
|
|
|
|
|
-private
|
|
|
|
|
"
|
|
|
|
|
>
|
|
|
|
|
<h4 class="phpdocumentor-element__name" id="property_email">
|
|
|
|
|
$email
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.php</abbr></a></abbr>
|
|
|
|
|
:
|
2021-12-19 13:43:26 +01:00
|
|
|
<span class="phpdocumentor-element-found-in__line">76</span>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
|
|
|
|
<p class="phpdocumentor-summary">An RFC Valid Email</p>
|
|
|
|
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
|
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
|
|
|
<span class="phpdocumentor-signature__name">$email</span>
|
|
|
|
|
= <span class="phpdocumentor-signature__default-value">null</span></code>
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-description"><p>Validate: rfc,dns,spoof,filter</p>
|
|
|
|
|
<p>Required
|
|
|
|
|
Min length N/A
|
|
|
|
|
Max length 255
|
|
|
|
|
Field Type varchar</p>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
|
|
|
<article
|
|
|
|
|
class="
|
|
|
|
|
phpdocumentor-element
|
|
|
|
|
-property
|
|
|
|
|
-private
|
|
|
|
|
"
|
|
|
|
|
>
|
|
|
|
|
<h4 class="phpdocumentor-element__name" id="property_firstname">
|
|
|
|
|
$firstname
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.php</abbr></a></abbr>
|
|
|
|
|
:
|
2021-12-19 13:43:26 +01:00
|
|
|
<span class="phpdocumentor-element-found-in__line">103</span>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
|
|
|
|
<p class="phpdocumentor-summary">First name</p>
|
|
|
|
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
|
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
|
|
|
<span class="phpdocumentor-signature__name">$firstname</span>
|
|
|
|
|
= <span class="phpdocumentor-signature__default-value">null</span></code>
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-description"><p>Required
|
|
|
|
|
Min length 2
|
|
|
|
|
Max length 255
|
|
|
|
|
Field Type varchar</p>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
|
|
|
<article
|
|
|
|
|
class="
|
|
|
|
|
phpdocumentor-element
|
|
|
|
|
-property
|
|
|
|
|
-private
|
|
|
|
|
"
|
|
|
|
|
>
|
|
|
|
|
<h4 class="phpdocumentor-element__name" id="property_hashcode">
|
|
|
|
|
$hashcode
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.php</abbr></a></abbr>
|
|
|
|
|
:
|
2021-12-19 13:43:26 +01:00
|
|
|
<span class="phpdocumentor-element-found-in__line">62</span>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
|
|
|
|
<p class="phpdocumentor-summary">The user hashcode, this is link with the customer and the brand it is related to
|
|
|
|
|
It is used to identify the customer itself.</p>
|
|
|
|
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
|
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
|
|
|
<span class="phpdocumentor-signature__name">$hashcode</span>
|
|
|
|
|
</code>
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-description"><p>Validate: UUID, in customer_infos</p>
|
|
|
|
|
<p>Required
|
|
|
|
|
Min length 36
|
|
|
|
|
Max length 36
|
|
|
|
|
Field Type varchar</p>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
|
|
|
<article
|
|
|
|
|
class="
|
|
|
|
|
phpdocumentor-element
|
|
|
|
|
-property
|
|
|
|
|
-private
|
|
|
|
|
"
|
|
|
|
|
>
|
|
|
|
|
<h4 class="phpdocumentor-element__name" id="property_last_connection">
|
|
|
|
|
$last_connection
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.php</abbr></a></abbr>
|
|
|
|
|
:
|
2021-12-19 13:43:26 +01:00
|
|
|
<span class="phpdocumentor-element-found-in__line">235</span>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
|
|
|
|
<p class="phpdocumentor-summary">The last time the account was connected</p>
|
|
|
|
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
|
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
|
|
|
<span class="phpdocumentor-signature__name">$last_connection</span>
|
|
|
|
|
= <span class="phpdocumentor-signature__default-value">null</span></code>
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-description"><p>This field is read only</p>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
|
|
|
<article
|
|
|
|
|
class="
|
|
|
|
|
phpdocumentor-element
|
|
|
|
|
-property
|
|
|
|
|
-private
|
|
|
|
|
"
|
|
|
|
|
>
|
|
|
|
|
<h4 class="phpdocumentor-element__name" id="property_lastname">
|
|
|
|
|
$lastname
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.php</abbr></a></abbr>
|
|
|
|
|
:
|
2021-12-19 13:43:26 +01:00
|
|
|
<span class="phpdocumentor-element-found-in__line">115</span>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
|
|
|
|
<p class="phpdocumentor-summary">Last name</p>
|
|
|
|
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
|
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
|
|
|
<span class="phpdocumentor-signature__name">$lastname</span>
|
|
|
|
|
= <span class="phpdocumentor-signature__default-value">null</span></code>
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-description"><p>Required
|
|
|
|
|
Min length 2
|
|
|
|
|
Max length 255
|
|
|
|
|
Field Type varchar</p>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
|
|
|
<article
|
|
|
|
|
class="
|
|
|
|
|
phpdocumentor-element
|
|
|
|
|
-property
|
|
|
|
|
-private
|
|
|
|
|
"
|
|
|
|
|
>
|
|
|
|
|
<h4 class="phpdocumentor-element__name" id="property_opt_in">
|
|
|
|
|
$opt_in
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.php</abbr></a></abbr>
|
|
|
|
|
:
|
2021-12-19 13:43:26 +01:00
|
|
|
<span class="phpdocumentor-element-found-in__line">217</span>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
|
|
|
|
<p class="phpdocumentor-summary">The user optin choice</p>
|
|
|
|
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
|
|
|
<span class="phpdocumentor-signature__type">bool</span>
|
|
|
|
|
<span class="phpdocumentor-signature__name">$opt_in</span>
|
|
|
|
|
= <span class="phpdocumentor-signature__default-value">false</span></code>
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-description"><p>Validate: boolean</p>
|
|
|
|
|
<p>Required
|
|
|
|
|
Field Type TinyInt</p>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
|
|
|
<article
|
|
|
|
|
class="
|
|
|
|
|
phpdocumentor-element
|
|
|
|
|
-property
|
|
|
|
|
-private
|
|
|
|
|
"
|
|
|
|
|
>
|
|
|
|
|
<h4 class="phpdocumentor-element__name" id="property_password">
|
|
|
|
|
$password
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.php</abbr></a></abbr>
|
|
|
|
|
:
|
2021-12-19 13:43:26 +01:00
|
|
|
<span class="phpdocumentor-element-found-in__line">91</span>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
|
|
|
|
<p class="phpdocumentor-summary">The user password
|
|
|
|
|
This is set only when creating a user
|
|
|
|
|
Otherwise it has to be set to null</p>
|
|
|
|
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
|
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
|
|
|
<span class="phpdocumentor-signature__name">$password</span>
|
|
|
|
|
= <span class="phpdocumentor-signature__default-value">null</span></code>
|
|
|
|
|
|
2021-08-11 17:36:59 +02:00
|
|
|
<section class="phpdocumentor-description"><p>Validate: case_diff,numbers,letters,symbols,min:8</p>
|
|
|
|
|
<p>Min length 8
|
2021-08-09 09:18:46 +02:00
|
|
|
Max length 255
|
|
|
|
|
Field Type varchar</p>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
|
|
|
<article
|
|
|
|
|
class="
|
|
|
|
|
phpdocumentor-element
|
|
|
|
|
-property
|
|
|
|
|
-private
|
|
|
|
|
"
|
|
|
|
|
>
|
|
|
|
|
<h4 class="phpdocumentor-element__name" id="property_phone">
|
|
|
|
|
$phone
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.php</abbr></a></abbr>
|
|
|
|
|
:
|
2021-12-19 13:43:26 +01:00
|
|
|
<span class="phpdocumentor-element-found-in__line">140</span>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
|
|
|
|
<p class="phpdocumentor-summary">The user phone</p>
|
|
|
|
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
|
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
|
|
|
<span class="phpdocumentor-signature__name">$phone</span>
|
|
|
|
|
= <span class="phpdocumentor-signature__default-value">null</span></code>
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-description"><p>Validate: sometimes,string</p>
|
|
|
|
|
<p>Required
|
|
|
|
|
Min length NA
|
|
|
|
|
Max length 255
|
|
|
|
|
Field Type varchar</p>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
|
|
|
<article
|
|
|
|
|
class="
|
|
|
|
|
phpdocumentor-element
|
|
|
|
|
-property
|
|
|
|
|
-private
|
|
|
|
|
"
|
|
|
|
|
>
|
|
|
|
|
<h4 class="phpdocumentor-element__name" id="property_postcode">
|
|
|
|
|
$postcode
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.php</abbr></a></abbr>
|
|
|
|
|
:
|
2021-12-19 13:43:26 +01:00
|
|
|
<span class="phpdocumentor-element-found-in__line">193</span>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
|
|
|
|
<p class="phpdocumentor-summary">The user address postcode</p>
|
|
|
|
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
|
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
|
|
|
<span class="phpdocumentor-signature__name">$postcode</span>
|
|
|
|
|
= <span class="phpdocumentor-signature__default-value">null</span></code>
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-description"><p>Validate: string</p>
|
|
|
|
|
<p>Required
|
|
|
|
|
Min length NA
|
|
|
|
|
Max length 255
|
|
|
|
|
Field Type varchar</p>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
|
|
|
<article
|
|
|
|
|
class="
|
|
|
|
|
phpdocumentor-element
|
|
|
|
|
-property
|
|
|
|
|
-private
|
|
|
|
|
"
|
|
|
|
|
>
|
|
|
|
|
<h4 class="phpdocumentor-element__name" id="property_status">
|
|
|
|
|
$status
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.php</abbr></a></abbr>
|
|
|
|
|
:
|
2021-12-19 13:43:26 +01:00
|
|
|
<span class="phpdocumentor-element-found-in__line">226</span>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
|
|
|
|
<p class="phpdocumentor-summary">Is the account activated ?</p>
|
|
|
|
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
|
|
|
<span class="phpdocumentor-signature__type">bool</span>
|
|
|
|
|
<span class="phpdocumentor-signature__name">$status</span>
|
|
|
|
|
= <span class="phpdocumentor-signature__default-value">false</span></code>
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-description"><p>This field is read only</p>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-methods">
|
|
|
|
|
<h3 class="phpdocumentor-elements__header" id="methods">
|
|
|
|
|
Methods
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.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-Models-Customer.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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.php</abbr></a></abbr>
|
|
|
|
|
:
|
2021-12-19 13:43:26 +01:00
|
|
|
<span class="phpdocumentor-element-found-in__line">288</span>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
2021-12-19 13:43:26 +01:00
|
|
|
<p class="phpdocumentor-summary">Customer</p>
|
|
|
|
|
|
2021-08-09 09:18:46 +02:00
|
|
|
<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">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$properties</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</span></code>
|
|
|
|
|
|
2021-12-19 13:43:26 +01:00
|
|
|
|
2021-08-09 09:18:46 +02:00
|
|
|
<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">$properties</span>
|
|
|
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
|
|
|
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
|
|
|
|
|
<dd class="phpdocumentor-argument-list__definition">
|
2021-12-19 13:43:26 +01:00
|
|
|
|
2021-08-09 09:18:46 +02:00
|
|
|
</dd>
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
2021-12-19 13:43:26 +01:00
|
|
|
<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 field could not be validated.</p>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
</dl>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
<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-Models-Customer.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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.php</abbr></a></abbr>
|
|
|
|
|
:
|
2021-09-14 14:23:31 +02:00
|
|
|
<span class="phpdocumentor-element-found-in__line">301</span>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
2021-12-19 13:43:26 +01:00
|
|
|
<p class="phpdocumentor-summary">Generic accessor</p>
|
|
|
|
|
|
2021-08-09 09:18:46 +02:00
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
2021-12-19 13:43:26 +01:00
|
|
|
<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">$field</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed|null</span></code>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
2021-12-19 13:43:26 +01:00
|
|
|
|
2021-08-09 09:18:46 +02:00
|
|
|
<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">$field</span>
|
|
|
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
|
|
|
</dt>
|
|
|
|
|
<dd class="phpdocumentor-argument-list__definition">
|
2021-12-19 13:43:26 +01:00
|
|
|
|
2021-08-09 09:18:46 +02:00
|
|
|
</dd>
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
2021-12-19 13:43:26 +01:00
|
|
|
<span class="phpdocumentor-signature__response_type">mixed|null</span>
|
2021-08-09 09:18:46 +02:00
|
|
|
—
|
2021-12-19 13:43:26 +01:00
|
|
|
<section class="phpdocumentor-description"><p>Returns null if the property was not found any way.</p>
|
|
|
|
|
</section>
|
|
|
|
|
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
</article>
|
|
|
|
|
<article
|
|
|
|
|
class="phpdocumentor-element
|
|
|
|
|
-method
|
|
|
|
|
-public
|
|
|
|
|
"
|
|
|
|
|
>
|
|
|
|
|
<h4 class="phpdocumentor-element__name" id="method___set">
|
|
|
|
|
__set()
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.php</abbr></a></abbr>
|
|
|
|
|
:
|
2021-12-19 13:43:26 +01:00
|
|
|
<span class="phpdocumentor-element-found-in__line">324</span>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
2021-12-19 13:43:26 +01:00
|
|
|
<p class="phpdocumentor-summary">Set prop on the model.</p>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
2021-12-19 13:43:26 +01:00
|
|
|
<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">$field</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>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
<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">$field</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">$value</span>
|
|
|
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
|
|
|
|
|
</dt>
|
|
|
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
|
|
|
|
|
|
</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">
|
2021-12-19 13:43:26 +01:00
|
|
|
<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 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-AccessError.html"><abbr title="\LDC\LDCCRM\Exceptions\AccessError">AccessError</abbr></a></span>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
2021-12-19 13:43:26 +01:00
|
|
|
<section class="phpdocumentor-description"><p>If trying to set a value on a unknown property.</p>
|
2021-08-09 09:18:46 +02:00
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
2021-12-19 13:43:26 +01:00
|
|
|
<span class="phpdocumentor-signature__response_type">void</span>
|
2021-08-09 09:18:46 +02:00
|
|
|
—
|
2021-12-19 13:43:26 +01:00
|
|
|
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
</article>
|
|
|
|
|
<article
|
|
|
|
|
class="phpdocumentor-element
|
|
|
|
|
-method
|
|
|
|
|
-public
|
|
|
|
|
"
|
|
|
|
|
>
|
|
|
|
|
<h4 class="phpdocumentor-element__name" id="method_activate">
|
|
|
|
|
activate()
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.php</abbr></a></abbr>
|
|
|
|
|
:
|
2021-12-19 13:43:26 +01:00
|
|
|
<span class="phpdocumentor-element-found-in__line">542</span>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
2021-12-19 13:43:26 +01:00
|
|
|
<p class="phpdocumentor-summary">Active the customer on CRM.</p>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
<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>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2021-09-14 14:23:31 +02:00
|
|
|
<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>
|
2021-12-19 13:43:26 +01:00
|
|
|
<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>
|
2021-09-14 14:23:31 +02:00
|
|
|
<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>
|
|
|
|
|
|
2021-12-19 13:43:26 +01:00
|
|
|
<section class="phpdocumentor-description"><p>If an error occurs on server side or on getting response.</p>
|
2021-09-14 14:23:31 +02:00
|
|
|
</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>
|
|
|
|
|
|
2021-12-19 13:43:26 +01:00
|
|
|
<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>
|
|
|
|
|
<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>
|
2021-09-14 14:23:31 +02:00
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
</dl>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
<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-Models-Customer.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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.php</abbr></a></abbr>
|
|
|
|
|
:
|
2021-12-19 13:43:26 +01:00
|
|
|
<span class="phpdocumentor-element-found-in__line">519</span>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
2021-12-19 13:43:26 +01:00
|
|
|
<p class="phpdocumentor-summary">Removes the customer from CRM.</p>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
<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>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2021-09-14 14:23:31 +02:00
|
|
|
<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>
|
2021-12-19 13:43:26 +01:00
|
|
|
<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 could not be validated.</p>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
|
|
|
<span class="phpdocumentor-tag__name">throws</span>
|
|
|
|
|
</dt>
|
2021-09-14 14:23:31 +02:00
|
|
|
<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>
|
|
|
|
|
|
2021-12-19 13:43:26 +01:00
|
|
|
<section class="phpdocumentor-description"><p>If an error occurs on server side or on getting response.</p>
|
2021-09-14 14:23:31 +02:00
|
|
|
</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>
|
|
|
|
|
|
2021-12-19 13:43:26 +01:00
|
|
|
<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>
|
2021-09-14 14:23:31 +02:00
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
</dl>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
<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_fill">
|
|
|
|
|
fill()
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.html#method_fill" 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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.php</abbr></a></abbr>
|
|
|
|
|
:
|
2021-12-19 13:43:26 +01:00
|
|
|
<span class="phpdocumentor-element-found-in__line">340</span>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
2021-12-19 13:43:26 +01:00
|
|
|
<p class="phpdocumentor-summary">Fill values into model using validation rules.</p>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
|
|
|
<span class="phpdocumentor-signature__name">fill</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$properties</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">$properties</span>
|
|
|
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
|
|
|
</dt>
|
|
|
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
|
|
|
|
|
|
</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">
|
2021-12-19 13:43:26 +01:00
|
|
|
<span class="phpdocumentor-tag-link"><a href="classes/LDC-LDCCRM-Exceptions-ValidationException.html"><abbr title="\LDC\LDCCRM\Exceptions\ValidationException">ValidationException</abbr></a></span>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
2021-12-19 13:43:26 +01:00
|
|
|
<section class="phpdocumentor-description"><p>If a field could not be validated.</p>
|
2021-08-09 09:18:46 +02:00
|
|
|
</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
|
|
|
|
|
-static "
|
|
|
|
|
>
|
|
|
|
|
<h4 class="phpdocumentor-element__name" id="method_find">
|
|
|
|
|
find()
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.html#method_find" 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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.php</abbr></a></abbr>
|
|
|
|
|
:
|
2021-12-19 13:43:26 +01:00
|
|
|
<span class="phpdocumentor-element-found-in__line">389</span>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
|
|
|
|
<p class="phpdocumentor-summary">Find a customer using its hashcode in 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">find</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$hashcode</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self|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">$hashcode</span>
|
|
|
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
|
|
|
</dt>
|
|
|
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
2021-09-14 14:23:31 +02:00
|
|
|
<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-CrmException.html"><abbr title="\LDC\LDCCRM\Exceptions\CrmException">CrmException</abbr></a></span>
|
|
|
|
|
|
2021-12-19 13:43:26 +01:00
|
|
|
<section class="phpdocumentor-description"><p>If an error occurs on server side or on getting response.</p>
|
2021-09-14 14:23:31 +02:00
|
|
|
</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>
|
|
|
|
|
|
2021-12-19 13:43:26 +01:00
|
|
|
<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>
|
2021-09-14 14:23:31 +02:00
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
</dl>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
|
|
|
<span class="phpdocumentor-signature__response_type">self|null</span>
|
|
|
|
|
—
|
2021-09-14 14:23:31 +02:00
|
|
|
<section class="phpdocumentor-description"><p>Return null if the customer was not found</p>
|
|
|
|
|
</section>
|
|
|
|
|
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
</article>
|
|
|
|
|
<article
|
|
|
|
|
class="phpdocumentor-element
|
|
|
|
|
-method
|
|
|
|
|
-public
|
|
|
|
|
-static "
|
|
|
|
|
>
|
|
|
|
|
<h4 class="phpdocumentor-element__name" id="method_findWithEmail">
|
|
|
|
|
findWithEmail()
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.html#method_findWithEmail" 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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.php</abbr></a></abbr>
|
|
|
|
|
:
|
2021-12-19 13:43:26 +01:00
|
|
|
<span class="phpdocumentor-element-found-in__line">421</span>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
|
|
|
|
<p class="phpdocumentor-summary">Find a customer using its email in the crm
|
|
|
|
|
This is an alias of Customer::find()</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">findWithEmail</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$email</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self|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">$email</span>
|
|
|
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
|
|
|
</dt>
|
|
|
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
2021-09-14 14:23:31 +02:00
|
|
|
<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-CrmException.html"><abbr title="\LDC\LDCCRM\Exceptions\CrmException">CrmException</abbr></a></span>
|
|
|
|
|
|
2021-12-19 13:43:26 +01:00
|
|
|
<section class="phpdocumentor-description"><p>If an error occurs on server side or on getting response.</p>
|
2021-09-14 14:23:31 +02:00
|
|
|
</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>
|
|
|
|
|
|
2021-12-19 13:43:26 +01:00
|
|
|
<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>
|
2021-09-14 14:23:31 +02:00
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
</dl>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
|
|
|
<span class="phpdocumentor-signature__response_type">self|null</span>
|
|
|
|
|
—
|
|
|
|
|
|
|
|
|
|
|
2021-09-14 14:23:31 +02:00
|
|
|
</article>
|
|
|
|
|
<article
|
|
|
|
|
class="phpdocumentor-element
|
|
|
|
|
-method
|
|
|
|
|
-public
|
|
|
|
|
"
|
|
|
|
|
>
|
|
|
|
|
<h4 class="phpdocumentor-element__name" id="method_jsonSerialize">
|
|
|
|
|
jsonSerialize()
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.php</abbr></a></abbr>
|
|
|
|
|
:
|
2021-12-19 13:43:26 +01:00
|
|
|
<span class="phpdocumentor-element-found-in__line">601</span>
|
2021-09-14 14:23:31 +02:00
|
|
|
|
|
|
|
|
</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_login">
|
|
|
|
|
login()
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.php</abbr></a></abbr>
|
|
|
|
|
:
|
2021-12-19 13:43:26 +01:00
|
|
|
<span class="phpdocumentor-element-found-in__line">584</span>
|
2021-09-14 14:23:31 +02:00
|
|
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
|
|
|
|
<p class="phpdocumentor-summary">Test customer credentials</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 </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 </span><span class="phpdocumentor-signature__argument__name">$password</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</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">$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">$password</span>
|
|
|
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
|
|
|
</dt>
|
|
|
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
|
|
|
|
|
|
</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>
|
2021-12-19 13:43:26 +01:00
|
|
|
<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 email could not be validated.</p>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
|
|
|
<span class="phpdocumentor-tag__name">throws</span>
|
|
|
|
|
</dt>
|
2021-09-14 14:23:31 +02:00
|
|
|
<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>
|
|
|
|
|
|
2021-12-19 13:43:26 +01:00
|
|
|
<section class="phpdocumentor-description"><p>If an error occurs on server side or on getting response.</p>
|
2021-09-14 14:23:31 +02:00
|
|
|
</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>
|
|
|
|
|
|
2021-12-19 13:43:26 +01:00
|
|
|
<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>
|
|
|
|
|
<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>
|
2021-09-14 14:23:31 +02:00
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
|
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
|
|
|
—
|
|
|
|
|
|
|
|
|
|
|
2021-08-09 09:18:46 +02:00
|
|
|
</article>
|
|
|
|
|
<article
|
|
|
|
|
class="phpdocumentor-element
|
|
|
|
|
-method
|
|
|
|
|
-public
|
|
|
|
|
"
|
|
|
|
|
>
|
|
|
|
|
<h4 class="phpdocumentor-element__name" id="method_save">
|
|
|
|
|
save()
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.php</abbr></a></abbr>
|
|
|
|
|
:
|
2021-12-19 13:43:26 +01:00
|
|
|
<span class="phpdocumentor-element-found-in__line">437</span>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
2021-12-19 13:43:26 +01:00
|
|
|
<p class="phpdocumentor-summary">Save the customer on CRM.</p>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
<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>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2021-09-14 14:23:31 +02:00
|
|
|
<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>
|
2021-12-19 13:43:26 +01:00
|
|
|
<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 could not be validated.</p>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
|
|
|
<span class="phpdocumentor-tag__name">throws</span>
|
|
|
|
|
</dt>
|
2021-09-14 14:23:31 +02:00
|
|
|
<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>
|
|
|
|
|
|
2021-12-19 13:43:26 +01:00
|
|
|
<section class="phpdocumentor-description"><p>If an error occurs on server side or on getting response.</p>
|
2021-09-14 14:23:31 +02:00
|
|
|
</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>
|
|
|
|
|
|
2021-12-19 13:43:26 +01:00
|
|
|
<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 (new customers only).</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>
|
2021-09-14 14:23:31 +02:00
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
</dl>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
|
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
|
|
|
—
|
2021-12-19 13:43:26 +01:00
|
|
|
<section class="phpdocumentor-description"><p>True if save was successfull.</p>
|
2021-08-09 09:18:46 +02:00
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
|
|
|
<article
|
|
|
|
|
class="phpdocumentor-element
|
|
|
|
|
-method
|
|
|
|
|
-public
|
|
|
|
|
"
|
|
|
|
|
>
|
|
|
|
|
<h4 class="phpdocumentor-element__name" id="method_toggleOptin">
|
|
|
|
|
toggleOptin()
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.php</abbr></a></abbr>
|
|
|
|
|
:
|
2021-12-19 13:43:26 +01:00
|
|
|
<span class="phpdocumentor-element-found-in__line">565</span>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
|
|
|
|
<p class="phpdocumentor-summary">Toggle the account optin value in 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>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2021-09-14 14:23:31 +02:00
|
|
|
<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>
|
2021-12-19 13:43:26 +01:00
|
|
|
<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 could not be validated.</p>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
|
|
|
<span class="phpdocumentor-tag__name">throws</span>
|
|
|
|
|
</dt>
|
2021-09-14 14:23:31 +02:00
|
|
|
<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>
|
|
|
|
|
|
2021-12-19 13:43:26 +01:00
|
|
|
<section class="phpdocumentor-description"><p>If an error occurs on server side or on getting response.</p>
|
2021-09-14 14:23:31 +02:00
|
|
|
</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>
|
|
|
|
|
|
2021-12-19 13:43:26 +01:00
|
|
|
<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>
|
2021-09-14 14:23:31 +02:00
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
</dl>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
<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
|
|
|
|
|
-protected
|
|
|
|
|
"
|
|
|
|
|
>
|
|
|
|
|
<h4 class="phpdocumentor-element__name" id="method_validateAllValues">
|
|
|
|
|
validateAllValues()
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.html#method_validateAllValues" 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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.php</abbr></a></abbr>
|
|
|
|
|
:
|
2021-12-19 13:43:26 +01:00
|
|
|
<span class="phpdocumentor-element-found-in__line">363</span>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
|
|
|
|
<p class="phpdocumentor-summary">Validate all model properties</p>
|
|
|
|
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
|
|
|
<span class="phpdocumentor-signature__name">validateAllValues</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$ignore</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, 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">$ignore</span>
|
|
|
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
|
|
|
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
|
|
|
|
|
<dd class="phpdocumentor-argument-list__definition">
|
2021-12-19 13:43:26 +01:00
|
|
|
|
2021-08-09 09:18:46 +02:00
|
|
|
</dd>
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
2021-12-19 13:43:26 +01:00
|
|
|
<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 field could not be validated.</p>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
</dl>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
|
|
|
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
|
|
|
|
|
—
|
|
|
|
|
<section class="phpdocumentor-description"><p>the validated values</p>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
|
|
|
<article
|
|
|
|
|
class="phpdocumentor-element
|
|
|
|
|
-method
|
|
|
|
|
-private
|
|
|
|
|
"
|
|
|
|
|
>
|
|
|
|
|
<h4 class="phpdocumentor-element__name" id="method_store">
|
|
|
|
|
store()
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.html#method_store" 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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.php</abbr></a></abbr>
|
|
|
|
|
:
|
2021-12-19 13:43:26 +01:00
|
|
|
<span class="phpdocumentor-element-found-in__line">466</span>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
2021-12-19 13:43:26 +01:00
|
|
|
<p class="phpdocumentor-summary">Calls api store customer method</p>
|
|
|
|
|
|
2021-08-09 09:18:46 +02:00
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
|
|
|
<span class="phpdocumentor-signature__name">store</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2021-12-19 13:43:26 +01:00
|
|
|
|
|
|
|
|
<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 field 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 : - validationFailed, If provided data is wrong(CRM side).</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>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
|
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
|
|
|
—
|
2021-12-19 13:43:26 +01:00
|
|
|
<section class="phpdocumentor-description"><p>True if save was successfull.</p>
|
|
|
|
|
</section>
|
|
|
|
|
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
</article>
|
|
|
|
|
<article
|
|
|
|
|
class="phpdocumentor-element
|
|
|
|
|
-method
|
|
|
|
|
-private
|
|
|
|
|
"
|
|
|
|
|
>
|
|
|
|
|
<h4 class="phpdocumentor-element__name" id="method_update">
|
|
|
|
|
update()
|
|
|
|
|
<a href="classes/LDC-LDCCRM-Models-Customer.html#method_update" 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/Models/Customer.php"><a href="files/src-models-customer.html"><abbr title="src/Models/Customer.php">Customer.php</abbr></a></abbr>
|
|
|
|
|
:
|
2021-12-19 13:43:26 +01:00
|
|
|
<span class="phpdocumentor-element-found-in__line">493</span>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
2021-12-19 13:43:26 +01:00
|
|
|
<p class="phpdocumentor-summary">Calls api update customer method</p>
|
|
|
|
|
|
2021-08-09 09:18:46 +02:00
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
|
|
|
<span class="phpdocumentor-signature__name">update</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2021-12-19 13:43:26 +01:00
|
|
|
|
|
|
|
|
<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 field 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 : - 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>
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
|
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
|
|
|
—
|
2021-12-19 13:43:26 +01:00
|
|
|
<section class="phpdocumentor-description"><p>True if save was successfull.</p>
|
|
|
|
|
</section>
|
|
|
|
|
|
2021-08-09 09:18:46 +02:00
|
|
|
|
|
|
|
|
</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-Models-Customer.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>
|