diff --git a/changelog.md b/changelog.md index 9966017..b62963d 100644 --- a/changelog.md +++ b/changelog.md @@ -1,6 +1,13 @@ # Changelog ### All notable changes to `CRM CLient V2` will be documented in this file. +# version 3.0.1 +- Fixed : Customer do not call update if there are no updated fields +- Fixed : WPCrm bootSessionIfNeeded trying to access $_SESSION['wpcrm'] before session was started +- Fixed : WPCrm now only returns a boolean +- Fixed : get crm info when client used in laravel +- Changed : WpCrm::makeApiV2Call Change LogLevel on error from Emerge to Critical +- Changed : WPCrm readd forceLogin() # version 3.0.0 @@ -9,6 +16,7 @@ Refactored code and clean up. It add more unit test plus code coverage in test/coverage. - Added : mardown documentation. +- Changed : WPCrm::login now only returns a boolean - Changed : model Stats::getQuestionStats to pass question as route parameter - Changed : now requests need to have a signature generated with a private key (crm password) using hmac sha256 wrapping url, method and parameters - Changed : now timestamp will timeout if request is slower than "timestampTimeout", this means crm will reject the request diff --git a/composer.json b/composer.json index d83846e..ff44e78 100644 --- a/composer.json +++ b/composer.json @@ -3,7 +3,7 @@ "type": "library", "description": "LDC CRM Client V2", "license": "MIT", - "version": "3.0.0", + "version": "3.0.1", "authors": [ { "name": "Jérémy Munsch", diff --git a/documentation/classes/LDC-LDCCRM-CrmApiV2.html b/documentation/classes/LDC-LDCCRM-CrmApiV2.html new file mode 100644 index 0000000..80b4c8e --- /dev/null +++ b/documentation/classes/LDC-LDCCRM-CrmApiV2.html @@ -0,0 +1,785 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
+

CRM V2

+ + + + + +
+ +
+
+ + + + +
+ + +
+

+ CrmApiV2 + + +
+ in package + +
+ + +

+ + + +

This is the main class to interact with the CRM

+ + + + + + + + + +

+ Table of Contents + +

+ +
+
+ $apiInterface + +  : ApiInterface +
+
The Api object that will handle requests and responses
+ +
+ __construct() + +  : mixed +
+
CrmApiV2
+ +
+ getCustomer() + +  : Customer|null +
+
Get a customer from its hashcode or email +If it does not exists a new instance +will be returned. You would have +to call its save method later on.
+ +
+ getCustomerOrNew() + +  : Customer +
+
Get a customer from its hashcode or email +If it does not exists a new instance +will be returned. You would have +to call its save method later on.
+ +
+ login() + +  : bool +
+
Test a customer credentials to see if it can login
+ +
+ ping() + +  : bool +
+
Use this the ping the crm and know its current status
+ +
+ setStatus() + +  : bool +
+
Set the single optin status for an email
+ +
+ + + + + + +
+

+ Properties + +

+
+

+ $apiInterface + + + +

+ + +

The Api object that will handle requests and responses

+ + + private + static ApiInterface + $apiInterface + + + + + + +
+
+ +
+

+ Methods + +

+
+

+ __construct() + +

+ + +

CrmApiV2

+ + + public + __construct([string|null $endpoint = null ][, string|null $bearerToken = null ][, string|null $bearerPwd = null ]) : mixed + + +
Parameters
+
+
+ $endpoint + : string|null + = null
+
+ +
+
+ $bearerToken + : string|null + = null
+
+ +
+
+ $bearerPwd + : string|null + = null
+
+ +
+
+ + + +
Return values
+ mixed + — + + +
+
+

+ getCustomer() + +

+ + +

Get a customer from its hashcode or email +If it does not exists a new instance +will be returned. You would have +to call its save method later on.

+ + + public + getCustomer(string $identification) : Customer|null + + +
Parameters
+
+
+ $identification + : string +
+
+

The customer hashcode or email.

+
+ +
+
+ + +
+ Tags + +
+
+
+ throws +
+
+ CrmException + +

If an error occurs on server side or on getting response.

+
+ +
+
+ throws +
+
+ ApiErrorException + +

If any error or \LDC\LDCCRM\Enums\ApiError occurs. +Possibles are : - modelNotFound, If this customer hashcode could not be found.

+
+ +
+
+ phpcs:ignore +
+
+ +

Squiz.Commenting.FunctionCommentThrowTag.WrongNumber

+
+ +
+
+ +
Return values
+ Customer|null + — +

Return null if the customer was not found

+
+ + +
+
+

+ getCustomerOrNew() + +

+ + +

Get a customer from its hashcode or email +If it does not exists a new instance +will be returned. You would have +to call its save method later on.

+ + + public + getCustomerOrNew(string $identification) : Customer + + +
Parameters
+
+
+ $identification + : string +
+
+

The customer hashcode or email.

+
+ +
+
+ + +
+ Tags + +
+
+
+ throws +
+
+ CrmException + +

If an error occurs on server side or on getting response.

+
+ +
+
+ throws +
+
+ ApiErrorException + +

If any error or \LDC\LDCCRM\Enums\ApiError occurs.

+
+ +
+
+ phpcs:ignore +
+
+ +

Squiz.Commenting.FunctionComment.EmptyThrows

+
+ +
+
+ +
Return values
+ Customer + — +

A client Customer model.

+
+ + +
+
+

+ login() + +

+ + +

Test a customer credentials to see if it can login

+ + + public + static login(string $email, string $password) : bool + + +
Parameters
+
+
+ $email + : string +
+
+ +
+
+ $password + : string +
+
+ +
+
+ + +
+ Tags + +
+
+
+ throws +
+
+ CrmException + +

If an error occurs on server side or on getting response.

+
+ +
+
+ throws +
+
+ ApiErrorException + +

If any error or \LDC\LDCCRM\Enums\ApiError occurs. +Possibles are : - authFailed, If credentials are not valid. +- customerNotActivated, If the account is not activated.

+
+ +
+
+ phpcs:ignore +
+
+ +

Squiz.Commenting.FunctionCommentThrowTag.WrongNumber

+
+ +
+
+ +
Return values
+ bool + — + + +
+
+

+ ping() + +

+ + +

Use this the ping the crm and know its current status

+ + + public + ping() : bool + + + + +
+ Tags + +
+
+
+ throws +
+
+ CrmException + +

If an error occurs +on server side or on getting response.

+
+ +
+
+ +
Return values
+ bool + — + + +
+
+

+ setStatus() + +

+ + +

Set the single optin status for an email

+ + + public + static setStatus(string $email, bool $opt_in) : bool + + +
Parameters
+
+
+ $email + : string +
+
+ +
+
+ $opt_in + : bool +
+
+ +
+
+ + +
+ Tags + +
+
+
+ throws +
+
+ CrmException + +

If an error occurs on server side or on getting response.

+
+ +
+
+ throws +
+
+ ApiErrorException + +

If any error or \LDC\LDCCRM\Enums\ApiError occurs. +Possibles are : - singleOptinCustomerExists, If a customer exists with this email.

+
+ +
+
+ phpcs:ignore +
+
+ +

Squiz.Commenting.FunctionCommentThrowTag.WrongNumber

+
+ +
+
+ +
Return values
+ bool + — +

true if succeeded

+
+ + +
+
+ + + + +
+
+
+
+

Search results

+ +
+
+
    +
    +
    +
    +
    +
    + + +
    + + + + + + + + diff --git a/documentation/classes/LDC-LDCCRM-Enums-ApiError.html b/documentation/classes/LDC-LDCCRM-Enums-ApiError.html new file mode 100644 index 0000000..67fa657 --- /dev/null +++ b/documentation/classes/LDC-LDCCRM-Enums-ApiError.html @@ -0,0 +1,884 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
    +

    CRM V2

    + + + + + +
    + +
    +
    + + + + +
    + + +
    +

    + ApiError + + + extends BaseEnum + + +
    + in package + +
    + + +

    + + + +

    This describes an API error.

    + + + +
    + Tags + +
    +
    +
    + subpackage +
    +
    + +

    enums

    +
    + +
    +
    + + + + + + +

    + Table of Contents + +

    + +
    +
    + apiAuthFailed() + +  : +
    +
    + +
    + authFailed() + +  : +
    +
    + +
    + authorizationException() + +  : +
    +
    + +
    + customerAlreadyActive() + +  : +
    +
    + +
    + customerExists() + +  : +
    +
    + +
    + customerNotActivated() + +  : +
    +
    + +
    + labels() + +  : array<string|int, mixed> +
    +
    Libellés des possibilités de cet énumération (label)
    + +
    + methodNotAllowed() + +  : +
    +
    + +
    + missingParameter() + +  : +
    +
    + +
    + modelNotFound() + +  : +
    +
    + +
    + singleOptinCustomerExists() + +  : +
    +
    + +
    + throttleRequestsException() + +  : +
    +
    + +
    + validationFailed() + +  : +
    +
    + +
    + values() + +  : array<string|int, mixed> +
    +
    Valeurs des possibilités de cet énumération (value)
    + +
    + wrongTimeStamp() + +  : +
    +
    + +
    + + + + + + + +
    +

    + Methods + +

    +
    +

    + apiAuthFailed() + +

    + + + + + public + static apiAuthFailed() : + +

    The authentification to the api failed. You may have to +check into config or .env file for your service credentials

    +
    + + + + +
    Return values
    + + — + + +
    +
    +

    + authFailed() + +

    + + + + + public + static authFailed() : + +

    The authentification for this customer failed because of wrong credentials

    +
    + + + + +
    Return values
    + + — + + +
    +
    +

    + authorizationException() + +

    + + + + + public + static authorizationException() : + +

    You are maybe trying to access data that is out of your range. +This should not happen normally, it is here to allow you to handle this case. +If this happens fill a ticket on https://supportweb.ldc.fr +with some technical details

    +
    + + + + +
    Return values
    + + — + + +
    +
    +

    + customerAlreadyActive() + +

    + + + + + public + static customerAlreadyActive() : + +

    You have requested to activate a customer account, +but it is already active

    +
    + + + + +
    Return values
    + + — + + +
    +
    +

    + customerExists() + +

    + + + + + public + static customerExists() : + +

    The customer already exists

    +
    + + + + +
    Return values
    + + — + + +
    +
    +

    + customerNotActivated() + +

    + + + + + public + static customerNotActivated() : + +

    The customer account is not activated and cannot perform +this action

    +
    + + + + +
    Return values
    + + — + + +
    +
    +

    + labels() + +

    + + +

    Libellés des possibilités de cet énumération (label)

    + + + public + static labels() : array<string|int, mixed> + + + + + +
    Return values
    + array<string|int, mixed> + — + + +
    +
    +

    + methodNotAllowed() + +

    + + + + + public + static methodNotAllowed() : + +

    This http method is not allowed

    +
    + + + + +
    Return values
    + + — + + +
    +
    +

    + missingParameter() + +

    + + + + + public + static missingParameter() : + +

    The request is missing some parameters

    +
    + + + + +
    Return values
    + + — + + +
    +
    +

    + modelNotFound() + +

    + + + + + public + static modelNotFound() : + +

    The request model was not found (typically the customer)

    +
    + + + + +
    Return values
    + + — + + +
    +
    +

    + singleOptinCustomerExists() + +

    + + + + + public + static singleOptinCustomerExists() : + +

    You have requested to create a single optin for an email, +but it already exists

    +
    + + + + +
    Return values
    + + — + + +
    +
    +

    + throttleRequestsException() + +

    + + + + + public + static throttleRequestsException() : + +

    Too many requests have been attempted. The is a throttle security. +Normally you should not trigger this. +If this happens fill a ticket on https://supportweb.ldc.fr +with some technical details

    +
    + + + + +
    Return values
    + + — + + +
    +
    +

    + validationFailed() + +

    + + + + + public + static validationFailed() : + +

    This means some data could not be validated, +you may have to look into message to get the details

    +
    + + + + +
    Return values
    + + — + + +
    +
    +

    + values() + +

    + + +

    Valeurs des possibilités de cet énumération (value)

    + + + public + static values() : array<string|int, mixed> + + + + + +
    Return values
    + array<string|int, mixed> + — + + +
    +
    +

    + wrongTimeStamp() + +

    + + + + + public + static wrongTimeStamp() : + +

    The timestamp given is wrong. This would happen in case if +a replay attack scenario. Timestamps are provided in headers +and in the http body

    +
    + + + + +
    Return values
    + + — + + +
    +
    + + + + +
    +
    +
    +
    +

    Search results

    + +
    +
    +
      +
      +
      +
      +
      +
      + + +
      + + + + + + + + diff --git a/documentation/classes/LDC-LDCCRM-Enums-ApiStatus.html b/documentation/classes/LDC-LDCCRM-Enums-ApiStatus.html new file mode 100644 index 0000000..7673647 --- /dev/null +++ b/documentation/classes/LDC-LDCCRM-Enums-ApiStatus.html @@ -0,0 +1,335 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
      +

      CRM V2

      + + + + + +
      + +
      +
      + + + + +
      + + +
      +

      + ApiStatus + + + extends BaseEnum + + +
      + in package + +
      + + +

      + + + + + + +
      + Tags + +
      +
      +
      + subpackage +
      +
      + +

      enums

      +
      + +
      +
      + + + + + + +

      + Table of Contents + +

      + +
      +
      + KO() + +  : +
      +
      + +
      + OK() + +  : +
      +
      + +
      + + + + + + + +
      +

      + Methods + +

      +
      +

      + KO() + +

      + + + + + public + static KO() : + + + + + +
      Return values
      + + — + + +
      +
      +

      + OK() + +

      + + + + + public + static OK() : + + + + + +
      Return values
      + + — + + +
      +
      + + + + +
      +
      +
      +
      +

      Search results

      + +
      +
      +
        +
        +
        +
        +
        +
        + + +
        + + + + + + + + diff --git a/documentation/classes/LDC-LDCCRM-Enums-ArcadiaMailType.html b/documentation/classes/LDC-LDCCRM-Enums-ArcadiaMailType.html new file mode 100644 index 0000000..022ec3b --- /dev/null +++ b/documentation/classes/LDC-LDCCRM-Enums-ArcadiaMailType.html @@ -0,0 +1,375 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
        +

        CRM V2

        + + + + + +
        + +
        +
        + + + + +
        + + +
        +

        + ArcadiaMailType + + + extends BaseEnum + + +
        + in package + +
        + + +

        + + + + + + +
        + Tags + +
        +
        +
        + subpackage +
        +
        + +

        enums

        +
        + +
        +
        + + + + + + +

        + Table of Contents + +

        + +
        +
        + default() + +  : +
        +
        + +
        + game() + +  : +
        +
        + +
        + values() + +  : array<string|int, mixed> +
        +
        Valeurs des possibilités de cet énumération (value)
        + +
        + + + + + + + +
        +

        + Methods + +

        +
        +

        + default() + +

        + + + + + public + static default() : + + + + + +
        Return values
        + + — + + +
        +
        +

        + game() + +

        + + + + + public + static game() : + + + + + +
        Return values
        + + — + + +
        +
        +

        + values() + +

        + + +

        Valeurs des possibilités de cet énumération (value)

        + + + public + static values() : array<string|int, mixed> + + + + + +
        Return values
        + array<string|int, mixed> + — + + +
        +
        + + + + +
        +
        +
        +
        +

        Search results

        + +
        +
        +
          +
          +
          +
          +
          +
          + + +
          + + + + + + + + diff --git a/documentation/classes/LDC-LDCCRM-Enums-ArcadiaOrderType.html b/documentation/classes/LDC-LDCCRM-Enums-ArcadiaOrderType.html new file mode 100644 index 0000000..8c5779b --- /dev/null +++ b/documentation/classes/LDC-LDCCRM-Enums-ArcadiaOrderType.html @@ -0,0 +1,375 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
          +

          CRM V2

          + + + + + +
          + +
          +
          + + + + +
          + + +
          +

          + ArcadiaOrderType + + + extends BaseEnum + + +
          + in package + +
          + + +

          + + + + + + +
          + Tags + +
          +
          +
          + subpackage +
          +
          + +

          enums

          +
          + +
          +
          + + + + + + +

          + Table of Contents + +

          + +
          +
          + cb() + +  : +
          +
          + +
          + check() + +  : +
          +
          + +
          + values() + +  : array<string|int, mixed> +
          +
          Valeurs des possibilités de cet énumération (value)
          + +
          + + + + + + + +
          +

          + Methods + +

          +
          +

          + cb() + +

          + + + + + public + static cb() : + + + + + +
          Return values
          + + — + + +
          +
          +

          + check() + +

          + + + + + public + static check() : + + + + + +
          Return values
          + + — + + +
          +
          +

          + values() + +

          + + +

          Valeurs des possibilités de cet énumération (value)

          + + + public + static values() : array<string|int, mixed> + + + + + +
          Return values
          + array<string|int, mixed> + — + + +
          +
          + + + + +
          +
          +
          +
          +

          Search results

          + +
          +
          +
            +
            +
            +
            +
            +
            + + +
            + + + + + + + + diff --git a/documentation/classes/LDC-LDCCRM-Enums-Country.html b/documentation/classes/LDC-LDCCRM-Enums-Country.html new file mode 100644 index 0000000..4172692 --- /dev/null +++ b/documentation/classes/LDC-LDCCRM-Enums-Country.html @@ -0,0 +1,10056 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
            +

            CRM V2

            + + + + + +
            + +
            +
            + + + + +
            + + +
            +

            + Country + + + extends BaseEnum + + +
            + in package + +
            + + +

            + + + +

            Liste de Pays

            + + + +
            + Tags + +
            +
            +
            + source +
            +
            + + +
            +
            + subpackage +
            +
            + +

            enums

            +
            + +
            +
            + + + + + + +

            + Table of Contents + +

            + +
            +
            + afghanistan() + +  : +
            +
            + +
            + alandIslands() + +  : +
            +
            + +
            + albania() + +  : +
            +
            + +
            + algeria() + +  : +
            +
            + +
            + americanSamoa() + +  : +
            +
            + +
            + andorra() + +  : +
            +
            + +
            + angola() + +  : +
            +
            + +
            + anguilla() + +  : +
            +
            + +
            + antarctica() + +  : +
            +
            + +
            + antiguaAndBarbuda() + +  : +
            +
            + +
            + argentina() + +  : +
            +
            + +
            + armenia() + +  : +
            +
            + +
            + aruba() + +  : +
            +
            + +
            + australia() + +  : +
            +
            + +
            + austria() + +  : +
            +
            + +
            + azerbaijan() + +  : +
            +
            + +
            + bahamas() + +  : +
            +
            + +
            + bahrain() + +  : +
            +
            + +
            + bangladesh() + +  : +
            +
            + +
            + barbados() + +  : +
            +
            + +
            + belarus() + +  : +
            +
            + +
            + belgium() + +  : +
            +
            + +
            + belize() + +  : +
            +
            + +
            + benin() + +  : +
            +
            + +
            + bermuda() + +  : +
            +
            + +
            + bhutan() + +  : +
            +
            + +
            + boliviaPlurinationalStateOf() + +  : +
            +
            + +
            + bonaireSintEustatiusAndSaba() + +  : +
            +
            + +
            + bosniaAndHerzegovina() + +  : +
            +
            + +
            + botswana() + +  : +
            +
            + +
            + bouvetIsland() + +  : +
            +
            + +
            + brazil() + +  : +
            +
            + +
            + britishIndianOceanTerritory() + +  : +
            +
            + +
            + bruneiDarussalam() + +  : +
            +
            + +
            + bulgaria() + +  : +
            +
            + +
            + burkinaFaso() + +  : +
            +
            + +
            + burundi() + +  : +
            +
            + +
            + cambodia() + +  : +
            +
            + +
            + cameroon() + +  : +
            +
            + +
            + canada() + +  : +
            +
            + +
            + capeVerde() + +  : +
            +
            + +
            + caymanIslands() + +  : +
            +
            + +
            + centralAfricanRepublic() + +  : +
            +
            + +
            + chad() + +  : +
            +
            + +
            + chile() + +  : +
            +
            + +
            + china() + +  : +
            +
            + +
            + christmasIsland() + +  : +
            +
            + +
            + cocosKeelingIslands() + +  : +
            +
            + +
            + colombia() + +  : +
            +
            + +
            + comoros() + +  : +
            +
            + +
            + congo() + +  : +
            +
            + +
            + congoTheDemocraticRepublicOfThe() + +  : +
            +
            + +
            + cookIslands() + +  : +
            +
            + +
            + costaRica() + +  : +
            +
            + +
            + coteDivoire() + +  : +
            +
            + +
            + croatia() + +  : +
            +
            + +
            + cuba() + +  : +
            +
            + +
            + curacao() + +  : +
            +
            + +
            + cyprus() + +  : +
            +
            + +
            + czechRepublic() + +  : +
            +
            + +
            + denmark() + +  : +
            +
            + +
            + djibouti() + +  : +
            +
            + +
            + dominica() + +  : +
            +
            + +
            + dominicanRepublic() + +  : +
            +
            + +
            + ecuador() + +  : +
            +
            + +
            + egypt() + +  : +
            +
            + +
            + elSalvador() + +  : +
            +
            + +
            + equatorialGuinea() + +  : +
            +
            + +
            + eritrea() + +  : +
            +
            + +
            + estonia() + +  : +
            +
            + +
            + ethiopia() + +  : +
            +
            + +
            + falklandIslandsMalvinas() + +  : +
            +
            + +
            + faroeIslands() + +  : +
            +
            + +
            + fiji() + +  : +
            +
            + +
            + finland() + +  : +
            +
            + +
            + france() + +  : +
            +
            + +
            + frenchGuiana() + +  : +
            +
            + +
            + frenchPolynesia() + +  : +
            +
            + +
            + frenchSouthernTerritories() + +  : +
            +
            + +
            + gabon() + +  : +
            +
            + +
            + gambia() + +  : +
            +
            + +
            + georgia() + +  : +
            +
            + +
            + germany() + +  : +
            +
            + +
            + ghana() + +  : +
            +
            + +
            + gibraltar() + +  : +
            +
            + +
            + greece() + +  : +
            +
            + +
            + greenland() + +  : +
            +
            + +
            + grenada() + +  : +
            +
            + +
            + guadeloupe() + +  : +
            +
            + +
            + guam() + +  : +
            +
            + +
            + guatemala() + +  : +
            +
            + +
            + guernsey() + +  : +
            +
            + +
            + guinea() + +  : +
            +
            + +
            + guineaBissau() + +  : +
            +
            + +
            + guyana() + +  : +
            +
            + +
            + haiti() + +  : +
            +
            + +
            + heardIslandAndMcdonaldIslands() + +  : +
            +
            + +
            + holySeeVaticanCityState() + +  : +
            +
            + +
            + honduras() + +  : +
            +
            + +
            + hongKong() + +  : +
            +
            + +
            + hungary() + +  : +
            +
            + +
            + iceland() + +  : +
            +
            + +
            + india() + +  : +
            +
            + +
            + indonesia() + +  : +
            +
            + +
            + iranIslamicRepublicOf() + +  : +
            +
            + +
            + iraq() + +  : +
            +
            + +
            + ireland() + +  : +
            +
            + +
            + isleOfMan() + +  : +
            +
            + +
            + israel() + +  : +
            +
            + +
            + italy() + +  : +
            +
            + +
            + jamaica() + +  : +
            +
            + +
            + japan() + +  : +
            +
            + +
            + jersey() + +  : +
            +
            + +
            + jordan() + +  : +
            +
            + +
            + kazakhstan() + +  : +
            +
            + +
            + kenya() + +  : +
            +
            + +
            + kiribati() + +  : +
            +
            + +
            + koreaDemocraticPeoplesRepublicOf() + +  : +
            +
            + +
            + koreaRepublicOf() + +  : +
            +
            + +
            + kuwait() + +  : +
            +
            + +
            + kyrgyzstan() + +  : +
            +
            + +
            + labels() + +  : array<string|int, mixed> +
            +
            Libellés des possibilités de cet énumération (label)
            + +
            + laoPeoplesDemocraticRepublic() + +  : +
            +
            + +
            + latvia() + +  : +
            +
            + +
            + lebanon() + +  : +
            +
            + +
            + lesotho() + +  : +
            +
            + +
            + liberia() + +  : +
            +
            + +
            + libya() + +  : +
            +
            + +
            + liechtenstein() + +  : +
            +
            + +
            + lithuania() + +  : +
            +
            + +
            + luxembourg() + +  : +
            +
            + +
            + macao() + +  : +
            +
            + +
            + macedoniaTheFormerYugoslavRepublicOf() + +  : +
            +
            + +
            + madagascar() + +  : +
            +
            + +
            + malawi() + +  : +
            +
            + +
            + malaysia() + +  : +
            +
            + +
            + maldives() + +  : +
            +
            + +
            + mali() + +  : +
            +
            + +
            + malta() + +  : +
            +
            + +
            + marshallIslands() + +  : +
            +
            + +
            + martinique() + +  : +
            +
            + +
            + mauritania() + +  : +
            +
            + +
            + mauritius() + +  : +
            +
            + +
            + mayotte() + +  : +
            +
            + +
            + mexico() + +  : +
            +
            + +
            + micronesiaFederatedStatesOf() + +  : +
            +
            + +
            + moldovaRepublicOf() + +  : +
            +
            + +
            + monaco() + +  : +
            +
            + +
            + mongolia() + +  : +
            +
            + +
            + montenegro() + +  : +
            +
            + +
            + montserrat() + +  : +
            +
            + +
            + morocco() + +  : +
            +
            + +
            + mozambique() + +  : +
            +
            + +
            + myanmar() + +  : +
            +
            + +
            + namibia() + +  : +
            +
            + +
            + nauru() + +  : +
            +
            + +
            + nepal() + +  : +
            +
            + +
            + netherlands() + +  : +
            +
            + +
            + newCaledonia() + +  : +
            +
            + +
            + newZealand() + +  : +
            +
            + +
            + nicaragua() + +  : +
            +
            + +
            + niger() + +  : +
            +
            + +
            + nigeria() + +  : +
            +
            + +
            + niue() + +  : +
            +
            + +
            + norfolkIsland() + +  : +
            +
            + +
            + northernMarianaIslands() + +  : +
            +
            + +
            + norway() + +  : +
            +
            + +
            + oman() + +  : +
            +
            + +
            + pakistan() + +  : +
            +
            + +
            + palau() + +  : +
            +
            + +
            + palestineStateOf() + +  : +
            +
            + +
            + panama() + +  : +
            +
            + +
            + papuaNewGuinea() + +  : +
            +
            + +
            + paraguay() + +  : +
            +
            + +
            + peru() + +  : +
            +
            + +
            + philippines() + +  : +
            +
            + +
            + pitcairn() + +  : +
            +
            + +
            + poland() + +  : +
            +
            + +
            + portugal() + +  : +
            +
            + +
            + puertoRico() + +  : +
            +
            + +
            + qatar() + +  : +
            +
            + +
            + reunion() + +  : +
            +
            + +
            + romania() + +  : +
            +
            + +
            + russianFederation() + +  : +
            +
            + +
            + rwanda() + +  : +
            +
            + +
            + saintBarthelemy() + +  : +
            +
            + +
            + saintHelenaAscensionAndTristanDaCunha() + +  : +
            +
            + +
            + saintKittsAndNevis() + +  : +
            +
            + +
            + saintLucia() + +  : +
            +
            + +
            + saintMartinFrenchPart() + +  : +
            +
            + +
            + saintPierreAndMiquelon() + +  : +
            +
            + +
            + saintVincentAndTheGrenadines() + +  : +
            +
            + +
            + samoa() + +  : +
            +
            + +
            + sanMarino() + +  : +
            +
            + +
            + saoTomeAndPrincipe() + +  : +
            +
            + +
            + saudiArabia() + +  : +
            +
            + +
            + senegal() + +  : +
            +
            + +
            + serbia() + +  : +
            +
            + +
            + seychelles() + +  : +
            +
            + +
            + sierraLeone() + +  : +
            +
            + +
            + singapore() + +  : +
            +
            + +
            + sintMaartenDutchPart() + +  : +
            +
            + +
            + slovakia() + +  : +
            +
            + +
            + slovenia() + +  : +
            +
            + +
            + solomonIslands() + +  : +
            +
            + +
            + somalia() + +  : +
            +
            + +
            + southAfrica() + +  : +
            +
            + +
            + southGeorgiaAndTheSouthSandwichIslands() + +  : +
            +
            + +
            + southSudan() + +  : +
            +
            + +
            + spain() + +  : +
            +
            + +
            + sriLanka() + +  : +
            +
            + +
            + sudan() + +  : +
            +
            + +
            + suriname() + +  : +
            +
            + +
            + svalbardAndJanMayen() + +  : +
            +
            + +
            + swaziland() + +  : +
            +
            + +
            + sweden() + +  : +
            +
            + +
            + switzerland() + +  : +
            +
            + +
            + syrianArabRepublic() + +  : +
            +
            + +
            + taiwanProvinceOfChina() + +  : +
            +
            + +
            + tajikistan() + +  : +
            +
            + +
            + tanzaniaUnitedRepublicOf() + +  : +
            +
            + +
            + thailand() + +  : +
            +
            + +
            + timorLeste() + +  : +
            +
            + +
            + togo() + +  : +
            +
            + +
            + tokelau() + +  : +
            +
            + +
            + tonga() + +  : +
            +
            + +
            + trinidadAndTobago() + +  : +
            +
            + +
            + tunisia() + +  : +
            +
            + +
            + turkey() + +  : +
            +
            + +
            + turkmenistan() + +  : +
            +
            + +
            + turksAndCaicosIslands() + +  : +
            +
            + +
            + tuvalu() + +  : +
            +
            + +
            + uganda() + +  : +
            +
            + +
            + ukraine() + +  : +
            +
            + +
            + unitedArabEmirates() + +  : +
            +
            + +
            + unitedKingdom() + +  : +
            +
            + +
            + unitedStates() + +  : +
            +
            + +
            + unitedStatesMinorOutlyingIslands() + +  : +
            +
            + +
            + uruguay() + +  : +
            +
            + +
            + uzbekistan() + +  : +
            +
            + +
            + values() + +  : array<string|int, mixed> +
            +
            Valeurs des possibilités de cet énumération (value)
            + +
            + vanuatu() + +  : +
            +
            + +
            + venezuelaBolivarianRepublicOf() + +  : +
            +
            + +
            + vietNam() + +  : +
            +
            + +
            + virginIslandsBritish() + +  : +
            +
            + +
            + virginIslandsUs() + +  : +
            +
            + +
            + wallisAndFutuna() + +  : +
            +
            + +
            + westernSahara() + +  : +
            +
            + +
            + yemen() + +  : +
            +
            + +
            + zambia() + +  : +
            +
            + +
            + zimbabwe() + +  : +
            +
            + +
            + + + + + + + +
            +

            + Methods + +

            +
            +

            + afghanistan() + +

            + + + + + public + static afghanistan() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + alandIslands() + +

            + + + + + public + static alandIslands() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + albania() + +

            + + + + + public + static albania() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + algeria() + +

            + + + + + public + static algeria() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + americanSamoa() + +

            + + + + + public + static americanSamoa() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + andorra() + +

            + + + + + public + static andorra() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + angola() + +

            + + + + + public + static angola() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + anguilla() + +

            + + + + + public + static anguilla() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + antarctica() + +

            + + + + + public + static antarctica() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + antiguaAndBarbuda() + +

            + + + + + public + static antiguaAndBarbuda() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + argentina() + +

            + + + + + public + static argentina() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + armenia() + +

            + + + + + public + static armenia() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + aruba() + +

            + + + + + public + static aruba() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + australia() + +

            + + + + + public + static australia() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + austria() + +

            + + + + + public + static austria() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + azerbaijan() + +

            + + + + + public + static azerbaijan() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + bahamas() + +

            + + + + + public + static bahamas() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + bahrain() + +

            + + + + + public + static bahrain() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + bangladesh() + +

            + + + + + public + static bangladesh() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + barbados() + +

            + + + + + public + static barbados() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + belarus() + +

            + + + + + public + static belarus() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + belgium() + +

            + + + + + public + static belgium() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + belize() + +

            + + + + + public + static belize() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + benin() + +

            + + + + + public + static benin() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + bermuda() + +

            + + + + + public + static bermuda() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + bhutan() + +

            + + + + + public + static bhutan() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + boliviaPlurinationalStateOf() + +

            + + + + + public + static boliviaPlurinationalStateOf() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + bonaireSintEustatiusAndSaba() + +

            + + + + + public + static bonaireSintEustatiusAndSaba() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + bosniaAndHerzegovina() + +

            + + + + + public + static bosniaAndHerzegovina() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + botswana() + +

            + + + + + public + static botswana() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + bouvetIsland() + +

            + + + + + public + static bouvetIsland() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + brazil() + +

            + + + + + public + static brazil() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + britishIndianOceanTerritory() + +

            + + + + + public + static britishIndianOceanTerritory() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + bruneiDarussalam() + +

            + + + + + public + static bruneiDarussalam() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + bulgaria() + +

            + + + + + public + static bulgaria() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + burkinaFaso() + +

            + + + + + public + static burkinaFaso() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + burundi() + +

            + + + + + public + static burundi() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + cambodia() + +

            + + + + + public + static cambodia() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + cameroon() + +

            + + + + + public + static cameroon() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + canada() + +

            + + + + + public + static canada() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + capeVerde() + +

            + + + + + public + static capeVerde() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + caymanIslands() + +

            + + + + + public + static caymanIslands() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + centralAfricanRepublic() + +

            + + + + + public + static centralAfricanRepublic() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + chad() + +

            + + + + + public + static chad() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + chile() + +

            + + + + + public + static chile() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + china() + +

            + + + + + public + static china() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + christmasIsland() + +

            + + + + + public + static christmasIsland() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + cocosKeelingIslands() + +

            + + + + + public + static cocosKeelingIslands() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + colombia() + +

            + + + + + public + static colombia() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + comoros() + +

            + + + + + public + static comoros() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + congo() + +

            + + + + + public + static congo() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + congoTheDemocraticRepublicOfThe() + +

            + + + + + public + static congoTheDemocraticRepublicOfThe() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + cookIslands() + +

            + + + + + public + static cookIslands() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + costaRica() + +

            + + + + + public + static costaRica() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + coteDivoire() + +

            + + + + + public + static coteDivoire() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + croatia() + +

            + + + + + public + static croatia() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + cuba() + +

            + + + + + public + static cuba() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + curacao() + +

            + + + + + public + static curacao() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + cyprus() + +

            + + + + + public + static cyprus() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + czechRepublic() + +

            + + + + + public + static czechRepublic() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + denmark() + +

            + + + + + public + static denmark() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + djibouti() + +

            + + + + + public + static djibouti() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + dominica() + +

            + + + + + public + static dominica() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + dominicanRepublic() + +

            + + + + + public + static dominicanRepublic() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + ecuador() + +

            + + + + + public + static ecuador() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + egypt() + +

            + + + + + public + static egypt() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + elSalvador() + +

            + + + + + public + static elSalvador() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + equatorialGuinea() + +

            + + + + + public + static equatorialGuinea() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + eritrea() + +

            + + + + + public + static eritrea() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + estonia() + +

            + + + + + public + static estonia() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + ethiopia() + +

            + + + + + public + static ethiopia() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + falklandIslandsMalvinas() + +

            + + + + + public + static falklandIslandsMalvinas() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + faroeIslands() + +

            + + + + + public + static faroeIslands() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + fiji() + +

            + + + + + public + static fiji() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + finland() + +

            + + + + + public + static finland() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + france() + +

            + + + + + public + static france() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + frenchGuiana() + +

            + + + + + public + static frenchGuiana() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + frenchPolynesia() + +

            + + + + + public + static frenchPolynesia() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + frenchSouthernTerritories() + +

            + + + + + public + static frenchSouthernTerritories() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + gabon() + +

            + + + + + public + static gabon() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + gambia() + +

            + + + + + public + static gambia() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + georgia() + +

            + + + + + public + static georgia() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + germany() + +

            + + + + + public + static germany() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + ghana() + +

            + + + + + public + static ghana() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + gibraltar() + +

            + + + + + public + static gibraltar() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + greece() + +

            + + + + + public + static greece() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + greenland() + +

            + + + + + public + static greenland() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + grenada() + +

            + + + + + public + static grenada() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + guadeloupe() + +

            + + + + + public + static guadeloupe() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + guam() + +

            + + + + + public + static guam() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + guatemala() + +

            + + + + + public + static guatemala() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + guernsey() + +

            + + + + + public + static guernsey() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + guinea() + +

            + + + + + public + static guinea() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + guineaBissau() + +

            + + + + + public + static guineaBissau() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + guyana() + +

            + + + + + public + static guyana() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + haiti() + +

            + + + + + public + static haiti() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + heardIslandAndMcdonaldIslands() + +

            + + + + + public + static heardIslandAndMcdonaldIslands() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + holySeeVaticanCityState() + +

            + + + + + public + static holySeeVaticanCityState() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + honduras() + +

            + + + + + public + static honduras() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + hongKong() + +

            + + + + + public + static hongKong() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + hungary() + +

            + + + + + public + static hungary() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + iceland() + +

            + + + + + public + static iceland() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + india() + +

            + + + + + public + static india() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + indonesia() + +

            + + + + + public + static indonesia() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + iranIslamicRepublicOf() + +

            + + + + + public + static iranIslamicRepublicOf() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + iraq() + +

            + + + + + public + static iraq() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + ireland() + +

            + + + + + public + static ireland() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + isleOfMan() + +

            + + + + + public + static isleOfMan() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + israel() + +

            + + + + + public + static israel() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + italy() + +

            + + + + + public + static italy() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + jamaica() + +

            + + + + + public + static jamaica() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + japan() + +

            + + + + + public + static japan() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + jersey() + +

            + + + + + public + static jersey() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + jordan() + +

            + + + + + public + static jordan() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + kazakhstan() + +

            + + + + + public + static kazakhstan() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + kenya() + +

            + + + + + public + static kenya() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + kiribati() + +

            + + + + + public + static kiribati() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + koreaDemocraticPeoplesRepublicOf() + +

            + + + + + public + static koreaDemocraticPeoplesRepublicOf() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + koreaRepublicOf() + +

            + + + + + public + static koreaRepublicOf() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + kuwait() + +

            + + + + + public + static kuwait() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + kyrgyzstan() + +

            + + + + + public + static kyrgyzstan() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + labels() + +

            + + +

            Libellés des possibilités de cet énumération (label)

            + + + public + static labels() : array<string|int, mixed> + + + + + +
            Return values
            + array<string|int, mixed> + — + + +
            +
            +

            + laoPeoplesDemocraticRepublic() + +

            + + + + + public + static laoPeoplesDemocraticRepublic() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + latvia() + +

            + + + + + public + static latvia() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + lebanon() + +

            + + + + + public + static lebanon() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + lesotho() + +

            + + + + + public + static lesotho() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + liberia() + +

            + + + + + public + static liberia() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + libya() + +

            + + + + + public + static libya() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + liechtenstein() + +

            + + + + + public + static liechtenstein() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + lithuania() + +

            + + + + + public + static lithuania() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + luxembourg() + +

            + + + + + public + static luxembourg() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + macao() + +

            + + + + + public + static macao() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + macedoniaTheFormerYugoslavRepublicOf() + +

            + + + + + public + static macedoniaTheFormerYugoslavRepublicOf() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + madagascar() + +

            + + + + + public + static madagascar() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + malawi() + +

            + + + + + public + static malawi() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + malaysia() + +

            + + + + + public + static malaysia() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + maldives() + +

            + + + + + public + static maldives() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + mali() + +

            + + + + + public + static mali() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + malta() + +

            + + + + + public + static malta() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + marshallIslands() + +

            + + + + + public + static marshallIslands() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + martinique() + +

            + + + + + public + static martinique() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + mauritania() + +

            + + + + + public + static mauritania() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + mauritius() + +

            + + + + + public + static mauritius() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + mayotte() + +

            + + + + + public + static mayotte() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + mexico() + +

            + + + + + public + static mexico() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + micronesiaFederatedStatesOf() + +

            + + + + + public + static micronesiaFederatedStatesOf() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + moldovaRepublicOf() + +

            + + + + + public + static moldovaRepublicOf() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + monaco() + +

            + + + + + public + static monaco() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + mongolia() + +

            + + + + + public + static mongolia() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + montenegro() + +

            + + + + + public + static montenegro() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + montserrat() + +

            + + + + + public + static montserrat() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + morocco() + +

            + + + + + public + static morocco() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + mozambique() + +

            + + + + + public + static mozambique() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + myanmar() + +

            + + + + + public + static myanmar() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + namibia() + +

            + + + + + public + static namibia() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + nauru() + +

            + + + + + public + static nauru() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + nepal() + +

            + + + + + public + static nepal() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + netherlands() + +

            + + + + + public + static netherlands() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + newCaledonia() + +

            + + + + + public + static newCaledonia() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + newZealand() + +

            + + + + + public + static newZealand() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + nicaragua() + +

            + + + + + public + static nicaragua() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + niger() + +

            + + + + + public + static niger() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + nigeria() + +

            + + + + + public + static nigeria() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + niue() + +

            + + + + + public + static niue() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + norfolkIsland() + +

            + + + + + public + static norfolkIsland() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + northernMarianaIslands() + +

            + + + + + public + static northernMarianaIslands() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + norway() + +

            + + + + + public + static norway() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + oman() + +

            + + + + + public + static oman() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + pakistan() + +

            + + + + + public + static pakistan() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + palau() + +

            + + + + + public + static palau() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + palestineStateOf() + +

            + + + + + public + static palestineStateOf() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + panama() + +

            + + + + + public + static panama() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + papuaNewGuinea() + +

            + + + + + public + static papuaNewGuinea() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + paraguay() + +

            + + + + + public + static paraguay() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + peru() + +

            + + + + + public + static peru() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + philippines() + +

            + + + + + public + static philippines() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + pitcairn() + +

            + + + + + public + static pitcairn() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + poland() + +

            + + + + + public + static poland() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + portugal() + +

            + + + + + public + static portugal() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + puertoRico() + +

            + + + + + public + static puertoRico() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + qatar() + +

            + + + + + public + static qatar() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + reunion() + +

            + + + + + public + static reunion() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + romania() + +

            + + + + + public + static romania() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + russianFederation() + +

            + + + + + public + static russianFederation() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + rwanda() + +

            + + + + + public + static rwanda() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + saintBarthelemy() + +

            + + + + + public + static saintBarthelemy() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + saintHelenaAscensionAndTristanDaCunha() + +

            + + + + + public + static saintHelenaAscensionAndTristanDaCunha() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + saintKittsAndNevis() + +

            + + + + + public + static saintKittsAndNevis() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + saintLucia() + +

            + + + + + public + static saintLucia() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + saintMartinFrenchPart() + +

            + + + + + public + static saintMartinFrenchPart() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + saintPierreAndMiquelon() + +

            + + + + + public + static saintPierreAndMiquelon() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + saintVincentAndTheGrenadines() + +

            + + + + + public + static saintVincentAndTheGrenadines() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + samoa() + +

            + + + + + public + static samoa() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + sanMarino() + +

            + + + + + public + static sanMarino() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + saoTomeAndPrincipe() + +

            + + + + + public + static saoTomeAndPrincipe() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + saudiArabia() + +

            + + + + + public + static saudiArabia() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + senegal() + +

            + + + + + public + static senegal() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + serbia() + +

            + + + + + public + static serbia() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + seychelles() + +

            + + + + + public + static seychelles() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + sierraLeone() + +

            + + + + + public + static sierraLeone() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + singapore() + +

            + + + + + public + static singapore() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + sintMaartenDutchPart() + +

            + + + + + public + static sintMaartenDutchPart() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + slovakia() + +

            + + + + + public + static slovakia() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + slovenia() + +

            + + + + + public + static slovenia() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + solomonIslands() + +

            + + + + + public + static solomonIslands() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + somalia() + +

            + + + + + public + static somalia() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + southAfrica() + +

            + + + + + public + static southAfrica() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + southGeorgiaAndTheSouthSandwichIslands() + +

            + + + + + public + static southGeorgiaAndTheSouthSandwichIslands() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + southSudan() + +

            + + + + + public + static southSudan() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + spain() + +

            + + + + + public + static spain() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + sriLanka() + +

            + + + + + public + static sriLanka() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + sudan() + +

            + + + + + public + static sudan() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + suriname() + +

            + + + + + public + static suriname() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + svalbardAndJanMayen() + +

            + + + + + public + static svalbardAndJanMayen() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + swaziland() + +

            + + + + + public + static swaziland() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + sweden() + +

            + + + + + public + static sweden() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + switzerland() + +

            + + + + + public + static switzerland() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + syrianArabRepublic() + +

            + + + + + public + static syrianArabRepublic() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + taiwanProvinceOfChina() + +

            + + + + + public + static taiwanProvinceOfChina() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + tajikistan() + +

            + + + + + public + static tajikistan() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + tanzaniaUnitedRepublicOf() + +

            + + + + + public + static tanzaniaUnitedRepublicOf() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + thailand() + +

            + + + + + public + static thailand() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + timorLeste() + +

            + + + + + public + static timorLeste() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + togo() + +

            + + + + + public + static togo() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + tokelau() + +

            + + + + + public + static tokelau() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + tonga() + +

            + + + + + public + static tonga() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + trinidadAndTobago() + +

            + + + + + public + static trinidadAndTobago() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + tunisia() + +

            + + + + + public + static tunisia() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + turkey() + +

            + + + + + public + static turkey() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + turkmenistan() + +

            + + + + + public + static turkmenistan() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + turksAndCaicosIslands() + +

            + + + + + public + static turksAndCaicosIslands() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + tuvalu() + +

            + + + + + public + static tuvalu() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + uganda() + +

            + + + + + public + static uganda() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + ukraine() + +

            + + + + + public + static ukraine() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + unitedArabEmirates() + +

            + + + + + public + static unitedArabEmirates() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + unitedKingdom() + +

            + + + + + public + static unitedKingdom() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + unitedStates() + +

            + + + + + public + static unitedStates() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + unitedStatesMinorOutlyingIslands() + +

            + + + + + public + static unitedStatesMinorOutlyingIslands() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + uruguay() + +

            + + + + + public + static uruguay() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + uzbekistan() + +

            + + + + + public + static uzbekistan() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + values() + +

            + + +

            Valeurs des possibilités de cet énumération (value)

            + + + public + static values() : array<string|int, mixed> + + + + + +
            Return values
            + array<string|int, mixed> + — + + +
            +
            +

            + vanuatu() + +

            + + + + + public + static vanuatu() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + venezuelaBolivarianRepublicOf() + +

            + + + + + public + static venezuelaBolivarianRepublicOf() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + vietNam() + +

            + + + + + public + static vietNam() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + virginIslandsBritish() + +

            + + + + + public + static virginIslandsBritish() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + virginIslandsUs() + +

            + + + + + public + static virginIslandsUs() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + wallisAndFutuna() + +

            + + + + + public + static wallisAndFutuna() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + westernSahara() + +

            + + + + + public + static westernSahara() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + yemen() + +

            + + + + + public + static yemen() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + zambia() + +

            + + + + + public + static zambia() : + + + + + +
            Return values
            + + — + + +
            +
            +

            + zimbabwe() + +

            + + + + + public + static zimbabwe() : + + + + + +
            Return values
            + + — + + +
            +
            + + + + +
            +
            +
            +
            +

            Search results

            + +
            +
            +
              +
              +
              +
              +
              +
              + + +
              + + + + + + + + diff --git a/documentation/classes/LDC-LDCCRM-Enums-LogLevel.html b/documentation/classes/LDC-LDCCRM-Enums-LogLevel.html new file mode 100644 index 0000000..0aa2021 --- /dev/null +++ b/documentation/classes/LDC-LDCCRM-Enums-LogLevel.html @@ -0,0 +1,625 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
              +

              CRM V2

              + + + + + +
              + +
              +
              + + + + +
              + + +
              +

              + LogLevel + + + extends BaseEnum + + +
              + in package + +
              + + +

              + + + + + + +
              + Tags + +
              +
              +
              + subpackage +
              +
              + +

              enums

              +
              + +
              +
              + + + + + + +

              + Table of Contents + +

              + +
              +
              + ALERT() + +  : +
              +
              + +
              + CRIT() + +  : +
              +
              + +
              + DEBUG() + +  : +
              +
              + +
              + EMERG() + +  : +
              +
              + +
              + ERR() + +  : +
              +
              + +
              + INFO() + +  : +
              +
              + +
              + NOTICE() + +  : +
              +
              + +
              + WARNING() + +  : +
              +
              + +
              + values() + +  : array<string|int, mixed> +
              +
              Valeurs des possibilités de cet énumération (value)
              + +
              + + + + + + + +
              +

              + Methods + +

              +
              +

              + ALERT() + +

              + + + + + public + static ALERT() : + +

              action must be taken immediately

              +
              + + + + +
              Return values
              + + — + + +
              +
              +

              + CRIT() + +

              + + + + + public + static CRIT() : + +

              critical conditions

              +
              + + + + +
              Return values
              + + — + + +
              +
              +

              + DEBUG() + +

              + + + + + public + static DEBUG() : + +

              debug-level message

              +
              + + + + +
              Return values
              + + — + + +
              +
              +

              + EMERG() + +

              + + + + + public + static EMERG() : + +

              system is unusable

              +
              + + + + +
              Return values
              + + — + + +
              +
              +

              + ERR() + +

              + + + + + public + static ERR() : + +

              critical conditions

              +
              + + + + +
              Return values
              + + — + + +
              +
              +

              + INFO() + +

              + + + + + public + static INFO() : + +

              informational message

              +
              + + + + +
              Return values
              + + — + + +
              +
              +

              + NOTICE() + +

              + + + + + public + static NOTICE() : + +

              normal, but significant, condition

              +
              + + + + +
              Return values
              + + — + + +
              +
              +

              + WARNING() + +

              + + + + + public + static WARNING() : + +

              critical conditions

              +
              + + + + +
              Return values
              + + — + + +
              +
              +

              + values() + +

              + + +

              Valeurs des possibilités de cet énumération (value)

              + + + protected + static values() : array<string|int, mixed> + + + + + +
              Return values
              + array<string|int, mixed> + — + + +
              +
              + + + + +
              +
              +
              +
              +

              Search results

              + +
              +
              +
                +
                +
                +
                +
                +
                + + +
                + + + + + + + + diff --git a/documentation/classes/LDC-LDCCRM-Enums-QuestionType.html b/documentation/classes/LDC-LDCCRM-Enums-QuestionType.html new file mode 100644 index 0000000..3f8f304 --- /dev/null +++ b/documentation/classes/LDC-LDCCRM-Enums-QuestionType.html @@ -0,0 +1,414 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                +

                CRM V2

                + + + + + +
                + +
                +
                + + + + +
                + + +
                +

                + QuestionType + + + extends BaseEnum + + +
                + in package + +
                + + +

                + + + + + + +
                + Tags + +
                +
                +
                + subpackage +
                +
                + +

                enums

                +
                + +
                +
                + + + + + + +

                + Table of Contents + +

                + +
                +
                + checkbox() + +  : +
                +
                + +
                + radio() + +  : +
                +
                + +
                + select() + +  : +
                +
                + +
                + values() + +  : array<string|int, mixed> +
                +
                Valeurs des possibilités de cet énumération (value)
                + +
                + + + + + + + +
                +

                + Methods + +

                +
                +

                + checkbox() + +

                + + + + + public + static checkbox() : + + + + + +
                Return values
                + + — + + +
                +
                +

                + radio() + +

                + + + + + public + static radio() : + + + + + +
                Return values
                + + — + + +
                +
                +

                + select() + +

                + + + + + public + static select() : + + + + + +
                Return values
                + + — + + +
                +
                +

                + values() + +

                + + +

                Valeurs des possibilités de cet énumération (value)

                + + + public + static values() : array<string|int, mixed> + + + + + +
                Return values
                + array<string|int, mixed> + — + + +
                +
                + + + + +
                +
                +
                +
                +

                Search results

                + +
                +
                +
                  +
                  +
                  +
                  +
                  +
                  + + +
                  + + + + + + + + diff --git a/documentation/classes/LDC-LDCCRM-Exceptions-AccessError.html b/documentation/classes/LDC-LDCCRM-Exceptions-AccessError.html new file mode 100644 index 0000000..3a5c03b --- /dev/null +++ b/documentation/classes/LDC-LDCCRM-Exceptions-AccessError.html @@ -0,0 +1,319 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                  +

                  CRM V2

                  + + + + + +
                  + +
                  +
                  + + + + +
                  + + +
                  +

                  + AccessError + + + extends Error + + +
                  + in package + +
                  + + +

                  + + + +

                  This is thrown when trying to set a value on an object property that does not exist.

                  + + + +
                  + Tags + +
                  +
                  +
                  + subpackage +
                  +
                  + +

                  exceptions

                  +
                  + +
                  +
                  + + + + + + +

                  + Table of Contents + +

                  + +
                  +
                  + __construct() + +  : mixed +
                  +
                  AccessError
                  + +
                  + + + + + + + +
                  +

                  + Methods + +

                  +
                  +

                  + __construct() + +

                  + + +

                  AccessError

                  + + + public + __construct(string $objectName, string $propertyName) : mixed + + +
                  Parameters
                  +
                  +
                  + $objectName + : string +
                  +
                  +

                  The object name where the property does not exist.

                  +
                  + +
                  +
                  + $propertyName + : string +
                  +
                  +

                  The property name that does not exist.

                  +
                  + +
                  +
                  + + + +
                  Return values
                  + mixed + — + + +
                  +
                  + + + + +
                  +
                  +
                  +
                  +

                  Search results

                  + +
                  +
                  +
                    +
                    +
                    +
                    +
                    +
                    + + +
                    + + + + + + + + diff --git a/documentation/classes/LDC-LDCCRM-Exceptions-ApiErrorException.html b/documentation/classes/LDC-LDCCRM-Exceptions-ApiErrorException.html new file mode 100644 index 0000000..76fa30e --- /dev/null +++ b/documentation/classes/LDC-LDCCRM-Exceptions-ApiErrorException.html @@ -0,0 +1,595 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                    +

                    CRM V2

                    + + + + + +
                    + +
                    +
                    + + + + +
                    + + +
                    +

                    + ApiErrorException + + + extends Exception + + +
                    + in package + +
                    + + +

                    + + + +

                    This would be thrown if any of the case +referenced in \LDC\LDCCRM\Enums\ApiError would +occur within the crm

                    + +

                    On the client an ApiErrorException would +also be throw with the ApiError corresponding to +the situation

                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + subpackage +
                    +
                    + +

                    exceptions

                    +
                    + +
                    +
                    + + + + + + +

                    + Table of Contents + +

                    + +
                    +
                    + $error + +  : ApiError +
                    +
                    Api Error +This value makes the error more explicit.
                    + +
                    + $httpCode + +  : int +
                    +
                    This is the http code returned by the crm.
                    + +
                    + $message + +  : string +
                    +
                    This is an explicit error message, +ou may print this to the front or not depending +on $error value
                    + +
                    + __construct() + +  : mixed +
                    +
                    Create a new exception base on ApiError enum.
                    + +
                    + getApiError() + +  : ApiError +
                    +
                    Get the Api Error
                    + +
                    + getStatusCode() + +  : int +
                    +
                    Get the http code
                    + +
                    + report() + +  : void +
                    +
                    This is used by laravel only.
                    + +
                    + + + + + + +
                    +

                    + Properties + +

                    +
                    +

                    + $error + + + +

                    + + +

                    Api Error +This value makes the error more explicit.

                    + + + protected + ApiError + $error + + +

                    Handling these errors are normal as inputs or +request may be undesired or refused by the crm.

                    +
                    + + + + +
                    +
                    +

                    + $httpCode + + + +

                    + + +

                    This is the http code returned by the crm.

                    + + + protected + int + $httpCode + + +

                    This value could be used to handle errors. +But please take in consideration $error first

                    +
                    + + + + +
                    +
                    +

                    + $message + + + +

                    + + +

                    This is an explicit error message, +ou may print this to the front or not depending +on $error value

                    + + + protected + string + $message + + + + + + +
                    +
                    + +
                    +

                    + Methods + +

                    +
                    +

                    + __construct() + +

                    + + +

                    Create a new exception base on ApiError enum.

                    + + + public + __construct(ApiError $error[, int $httpCode = 400 ][, string $message = '' ][, Throwable|null $previous = null ]) : mixed + + +
                    Parameters
                    +
                    +
                    + $error + : ApiError +
                    +
                    + +
                    +
                    + $httpCode + : int + = 400
                    +
                    + +
                    +
                    + $message + : string + = ''
                    +
                    + +
                    +
                    + $previous + : Throwable|null + = null
                    +
                    + +
                    +
                    + + + +
                    Return values
                    + mixed + — + + +
                    + +
                    +

                    + getStatusCode() + +

                    + + +

                    Get the http code

                    + + + public + getStatusCode() : int + + + + + +
                    Return values
                    + int + — + + +
                    +
                    +

                    + report() + +

                    + + +

                    This is used by laravel only.

                    + + + public + report() : void + +

                    It uses Log class to print the error.

                    +
                    + + + + +
                    Return values
                    + void + — + + +
                    +
                    + + + + +
                    +
                    +
                    +
                    +

                    Search results

                    + +
                    +
                    +
                      +
                      +
                      +
                      +
                      +
                      + + +
                      + + + + + + + + diff --git a/documentation/classes/LDC-LDCCRM-Exceptions-CrmException.html b/documentation/classes/LDC-LDCCRM-Exceptions-CrmException.html new file mode 100644 index 0000000..8f1da3e --- /dev/null +++ b/documentation/classes/LDC-LDCCRM-Exceptions-CrmException.html @@ -0,0 +1,310 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                      +

                      CRM V2

                      + + + + + +
                      + +
                      +
                      + + + + +
                      + + +
                      +

                      + CrmException + + + extends Exception + + +
                      + in package + +
                      + + +

                      + + + +

                      This is a critical error.

                      + +

                      The request could not be handled. You may dump any value you can +get before submitting a ticker to https://supportweb.ldc.fr

                      +
                      + + +
                      + Tags + +
                      +
                      +
                      + subpackage +
                      +
                      + +

                      exceptions

                      +
                      + +
                      +
                      + codeCoverageIgnore +
                      +
                      + + +
                      +
                      + + + + + + +

                      + Table of Contents + +

                      + +
                      +
                      + report() + +  : void +
                      +
                      This is used by laravel only.
                      + +
                      + + + + + + + +
                      +

                      + Methods + +

                      +
                      +

                      + report() + +

                      + + +

                      This is used by laravel only.

                      + + + public + report() : void + +

                      It uses Log class to print the error.

                      +
                      + + + + +
                      Return values
                      + void + — + + +
                      +
                      + + + + +
                      +
                      +
                      +
                      +

                      Search results

                      + +
                      +
                      +
                        +
                        +
                        +
                        +
                        +
                        + + +
                        + + + + + + + + diff --git a/documentation/classes/LDC-LDCCRM-Exceptions-SkipValidationException.html b/documentation/classes/LDC-LDCCRM-Exceptions-SkipValidationException.html new file mode 100644 index 0000000..191f5a2 --- /dev/null +++ b/documentation/classes/LDC-LDCCRM-Exceptions-SkipValidationException.html @@ -0,0 +1,245 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                        +

                        CRM V2

                        + + + + + +
                        + +
                        +
                        + + + + +
                        + + +
                        +

                        + SkipValidationException + + + extends Exception + + +
                        + in package + +
                        + + +

                        + + + +

                        Used only for internal validator

                        + + + +
                        + Tags + +
                        +
                        +
                        + subpackage +
                        +
                        + +

                        exceptions

                        +
                        + +
                        +
                        + + + + + + + + + + + + + + + + + +
                        +
                        +
                        +
                        +

                        Search results

                        + +
                        +
                        +
                          +
                          +
                          +
                          +
                          +
                          + + +
                          + + + + + + + + diff --git a/documentation/classes/LDC-LDCCRM-Exceptions-ValidationException.html b/documentation/classes/LDC-LDCCRM-Exceptions-ValidationException.html new file mode 100644 index 0000000..f6cefc1 --- /dev/null +++ b/documentation/classes/LDC-LDCCRM-Exceptions-ValidationException.html @@ -0,0 +1,308 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                          +

                          CRM V2

                          + + + + + +
                          + +
                          +
                          + + + + +
                          + + +
                          +

                          + ValidationException + + + extends Exception + + +
                          + in package + +
                          + + +

                          + + + +

                          This would be thrown if a data could not be validated +on any models

                          + + + +
                          + Tags + +
                          +
                          +
                          + subpackage +
                          +
                          + +

                          exceptions

                          +
                          + +
                          +
                          + codeCoverageIgnore +
                          +
                          + + +
                          +
                          + + + + + + +

                          + Table of Contents + +

                          + +
                          +
                          + report() + +  : void +
                          +
                          This is used by laravel only.
                          + +
                          + + + + + + + +
                          +

                          + Methods + +

                          +
                          +

                          + report() + +

                          + + +

                          This is used by laravel only.

                          + + + public + report() : void + +

                          It uses Log class to print the error.

                          +
                          + + + + +
                          Return values
                          + void + — + + +
                          +
                          + + + + +
                          +
                          +
                          +
                          +

                          Search results

                          + +
                          +
                          +
                            +
                            +
                            +
                            +
                            +
                            + + +
                            + + + + + + + + diff --git a/documentation/classes/LDC-LDCCRM-Exceptions-WpCrmInvalidJsonUserInfo.html b/documentation/classes/LDC-LDCCRM-Exceptions-WpCrmInvalidJsonUserInfo.html new file mode 100644 index 0000000..73c0da5 --- /dev/null +++ b/documentation/classes/LDC-LDCCRM-Exceptions-WpCrmInvalidJsonUserInfo.html @@ -0,0 +1,310 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                            +

                            CRM V2

                            + + + + + +
                            + +
                            +
                            + + + + +
                            + + +
                            +

                            + WpCrmInvalidJsonUserInfo + + + extends Error + + +
                            + in package + +
                            + + +

                            + + + +

                            This is thrown when trying to read WP customer from DB json data.

                            + + + +
                            + Tags + +
                            +
                            +
                            + subpackage +
                            +
                            + +

                            exceptions

                            +
                            + +
                            +
                            + + + + + + +

                            + Table of Contents + +

                            + +
                            +
                            + __construct() + +  : mixed +
                            +
                            WpCrmInvalidJsonUserInfo
                            + +
                            + + + + + + + +
                            +

                            + Methods + +

                            +
                            +

                            + __construct() + +

                            + + +

                            WpCrmInvalidJsonUserInfo

                            + + + public + __construct(string $message) : mixed + + +
                            Parameters
                            +
                            +
                            + $message + : string +
                            +
                            +

                            The error message.

                            +
                            + +
                            +
                            + + + +
                            Return values
                            + mixed + — + + +
                            +
                            + + + + +
                            +
                            +
                            +
                            +

                            Search results

                            + +
                            +
                            +
                              +
                              +
                              +
                              +
                              +
                              + + +
                              + + + + + + + + diff --git a/documentation/classes/LDC-LDCCRM-Models-Answer.html b/documentation/classes/LDC-LDCCRM-Models-Answer.html new file mode 100644 index 0000000..5dd47ba --- /dev/null +++ b/documentation/classes/LDC-LDCCRM-Models-Answer.html @@ -0,0 +1,845 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                              +

                              CRM V2

                              + + + + + +
                              + +
                              +
                              + + + + +
                              + + +
                              +

                              + Answer + + + extends CrmClientModel + + +
                              + in package + +
                              + + +

                              + + + +

                              This class represents an answer +It has a method to submit answers

                              + + + +
                              + Tags + +
                              +
                              +
                              + category +
                              +
                              + +

                              Api Models

                              +
                              + +
                              +
                              + subpackage +
                              +
                              + +

                              models

                              +
                              + +
                              +
                              + author +
                              +
                              + +

                              Jérémy Munsch jeremy.munsch@ldc.fr

                              +
                              + +
                              +
                              + + + + + + +

                              + Table of Contents + +

                              + +
                              +
                              + $answers + +  : array<string|int, Answer> +
                              +
                              + +
                              + $id + +  : string +
                              +
                              + +
                              + $question + +  : string +
                              +
                              + +
                              + $type + +  : QuestionType +
                              +
                              + +
                              + $modelFields + +  : array<string|int, mixed> +
                              +
                              The crm customer fields
                              + +
                              + $validation + +  : array<string|int, mixed> +
                              +
                              Validation rules
                              + +
                              + $answer + +  : string +
                              +
                              The actual answer as a string
                              + +
                              + $id + +  : int +
                              +
                              The question id
                              + +
                              + __construct() + +  : mixed +
                              +
                              Answer
                              + +
                              + jsonSerialize() + +  : array<string|int, mixed> +
                              +
                              Serialize this object to an array
                              + +
                              + setQuestionAnswers() + +  : bool +
                              +
                              Set unanswered question for a specific customer
                              + +
                              + + + + + + +
                              +

                              + Properties + +

                              +
                              +

                              + $answers + + + +

                              + + + + + public + array<string|int, Answer> + $answers + + +

                              An array with answers

                              +
                              + +
                              + + + +
                              +
                              +

                              + $id + + + +

                              + + + + + public + string + $id + + +

                              The answer id

                              +
                              + +
                              + + + +
                              +
                              +

                              + $question + + + +

                              + + + + + public + string + $question + + +

                              The actual question as a string

                              +
                              + +
                              + + + +
                              +
                              +

                              + $type + + + +

                              + + + + + public + QuestionType + $type + + +

                              The question type to display, +it also hints wether it can accept one or multiple responses, +so only checkbox allows multiple responses

                              +
                              + +
                              + + + +
                              +
                              +

                              + $modelFields + + + +

                              + + +

                              The crm customer fields

                              + + + protected + array<string|int, mixed> + $modelFields + = ['id', 'answer'] + + + + + +
                              +
                              +

                              + $validation + + + +

                              + + +

                              Validation rules

                              + + + protected + static array<string|int, mixed> + $validation + = ['id' => 'required|int', 'answer' => 'required|string|max:255'] + + + + + +
                              +
                              +

                              + $answer + + + +

                              + + +

                              The actual answer as a string

                              + + + private + string + $answer + = null + +

                              Required +Max length 255 +Field Type varchar

                              +
                              + + + + +
                              +
                              +

                              + $id + + + +

                              + + +

                              The question id

                              + + + private + int + $id + + +

                              Required +Field Type bigInt

                              +
                              + + + + +
                              +
                              + +
                              +

                              + Methods + +

                              +
                              +

                              + __construct() + +

                              + + +

                              Answer

                              + + + public + __construct([array<string|int, mixed> $properties = [] ]) : mixed + + +
                              Parameters
                              +
                              +
                              + $properties + : array<string|int, mixed> + = []
                              +
                              + +
                              +
                              + + +
                              + Tags + +
                              +
                              +
                              + throws +
                              +
                              + ValidationException + +

                              If a field could not be validated.

                              +
                              + +
                              +
                              + +
                              Return values
                              + mixed + — + + +
                              +
                              +

                              + jsonSerialize() + +

                              + + +

                              Serialize this object to an array

                              + + + public + jsonSerialize() : array<string|int, mixed> + + + + + +
                              Return values
                              + array<string|int, mixed> + — + + +
                              +
                              +

                              + setQuestionAnswers() + +

                              + + +

                              Set unanswered question for a specific customer

                              + + + public + static setQuestionAnswers(string $hashcode, int $questionId, array<string|int, mixed> $answersId) : bool + + +
                              Parameters
                              +
                              +
                              + $hashcode + : string +
                              +
                              +

                              The customer hashcode.

                              +
                              + +
                              +
                              + $questionId + : int +
                              +
                              +

                              The question id.

                              +
                              + +
                              +
                              + $answersId + : array<string|int, mixed> +
                              +
                              +

                              An array with answers id.

                              +
                              + +
                              +
                              + + +
                              + Tags + +
                              +
                              +
                              + throws +
                              +
                              + ValidationException + +

                              If a hashcode is not a valid UUID.

                              +
                              + +
                              +
                              + throws +
                              +
                              + ValidationException + +

                              If any of the provided ids are invalid.

                              +
                              + +
                              +
                              + throws +
                              +
                              + ApiErrorException + +

                              If any error \LDC\LDCCRM\Enums\ApiError occurs. +Possibles are : - validationFailed, If given ids are wrong(CRM side).

                              +
                              + +
                              +
                              + throws +
                              +
                              + CrmException + +

                              If an error occurs on server side or on getting response.

                              +
                              + +
                              +
                              + +
                              Return values
                              + bool + — +

                              true if succeeded

                              +
                              + + +
                              +
                              + + + + +
                              +
                              +
                              +
                              +

                              Search results

                              + +
                              +
                              +
                                +
                                +
                                +
                                +
                                +
                                + + +
                                + + + + + + + + diff --git a/documentation/classes/LDC-LDCCRM-Models-ArcadiaMailDefault.html b/documentation/classes/LDC-LDCCRM-Models-ArcadiaMailDefault.html new file mode 100644 index 0000000..bfb379b --- /dev/null +++ b/documentation/classes/LDC-LDCCRM-Models-ArcadiaMailDefault.html @@ -0,0 +1,2111 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                +

                                CRM V2

                                + + + + + +
                                + +
                                +
                                + + + + +
                                + + +
                                +

                                + ArcadiaMailDefault + + + extends CrmClientModel + + +
                                + in package + +
                                + + +

                                + + + +

                                This class represents the customer info with +the account validation status

                                + + + +
                                + Tags + +
                                +
                                +
                                + category +
                                +
                                + +

                                Api Models

                                +
                                + +
                                +
                                + subpackage +
                                +
                                + +

                                models

                                +
                                + +
                                +
                                + author +
                                +
                                + +

                                Jérémy Munsch jeremy.munsch@ldc.fr

                                +
                                + +
                                +
                                + + + + + + +

                                + Table of Contents + +

                                + +
                                +
                                + $address + +  : string +
                                +
                                + +
                                + $address2 + +  : string +
                                +
                                + +
                                + $city + +  : string +
                                +
                                + +
                                + $email + +  : string +
                                +
                                + +
                                + $firstname + +  : string +
                                +
                                + +
                                + $label_type_support + +  : string +
                                +
                                + +
                                + $lastname + +  : string +
                                +
                                + +
                                + $operation + +  : int +
                                +
                                + +
                                + $order_date + +  : string +
                                +
                                + +
                                + $order_num + +  : int +
                                +
                                + +
                                + $package_unit_weight + +  : int +
                                +
                                + +
                                + $phone + +  : string +
                                +
                                + +
                                + $postcode + +  : string +
                                +
                                + +
                                + $state_order + +  : ArcadiaOrderType +
                                +
                                + +
                                + $support_code + +  : int +
                                +
                                + +
                                + $modelFields + +  : array<string|int, mixed> +
                                +
                                The crm customer fields
                                + +
                                + $validation + +  : array<string|int, mixed> +
                                +
                                Validation rules
                                + +
                                + $address + +  : string +
                                +
                                The user address (street number, name, etc)
                                + +
                                + $address2 + +  : string +
                                +
                                The user address 2nd part (street number, name, more, etc)
                                + +
                                + $city + +  : string +
                                +
                                The user address city
                                + +
                                + $email + +  : string +
                                +
                                An RFC Valid Email
                                + +
                                + $firstname + +  : string +
                                +
                                First name
                                + +
                                + $label_type_support + +  : string +
                                +
                                The arcadia type support label
                                + +
                                + $lastname + +  : string +
                                +
                                Last name
                                + +
                                + $operation + +  : int +
                                +
                                The arcadia operation code
                                + +
                                + $order_date + +  : string +
                                +
                                The arcadia order date
                                + +
                                + $order_num + +  : int +
                                +
                                The arcadia order number
                                + +
                                + $package_unit_weight + +  : int +
                                +
                                The arcadia package unit weight
                                + +
                                + $phone + +  : string +
                                +
                                The user phone
                                + +
                                + $postcode + +  : string +
                                +
                                The user address postcode
                                + +
                                + $state_order + +  : int +
                                +
                                The arcadia state order
                                + +
                                + $support_code + +  : int +
                                +
                                The arcadia support code
                                + +
                                + __construct() + +  : mixed +
                                +
                                ArcadiaMailDefault
                                + +
                                + __get() + +  : mixed +
                                +
                                Generic accessor
                                + +
                                + __set() + +  : void +
                                +
                                Set prop
                                + +
                                + fill() + +  : void +
                                +
                                Fill data into this model +using validation rules
                                + +
                                + jsonSerialize() + +  : array<string|int, mixed> +
                                +
                                Serialize this object to an array
                                + +
                                + send() + +  : bool +
                                +
                                Send The actual mail
                                + +
                                + validateAllValues() + +  : array<string|int, mixed> +
                                +
                                Validate all model properties
                                + +
                                + + + + + + +
                                +

                                + Properties + +

                                +
                                +

                                + $address + + + +

                                + + + + + public + string + $address + + +

                                The account address (street number, name, build, flat number)

                                +
                                + +
                                + + + +
                                +
                                +

                                + $address2 + + + +

                                + + + + + public + string + $address2 + + +

                                The account phone (address complement)

                                +
                                + +
                                + + + +
                                +
                                +

                                + $city + + + +

                                + + + + + public + string + $city + + +

                                The account city name

                                +
                                + +
                                + + + +
                                +
                                +

                                + $email + + + +

                                + + + + + public + string + $email + + +

                                Must be a rfc valid email on a valid domain name

                                +
                                + +
                                + + + +
                                +
                                +

                                + $firstname + + + +

                                + + + + + public + string + $firstname + + +

                                The account first name

                                +
                                + +
                                + + + +
                                +
                                +

                                + $label_type_support + + + +

                                + + + + + public + string + $label_type_support + + +

                                The arcadia type support label

                                +
                                + +
                                + + + +
                                +
                                +

                                + $lastname + + + +

                                + + + + + public + string + $lastname + + +

                                The account last name

                                +
                                + +
                                + + + +
                                +
                                +

                                + $operation + + + +

                                + + + + + public + int + $operation + + +

                                The arcadia operation code

                                +
                                + +
                                + + + +
                                +
                                +

                                + $order_date + + + +

                                + + + + + public + string + $order_date + + +

                                The arcadia order date 'yyyy-mm-dd HH:ii:ss'

                                +
                                + +
                                + + + +
                                +
                                +

                                + $order_num + + + +

                                + + + + + public + int + $order_num + + +

                                The arcadia order number

                                +
                                + +
                                + + + +
                                +
                                +

                                + $package_unit_weight + + + +

                                + + + + + public + int + $package_unit_weight + + +

                                The arcadia package unit weight

                                +
                                + +
                                + + + +
                                +
                                +

                                + $phone + + + +

                                + + + + + public + string + $phone + + +

                                The account phone

                                +
                                + +
                                + + + +
                                +
                                +

                                + $postcode + + + +

                                + + + + + public + string + $postcode + + +

                                The account city postcode

                                +
                                + +
                                + + + +
                                + +
                                +

                                + $support_code + + + +

                                + + + + + public + int + $support_code + + +

                                The arcadia support code

                                +
                                + +
                                + + + +
                                +
                                +

                                + $modelFields + + + +

                                + + +

                                The crm customer fields

                                + + + protected + array<string|int, mixed> + $modelFields + = ['email', 'firstname', 'lastname', 'phone', 'address', 'address2', 'city', 'postcode', 'operation', 'support_code', 'label_type_support', 'order_date', 'order_num', 'state_order', 'package_unit_weight'] + + + + + +
                                +
                                +

                                + $validation + + + +

                                + + +

                                Validation rules

                                + + + protected + static array<string|int, mixed> + $validation + = ['email' => 'required|email', 'firstname' => 'required|string|min:2|max:255', 'lastname' => 'required|string|min:2|max:255', 'phone' => 'sometimes|string|min:10|max:255', 'address' => 'sometimes|string|max:255', 'address2' => 'sometimes|string|max:255', 'city' => 'sometimes|string|max:255', 'postcode' => 'sometimes|string|max:255', 'operation' => 'required|int', 'support_code' => 'required|int', 'label_type_support' => 'required|string|min:2|max:255', 'order_date' => 'required|date_format:Y/m/d H:i:s', 'order_num' => 'required|int', 'state_order' => ['required'], 'package_unit_weight' => 'required|int'] + + + + + +
                                +
                                +

                                + $address + + + +

                                + + +

                                The user address (street number, name, etc)

                                + + + private + string + $address + = null + +

                                Validate: sometimes,string

                                +

                                Min length NA +Max length 255 +Field Type varchar

                                +
                                + + + + +
                                +
                                +

                                + $address2 + + + +

                                + + +

                                The user address 2nd part (street number, name, more, etc)

                                + + + private + string + $address2 + = null + +

                                Validate: sometimes,string

                                +

                                Min length NA +Max length 255 +Field Type varchar

                                +
                                + + + + +
                                +
                                +

                                + $city + + + +

                                + + +

                                The user address city

                                + + + private + string + $city + = null + +

                                Validate: sometimes,string

                                +

                                Min length NA +Max length 255 +Field Type varchar

                                +
                                + + + + +
                                +
                                +

                                + $email + + + +

                                + + +

                                An RFC Valid Email

                                + + + private + string + $email + = null + +

                                Validate: rfc,dns,spoof,filter

                                +

                                Required +Min length N/A +Max length 255 +Field Type varchar

                                +
                                + + + + +
                                +
                                +

                                + $firstname + + + +

                                + + +

                                First name

                                + + + private + string + $firstname + = null + +

                                Required +Min length 2 +Max length 255 +Field Type varchar

                                +
                                + + + + +
                                +
                                +

                                + $label_type_support + + + +

                                + + +

                                The arcadia type support label

                                + + + private + string + $label_type_support + = null + +

                                Validate: string

                                +

                                Required

                                +
                                + + + + +
                                +
                                +

                                + $lastname + + + +

                                + + +

                                Last name

                                + + + private + string + $lastname + = null + +

                                Required +Min length 2 +Max length 255 +Field Type varchar

                                +
                                + + + + +
                                +
                                +

                                + $operation + + + +

                                + + +

                                The arcadia operation code

                                + + + private + int + $operation + = null + +

                                Validate: int

                                +

                                Required

                                +
                                + + + + +
                                +
                                +

                                + $order_date + + + +

                                + + +

                                The arcadia order date

                                + + + private + string + $order_date + = null + +

                                Validate: date

                                +

                                Required

                                +
                                + + + + +
                                +
                                +

                                + $order_num + + + +

                                + + +

                                The arcadia order number

                                + + + private + int + $order_num + = null + +

                                Validate: numeric,digits:9

                                +

                                Required

                                +
                                + + + + +
                                +
                                +

                                + $package_unit_weight + + + +

                                + + +

                                The arcadia package unit weight

                                + + + private + int + $package_unit_weight + = null + +

                                Validate: integer

                                +

                                Required

                                +
                                + + + + +
                                +
                                +

                                + $phone + + + +

                                + + +

                                The user phone

                                + + + private + string + $phone + = null + +

                                Validate: sometimes,string

                                +

                                Required +Min length NA +Max length 255 +Field Type varchar

                                +
                                + + + + +
                                +
                                +

                                + $postcode + + + +

                                + + +

                                The user address postcode

                                + + + private + string + $postcode + = null + +

                                Validate: string

                                +

                                Required +Min length NA +Max length 255 +Field Type varchar

                                +
                                + + + + +
                                +
                                +

                                + $state_order + + + +

                                + + +

                                The arcadia state order

                                + + + private + int + $state_order + = null + +

                                Validate: in ArcadiaOrderType::toValues()

                                +

                                Required

                                +
                                + + + + +
                                +
                                +

                                + $support_code + + + +

                                + + +

                                The arcadia support code

                                + + + private + int + $support_code + = null + +

                                Validate: int

                                +

                                Required

                                +
                                + + + + +
                                +
                                + +
                                +

                                + Methods + +

                                +
                                +

                                + __construct() + +

                                + + +

                                ArcadiaMailDefault

                                + + + public + __construct([array<string|int, mixed> $properties = [] ]) : mixed + + +
                                Parameters
                                +
                                +
                                + $properties + : array<string|int, mixed> + = []
                                +
                                + +
                                +
                                + + +
                                + Tags + +
                                +
                                +
                                + throws +
                                +
                                + ValidationException + +

                                If a field could not be validated.

                                +
                                + +
                                +
                                + +
                                Return values
                                + mixed + — + + +
                                +
                                +

                                + __get() + +

                                + + +

                                Generic accessor

                                + + + public + __get(string $field) : mixed + + +
                                Parameters
                                +
                                +
                                + $field + : string +
                                +
                                + +
                                +
                                + + + +
                                Return values
                                + mixed + — + + +
                                +
                                +

                                + __set() + +

                                + + +

                                Set prop

                                + + + public + __set(string $field, mixed $value) : void + + +
                                Parameters
                                +
                                +
                                + $field + : string +
                                +
                                + +
                                +
                                + $value + : mixed +
                                +
                                + +
                                +
                                + + +
                                + Tags + +
                                +
                                +
                                + throws +
                                +
                                + TypeError + +

                                If the field has an incorrect value.

                                +
                                + +
                                +
                                + throws +
                                +
                                + AccessError + +

                                If trying to set a value on a unknown property.

                                +
                                + +
                                +
                                + +
                                Return values
                                + void + — + + +
                                +
                                +

                                + fill() + +

                                + + +

                                Fill data into this model +using validation rules

                                + + + public + fill(array<string|int, mixed> $properties) : void + + +
                                Parameters
                                +
                                +
                                + $properties + : array<string|int, mixed> +
                                +
                                + +
                                +
                                + + +
                                + Tags + +
                                +
                                +
                                + throws +
                                +
                                + ValidationException + +

                                If a field could not be validated.

                                +
                                + +
                                +
                                + +
                                Return values
                                + void + — + + +
                                +
                                +

                                + jsonSerialize() + +

                                + + +

                                Serialize this object to an array

                                + + + public + jsonSerialize() : array<string|int, mixed> + + + + + +
                                Return values
                                + array<string|int, mixed> + — + + +
                                +
                                +

                                + send() + +

                                + + +

                                Send The actual mail

                                + + + public + send() : bool + + + + +
                                + Tags + +
                                +
                                +
                                + throws +
                                +
                                + ValidationException + +

                                If a field could not be validated.

                                +
                                + +
                                +
                                + throws +
                                +
                                + CrmException + +

                                If an error occurs on server side or on getting response.

                                +
                                + +
                                +
                                + throws +
                                +
                                + ApiErrorException + +

                                If any error or \LDC\LDCCRM\Enums\ApiError occurs. +Possibles are : - validationFailed, If provided data is wrong(CRM side).

                                +
                                + +
                                +
                                + +
                                Return values
                                + bool + — +

                                true if succeeded

                                +
                                + + +
                                +
                                +

                                + validateAllValues() + +

                                + + +

                                Validate all model properties

                                + + + protected + validateAllValues([array<string|int, mixed> $ignore = [] ]) : array<string|int, mixed> + + +
                                Parameters
                                +
                                +
                                + $ignore + : array<string|int, mixed> + = []
                                +
                                + +
                                +
                                + + +
                                + Tags + +
                                +
                                +
                                + throws +
                                +
                                + ValidationException + +

                                If a field could not be validated.

                                +
                                + +
                                +
                                + +
                                Return values
                                + array<string|int, mixed> + — +

                                the validated values

                                +
                                + + +
                                +
                                + + + + +
                                +
                                +
                                +
                                +

                                Search results

                                + +
                                +
                                +
                                  +
                                  +
                                  +
                                  +
                                  +
                                  + + +
                                  + + + + + + + + diff --git a/documentation/classes/LDC-LDCCRM-Models-ArcadiaMailGame.html b/documentation/classes/LDC-LDCCRM-Models-ArcadiaMailGame.html new file mode 100644 index 0000000..b6f748b --- /dev/null +++ b/documentation/classes/LDC-LDCCRM-Models-ArcadiaMailGame.html @@ -0,0 +1,1900 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                  +

                                  CRM V2

                                  + + + + + +
                                  + +
                                  +
                                  + + + + +
                                  + + +
                                  +

                                  + ArcadiaMailGame + + + extends CrmClientModel + + +
                                  + in package + +
                                  + + +

                                  + + + +

                                  This class represents the customer info with +the account validation status

                                  + + + +
                                  + Tags + +
                                  +
                                  +
                                  + category +
                                  +
                                  + +

                                  Api Models

                                  +
                                  + +
                                  +
                                  + subpackage +
                                  +
                                  + +

                                  models

                                  +
                                  + +
                                  +
                                  + author +
                                  +
                                  + +

                                  Jérémy Munsch jeremy.munsch@ldc.fr

                                  +
                                  + +
                                  +
                                  + + + + + + +

                                  + Table of Contents + +

                                  + +
                                  +
                                  + $address + +  : string +
                                  +
                                  + +
                                  + $address2 + +  : string +
                                  +
                                  + +
                                  + $city + +  : string +
                                  +
                                  + +
                                  + $code_on_pack + +  : string +
                                  +
                                  + +
                                  + $code_unique + +  : string +
                                  +
                                  + +
                                  + $email + +  : string +
                                  +
                                  + +
                                  + $firstname + +  : string +
                                  +
                                  + +
                                  + $label_type_support + +  : string +
                                  +
                                  + +
                                  + $lastname + +  : string +
                                  +
                                  + +
                                  + $operation + +  : int +
                                  +
                                  + +
                                  + $order_date + +  : string +
                                  +
                                  + +
                                  + $phone + +  : string +
                                  +
                                  + +
                                  + $postcode + +  : string +
                                  +
                                  + +
                                  + $support_code + +  : int +
                                  +
                                  + +
                                  + $modelFields + +  : array<string|int, mixed> +
                                  +
                                  The crm customer fields
                                  + +
                                  + $validation + +  : array<string|int, mixed> +
                                  +
                                  Validation rules
                                  + +
                                  + $address + +  : string +
                                  +
                                  The user address (street number, name, etc)
                                  + +
                                  + $address2 + +  : string +
                                  +
                                  The user address 2nd part (street number, name, more, etc)
                                  + +
                                  + $city + +  : string +
                                  +
                                  The user address city
                                  + +
                                  + $code_on_pack + +  : string +
                                  +
                                  The arcadia code on pack
                                  + +
                                  + $code_unique + +  : string +
                                  +
                                  The arcadia code unique
                                  + +
                                  + $email + +  : string +
                                  +
                                  An RFC Valid Email
                                  + +
                                  + $firstname + +  : string +
                                  +
                                  First name
                                  + +
                                  + $label_type_support + +  : string +
                                  +
                                  The arcadia type support label
                                  + +
                                  + $lastname + +  : string +
                                  +
                                  Last name
                                  + +
                                  + $operation + +  : int +
                                  +
                                  The arcadia operation code
                                  + +
                                  + $order_date + +  : string +
                                  +
                                  The arcadia order date
                                  + +
                                  + $phone + +  : string +
                                  +
                                  The user phone
                                  + +
                                  + $postcode + +  : string +
                                  +
                                  The user address postcode
                                  + +
                                  + $support_code + +  : int +
                                  +
                                  The arcadia support code
                                  + +
                                  + __construct() + +  : mixed +
                                  +
                                  ArcadiaMailGame
                                  + +
                                  + __set() + +  : void +
                                  +
                                  Set prop
                                  + +
                                  + fill() + +  : void +
                                  +
                                  Fill data into this model +using validation rules
                                  + +
                                  + jsonSerialize() + +  : array<string|int, mixed> +
                                  +
                                  Serialize this object to an array
                                  + +
                                  + send() + +  : bool +
                                  +
                                  Send The actual mail
                                  + +
                                  + + + + + + +
                                  +

                                  + Properties + +

                                  +
                                  +

                                  + $address + + + +

                                  + + + + + public + string + $address + + +

                                  The account address (street number, name, build, flat number)

                                  +
                                  + +
                                  + + + +
                                  +
                                  +

                                  + $address2 + + + +

                                  + + + + + public + string + $address2 + + +

                                  The account phone (address complement)

                                  +
                                  + +
                                  + + + +
                                  +
                                  +

                                  + $city + + + +

                                  + + + + + public + string + $city + + +

                                  The account city name

                                  +
                                  + +
                                  + + + +
                                  +
                                  +

                                  + $code_on_pack + + + +

                                  + + + + + public + string + $code_on_pack + + +

                                  The arcadia code on pack

                                  +
                                  + +
                                  + + + +
                                  +
                                  +

                                  + $code_unique + + + +

                                  + + + + + public + string + $code_unique + + +

                                  The arcadia code unique

                                  +
                                  + +
                                  + + + +
                                  +
                                  +

                                  + $email + + + +

                                  + + + + + public + string + $email + + +

                                  Must be a rfc valid email on a valid domain name

                                  +
                                  + +
                                  + + + +
                                  +
                                  +

                                  + $firstname + + + +

                                  + + + + + public + string + $firstname + + +

                                  The account first name

                                  +
                                  + +
                                  + + + +
                                  +
                                  +

                                  + $label_type_support + + + +

                                  + + + + + public + string + $label_type_support + + +

                                  The arcadia type support label

                                  +
                                  + +
                                  + + + +
                                  +
                                  +

                                  + $lastname + + + +

                                  + + + + + public + string + $lastname + + +

                                  The account last name

                                  +
                                  + +
                                  + + + +
                                  +
                                  +

                                  + $operation + + + +

                                  + + + + + public + int + $operation + + +

                                  The arcadia operation code +Validate: int +Required

                                  +
                                  + +
                                  + + + +
                                  +
                                  +

                                  + $order_date + + + +

                                  + + + + + public + string + $order_date + + +

                                  The arcadia order date 'yyyy-mm-dd HH:ii:ss'

                                  +
                                  + +
                                  + + + +
                                  +
                                  +

                                  + $phone + + + +

                                  + + + + + public + string + $phone + + +

                                  The account phone

                                  +
                                  + +
                                  + + + +
                                  +
                                  +

                                  + $postcode + + + +

                                  + + + + + public + string + $postcode + + +

                                  The account city postcode

                                  +
                                  + +
                                  + + + +
                                  +
                                  +

                                  + $support_code + + + +

                                  + + + + + public + int + $support_code + + +

                                  The arcadia support code

                                  +
                                  + +
                                  + + + +
                                  +
                                  +

                                  + $modelFields + + + +

                                  + + +

                                  The crm customer fields

                                  + + + protected + array<string|int, mixed> + $modelFields + = ['email', 'firstname', 'lastname', 'phone', 'address', 'address2', 'city', 'postcode', 'operation', 'support_code', 'label_type_support', 'order_date', 'code_unique', 'code_on_pack'] + + + + + +
                                  +
                                  +

                                  + $validation + + + +

                                  + + +

                                  Validation rules

                                  + + + protected + static array<string|int, mixed> + $validation + = ['email' => 'required|email', 'firstname' => 'required|string|min:2|max:255', 'lastname' => 'required|string|min:2|max:255', 'phone' => 'sometimes|string|min:10|max:255', 'address' => 'sometimes|string|max:255', 'address2' => 'sometimes|string|max:255', 'city' => 'sometimes|string|max:255', 'postcode' => 'sometimes|string|max:255', 'operation' => 'required|int', 'support_code' => 'required|int', 'label_type_support' => 'required|string|min:2|max:255', 'order_date' => 'required|date_format:Y/m/d H:i:s', 'code_unique' => 'required|string', 'code_on_pack' => 'sometimes|string'] + + + + + +
                                  +
                                  +

                                  + $address + + + +

                                  + + +

                                  The user address (street number, name, etc)

                                  + + + private + string + $address + = null + +

                                  Validate: sometimes,string

                                  +

                                  Min length NA +Max length 255 +Field Type varchar

                                  +
                                  + + + + +
                                  +
                                  +

                                  + $address2 + + + +

                                  + + +

                                  The user address 2nd part (street number, name, more, etc)

                                  + + + private + string + $address2 + = null + +

                                  Validate: sometimes,string

                                  +

                                  Min length NA +Max length 255 +Field Type varchar

                                  +
                                  + + + + +
                                  +
                                  +

                                  + $city + + + +

                                  + + +

                                  The user address city

                                  + + + private + string + $city + = null + +

                                  Validate: sometimes,string

                                  +

                                  Min length NA +Max length 255 +Field Type varchar

                                  +
                                  + + + + +
                                  +
                                  +

                                  + $code_on_pack + + + +

                                  + + +

                                  The arcadia code on pack

                                  + + + private + string + $code_on_pack + = null + +

                                  Validate: sometimes

                                  +

                                  Required

                                  +
                                  + + + + +
                                  +
                                  +

                                  + $code_unique + + + +

                                  + + +

                                  The arcadia code unique

                                  + + + private + string + $code_unique + = null + +

                                  Validate: string

                                  +

                                  Required

                                  +
                                  + + + + +
                                  +
                                  +

                                  + $email + + + +

                                  + + +

                                  An RFC Valid Email

                                  + + + private + string + $email + = null + +

                                  Validate: rfc,dns,spoof,filter

                                  +

                                  Required +Min length N/A +Max length 255 +Field Type varchar

                                  +
                                  + + + + +
                                  +
                                  +

                                  + $firstname + + + +

                                  + + +

                                  First name

                                  + + + private + string + $firstname + = null + +

                                  Required +Min length 2 +Max length 255 +Field Type varchar

                                  +
                                  + + + + +
                                  +
                                  +

                                  + $label_type_support + + + +

                                  + + +

                                  The arcadia type support label

                                  + + + private + string + $label_type_support + = null + +

                                  Validate: string

                                  +

                                  Required

                                  +
                                  + + + + +
                                  +
                                  +

                                  + $lastname + + + +

                                  + + +

                                  Last name

                                  + + + private + string + $lastname + = null + +

                                  Required +Min length 2 +Max length 255 +Field Type varchar

                                  +
                                  + + + + +
                                  +
                                  +

                                  + $operation + + + +

                                  + + +

                                  The arcadia operation code

                                  + + + private + int + $operation + = null + +

                                  Validate: int

                                  +

                                  Required

                                  +
                                  + + + + +
                                  +
                                  +

                                  + $order_date + + + +

                                  + + +

                                  The arcadia order date

                                  + + + private + string + $order_date + = null + +

                                  Validate: date

                                  +

                                  Required

                                  +
                                  + + + + +
                                  +
                                  +

                                  + $phone + + + +

                                  + + +

                                  The user phone

                                  + + + private + string + $phone + = null + +

                                  Validate: sometimes,string

                                  +

                                  Required +Min length NA +Max length 255 +Field Type varchar

                                  +
                                  + + + + +
                                  +
                                  +

                                  + $postcode + + + +

                                  + + +

                                  The user address postcode

                                  + + + private + string + $postcode + = null + +

                                  Validate: string

                                  +

                                  Required +Min length NA +Max length 255 +Field Type varchar

                                  +
                                  + + + + +
                                  +
                                  +

                                  + $support_code + + + +

                                  + + +

                                  The arcadia support code

                                  + + + private + int + $support_code + = null + +

                                  Validate: int

                                  +

                                  Required

                                  +
                                  + + + + +
                                  +
                                  + +
                                  +

                                  + Methods + +

                                  +
                                  +

                                  + __construct() + +

                                  + + +

                                  ArcadiaMailGame

                                  + + + public + __construct([array<string|int, mixed> $properties = [] ]) : mixed + + +
                                  Parameters
                                  +
                                  +
                                  + $properties + : array<string|int, mixed> + = []
                                  +
                                  + +
                                  +
                                  + + +
                                  + Tags + +
                                  +
                                  +
                                  + throws +
                                  +
                                  + ValidationException + +

                                  If a field could not be validated.

                                  +
                                  + +
                                  +
                                  + +
                                  Return values
                                  + mixed + — + + +
                                  +
                                  +

                                  + __set() + +

                                  + + +

                                  Set prop

                                  + + + public + __set(string $field, mixed $value) : void + + +
                                  Parameters
                                  +
                                  +
                                  + $field + : string +
                                  +
                                  + +
                                  +
                                  + $value + : mixed +
                                  +
                                  + +
                                  +
                                  + + +
                                  + Tags + +
                                  +
                                  +
                                  + throws +
                                  +
                                  + TypeError + +

                                  If the field has an incorrect value.

                                  +
                                  + +
                                  +
                                  + throws +
                                  +
                                  + AccessError + +

                                  If trying to set a value on a unknown property.

                                  +
                                  + +
                                  +
                                  + +
                                  Return values
                                  + void + — + + +
                                  +
                                  +

                                  + fill() + +

                                  + + +

                                  Fill data into this model +using validation rules

                                  + + + public + fill(array<string|int, mixed> $properties) : void + + +
                                  Parameters
                                  +
                                  +
                                  + $properties + : array<string|int, mixed> +
                                  +
                                  + +
                                  +
                                  + + +
                                  + Tags + +
                                  +
                                  +
                                  + throws +
                                  +
                                  + ValidationException + +

                                  If a field could not be validated.

                                  +
                                  + +
                                  +
                                  + +
                                  Return values
                                  + void + — + + +
                                  +
                                  +

                                  + jsonSerialize() + +

                                  + + +

                                  Serialize this object to an array

                                  + + + public + jsonSerialize() : array<string|int, mixed> + + + + + +
                                  Return values
                                  + array<string|int, mixed> + — + + +
                                  +
                                  +

                                  + send() + +

                                  + + +

                                  Send The actual mail

                                  + + + public + send() : bool + + + + +
                                  + Tags + +
                                  +
                                  +
                                  + throws +
                                  +
                                  + CrmException + +

                                  If an error occurs on server side or on getting response.

                                  +
                                  + +
                                  +
                                  + throws +
                                  +
                                  + ApiErrorException + +

                                  If any error or \LDC\LDCCRM\Enums\ApiError occurs. +Possibles are : - validationFailed, If provided data is wrong(CRM side).

                                  +
                                  + +
                                  +
                                  + +
                                  Return values
                                  + bool + — +

                                  true if succeeded

                                  +
                                  + + +
                                  +
                                  + + + + +
                                  +
                                  +
                                  +
                                  +

                                  Search results

                                  + +
                                  +
                                  +
                                    +
                                    +
                                    +
                                    +
                                    +
                                    + + +
                                    + + + + + + + + diff --git a/documentation/classes/LDC-LDCCRM-Models-Customer.html b/documentation/classes/LDC-LDCCRM-Models-Customer.html new file mode 100644 index 0000000..0de86e7 --- /dev/null +++ b/documentation/classes/LDC-LDCCRM-Models-Customer.html @@ -0,0 +1,2914 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                    +

                                    CRM V2

                                    + + + + + +
                                    + +
                                    +
                                    + + + + +
                                    + + +
                                    +

                                    + Customer + + + extends CrmClientModel + + +
                                    + in package + +
                                    + + +

                                    + + + +

                                    This class represents the customer info with +the account validation status. You can use it as +a standalone class but beware of catching exceptions

                                    + +

                                    Be warned that on server side data is normalized

                                    +
                                      +
                                    • firstname and lastname are 'capitalized'
                                    • +
                                    • fields are trimmed
                                    • +
                                    • non numeric chars are removed from postcode
                                    • +
                                    +
                                    + + +
                                    + Tags + +
                                    +
                                    +
                                    + example +
                                    +
                                    + +

                                    examples/CustomerExample.php

                                    +
                                    + +
                                    +
                                    + category +
                                    +
                                    + +

                                    Api Models

                                    +
                                    + +
                                    +
                                    + subpackage +
                                    +
                                    + +

                                    models

                                    +
                                    + +
                                    +
                                    + author +
                                    +
                                    + +

                                    Jérémy Munsch jeremy.munsch@ldc.fr

                                    +
                                    + +
                                    +
                                    + + + + + + +

                                    + Table of Contents + +

                                    + +
                                    +
                                    + $address + +  : string +
                                    +
                                    + +
                                    + $address2 + +  : string +
                                    +
                                    + +
                                    + $birth_date + +  : string +
                                    +
                                    + +
                                    + $city + +  : string +
                                    +
                                    + +
                                    + $country + +  : Country +
                                    +
                                    + +
                                    + $email + +  : string +
                                    +
                                    + +
                                    + $firstname + +  : string +
                                    +
                                    + +
                                    + $hashcode + +  : string +
                                    +
                                    + +
                                    + $last_connection + +  : string +
                                    +
                                    + +
                                    + $lastname + +  : string +
                                    +
                                    + +
                                    + $opt_in + +  : bool +
                                    +
                                    + +
                                    + $password + +  : string +
                                    +
                                    + +
                                    + $phone + +  : string +
                                    +
                                    + +
                                    + $postcode + +  : string +
                                    +
                                    + +
                                    + $status + +  : bool +
                                    +
                                    + +
                                    + $invisibleFields + +  : array<string|int, mixed> +
                                    +
                                    The crm customer fields +the should not be visible
                                    + +
                                    + $modelFields + +  : array<string|int, mixed> +
                                    +
                                    The crm customer fields
                                    + +
                                    + $validation + +  : array<string|int, mixed> +
                                    +
                                    Validation rules
                                    + +
                                    + $address + +  : string +
                                    +
                                    The user address (street number, name, etc)
                                    + +
                                    + $address2 + +  : string +
                                    +
                                    The user address 2nd part (street number, name, more, etc)
                                    + +
                                    + $birth_date + +  : string +
                                    +
                                    Birth date
                                    + +
                                    + $city + +  : string +
                                    +
                                    The user address city
                                    + +
                                    + $country + +  : Country +
                                    +
                                    The user address postcode
                                    + +
                                    + $email + +  : string +
                                    +
                                    An RFC Valid Email
                                    + +
                                    + $firstname + +  : string +
                                    +
                                    First name
                                    + +
                                    + $hashcode + +  : string +
                                    +
                                    The user hashcode, this is link with the customer and the brand it is related to +It is used to identify the customer itself.
                                    + +
                                    + $last_connection + +  : string +
                                    +
                                    The last time the account was connected
                                    + +
                                    + $lastname + +  : string +
                                    +
                                    Last name
                                    + +
                                    + $opt_in + +  : bool +
                                    +
                                    The user optin choice
                                    + +
                                    + $password + +  : string +
                                    +
                                    The user password +This is set only when creating a user +Otherwise it has to be set to null
                                    + +
                                    + $phone + +  : string +
                                    +
                                    The user phone
                                    + +
                                    + $postcode + +  : string +
                                    +
                                    The user address postcode
                                    + +
                                    + $status + +  : bool +
                                    +
                                    Is the account activated ?
                                    + +
                                    + __construct() + +  : mixed +
                                    +
                                    Customer
                                    + +
                                    + __get() + +  : mixed|null +
                                    +
                                    Generic accessor
                                    + +
                                    + __set() + +  : void +
                                    +
                                    Set prop on the model.
                                    + +
                                    + activate() + +  : bool +
                                    +
                                    Active the customer on CRM.
                                    + +
                                    + delete() + +  : bool +
                                    +
                                    Removes the customer from CRM.
                                    + +
                                    + fill() + +  : void +
                                    +
                                    Fill values into model using validation rules.
                                    + +
                                    + find() + +  : self|null +
                                    +
                                    Find a customer using its hashcode in the crm
                                    + +
                                    + findWithEmail() + +  : self|null +
                                    +
                                    Find a customer using its email in the crm +This is an alias of Customer::find()
                                    + +
                                    + jsonSerialize() + +  : array<string|int, mixed> +
                                    +
                                    Serialize this object to an array
                                    + +
                                    + login() + +  : bool +
                                    +
                                    Test customer credentials
                                    + +
                                    + save() + +  : bool +
                                    +
                                    Save the customer on CRM.
                                    + +
                                    + toggleOptin() + +  : bool +
                                    +
                                    Toggle the account optin value in the crm
                                    + +
                                    + validateAllValues() + +  : array<string|int, mixed> +
                                    +
                                    Validate all model properties
                                    + +
                                    + store() + +  : bool +
                                    +
                                    Calls api store customer method
                                    + +
                                    + update() + +  : bool +
                                    +
                                    Calls api update customer method
                                    + +
                                    + + + + + + +
                                    +

                                    + Properties + +

                                    +
                                    +

                                    + $address + + + +

                                    + + + + + public + string + $address + + +

                                    The account address (street number, name, build, flat number)

                                    +
                                    + +
                                    + + + +
                                    +
                                    +

                                    + $address2 + + + +

                                    + + + + + public + string + $address2 + + +

                                    The account phone (address complement)

                                    +
                                    + +
                                    + + + +
                                    +
                                    +

                                    + $birth_date + + + +

                                    + + + + + public + string + $birth_date + + +

                                    The account birth date 'yyyy-mm-dd'

                                    +
                                    + +
                                    + + + +
                                    +
                                    +

                                    + $city + + + +

                                    + + + + + public + string + $city + + +

                                    The account city name

                                    +
                                    + +
                                    + + + +
                                    +
                                    +

                                    + $country + + + +

                                    + + + + + public + Country + $country + + +

                                    The account country residence

                                    +
                                    + +
                                    + + + +
                                    +
                                    +

                                    + $email + + + +

                                    + + + + + public + string + $email + + +

                                    Must be a rfc valid email on a valid domain name

                                    +
                                    + +
                                    + + + +
                                    +
                                    +

                                    + $firstname + + + +

                                    + + + + + public + string + $firstname + + +

                                    The account first name

                                    +
                                    + +
                                    + + + +
                                    +
                                    +

                                    + $hashcode + + + +

                                    + + + + + public + string + $hashcode + + +

                                    The crm hashcode this is a readonly field

                                    +
                                    + +
                                    + + + +
                                    +
                                    +

                                    + $last_connection + + + +

                                    + + + + + public + string + $last_connection + + +

                                    the last time user was connected 'yyyy-mm-dd HH:ii:ss'

                                    +
                                    + +
                                    + + + +
                                    +
                                    +

                                    + $lastname + + + +

                                    + + + + + public + string + $lastname + + +

                                    The account last name

                                    +
                                    + +
                                    + + + +
                                    +
                                    +

                                    + $opt_in + + + +

                                    + + + + + public + bool + $opt_in + + +

                                    true if the account is opt in

                                    +
                                    + +
                                    + + + +
                                    +
                                    +

                                    + $password + + + +

                                    + + + + + public + string + $password + + +

                                    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

                                    +
                                    + +
                                    + + + +
                                    +
                                    +

                                    + $phone + + + +

                                    + + + + + public + string + $phone + + +

                                    The account phone

                                    +
                                    + +
                                    + + + +
                                    +
                                    +

                                    + $postcode + + + +

                                    + + + + + public + string + $postcode + + +

                                    The account city postcode

                                    +
                                    + +
                                    + + + +
                                    +
                                    +

                                    + $status + + + +

                                    + + + + + public + bool + $status + + +

                                    true if the account is activated

                                    +
                                    + +
                                    + + + +
                                    +
                                    +

                                    + $invisibleFields + + + +

                                    + + +

                                    The crm customer fields +the should not be visible

                                    + + + protected + array<string|int, mixed> + $invisibleFields + = ['password'] + + + + + +
                                    +
                                    +

                                    + $modelFields + + + +

                                    + + +

                                    The crm customer fields

                                    + + + protected + array<string|int, mixed> + $modelFields + = ['hashcode', 'email', 'firstname', 'password', 'lastname', 'birth_date', 'phone', 'address', 'address2', 'city', 'postcode', 'country', 'opt_in', 'status', 'last_connection'] + + + + + +
                                    +
                                    +

                                    + $validation + + + +

                                    + + +

                                    Validation rules

                                    + + + protected + static array<string|int, mixed> + $validation + = ['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'] + + + + + +
                                    +
                                    +

                                    + $address + + + +

                                    + + +

                                    The user address (street number, name, etc)

                                    + + + private + string + $address + = null + +

                                    Validate: sometimes,string

                                    +

                                    Min length NA +Max length 255 +Field Type varchar

                                    +
                                    + + + + +
                                    +
                                    +

                                    + $address2 + + + +

                                    + + +

                                    The user address 2nd part (street number, name, more, etc)

                                    + + + private + string + $address2 + = null + +

                                    Validate: sometimes,string

                                    +

                                    Min length NA +Max length 255 +Field Type varchar

                                    +
                                    + + + + +
                                    +
                                    +

                                    + $birth_date + + + +

                                    + + +

                                    Birth date

                                    + + + private + string + $birth_date + = null + +

                                    Validate: date_format:Y-m-d

                                    +

                                    Required +Field Type Date

                                    +
                                    + + + + +
                                    +
                                    +

                                    + $city + + + +

                                    + + +

                                    The user address city

                                    + + + private + string + $city + = null + +

                                    Validate: sometimes,string

                                    +

                                    Min length NA +Max length 255 +Field Type varchar

                                    +
                                    + + + + +
                                    +
                                    +

                                    + $country + + + +

                                    + + +

                                    The user address postcode

                                    + + + private + Country + $country + = null + +

                                    Validate: sometimes, in Country::toValues()

                                    +

                                    Required +Field Type tinyInt

                                    +
                                    + + + + +
                                    +
                                    +

                                    + $email + + + +

                                    + + +

                                    An RFC Valid Email

                                    + + + private + string + $email + = null + +

                                    Validate: rfc,dns,spoof,filter

                                    +

                                    Required +Min length N/A +Max length 255 +Field Type varchar

                                    +
                                    + + + + +
                                    +
                                    +

                                    + $firstname + + + +

                                    + + +

                                    First name

                                    + + + private + string + $firstname + = null + +

                                    Required +Min length 2 +Max length 255 +Field Type varchar

                                    +
                                    + + + + +
                                    +
                                    +

                                    + $hashcode + + + +

                                    + + +

                                    The user hashcode, this is link with the customer and the brand it is related to +It is used to identify the customer itself.

                                    + + + private + string + $hashcode + + +

                                    Validate: UUID, in customer_infos

                                    +

                                    Required +Min length 36 +Max length 36 +Field Type varchar

                                    +
                                    + + + + +
                                    +
                                    +

                                    + $last_connection + + + +

                                    + + +

                                    The last time the account was connected

                                    + + + private + string + $last_connection + = null + +

                                    This field is read only

                                    +
                                    + + + + +
                                    +
                                    +

                                    + $lastname + + + +

                                    + + +

                                    Last name

                                    + + + private + string + $lastname + = null + +

                                    Required +Min length 2 +Max length 255 +Field Type varchar

                                    +
                                    + + + + +
                                    +
                                    +

                                    + $opt_in + + + +

                                    + + +

                                    The user optin choice

                                    + + + private + bool + $opt_in + = false + +

                                    Validate: boolean

                                    +

                                    Required +Field Type TinyInt

                                    +
                                    + + + + +
                                    +
                                    +

                                    + $password + + + +

                                    + + +

                                    The user password +This is set only when creating a user +Otherwise it has to be set to null

                                    + + + private + string + $password + = null + +

                                    Validate: case_diff,numbers,letters,symbols,min:8

                                    +

                                    Min length 8 +Max length 255 +Field Type varchar

                                    +
                                    + + + + +
                                    +
                                    +

                                    + $phone + + + +

                                    + + +

                                    The user phone

                                    + + + private + string + $phone + = null + +

                                    Validate: sometimes,string

                                    +

                                    Required +Min length NA +Max length 255 +Field Type varchar

                                    +
                                    + + + + +
                                    +
                                    +

                                    + $postcode + + + +

                                    + + +

                                    The user address postcode

                                    + + + private + string + $postcode + = null + +

                                    Validate: string

                                    +

                                    Required +Min length NA +Max length 255 +Field Type varchar

                                    +
                                    + + + + +
                                    +
                                    +

                                    + $status + + + +

                                    + + +

                                    Is the account activated ?

                                    + + + private + bool + $status + = false + +

                                    This field is read only

                                    +
                                    + + + + +
                                    +
                                    + +
                                    +

                                    + Methods + +

                                    +
                                    +

                                    + __construct() + +

                                    + + +

                                    Customer

                                    + + + public + __construct([array<string|int, mixed> $properties = [] ]) : mixed + + +
                                    Parameters
                                    +
                                    +
                                    + $properties + : array<string|int, mixed> + = []
                                    +
                                    + +
                                    +
                                    + + +
                                    + Tags + +
                                    +
                                    +
                                    + throws +
                                    +
                                    + ValidationException + +

                                    If a field could not be validated.

                                    +
                                    + +
                                    +
                                    + +
                                    Return values
                                    + mixed + — + + +
                                    +
                                    +

                                    + __get() + +

                                    + + +

                                    Generic accessor

                                    + + + public + __get(string $field) : mixed|null + + +
                                    Parameters
                                    +
                                    +
                                    + $field + : string +
                                    +
                                    + +
                                    +
                                    + + + +
                                    Return values
                                    + mixed|null + — +

                                    Returns null if the property was not found any way.

                                    +
                                    + + +
                                    +
                                    +

                                    + __set() + +

                                    + + +

                                    Set prop on the model.

                                    + + + public + __set(string $field, mixed $value) : void + + +
                                    Parameters
                                    +
                                    +
                                    + $field + : string +
                                    +
                                    + +
                                    +
                                    + $value + : mixed +
                                    +
                                    + +
                                    +
                                    + + +
                                    + Tags + +
                                    +
                                    +
                                    + throws +
                                    +
                                    + ValidationException + +

                                    If a field could not be validated.

                                    +
                                    + +
                                    +
                                    + throws +
                                    +
                                    + AccessError + +

                                    If trying to set a value on a unknown property.

                                    +
                                    + +
                                    +
                                    + +
                                    Return values
                                    + void + — + + +
                                    +
                                    +

                                    + activate() + +

                                    + + +

                                    Active the customer on CRM.

                                    + + + public + activate() : bool + + + + +
                                    + Tags + +
                                    +
                                    +
                                    + throws +
                                    +
                                    + ValidationException + +

                                    If a customer's hashcode could not be validated.

                                    +
                                    + +
                                    +
                                    + throws +
                                    +
                                    + CrmException + +

                                    If an error occurs on server side or on getting response.

                                    +
                                    + +
                                    +
                                    + throws +
                                    +
                                    + ApiErrorException + +

                                    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.

                                    +
                                    + +
                                    +
                                    + phpcs:ignore +
                                    +
                                    + +

                                    Squiz.Commenting.FunctionCommentThrowTag.WrongNumber

                                    +
                                    + +
                                    +
                                    + +
                                    Return values
                                    + bool + — +

                                    true if succeeded

                                    +
                                    + + +
                                    +
                                    +

                                    + delete() + +

                                    + + +

                                    Removes the customer from CRM.

                                    + + + public + delete() : bool + + + + +
                                    + Tags + +
                                    +
                                    +
                                    + throws +
                                    +
                                    + ValidationException + +

                                    If a field could not be validated.

                                    +
                                    + +
                                    +
                                    + throws +
                                    +
                                    + CrmException + +

                                    If an error occurs on server side or on getting response.

                                    +
                                    + +
                                    +
                                    + throws +
                                    +
                                    + ApiErrorException + +

                                    If any error or \LDC\LDCCRM\Enums\ApiError occurs. +Possibles are : - modelNotFound, If this customer hashcode could not be found.

                                    +
                                    + +
                                    +
                                    + phpcs:ignore +
                                    +
                                    + +

                                    Squiz.Commenting.FunctionCommentThrowTag.WrongNumber

                                    +
                                    + +
                                    +
                                    + +
                                    Return values
                                    + bool + — +

                                    true if succeeded

                                    +
                                    + + +
                                    +
                                    +

                                    + fill() + +

                                    + + +

                                    Fill values into model using validation rules.

                                    + + + public + fill(array<string|int, mixed> $properties) : void + + +
                                    Parameters
                                    +
                                    +
                                    + $properties + : array<string|int, mixed> +
                                    +
                                    + +
                                    +
                                    + + +
                                    + Tags + +
                                    +
                                    +
                                    + throws +
                                    +
                                    + ValidationException + +

                                    If a field could not be validated.

                                    +
                                    + +
                                    +
                                    + +
                                    Return values
                                    + void + — + + +
                                    +
                                    +

                                    + find() + +

                                    + + +

                                    Find a customer using its hashcode in the crm

                                    + + + public + static find(string $hashcode) : self|null + + +
                                    Parameters
                                    +
                                    +
                                    + $hashcode + : string +
                                    +
                                    + +
                                    +
                                    + + +
                                    + Tags + +
                                    +
                                    +
                                    + throws +
                                    +
                                    + CrmException + +

                                    If an error occurs on server side or on getting response.

                                    +
                                    + +
                                    +
                                    + throws +
                                    +
                                    + ApiErrorException + +

                                    If any error or \LDC\LDCCRM\Enums\ApiError occurs.

                                    +
                                    + +
                                    +
                                    + phpcs:ignore +
                                    +
                                    + +

                                    Squiz.Commenting.FunctionCommentThrowTag.WrongNumber

                                    +
                                    + +
                                    +
                                    + +
                                    Return values
                                    + self|null + — +

                                    Return null if the customer was not found

                                    +
                                    + + +
                                    +
                                    +

                                    + findWithEmail() + +

                                    + + +

                                    Find a customer using its email in the crm +This is an alias of Customer::find()

                                    + + + public + static findWithEmail(string $email) : self|null + + +
                                    Parameters
                                    +
                                    +
                                    + $email + : string +
                                    +
                                    + +
                                    +
                                    + + +
                                    + Tags + +
                                    +
                                    +
                                    + throws +
                                    +
                                    + CrmException + +

                                    If an error occurs on server side or on getting response.

                                    +
                                    + +
                                    +
                                    + throws +
                                    +
                                    + ApiErrorException + +

                                    If any error or \LDC\LDCCRM\Enums\ApiError occurs.

                                    +
                                    + +
                                    +
                                    + phpcs:ignore +
                                    +
                                    + +

                                    Squiz.Commenting.FunctionCommentThrowTag.WrongNumber

                                    +
                                    + +
                                    +
                                    + +
                                    Return values
                                    + self|null + — + + +
                                    +
                                    +

                                    + jsonSerialize() + +

                                    + + +

                                    Serialize this object to an array

                                    + + + public + jsonSerialize() : array<string|int, mixed> + + + + + +
                                    Return values
                                    + array<string|int, mixed> + — + + +
                                    +
                                    +

                                    + login() + +

                                    + + +

                                    Test customer credentials

                                    + + + public + static login(string $email, string $password) : bool + + +
                                    Parameters
                                    +
                                    +
                                    + $email + : string +
                                    +
                                    + +
                                    +
                                    + $password + : string +
                                    +
                                    + +
                                    +
                                    + + +
                                    + Tags + +
                                    +
                                    +
                                    + throws +
                                    +
                                    + ValidationException + +

                                    If a customer's email could not be validated.

                                    +
                                    + +
                                    +
                                    + throws +
                                    +
                                    + CrmException + +

                                    If an error occurs on server side or on getting response.

                                    +
                                    + +
                                    +
                                    + throws +
                                    +
                                    + ApiErrorException + +

                                    If any error or \LDC\LDCCRM\Enums\ApiError occurs. +Possibles are : - authFailed, If credentials are not valid. +- customerNotActivated, If the account is not activated.

                                    +
                                    + +
                                    +
                                    + phpcs:ignore +
                                    +
                                    + +

                                    Squiz.Commenting.FunctionCommentThrowTag.WrongNumber

                                    +
                                    + +
                                    +
                                    + +
                                    Return values
                                    + bool + — + + +
                                    +
                                    +

                                    + save() + +

                                    + + +

                                    Save the customer on CRM.

                                    + + + public + save() : bool + + + + +
                                    + Tags + +
                                    +
                                    +
                                    + throws +
                                    +
                                    + ValidationException + +

                                    If a field could not be validated.

                                    +
                                    + +
                                    +
                                    + throws +
                                    +
                                    + CrmException + +

                                    If an error occurs on server side or on getting response.

                                    +
                                    + +
                                    +
                                    + throws +
                                    +
                                    + ApiErrorException + +

                                    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).

                                    +
                                    + +
                                    +
                                    + phpcs:ignore +
                                    +
                                    + +

                                    Squiz.Commenting.FunctionCommentThrowTag.WrongNumber

                                    +
                                    + +
                                    +
                                    + +
                                    Return values
                                    + bool + — +

                                    True if save was successfull.

                                    +
                                    + + +
                                    +
                                    +

                                    + toggleOptin() + +

                                    + + +

                                    Toggle the account optin value in the crm

                                    + + + public + toggleOptin() : bool + + + + +
                                    + Tags + +
                                    +
                                    +
                                    + throws +
                                    +
                                    + ValidationException + +

                                    If a field could not be validated.

                                    +
                                    + +
                                    +
                                    + throws +
                                    +
                                    + CrmException + +

                                    If an error occurs on server side or on getting response.

                                    +
                                    + +
                                    +
                                    + throws +
                                    +
                                    + ApiErrorException + +

                                    If any error or \LDC\LDCCRM\Enums\ApiError occurs. +Possibles are : - modelNotFound, If this customer hashcode could not be found.

                                    +
                                    + +
                                    +
                                    + phpcs:ignore +
                                    +
                                    + +

                                    Squiz.Commenting.FunctionCommentThrowTag.WrongNumber

                                    +
                                    + +
                                    +
                                    + +
                                    Return values
                                    + bool + — +

                                    true if succeeded

                                    +
                                    + + +
                                    +
                                    +

                                    + validateAllValues() + +

                                    + + +

                                    Validate all model properties

                                    + + + protected + validateAllValues([array<string|int, mixed> $ignore = [] ]) : array<string|int, mixed> + + +
                                    Parameters
                                    +
                                    +
                                    + $ignore + : array<string|int, mixed> + = []
                                    +
                                    + +
                                    +
                                    + + +
                                    + Tags + +
                                    +
                                    +
                                    + throws +
                                    +
                                    + ValidationException + +

                                    If a field could not be validated.

                                    +
                                    + +
                                    +
                                    + +
                                    Return values
                                    + array<string|int, mixed> + — +

                                    the validated values

                                    +
                                    + + +
                                    +
                                    +

                                    + store() + +

                                    + + +

                                    Calls api store customer method

                                    + + + private + store() : bool + + + + +
                                    + Tags + +
                                    +
                                    +
                                    + throws +
                                    +
                                    + ValidationException + +

                                    If a field could not be validated.

                                    +
                                    + +
                                    +
                                    + throws +
                                    +
                                    + CrmException + +

                                    If an error occurs on server side or on getting response.

                                    +
                                    + +
                                    +
                                    + throws +
                                    +
                                    + ApiErrorException + +

                                    If any error or \LDC\LDCCRM\Enums\ApiError occurs. +Possibles are : - validationFailed, If provided data is wrong(CRM side).

                                    +
                                    + +
                                    +
                                    + phpcs:ignore +
                                    +
                                    + +

                                    Squiz.Commenting.FunctionCommentThrowTag.WrongNumber

                                    +
                                    + +
                                    +
                                    + +
                                    Return values
                                    + bool + — +

                                    True if save was successfull.

                                    +
                                    + + +
                                    +
                                    +

                                    + update() + +

                                    + + +

                                    Calls api update customer method

                                    + + + private + update() : bool + + + + +
                                    + Tags + +
                                    +
                                    +
                                    + throws +
                                    +
                                    + ValidationException + +

                                    If a field could not be validated.

                                    +
                                    + +
                                    +
                                    + throws +
                                    +
                                    + CrmException + +

                                    If an error occurs on server side or on getting response.

                                    +
                                    + +
                                    +
                                    + throws +
                                    +
                                    + ApiErrorException + +

                                    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.

                                    +
                                    + +
                                    +
                                    + phpcs:ignore +
                                    +
                                    + +

                                    Squiz.Commenting.FunctionCommentThrowTag.WrongNumber

                                    +
                                    + +
                                    +
                                    + +
                                    Return values
                                    + bool + — +

                                    True if save was successfull.

                                    +
                                    + + +
                                    +
                                    + + + + +
                                    +
                                    +
                                    +
                                    +

                                    Search results

                                    + +
                                    +
                                    +
                                      +
                                      +
                                      +
                                      +
                                      +
                                      + + +
                                      + + + + + + + + diff --git a/documentation/classes/LDC-LDCCRM-Models-Question.html b/documentation/classes/LDC-LDCCRM-Models-Question.html new file mode 100644 index 0000000..1c86565 --- /dev/null +++ b/documentation/classes/LDC-LDCCRM-Models-Question.html @@ -0,0 +1,1359 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                      +

                                      CRM V2

                                      + + + + + +
                                      + +
                                      +
                                      + + + + +
                                      + + +
                                      +

                                      + Question + + + extends CrmClientModel + + +
                                      + in package + +
                                      + + +

                                      + + + +

                                      This class represents a question +It has some static methods to retrieve questions and answers

                                      + + + +
                                      + Tags + +
                                      +
                                      +
                                      + category +
                                      +
                                      + +

                                      Api Models

                                      +
                                      + +
                                      +
                                      + subpackage +
                                      +
                                      + +

                                      models

                                      +
                                      + +
                                      +
                                      + author +
                                      +
                                      + +

                                      Jérémy Munsch jeremy.munsch@ldc.fr

                                      +
                                      + +
                                      +
                                      + + + + + + +

                                      + Table of Contents + +

                                      + +
                                      +
                                      + $answers + +  : array<string|int, Answer> +
                                      +
                                      + +
                                      + $id + +  : string +
                                      +
                                      + +
                                      + $question + +  : string +
                                      +
                                      + +
                                      + $type + +  : QuestionType +
                                      +
                                      + +
                                      + $modelFields + +  : array<string|int, mixed> +
                                      +
                                      The crm customer fields
                                      + +
                                      + $validation + +  : array<string|int, mixed> +
                                      +
                                      Validation rules
                                      + +
                                      + $answers + +  : array<string|int, mixed> +
                                      +
                                      The question answers
                                      + +
                                      + $id + +  : int +
                                      +
                                      The question id
                                      + +
                                      + $question + +  : string +
                                      +
                                      The actual question as a string
                                      + +
                                      + $type + +  : QuestionType +
                                      +
                                      The question type
                                      + +
                                      + __construct() + +  : mixed +
                                      +
                                      Question
                                      + +
                                      + __get() + +  : mixed +
                                      +
                                      General accessor
                                      + +
                                      + __set() + +  : void +
                                      +
                                      Set prop on the model.
                                      + +
                                      + all() + +  : array<string|int, mixed> +
                                      +
                                      Get all questions only
                                      + +
                                      + allWithCustomerAnswers() + +  : array<string|int, mixed> +
                                      +
                                      Get all the questions with customer answers
                                      + +
                                      + fill() + +  : void +
                                      +
                                      Fill values into model using validation rules.
                                      + +
                                      + jsonSerialize() + +  : array<string|int, mixed> +
                                      +
                                      Serialize this object to an array
                                      + +
                                      + unansweredBy() + +  : array<string|int, mixed> +
                                      +
                                      Get unanswered question for a specific customer
                                      + +
                                      + validateAllValues() + +  : array<string|int, mixed> +
                                      +
                                      Validate all model properties
                                      + +
                                      + + + + + + +
                                      +

                                      + Properties + +

                                      +
                                      +

                                      + $answers + + + +

                                      + + + + + public + array<string|int, Answer> + $answers + + +

                                      An array with answers

                                      +
                                      + +
                                      + + + +
                                      +
                                      +

                                      + $id + + + +

                                      + + + + + public + string + $id + + +

                                      The question id

                                      +
                                      + +
                                      + + + +
                                      +
                                      +

                                      + $question + + + +

                                      + + + + + public + string + $question + + +

                                      The actual question as a string

                                      +
                                      + +
                                      + + + +
                                      +
                                      +

                                      + $type + + + +

                                      + + + + + public + QuestionType + $type + + +

                                      The question type to display, +it also hints wether it can accept one or multiple responses, +so only checkbox allows multiple responses

                                      +
                                      + +
                                      + + + +
                                      +
                                      +

                                      + $modelFields + + + +

                                      + + +

                                      The crm customer fields

                                      + + + protected + array<string|int, mixed> + $modelFields + = ['id', 'question', 'type', 'answers'] + + + + + +
                                      +
                                      +

                                      + $validation + + + +

                                      + + +

                                      Validation rules

                                      + + + protected + static array<string|int, mixed> + $validation + = ['id' => 'required|int', 'question' => 'required|string|max:255', 'type' => ['required'], 'answers' => 'required|array'] + + + + + +
                                      +
                                      +

                                      + $answers + + + +

                                      + + +

                                      The question answers

                                      + + + private + array<string|int, mixed> + $answers + = [] + +

                                      \LDC\LDCCRM\Models\Answer

                                      +
                                      + + + + +
                                      +
                                      +

                                      + $id + + + +

                                      + + +

                                      The question id

                                      + + + private + int + $id + + +

                                      Required +Field Type bigInt

                                      +
                                      + + + + +
                                      +
                                      +

                                      + $question + + + +

                                      + + +

                                      The actual question as a string

                                      + + + private + string + $question + = null + +

                                      Required +Max length 255 +Field Type varchar

                                      +
                                      + + + + +
                                      +
                                      +

                                      + $type + + + +

                                      + + +

                                      The question type

                                      + + + private + QuestionType + $type + = null + +

                                      Validate: in QuestionType::toValues()

                                      +

                                      Required +Field Type tinyInteger

                                      +
                                      + + + + +
                                      +
                                      + +
                                      +

                                      + Methods + +

                                      +
                                      +

                                      + __construct() + +

                                      + + +

                                      Question

                                      + + + public + __construct([array<string|int, mixed> $properties = [] ]) : mixed + + +
                                      Parameters
                                      +
                                      +
                                      + $properties + : array<string|int, mixed> + = []
                                      +
                                      + +
                                      +
                                      + + +
                                      + Tags + +
                                      +
                                      +
                                      + throws +
                                      +
                                      + ValidationException + +

                                      If a field could not be validated.

                                      +
                                      + +
                                      +
                                      + +
                                      Return values
                                      + mixed + — + + +
                                      +
                                      +

                                      + __get() + +

                                      + + +

                                      General accessor

                                      + + + public + __get(string $field) : mixed + + +
                                      Parameters
                                      +
                                      +
                                      + $field + : string +
                                      +
                                      + +
                                      +
                                      + + + +
                                      Return values
                                      + mixed + — + + +
                                      +
                                      +

                                      + __set() + +

                                      + + +

                                      Set prop on the model.

                                      + + + public + __set(string $field, mixed $value) : void + + +
                                      Parameters
                                      +
                                      +
                                      + $field + : string +
                                      +
                                      + +
                                      +
                                      + $value + : mixed +
                                      +
                                      + +
                                      +
                                      + + +
                                      + Tags + +
                                      +
                                      +
                                      + throws +
                                      +
                                      + ValidationException + +

                                      If a field could not be validated.

                                      +
                                      + +
                                      +
                                      + throws +
                                      +
                                      + AccessError + +

                                      If trying to set a value on a unknown property.

                                      +
                                      + +
                                      +
                                      + +
                                      Return values
                                      + void + — + + +
                                      +
                                      +

                                      + all() + +

                                      + + +

                                      Get all questions only

                                      + + + public + static all() : array<string|int, mixed> + + + + +
                                      + Tags + +
                                      +
                                      +
                                      + throws +
                                      +
                                      + CrmException + +

                                      If an error occurs on server side or on getting response.

                                      +
                                      + +
                                      +
                                      + throws +
                                      +
                                      + ApiErrorException + +

                                      If any error or \LDC\LDCCRM\Enums\ApiError occurs.

                                      +
                                      + +
                                      +
                                      + phpcs:ignore +
                                      +
                                      + +

                                      Squiz.Commenting.FunctionCommentThrowTag.WrongNumber

                                      +
                                      + +
                                      +
                                      + +
                                      Return values
                                      + array<string|int, mixed> + — +

                                      of \LDC\LDCCRM\Models\Question

                                      +
                                      + + +
                                      +
                                      +

                                      + allWithCustomerAnswers() + +

                                      + + +

                                      Get all the questions with customer answers

                                      + + + public + static allWithCustomerAnswers(Customer $customer) : array<string|int, mixed> + + +
                                      Parameters
                                      +
                                      +
                                      + $customer + : Customer +
                                      +
                                      + +
                                      +
                                      + + +
                                      + Tags + +
                                      +
                                      +
                                      + throws +
                                      +
                                      + ValidationException + +

                                      If a customer's hashcode could not be validated.

                                      +
                                      + +
                                      +
                                      + throws +
                                      +
                                      + CrmException + +

                                      If an error occurs on server side or on getting response.

                                      +
                                      + +
                                      +
                                      + throws +
                                      +
                                      + ApiErrorException + +

                                      If any error or \LDC\LDCCRM\Enums\ApiError occurs. +Possibles are : - modelNotFound, If the customer could not be found(CRM side).

                                      +
                                      + +
                                      +
                                      + phpcs:ignore +
                                      +
                                      + +

                                      Squiz.Commenting.FunctionCommentThrowTag.WrongNumber

                                      +
                                      + +
                                      +
                                      + +
                                      Return values
                                      + array<string|int, mixed> + — +

                                      [ +0 => [ +'question' => \LDC\LDCCRM\Models\Question, +'customerAnswers' => \LDC\LDCCRM\Models\Answer[] +] +]

                                      +

                                      with \LDC\LDCCRM\Models\Question[] +and the customer \LDC\LDCCRM\Models\Answer[]

                                      +
                                      + + +
                                      +
                                      +

                                      + fill() + +

                                      + + +

                                      Fill values into model using validation rules.

                                      + + + public + fill(array<string|int, mixed> $properties) : void + + +
                                      Parameters
                                      +
                                      +
                                      + $properties + : array<string|int, mixed> +
                                      +
                                      + +
                                      +
                                      + + +
                                      + Tags + +
                                      +
                                      +
                                      + throws +
                                      +
                                      + ValidationException + +

                                      If a field could not be validated.

                                      +
                                      + +
                                      +
                                      + +
                                      Return values
                                      + void + — + + +
                                      +
                                      +

                                      + jsonSerialize() + +

                                      + + +

                                      Serialize this object to an array

                                      + + + public + jsonSerialize() : array<string|int, mixed> + + + + + +
                                      Return values
                                      + array<string|int, mixed> + — + + +
                                      +
                                      +

                                      + unansweredBy() + +

                                      + + +

                                      Get unanswered question for a specific customer

                                      + + + public + static unansweredBy(Customer $customer) : array<string|int, mixed> + + +
                                      Parameters
                                      +
                                      +
                                      + $customer + : Customer +
                                      +
                                      + +
                                      +
                                      + + +
                                      + Tags + +
                                      +
                                      +
                                      + throws +
                                      +
                                      + ValidationException + +

                                      If a customer's hashcode could not be validated.

                                      +
                                      + +
                                      +
                                      + throws +
                                      +
                                      + CrmException + +

                                      If an error occurs on server side or on getting response.

                                      +
                                      + +
                                      +
                                      + throws +
                                      +
                                      + ApiErrorException + +

                                      If any error or \LDC\LDCCRM\Enums\ApiError occurs. +Possibles are : - modelNotFound, If the customer could not be found(CRM side).

                                      +
                                      + +
                                      +
                                      + phpcs:ignore +
                                      +
                                      + +

                                      Squiz.Commenting.FunctionCommentThrowTag.WrongNumber

                                      +
                                      + +
                                      +
                                      + +
                                      Return values
                                      + array<string|int, mixed> + — +

                                      of \LDC\LDCCRM\Models\Question

                                      +
                                      + + +
                                      +
                                      +

                                      + validateAllValues() + +

                                      + + +

                                      Validate all model properties

                                      + + + protected + validateAllValues([array<string|int, mixed> $ignore = [] ]) : array<string|int, mixed> + + +
                                      Parameters
                                      +
                                      +
                                      + $ignore + : array<string|int, mixed> + = []
                                      +
                                      + +
                                      +
                                      + + +
                                      + Tags + +
                                      +
                                      +
                                      + throws +
                                      +
                                      + ValidationException + +

                                      If a field could not be validated.

                                      +
                                      + +
                                      +
                                      + +
                                      Return values
                                      + array<string|int, mixed> + — +

                                      the validated values

                                      +
                                      + + +
                                      +
                                      + + + + +
                                      +
                                      +
                                      +
                                      +

                                      Search results

                                      + +
                                      +
                                      +
                                        +
                                        +
                                        +
                                        +
                                        +
                                        + + +
                                        + + + + + + + + diff --git a/documentation/classes/LDC-LDCCRM-Models-SingleOptin.html b/documentation/classes/LDC-LDCCRM-Models-SingleOptin.html new file mode 100644 index 0000000..892e7b7 --- /dev/null +++ b/documentation/classes/LDC-LDCCRM-Models-SingleOptin.html @@ -0,0 +1,427 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                        +

                                        CRM V2

                                        + + + + + +
                                        + +
                                        +
                                        + + + + +
                                        + + +
                                        +

                                        + SingleOptin + + + extends CrmClientModel + + +
                                        + in package + +
                                        + + +

                                        + + + +

                                        This class allows to handle single opt in

                                        + + + +
                                        + Tags + +
                                        +
                                        +
                                        + category +
                                        +
                                        + +

                                        Api Models

                                        +
                                        + +
                                        +
                                        + subpackage +
                                        +
                                        + +

                                        models

                                        +
                                        + +
                                        +
                                        + author +
                                        +
                                        + +

                                        Jérémy Munsch jeremy.munsch@ldc.fr

                                        +
                                        + +
                                        +
                                        + + + + + + +

                                        + Table of Contents + +

                                        + +
                                        +
                                        + $validation + +  : array<string|int, mixed> +
                                        +
                                        Validation rules
                                        + +
                                        + setStatus() + +  : bool +
                                        +
                                        Set the single opt in status for an email
                                        + +
                                        + + + + + + +
                                        +

                                        + Properties + +

                                        +
                                        +

                                        + $validation + + + +

                                        + + +

                                        Validation rules

                                        + + + protected + static array<string|int, mixed> + $validation + = ['email' => 'required|email', 'opt_in' => 'required|bool'] + + + + + +
                                        +
                                        + +
                                        +

                                        + Methods + +

                                        +
                                        +

                                        + setStatus() + +

                                        + + +

                                        Set the single opt in status for an email

                                        + + + public + static setStatus(string $email, bool $opt_in) : bool + + +
                                        Parameters
                                        +
                                        +
                                        + $email + : string +
                                        +
                                        + +
                                        +
                                        + $opt_in + : bool +
                                        +
                                        + +
                                        +
                                        + + +
                                        + Tags + +
                                        +
                                        +
                                        + throws +
                                        +
                                        + ValidationException + +

                                        If a field email could not be validated.

                                        +
                                        + +
                                        +
                                        + throws +
                                        +
                                        + CrmException + +

                                        If an error occurs on server side or on getting response.

                                        +
                                        + +
                                        +
                                        + throws +
                                        +
                                        + ApiErrorException + +

                                        If any error or \LDC\LDCCRM\Enums\ApiError occurs. +Possibles are : - singleOptinCustomerExists, If a customer exists with this email.

                                        +
                                        + +
                                        +
                                        + phpcs:ignore +
                                        +
                                        + +

                                        Squiz.Commenting.FunctionCommentThrowTag.WrongNumber

                                        +
                                        + +
                                        +
                                        + +
                                        Return values
                                        + bool + — +

                                        true if succeeded

                                        +
                                        + + +
                                        +
                                        + + + + +
                                        +
                                        +
                                        +
                                        +

                                        Search results

                                        + +
                                        +
                                        +
                                          +
                                          +
                                          +
                                          +
                                          +
                                          + + +
                                          + + + + + + + + diff --git a/documentation/classes/LDC-LDCCRM-Models-Stats.html b/documentation/classes/LDC-LDCCRM-Models-Stats.html new file mode 100644 index 0000000..53f0e3a --- /dev/null +++ b/documentation/classes/LDC-LDCCRM-Models-Stats.html @@ -0,0 +1,599 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                          +

                                          CRM V2

                                          + + + + + +
                                          + +
                                          +
                                          + + + + +
                                          + + +
                                          +

                                          + Stats + + + extends CrmClientModel + + +
                                          + in package + +
                                          + + +

                                          + + + +

                                          This class is used to get stats from CRM

                                          + + + +
                                          + Tags + +
                                          +
                                          +
                                          + throws +
                                          +
                                          + ApiErrorException + +

                                          If an error occurs

                                          +
                                          + +
                                          +
                                          + throws +
                                          +
                                          + CrmException + +

                                          If the CRM encounters an error

                                          +
                                          + +
                                          +
                                          + category +
                                          +
                                          + +

                                          Api Models

                                          +
                                          + +
                                          +
                                          + subpackage +
                                          +
                                          + +

                                          models

                                          +
                                          + +
                                          +
                                          + author +
                                          +
                                          + +

                                          Jérémy Munsch jeremy.munsch@ldc.fr

                                          +
                                          + +
                                          +
                                          + + + + + + +

                                          + Table of Contents + +

                                          + +
                                          +
                                          + $validation + +  : array<string|int, mixed> +
                                          +
                                          Validation rules
                                          + +
                                          + getBrandStats() + +  : array<string|int, mixed> +
                                          +
                                          Get brand stats ordered by ascendent days
                                          + +
                                          + getQuestionStats() + +  : array<string|int, mixed> +
                                          +
                                          Get brand stats ordered by ascendent days
                                          + +
                                          + + + + + + +
                                          +

                                          + Properties + +

                                          +
                                          +

                                          + $validation + + + +

                                          + + +

                                          Validation rules

                                          + + + protected + static array<string|int, mixed> + $validation + = ['question.id' => 'required|int|min:1', 'start' => 'required|date_format:Y-m-d', 'end' => 'required|date_format:Y-m-d'] + + + + + +
                                          +
                                          + +
                                          +

                                          + Methods + +

                                          +
                                          +

                                          + getBrandStats() + +

                                          + + +

                                          Get brand stats ordered by ascendent days

                                          + + + public + static getBrandStats(string $start, string $end) : array<string|int, mixed> + + +
                                          Parameters
                                          +
                                          +
                                          + $start + : string +
                                          +
                                          +

                                          Une date valide au format Y-m-d .

                                          +
                                          + +
                                          +
                                          + $end + : string +
                                          +
                                          +

                                          Une date valide au format Y-m-d .

                                          +
                                          + +
                                          +
                                          + + +
                                          + Tags + +
                                          +
                                          +
                                          + throws +
                                          +
                                          + ValidationException + +

                                          If a field start could not be validated.

                                          +
                                          + +
                                          +
                                          + throws +
                                          +
                                          + ValidationException + +

                                          If a field end could not be validated.

                                          +
                                          + +
                                          +
                                          + throws +
                                          +
                                          + CrmException + +

                                          If an error occurs on server side or on getting response.

                                          +
                                          + +
                                          +
                                          + throws +
                                          +
                                          + ApiErrorException + +

                                          If any error or \LDC\LDCCRM\Enums\ApiError occurs. +Possibles are : - validationFailed, If provided data is wrong(CRM side).

                                          +
                                          + +
                                          +
                                          + phpcs:ignore +
                                          +
                                          + +

                                          Squiz.Commenting.FunctionCommentThrowTag.WrongNumber

                                          +
                                          + +
                                          +
                                          + +
                                          Return values
                                          + array<string|int, mixed> + — +

                                          The stats array by day

                                          +
                                          + + +
                                          +
                                          +

                                          + getQuestionStats() + +

                                          + + +

                                          Get brand stats ordered by ascendent days

                                          + + + public + static getQuestionStats(Question $question, string $start, string $end) : array<string|int, mixed> + + +
                                          Parameters
                                          +
                                          +
                                          + $question + : Question +
                                          +
                                          +

                                          Une question CRM possèdant un id réel.

                                          +
                                          + +
                                          +
                                          + $start + : string +
                                          +
                                          +

                                          Une date valide au format Y-m-d .

                                          +
                                          + +
                                          +
                                          + $end + : string +
                                          +
                                          +

                                          Une date valide au format Y-m-d .

                                          +
                                          + +
                                          +
                                          + + +
                                          + Tags + +
                                          +
                                          +
                                          + throws +
                                          +
                                          + ValidationException + +

                                          If a question's id could not be validated.

                                          +
                                          + +
                                          +
                                          + throws +
                                          +
                                          + ValidationException + +

                                          If a field start could not be validated.

                                          +
                                          + +
                                          +
                                          + throws +
                                          +
                                          + ValidationException + +

                                          If a field end could not be validated.

                                          +
                                          + +
                                          +
                                          + throws +
                                          +
                                          + CrmException + +

                                          If an error occurs on server side or on getting response.

                                          +
                                          + +
                                          +
                                          + throws +
                                          +
                                          + ApiErrorException + +

                                          If any error or \LDC\LDCCRM\Enums\ApiError occurs. +Possibles are : - validationFailed, If provided data is wrong(CRM side).

                                          +
                                          + +
                                          +
                                          + phpcs:ignore +
                                          +
                                          + +

                                          Squiz.Commenting.FunctionCommentThrowTag.WrongNumber

                                          +
                                          + +
                                          +
                                          + +
                                          Return values
                                          + array<string|int, mixed> + — +

                                          The stats array by day

                                          +
                                          + + +
                                          +
                                          + + + + +
                                          +
                                          +
                                          +
                                          +

                                          Search results

                                          + +
                                          +
                                          +
                                            +
                                            +
                                            +
                                            +
                                            +
                                            + + +
                                            + + + + + + + + diff --git a/documentation/classes/LDC-LDCCRM-Transport-Request.html b/documentation/classes/LDC-LDCCRM-Transport-Request.html new file mode 100644 index 0000000..2bf4142 --- /dev/null +++ b/documentation/classes/LDC-LDCCRM-Transport-Request.html @@ -0,0 +1,1063 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                            +

                                            CRM V2

                                            + + + + + +
                                            + +
                                            +
                                            + + + + +
                                            + + +
                                            +

                                            + Request + + +
                                            + in package + +
                                            + + +

                                            + + + +

                                            The LDC CRM request +Contains the http method, the requested url and data to pass

                                            + + + +
                                            + Tags + +
                                            +
                                            +
                                            + subpackage +
                                            +
                                            + +

                                            transport

                                            +
                                            + +
                                            +
                                            + + + + + + +

                                            + Table of Contents + +

                                            + +
                                            +
                                            + $data + +  : array<string|int, mixed> +
                                            +
                                            + +
                                            + $headers + +  : array<string|int, mixed> +
                                            +
                                            + +
                                            + $method + +  : HttpMethods +
                                            +
                                            + +
                                            + $uri + +  : string +
                                            +
                                            + +
                                            + $data + +  : array<string|int, mixed> +
                                            +
                                            Data to pass to the http body
                                            + +
                                            + $headers + +  : array<string|int, mixed> +
                                            +
                                            Data to pass to the http headers
                                            + +
                                            + $method + +  : HttpMethods +
                                            +
                                            The http method
                                            + +
                                            + $uri + +  : string +
                                            +
                                            The http url
                                            + +
                                            + $client + +  : Client +
                                            +
                                            GuzzleHttp client
                                            + +
                                            + $endpoint + +  : string +
                                            +
                                            The Api endpoint
                                            + +
                                            + $request + +  : callable +
                                            +
                                            Guzzle request
                                            + +
                                            + __construct() + +  : mixed +
                                            +
                                            Request
                                            + +
                                            + __get() + +  : mixed|null +
                                            +
                                            Generic accessor
                                            + +
                                            + addData() + +  : void +
                                            +
                                            Add data to the request
                                            + +
                                            + addHeaders() + +  : void +
                                            +
                                            Add headers to the request
                                            + +
                                            + call() + +  : ResponseInterface +
                                            +
                                            Make the Http request
                                            + +
                                            + setEndpoint() + +  : void +
                                            +
                                            Set the api endpoint to the request
                                            + +
                                            + makeRequest() + +  : void +
                                            +
                                            make the guzzle request
                                            + +
                                            + + + + + + +
                                            +

                                            + Properties + +

                                            +
                                            +

                                            + $data + + + +

                                            + + + + + public + array<string|int, mixed> + $data + + +

                                            readonly data

                                            +
                                            + +
                                            + + + +
                                            +
                                            +

                                            + $headers + + + +

                                            + + + + + public + array<string|int, mixed> + $headers + + +

                                            headers

                                            +
                                            + +
                                            + + + +
                                            +
                                            +

                                            + $method + + + +

                                            + + + + + public + HttpMethods + $method + + +

                                            readonly method

                                            +
                                            + +
                                            + + + +
                                            +
                                            +

                                            + $uri + + + +

                                            + + + + + public + string + $uri + + +

                                            readonly uri

                                            +
                                            + +
                                            + + + +
                                            +
                                            +

                                            + $data + + + +

                                            + + +

                                            Data to pass to the http body

                                            + + + protected + array<string|int, mixed> + $data + = [] + + + + + +
                                            +
                                            +

                                            + $headers + + + +

                                            + + +

                                            Data to pass to the http headers

                                            + + + protected + array<string|int, mixed> + $headers + = [] + + + + + +
                                            +
                                            +

                                            + $method + + + +

                                            + + +

                                            The http method

                                            + + + protected + HttpMethods + $method + + + + + + +
                                            +
                                            +

                                            + $uri + + + +

                                            + + +

                                            The http url

                                            + + + protected + string + $uri + + + + + + +
                                            +
                                            +

                                            + $client + + + +

                                            + + +

                                            GuzzleHttp client

                                            + + + private + Client + $client + + + + + + +
                                            +
                                            +

                                            + $endpoint + + + +

                                            + + +

                                            The Api endpoint

                                            + + + private + string + $endpoint + + + + + + +
                                            +
                                            +

                                            + $request + + + +

                                            + + +

                                            Guzzle request

                                            + + + private + callable + $request + + + +

                                            the returns \GuzzleHttp\Psr7\Request

                                            +
                                            + + + +
                                            +
                                            + +
                                            +

                                            + Methods + +

                                            +
                                            +

                                            + __construct() + +

                                            + + +

                                            Request

                                            + + + public + __construct(HttpMethods $method, string $uri[, array<string|int, mixed> $headers = [] ][, array<string|int, mixed> $data = [] ]) : mixed + + +
                                            Parameters
                                            +
                                            +
                                            + $method + : HttpMethods +
                                            +
                                            + +
                                            +
                                            + $uri + : string +
                                            +
                                            + +
                                            +
                                            + $headers + : array<string|int, mixed> + = []
                                            +
                                            + +
                                            +
                                            + $data + : array<string|int, mixed> + = []
                                            +
                                            + +
                                            +
                                            + + + +
                                            Return values
                                            + mixed + — + + +
                                            +
                                            +

                                            + __get() + +

                                            + + +

                                            Generic accessor

                                            + + + public + __get(string $field) : mixed|null + + +
                                            Parameters
                                            +
                                            +
                                            + $field + : string +
                                            +
                                            + +
                                            +
                                            + + + +
                                            Return values
                                            + mixed|null + — + + +
                                            +
                                            +

                                            + addData() + +

                                            + + +

                                            Add data to the request

                                            + + + public + addData(array<string|int, mixed> $data) : void + + +
                                            Parameters
                                            +
                                            +
                                            + $data + : array<string|int, mixed> +
                                            +
                                            + +
                                            +
                                            + + + +
                                            Return values
                                            + void + — + + +
                                            +
                                            +

                                            + addHeaders() + +

                                            + + +

                                            Add headers to the request

                                            + + + public + addHeaders(array<string|int, mixed> $headers) : void + + +
                                            Parameters
                                            +
                                            +
                                            + $headers + : array<string|int, mixed> +
                                            +
                                            + +
                                            +
                                            + + + +
                                            Return values
                                            + void + — + + +
                                            +
                                            +

                                            + call() + +

                                            + + +

                                            Make the Http request

                                            + + + public + call() : ResponseInterface + + + + + +
                                            Return values
                                            + ResponseInterface + — + + +
                                            +
                                            +

                                            + setEndpoint() + +

                                            + + +

                                            Set the api endpoint to the request

                                            + + + public + setEndpoint(string $endpoint) : void + + +
                                            Parameters
                                            +
                                            +
                                            + $endpoint + : string +
                                            +
                                            + +
                                            +
                                            + + + +
                                            Return values
                                            + void + — + + +
                                            +
                                            +

                                            + makeRequest() + +

                                            + + +

                                            make the guzzle request

                                            + + + private + makeRequest() : void + + + + + +
                                            Return values
                                            + void + — + + +
                                            +
                                            + + + + +
                                            +
                                            +
                                            +
                                            +

                                            Search results

                                            + +
                                            +
                                            +
                                              +
                                              +
                                              +
                                              +
                                              +
                                              + + +
                                              + + + + + + + + diff --git a/documentation/classes/LDC-LDCCRM-Transport-Response.html b/documentation/classes/LDC-LDCCRM-Transport-Response.html new file mode 100644 index 0000000..dbb2228 --- /dev/null +++ b/documentation/classes/LDC-LDCCRM-Transport-Response.html @@ -0,0 +1,1083 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                              +

                                              CRM V2

                                              + + + + + +
                                              + +
                                              +
                                              + + + + +
                                              + + +
                                              +

                                              + Response + + +
                                              + in package + +
                                              + + +

                                              + + + + + + +
                                              + Tags + +
                                              +
                                              +
                                              + subpackage +
                                              +
                                              + +

                                              transport

                                              +
                                              + +
                                              +
                                              + + + + + + +

                                              + Table of Contents + +

                                              + +
                                              +
                                              + $apiError + +  : ApiError|int +
                                              +
                                              + +
                                              + $body + +  : array<string|int, mixed> +
                                              +
                                              + +
                                              + $data + +  : array<string|int, mixed>|null +
                                              +
                                              + +
                                              + $headers + +  : array<string|int, mixed> +
                                              +
                                              + +
                                              + $httpCode + +  : int +
                                              +
                                              + +
                                              + $message + +  : string +
                                              +
                                              + +
                                              + $status + +  : ApiStatus +
                                              +
                                              + +
                                              + $apiError + +  : ApiError +
                                              +
                                              The api error
                                              + +
                                              + $body + +  : string +
                                              +
                                              The response body
                                              + +
                                              + $headers + +  : string +
                                              +
                                              The response headers
                                              + +
                                              + $httpCode + +  : int +
                                              +
                                              The response http code
                                              + +
                                              + $message + +  : string +
                                              +
                                              The interface message
                                              + +
                                              + $response + +  : ResponseInterface +
                                              +
                                              PSR response
                                              + +
                                              + $status + +  : ApiStatus +
                                              +
                                              The response status
                                              + +
                                              + __construct() + +  : mixed +
                                              +
                                              Response
                                              + +
                                              + __get() + +  : mixed|null +
                                              +
                                              Generic accessor
                                              + +
                                              + checkVersion() + +  : void +
                                              +
                                              This checks if the crm version is way far beyond the client version.
                                              + +
                                              + tryDecodeJson() + +  : array<string|int, mixed>|false +
                                              +
                                              Try to decode json and return false if it is +not a valid json
                                              + +
                                              + + + + + + +
                                              +

                                              + Properties + +

                                              +
                                              +

                                              + $apiError + + + +

                                              + + + + + public + ApiError|int + $apiError + + +

                                              The api error status it there is any

                                              +
                                              + +
                                              + + + +
                                              +
                                              +

                                              + $body + + + +

                                              + + + + + public + array<string|int, mixed> + $body + + +

                                              The http response body, this is parsed json

                                              +
                                              + +
                                              + + + +
                                              +
                                              +

                                              + $data + + + +

                                              + + + + + public + array<string|int, mixed>|null + $data + + +

                                              The reponse data

                                              +
                                              + +
                                              + + + +
                                              +
                                              +

                                              + $headers + + + +

                                              + + + + + public + array<string|int, mixed> + $headers + + +

                                              The http reponse headers

                                              +
                                              + +
                                              + + + +
                                              +
                                              +

                                              + $httpCode + + + +

                                              + + + + + public + int + $httpCode + + +

                                              The http response code

                                              +
                                              + +
                                              + + + +
                                              +
                                              +

                                              + $message + + + +

                                              + + + + + public + string + $message + + +

                                              The api message

                                              +
                                              + +
                                              + + + +
                                              +
                                              +

                                              + $status + + + +

                                              + + + + + public + ApiStatus + $status + + +

                                              The response api status

                                              +
                                              + +
                                              + + + +
                                              +
                                              +

                                              + $apiError + + + +

                                              + + +

                                              The api error

                                              + + + private + ApiError + $apiError + + + + + + +
                                              +
                                              +

                                              + $body + + + +

                                              + + +

                                              The response body

                                              + + + private + string + $body + + + + + + +
                                              +
                                              +

                                              + $headers + + + +

                                              + + +

                                              The response headers

                                              + + + private + string + $headers + + + + + + +
                                              +
                                              +

                                              + $httpCode + + + +

                                              + + +

                                              The response http code

                                              + + + private + int + $httpCode + = 0 + + + + + +
                                              +
                                              +

                                              + $message + + + +

                                              + + +

                                              The interface message

                                              + + + private + string + $message + + + + + + +
                                              +
                                              +

                                              + $response + + + +

                                              + + +

                                              PSR response

                                              + + + private + ResponseInterface + $response + + + + + + +
                                              +
                                              +

                                              + $status + + + +

                                              + + +

                                              The response status

                                              + + + private + ApiStatus + $status + + + + + + +
                                              +
                                              + +
                                              +

                                              + Methods + +

                                              +
                                              +

                                              + __construct() + +

                                              + + +

                                              Response

                                              + + + public + __construct(ApiStatus $status, ResponseInterface $response) : mixed + + +
                                              Parameters
                                              +
                                              +
                                              + $status + : ApiStatus +
                                              +
                                              + +
                                              +
                                              + $response + : ResponseInterface +
                                              +
                                              + +
                                              +
                                              + + +
                                              + Tags + +
                                              +
                                              +
                                              + throws +
                                              +
                                              + CrmException + +

                                              If HTTP response body in not JSON.

                                              +
                                              + +
                                              +
                                              + +
                                              Return values
                                              + mixed + — + + +
                                              +
                                              +

                                              + __get() + +

                                              + + +

                                              Generic accessor

                                              + + + public + __get(string $field) : mixed|null + + +
                                              Parameters
                                              +
                                              +
                                              + $field + : string +
                                              +
                                              + +
                                              +
                                              + + + +
                                              Return values
                                              + mixed|null + — + + +
                                              +
                                              +

                                              + checkVersion() + +

                                              + + +

                                              This checks if the crm version is way far beyond the client version.

                                              + + + private + checkVersion(string $version) : void + +

                                              If a minor version mismatch is detected we will log this as a warning. +If a major version mismatch is detected we will throw a CrmException as +there shall be an incompatibility with the response.

                                              +

                                              The goal here is to force clients to be up to date. +A major version change means breaking change.

                                              +
                                              + +
                                              Parameters
                                              +
                                              +
                                              + $version + : string +
                                              +
                                              + +
                                              +
                                              + + +
                                              + Tags + +
                                              +
                                              +
                                              + throws +
                                              +
                                              + CrmException + +

                                              If a major version mismatch is detected.

                                              +
                                              + +
                                              +
                                              + +
                                              Return values
                                              + void + — + + +
                                              +
                                              +

                                              + tryDecodeJson() + +

                                              + + +

                                              Try to decode json and return false if it is +not a valid json

                                              + + + private + tryDecodeJson(string $string) : array<string|int, mixed>|false + + +
                                              Parameters
                                              +
                                              +
                                              + $string + : string +
                                              +
                                              + +
                                              +
                                              + + + +
                                              Return values
                                              + array<string|int, mixed>|false + — +

                                              Returns an associative data array or false if failed to parse.

                                              +
                                              + + +
                                              +
                                              + + + + +
                                              +
                                              +
                                              +
                                              +

                                              Search results

                                              + +
                                              +
                                              +
                                                +
                                                +
                                                +
                                                +
                                                +
                                                + + +
                                                + + + + + + + + diff --git a/documentation/classes/LDC-LDCCRM-Utils.html b/documentation/classes/LDC-LDCCRM-Utils.html new file mode 100644 index 0000000..c710c60 --- /dev/null +++ b/documentation/classes/LDC-LDCCRM-Utils.html @@ -0,0 +1,1983 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                +

                                                CRM V2

                                                + + + + + +
                                                + +
                                                +
                                                + + + + +
                                                + + +
                                                +

                                                + Utils + + +
                                                + in package + +
                                                + + +

                                                + + + +

                                                This is the LDCCRM utility class

                                                + + + +
                                                + Tags + +
                                                +
                                                +
                                                + category +
                                                +
                                                + +

                                                Utility

                                                +
                                                + +
                                                +
                                                + uses +
                                                +
                                                + HttpMethods + + +
                                                +
                                                + uses +
                                                +
                                                + Request + + +
                                                +
                                                + subpackage +
                                                +
                                                + +

                                                utilities

                                                +
                                                + +
                                                +
                                                + + + + + + +

                                                + Table of Contents + +

                                                + +
                                                +
                                                + $packageInfos + +  : array<string|int, mixed> +
                                                +
                                                Package infos
                                                + +
                                                + $translations + +  : array<string|int, mixed> +
                                                +
                                                Loaded translations
                                                + +
                                                + getConfig() + +  : string|null +
                                                +
                                                This is only used for unit tests.
                                                + +
                                                + getPackageInfo() + +  : array<string|int, mixed> +
                                                +
                                                Get composer.json infos
                                                + +
                                                + getRawProperty() + +  : mixed|null +
                                                +
                                                Get a property of an object.
                                                + +
                                                + getResquest() + +  : Request +
                                                +
                                                Generate a Request from the route name
                                                + +
                                                + log() + +  : void +
                                                +
                                                Write log using syslog +It also write log using \Illuminate\Support\Facades\Log +if it is present
                                                + +
                                                + makeValidator() + +  : closure +
                                                +
                                                Create a new Validator instance.
                                                + +
                                                + setRawProperty() + +  : void +
                                                +
                                                Set a property without any validation.
                                                + +
                                                + translate() + +  : string +
                                                +
                                                Translation a string using php file lang
                                                + +
                                                + makeValidatorFromRule() + +  : array<string|int, mixed> +
                                                +
                                                Generate a validator
                                                + +
                                                + validationArray() + +  : array<string|int, mixed> +
                                                +
                                                Make Array validator
                                                + +
                                                + validationBool() + +  : array<string|int, mixed> +
                                                +
                                                Make Bool validator
                                                + +
                                                + validationClosure() + +  : array<string|int, mixed> +
                                                +
                                                Make Closure validator
                                                + +
                                                + validationContainDigit() + +  : array<string|int, mixed> +
                                                +
                                                Make ContainDigit validator
                                                + +
                                                + validationContainSymbol() + +  : array<string|int, mixed> +
                                                +
                                                Make ContainSymbol validator
                                                + +
                                                + validationDate() + +  : array<string|int, mixed> +
                                                +
                                                Make Date validator
                                                + +
                                                + validationDateFormat() + +  : array<string|int, mixed> +
                                                +
                                                Make DateFormat validator
                                                + +
                                                + validationEmail() + +  : array<string|int, mixed> +
                                                +
                                                Make Email validator
                                                + +
                                                + validationInt() + +  : array<string|int, mixed> +
                                                +
                                                Make Int validator
                                                + +
                                                + validationMax() + +  : array<string|int, mixed> +
                                                +
                                                Make Max validator
                                                + +
                                                + validationMin() + +  : array<string|int, mixed> +
                                                +
                                                Make Min validator
                                                + +
                                                + validationMixedCase() + +  : array<string|int, mixed> +
                                                +
                                                Make MixedCase validator
                                                + +
                                                + validationNullable() + +  : array<string|int, mixed> +
                                                +
                                                Make Nullable validator
                                                + +
                                                + validationRequired() + +  : array<string|int, mixed> +
                                                +
                                                Make Required validator
                                                + +
                                                + validationSometimes() + +  : array<string|int, mixed> +
                                                +
                                                Make Sometimes validator
                                                + +
                                                + validationString() + +  : array<string|int, mixed> +
                                                +
                                                Make String validator
                                                + +
                                                + validationUuid() + +  : array<string|int, mixed> +
                                                +
                                                Make Uuid validator
                                                + +
                                                + + + + + + +
                                                +

                                                + Properties + +

                                                +
                                                +

                                                + $packageInfos + + + +

                                                + + +

                                                Package infos

                                                + + + private + static array<string|int, mixed> + $packageInfos + + + + + + +
                                                +
                                                +

                                                + $translations + + + +

                                                + + +

                                                Loaded translations

                                                + + + private + static array<string|int, mixed> + $translations + = [] + + + + + +
                                                +
                                                + +
                                                +

                                                + Methods + +

                                                +
                                                +

                                                + getConfig() + +

                                                + + +

                                                This is only used for unit tests.

                                                + + + public + static getConfig(string $key[, string $default = null ]) : string|null + +

                                                Get config

                                                +
                                                + +
                                                Parameters
                                                +
                                                +
                                                + $key + : string +
                                                +
                                                + +
                                                +
                                                + $default + : string + = null
                                                +
                                                + +
                                                +
                                                + + + +
                                                Return values
                                                + string|null + — + + +
                                                +
                                                +

                                                + getPackageInfo() + +

                                                + + +

                                                Get composer.json infos

                                                + + + public + static getPackageInfo() : array<string|int, mixed> + + + + + +
                                                Return values
                                                + array<string|int, mixed> + — + + +
                                                +
                                                +

                                                + getRawProperty() + +

                                                + + +

                                                Get a property of an object.

                                                + + + public + static getRawProperty(object $object, string $property) : mixed|null + +

                                                ! Warning : this will return any property of the object, use with caution.

                                                +
                                                + +
                                                Parameters
                                                +
                                                +
                                                + $object + : object +
                                                +
                                                +

                                                The object to inspect.

                                                +
                                                + +
                                                +
                                                + $property + : string +
                                                +
                                                +

                                                The object property to inspect.

                                                +
                                                + +
                                                +
                                                + + + +
                                                Return values
                                                + mixed|null + — +

                                                Returns null if the property was not found any way.

                                                +
                                                + + +
                                                +
                                                +

                                                + getResquest() + +

                                                + + +

                                                Generate a Request from the route name

                                                + + + public + static getResquest(string $routeName[, array<string|int, mixed> $query = [] ][, array<string|int, mixed> $data = [] ]) : Request + + +
                                                Parameters
                                                +
                                                +
                                                + $routeName + : string +
                                                +
                                                + +
                                                +
                                                + $query + : array<string|int, mixed> + = []
                                                +
                                                +

                                                Params to pass on to the route.

                                                +
                                                + +
                                                +
                                                + $data + : array<string|int, mixed> + = []
                                                +
                                                +

                                                Http body params.

                                                +
                                                + +
                                                +
                                                + + +
                                                + Tags + +
                                                +
                                                +
                                                + throws +
                                                +
                                                + ErrorException + +

                                                If the requested route is unknown.

                                                +
                                                + +
                                                +
                                                + throws +
                                                +
                                                + ErrorException + +

                                                If a required parameter is missing.

                                                +
                                                + +
                                                +
                                                + +
                                                Return values
                                                + Request + — + + +
                                                +
                                                +

                                                + log() + +

                                                + + +

                                                Write log using syslog +It also write log using \Illuminate\Support\Facades\Log +if it is present

                                                + + + public + static log(string $message, LogLevel $level) : void + + +
                                                Parameters
                                                +
                                                +
                                                + $message + : string +
                                                +
                                                +

                                                The message is prefixed with "LDC CRM:" .

                                                +
                                                + +
                                                +
                                                + $level + : LogLevel +
                                                +
                                                +

                                                The log level to apply.

                                                +
                                                + +
                                                +
                                                + + + +
                                                Return values
                                                + void + — + + +
                                                +
                                                +

                                                + makeValidator() + +

                                                + + +

                                                Create a new Validator instance.

                                                + + + public + static makeValidator(array<string|int, mixed> $data, array<string|int, mixed> $rules) : closure + + +
                                                Parameters
                                                +
                                                +
                                                + $data + : array<string|int, mixed> +
                                                +
                                                + +
                                                +
                                                + $rules + : array<string|int, mixed> +
                                                +
                                                + +
                                                +
                                                + + +
                                                + Tags + +
                                                +
                                                +
                                                + throws +
                                                +
                                                + ErrorException + +

                                                If an unknown validation rule is used.

                                                +
                                                + +
                                                +
                                                + +
                                                Return values
                                                + closure + — + + +
                                                +
                                                +

                                                + setRawProperty() + +

                                                + + +

                                                Set a property without any validation.

                                                + + + public + static setRawProperty(object $object, string $property, mixed $value) : void + +

                                                ! Warning : this can change any property of the object, use with caution.

                                                +
                                                + +
                                                Parameters
                                                +
                                                +
                                                + $object + : object +
                                                +
                                                +

                                                The object to inspect.

                                                +
                                                + +
                                                +
                                                + $property + : string +
                                                +
                                                +

                                                The object property to assign to.

                                                +
                                                + +
                                                +
                                                + $value + : mixed +
                                                +
                                                +

                                                The value to insert.

                                                +
                                                + +
                                                +
                                                + + +
                                                + Tags + +
                                                +
                                                +
                                                + throws +
                                                +
                                                + AccessError + +

                                                If trying to set a value on a unknown property.

                                                +
                                                + +
                                                +
                                                + +
                                                Return values
                                                + void + — + + +
                                                +
                                                +

                                                + translate() + +

                                                + + +

                                                Translation a string using php file lang

                                                + + + public + static translate(string $key[, string $lang = 'fr' ]) : string + + +
                                                Parameters
                                                +
                                                +
                                                + $key + : string +
                                                +
                                                + +
                                                +
                                                + $lang + : string + = 'fr'
                                                +
                                                + +
                                                +
                                                + + + +
                                                Return values
                                                + string + — + + +
                                                +
                                                +

                                                + makeValidatorFromRule() + +

                                                + + +

                                                Generate a validator

                                                + + + private + static makeValidatorFromRule(mixed $rule, array<string|int, mixed> $data, string $attribute) : array<string|int, mixed> + + +
                                                Parameters
                                                +
                                                +
                                                + $rule + : mixed +
                                                +
                                                + +
                                                +
                                                + $data + : array<string|int, mixed> +
                                                +
                                                + +
                                                +
                                                + $attribute + : string +
                                                +
                                                + +
                                                +
                                                + + +
                                                + Tags + +
                                                +
                                                +
                                                + throws +
                                                +
                                                + ErrorException + +

                                                If a rule is unknown.

                                                +
                                                + +
                                                +
                                                + +
                                                Return values
                                                + array<string|int, mixed> + — + + +
                                                +
                                                +

                                                + validationArray() + +

                                                + + +

                                                Make Array validator

                                                + + + private + static validationArray(string $attribute, mixed $value) : array<string|int, mixed> + + +
                                                Parameters
                                                +
                                                +
                                                + $attribute + : string +
                                                +
                                                + +
                                                +
                                                + $value + : mixed +
                                                +
                                                + +
                                                +
                                                + + + +
                                                Return values
                                                + array<string|int, mixed> + — + + +
                                                +
                                                +

                                                + validationBool() + +

                                                + + +

                                                Make Bool validator

                                                + + + private + static validationBool(string $attribute, mixed $value) : array<string|int, mixed> + + +
                                                Parameters
                                                +
                                                +
                                                + $attribute + : string +
                                                +
                                                + +
                                                +
                                                + $value + : mixed +
                                                +
                                                + +
                                                +
                                                + + + +
                                                Return values
                                                + array<string|int, mixed> + — + + +
                                                +
                                                +

                                                + validationClosure() + +

                                                + + +

                                                Make Closure validator

                                                + + + private + static validationClosure(string $attribute, mixed $value, Closure $closure) : array<string|int, mixed> + + +
                                                Parameters
                                                +
                                                +
                                                + $attribute + : string +
                                                +
                                                + +
                                                +
                                                + $value + : mixed +
                                                +
                                                + +
                                                +
                                                + $closure + : Closure +
                                                +
                                                + +
                                                +
                                                + + + +
                                                Return values
                                                + array<string|int, mixed> + — + + +
                                                +
                                                +

                                                + validationContainDigit() + +

                                                + + +

                                                Make ContainDigit validator

                                                + + + private + static validationContainDigit(string $attribute, mixed $value) : array<string|int, mixed> + + +
                                                Parameters
                                                +
                                                +
                                                + $attribute + : string +
                                                +
                                                + +
                                                +
                                                + $value + : mixed +
                                                +
                                                + +
                                                +
                                                + + + +
                                                Return values
                                                + array<string|int, mixed> + — + + +
                                                +
                                                +

                                                + validationContainSymbol() + +

                                                + + +

                                                Make ContainSymbol validator

                                                + + + private + static validationContainSymbol(string $attribute, mixed $value) : array<string|int, mixed> + + +
                                                Parameters
                                                +
                                                +
                                                + $attribute + : string +
                                                +
                                                + +
                                                +
                                                + $value + : mixed +
                                                +
                                                + +
                                                +
                                                + + + +
                                                Return values
                                                + array<string|int, mixed> + — + + +
                                                +
                                                +

                                                + validationDate() + +

                                                + + +

                                                Make Date validator

                                                + + + private + static validationDate(string $attribute, mixed $value) : array<string|int, mixed> + + +
                                                Parameters
                                                +
                                                +
                                                + $attribute + : string +
                                                +
                                                + +
                                                +
                                                + $value + : mixed +
                                                +
                                                + +
                                                +
                                                + + + +
                                                Return values
                                                + array<string|int, mixed> + — + + +
                                                +
                                                +

                                                + validationDateFormat() + +

                                                + + +

                                                Make DateFormat validator

                                                + + + private + static validationDateFormat(string $attribute, mixed $value, array<string|int, mixed> $params) : array<string|int, mixed> + + +
                                                Parameters
                                                +
                                                +
                                                + $attribute + : string +
                                                +
                                                + +
                                                +
                                                + $value + : mixed +
                                                +
                                                + +
                                                +
                                                + $params + : array<string|int, mixed> +
                                                +
                                                + +
                                                +
                                                + + + +
                                                Return values
                                                + array<string|int, mixed> + — + + +
                                                +
                                                +

                                                + validationEmail() + +

                                                + + +

                                                Make Email validator

                                                + + + private + static validationEmail(string $attribute, mixed $value) : array<string|int, mixed> + + +
                                                Parameters
                                                +
                                                +
                                                + $attribute + : string +
                                                +
                                                + +
                                                +
                                                + $value + : mixed +
                                                +
                                                + +
                                                +
                                                + + + +
                                                Return values
                                                + array<string|int, mixed> + — + + +
                                                +
                                                +

                                                + validationInt() + +

                                                + + +

                                                Make Int validator

                                                + + + private + static validationInt(string $attribute, mixed $value) : array<string|int, mixed> + + +
                                                Parameters
                                                +
                                                +
                                                + $attribute + : string +
                                                +
                                                + +
                                                +
                                                + $value + : mixed +
                                                +
                                                + +
                                                +
                                                + + + +
                                                Return values
                                                + array<string|int, mixed> + — + + +
                                                +
                                                +

                                                + validationMax() + +

                                                + + +

                                                Make Max validator

                                                + + + private + static validationMax(string $attribute, mixed $value, array<string|int, mixed> $params) : array<string|int, mixed> + + +
                                                Parameters
                                                +
                                                +
                                                + $attribute + : string +
                                                +
                                                + +
                                                +
                                                + $value + : mixed +
                                                +
                                                + +
                                                +
                                                + $params + : array<string|int, mixed> +
                                                +
                                                + +
                                                +
                                                + + + +
                                                Return values
                                                + array<string|int, mixed> + — + + +
                                                +
                                                +

                                                + validationMin() + +

                                                + + +

                                                Make Min validator

                                                + + + private + static validationMin(string $attribute, mixed $value, array<string|int, mixed> $params) : array<string|int, mixed> + + +
                                                Parameters
                                                +
                                                +
                                                + $attribute + : string +
                                                +
                                                + +
                                                +
                                                + $value + : mixed +
                                                +
                                                + +
                                                +
                                                + $params + : array<string|int, mixed> +
                                                +
                                                + +
                                                +
                                                + + + +
                                                Return values
                                                + array<string|int, mixed> + — + + +
                                                +
                                                +

                                                + validationMixedCase() + +

                                                + + +

                                                Make MixedCase validator

                                                + + + private + static validationMixedCase(string $attribute, mixed $value) : array<string|int, mixed> + + +
                                                Parameters
                                                +
                                                +
                                                + $attribute + : string +
                                                +
                                                + +
                                                +
                                                + $value + : mixed +
                                                +
                                                + +
                                                +
                                                + + + +
                                                Return values
                                                + array<string|int, mixed> + — + + +
                                                +
                                                +

                                                + validationNullable() + +

                                                + + +

                                                Make Nullable validator

                                                + + + private + static validationNullable(string $attribute, mixed $value) : array<string|int, mixed> + + +
                                                Parameters
                                                +
                                                +
                                                + $attribute + : string +
                                                +
                                                + +
                                                +
                                                + $value + : mixed +
                                                +
                                                + +
                                                +
                                                + + + +
                                                Return values
                                                + array<string|int, mixed> + — + + +
                                                +
                                                +

                                                + validationRequired() + +

                                                + + +

                                                Make Required validator

                                                + + + private + static validationRequired(string $attribute, array<string|int, mixed> $data) : array<string|int, mixed> + + +
                                                Parameters
                                                +
                                                +
                                                + $attribute + : string +
                                                +
                                                + +
                                                +
                                                + $data + : array<string|int, mixed> +
                                                +
                                                + +
                                                +
                                                + + + +
                                                Return values
                                                + array<string|int, mixed> + — + + +
                                                +
                                                +

                                                + validationSometimes() + +

                                                + + +

                                                Make Sometimes validator

                                                + + + private + static validationSometimes(string $attribute, mixed $data) : array<string|int, mixed> + + +
                                                Parameters
                                                +
                                                +
                                                + $attribute + : string +
                                                +
                                                + +
                                                +
                                                + $data + : mixed +
                                                +
                                                + +
                                                +
                                                + + + +
                                                Return values
                                                + array<string|int, mixed> + — + + +
                                                +
                                                +

                                                + validationString() + +

                                                + + +

                                                Make String validator

                                                + + + private + static validationString(string $attribute, mixed $value) : array<string|int, mixed> + + +
                                                Parameters
                                                +
                                                +
                                                + $attribute + : string +
                                                +
                                                + +
                                                +
                                                + $value + : mixed +
                                                +
                                                + +
                                                +
                                                + + + +
                                                Return values
                                                + array<string|int, mixed> + — + + +
                                                +
                                                +

                                                + validationUuid() + +

                                                + + +

                                                Make Uuid validator

                                                + + + private + static validationUuid(string $attribute, mixed $value) : array<string|int, mixed> + + +
                                                Parameters
                                                +
                                                +
                                                + $attribute + : string +
                                                +
                                                + +
                                                +
                                                + $value + : mixed +
                                                +
                                                + +
                                                +
                                                + + + +
                                                Return values
                                                + array<string|int, mixed> + — + + +
                                                +
                                                + + + + +
                                                +
                                                +
                                                +
                                                +

                                                Search results

                                                + +
                                                +
                                                +
                                                  +
                                                  +
                                                  +
                                                  +
                                                  +
                                                  + + +
                                                  + + + + + + + + diff --git a/documentation/classes/LDC-LDCCRM-WordPress-WPCrm.html b/documentation/classes/LDC-LDCCRM-WordPress-WPCrm.html new file mode 100644 index 0000000..9ec7601 --- /dev/null +++ b/documentation/classes/LDC-LDCCRM-WordPress-WPCrm.html @@ -0,0 +1,2033 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                  +

                                                  CRM V2

                                                  + + + + + +
                                                  + +
                                                  +
                                                  + + + + +
                                                  + + +
                                                  +

                                                  + WPCrm + + +
                                                  + in package + +
                                                  + + +

                                                  + + + +

                                                  Class de gestion des users en session avec Wordpress (ce truc immonde)

                                                  + + + +
                                                  + Tags + +
                                                  +
                                                  +
                                                  + category +
                                                  +
                                                  + +

                                                  API

                                                  +
                                                  + +
                                                  +
                                                  + subpackage +
                                                  +
                                                  + +

                                                  Wordpress

                                                  +
                                                  + +
                                                  +
                                                  + author +
                                                  +
                                                  + +

                                                  Jérémy Munsch jeremy.munsch@ldc.fr

                                                  +
                                                  + +
                                                  +
                                                  + license +
                                                  +
                                                  + +

                                                  MIT https://opensource.org/licenses/MIT

                                                  +
                                                  + +
                                                  +
                                                  + link +
                                                  +
                                                  + / + +
                                                  +
                                                  + + + + + + +

                                                  + Table of Contents + +

                                                  + +
                                                  +
                                                  + $api + +  : CrmApiV2 +
                                                  +
                                                  The user object
                                                  + +
                                                  + $user + +  : WPCrmUser +
                                                  +
                                                  The user object
                                                  + +
                                                  + $sessionDestroyed + +  : bool +
                                                  +
                                                  The session live status
                                                  + +
                                                  + $sessionKey + +  : string +
                                                  +
                                                  The session key name
                                                  + +
                                                  + activateUser() + +  : bool +
                                                  +
                                                  Toggle the current user optin value +on the current user and the crm
                                                  + +
                                                  + check() + +  : bool +
                                                  +
                                                  Check if the user is logged in.
                                                  + +
                                                  + deleteUser() + +  : bool +
                                                  +
                                                  Delete current customer from +the local database and the crm
                                                  + +
                                                  + forceLogin() + +  : WPCrmUser|null +
                                                  +
                                                  Manually login a user +If self::$user is already set.
                                                  + +
                                                  + getNewUser() + +  : WPCrmUser +
                                                  +
                                                  Generate a new user
                                                  + +
                                                  + getUser() + +  : WPCrmUser|null +
                                                  +
                                                  Get the current user +return null if the user is not logged in
                                                  + +
                                                  + getUserFromApi() + +  : WPCrmUser|false +
                                                  +
                                                  Get the current user +return api response code if an error occurs
                                                  + +
                                                  + getUserFromTable() + +  : array<string|int, mixed>|null +
                                                  +
                                                  Get a customer from table
                                                  + +
                                                  + getUserFromTableByEmail() + +  : array<string|int, mixed>|null +
                                                  +
                                                  Get a customer from table by an email
                                                  + +
                                                  + getUserFromTableByUuid() + +  : array<string|int, mixed>|null +
                                                  +
                                                  Get a customer from table by an email
                                                  + +
                                                  + login() + +  : bool +
                                                  +
                                                  Try to login with CRM API +A session will be started if credentials are valid.
                                                  + +
                                                  + logout() + +  : void +
                                                  +
                                                  Destroy the customer from session +and therefore logout
                                                  + +
                                                  + saveUser() + +  : bool +
                                                  +
                                                  Save current customer to +the local database and on crm
                                                  + +
                                                  + setSingleOptin() + +  : bool +
                                                  +
                                                  Set the single optin status for an email +on the crm
                                                  + +
                                                  + toggleUserOptin() + +  : bool +
                                                  +
                                                  Toggle the current user optin value +on the current user and the crm
                                                  + +
                                                  + unsetActiveUser() + +  : void +
                                                  +
                                                  Remove active user +to prevent WPCrm::check to return true
                                                  + +
                                                  + bootSessionIfNeeded() + +  : void +
                                                  +
                                                  Boot the php session if needed
                                                  + +
                                                  + deleteUserFromTable() + +  : int +
                                                  +
                                                  Save or update the user to the table
                                                  + +
                                                  + getCustomer() + +  : Customer|null +
                                                  +
                                                  Get all customer infos
                                                  + +
                                                  + getWpDb() + +  : object +
                                                  +
                                                  Get WP 'pdo instance'
                                                  + +
                                                  + initLdcApi() + +  : CrmApiV2 +
                                                  +
                                                  Get the initialized API object
                                                  + +
                                                  + loginUserWithApi() + +  : bool +
                                                  +
                                                  Check customer credentials using the CRM.
                                                  + +
                                                  + makeApiV2Call() + +  : mixed|false +
                                                  +
                                                  Make a call using apiV2
                                                  + +
                                                  + query() + +  : int|bool +
                                                  +
                                                  Query in DB
                                                  + +
                                                  + saveOrUpdateUserToTable() + +  : int +
                                                  +
                                                  Save or update the user to the table
                                                  + +
                                                  + setUser() + +  : void +
                                                  +
                                                  Create a user +stores it to the session +and finally saves it to the database if it does not exists
                                                  + +
                                                  + + + + + + +
                                                  +

                                                  + Properties + +

                                                  +
                                                  +

                                                  + $api + + + +

                                                  + + +

                                                  The user object

                                                  + + + protected + static CrmApiV2 + $api + = null + + + + + +
                                                  +
                                                  +

                                                  + $user + + + +

                                                  + + +

                                                  The user object

                                                  + + + protected + static WPCrmUser + $user + = null + + + + + +
                                                  +
                                                  +

                                                  + $sessionDestroyed + + + +

                                                  + + +

                                                  The session live status

                                                  + + + private + static bool + $sessionDestroyed + = false + + + + + +
                                                  +
                                                  +

                                                  + $sessionKey + + + +

                                                  + + +

                                                  The session key name

                                                  + + + private + static string + $sessionKey + = null + + + + + +
                                                  +
                                                  + +
                                                  +

                                                  + Methods + +

                                                  +
                                                  +

                                                  + activateUser() + +

                                                  + + +

                                                  Toggle the current user optin value +on the current user and the crm

                                                  + + + public + static activateUser() : bool + + + + +
                                                  + Tags + +
                                                  +
                                                  +
                                                  + throws +
                                                  +
                                                  + ValidationException + +

                                                  If a customer's hashcode could not be validated.

                                                  +
                                                  + +
                                                  +
                                                  + throws +
                                                  +
                                                  + CrmException + +

                                                  If an error occurs on server side or on getting response.

                                                  +
                                                  + +
                                                  +
                                                  + throws +
                                                  +
                                                  + ApiErrorException + +

                                                  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.

                                                  +
                                                  + +
                                                  +
                                                  + +
                                                  Return values
                                                  + bool + — +

                                                  True if the operation succeeded.

                                                  +
                                                  + + +
                                                  +
                                                  +

                                                  + check() + +

                                                  + + +

                                                  Check if the user is logged in.

                                                  + + + public + static check() : bool + +

                                                  This means he has an active valid session.

                                                  +
                                                  + + + + +
                                                  Return values
                                                  + bool + — + + +
                                                  +
                                                  +

                                                  + deleteUser() + +

                                                  + + +

                                                  Delete current customer from +the local database and the crm

                                                  + + + public + static deleteUser() : bool + + + + +
                                                  + Tags + +
                                                  +
                                                  +
                                                  + throws +
                                                  +
                                                  + CrmException + +

                                                  If a critical error occured.

                                                  +
                                                  + +
                                                  +
                                                  + throws +
                                                  +
                                                  + ApiErrorException + +

                                                  If any error or \LDC\LDCCRM\Enums\ApiError occurs. +Possibles are : - modelNotFound, If this customer hashcode could not be found.

                                                  +
                                                  + +
                                                  +
                                                  + phpcs:ignore +
                                                  +
                                                  + +

                                                  Squiz.Commenting.FunctionCommentThrowTag.WrongNumber

                                                  +
                                                  + +
                                                  +
                                                  + +
                                                  Return values
                                                  + bool + — +

                                                  true if the operation succeeded

                                                  +
                                                  + + +
                                                  +
                                                  +

                                                  + forceLogin() + +

                                                  + + +

                                                  Manually login a user +If self::$user is already set.

                                                  + + + public + static forceLogin() : WPCrmUser|null + + + + + +
                                                  Return values
                                                  + WPCrmUser|null + — + + +
                                                  +
                                                  +

                                                  + getNewUser() + +

                                                  + + +

                                                  Generate a new user

                                                  + + + public + static getNewUser() : WPCrmUser + + + + + +
                                                  Return values
                                                  + WPCrmUser + — + + +
                                                  +
                                                  +

                                                  + getUser() + +

                                                  + + +

                                                  Get the current user +return null if the user is not logged in

                                                  + + + public + static getUser() : WPCrmUser|null + + + + + +
                                                  Return values
                                                  + WPCrmUser|null + — + + +
                                                  +
                                                  +

                                                  + getUserFromApi() + +

                                                  + + +

                                                  Get the current user +return api response code if an error occurs

                                                  + + + public + static getUserFromApi(string $identification) : WPCrmUser|false + + +
                                                  Parameters
                                                  +
                                                  +
                                                  + $identification + : string +
                                                  +
                                                  +

                                                  The customer hashcode or email.

                                                  +
                                                  + +
                                                  +
                                                  + + +
                                                  + Tags + +
                                                  +
                                                  +
                                                  + throws +
                                                  +
                                                  + CrmException + +

                                                  If an error occurs on server side or on getting response.

                                                  +
                                                  + +
                                                  +
                                                  + throws +
                                                  +
                                                  + ApiErrorException + +

                                                  If any error or \LDC\LDCCRM\Enums\ApiError occurs.

                                                  +
                                                  + +
                                                  +
                                                  + phpcs:ignore +
                                                  +
                                                  + +

                                                  Squiz.Commenting.FunctionCommentThrowTag.WrongNumber

                                                  +
                                                  + +
                                                  +
                                                  + +
                                                  Return values
                                                  + WPCrmUser|false + — + + +
                                                  +
                                                  +

                                                  + getUserFromTable() + +

                                                  + + +

                                                  Get a customer from table

                                                  + + + public + static getUserFromTable(string $hashcode) : array<string|int, mixed>|null + + +
                                                  Parameters
                                                  +
                                                  +
                                                  + $hashcode + : string +
                                                  +
                                                  +

                                                  The customer hashcode.

                                                  +
                                                  + +
                                                  +
                                                  + + + +
                                                  Return values
                                                  + array<string|int, mixed>|null + — +

                                                  Database query result in format specified by $output or null on failure.

                                                  +
                                                  + + +
                                                  +
                                                  +

                                                  + getUserFromTableByEmail() + +

                                                  + + +

                                                  Get a customer from table by an email

                                                  + + + public + static getUserFromTableByEmail(string $email) : array<string|int, mixed>|null + + +
                                                  Parameters
                                                  +
                                                  +
                                                  + $email + : string +
                                                  +
                                                  +

                                                  The customer email.

                                                  +
                                                  + +
                                                  +
                                                  + + + +
                                                  Return values
                                                  + array<string|int, mixed>|null + — +

                                                  Database query result in format specified by $output or null on failure.

                                                  +
                                                  + + +
                                                  +
                                                  +

                                                  + getUserFromTableByUuid() + +

                                                  + + +

                                                  Get a customer from table by an email

                                                  + + + public + static getUserFromTableByUuid(string $uuid) : array<string|int, mixed>|null + + +
                                                  Parameters
                                                  +
                                                  +
                                                  + $uuid + : string +
                                                  +
                                                  +

                                                  The customer transaction uuid.

                                                  +
                                                  + +
                                                  +
                                                  + + + +
                                                  Return values
                                                  + array<string|int, mixed>|null + — +

                                                  Database query result in format specified by $output or null on failure.

                                                  +
                                                  + + +
                                                  +
                                                  +

                                                  + login() + +

                                                  + + +

                                                  Try to login with CRM API +A session will be started if credentials are valid.

                                                  + + + public + static login(string $email, string $password) : bool + + +
                                                  Parameters
                                                  +
                                                  +
                                                  + $email + : string +
                                                  +
                                                  +

                                                  The customer email.

                                                  +
                                                  + +
                                                  +
                                                  + $password + : string +
                                                  +
                                                  +

                                                  The customer password.

                                                  +
                                                  + +
                                                  +
                                                  + + +
                                                  + Tags + +
                                                  +
                                                  +
                                                  + throws +
                                                  +
                                                  + CrmException + +

                                                  If an error occurs on server side or on getting response.

                                                  +
                                                  + +
                                                  +
                                                  + throws +
                                                  +
                                                  + ApiErrorException + +

                                                  If any error or \LDC\LDCCRM\Enums\ApiError occurs. +Possibles are : - authFailed, If credentials are not valid. +- customerNotActivated, If the account is not activated.

                                                  +
                                                  + +
                                                  +
                                                  + +
                                                  Return values
                                                  + bool + — + + +
                                                  +
                                                  +

                                                  + logout() + +

                                                  + + +

                                                  Destroy the customer from session +and therefore logout

                                                  + + + public + static logout() : void + + + + + +
                                                  Return values
                                                  + void + — + + +
                                                  +
                                                  +

                                                  + saveUser() + +

                                                  + + +

                                                  Save current customer to +the local database and on crm

                                                  + + + public + static saveUser() : bool + + + + +
                                                  + Tags + +
                                                  +
                                                  +
                                                  + throws +
                                                  +
                                                  + CrmException + +

                                                  If a critical error occured.

                                                  +
                                                  + +
                                                  +
                                                  + throws +
                                                  +
                                                  + ApiErrorException + +

                                                  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.

                                                  +
                                                  + +
                                                  +
                                                  + phpcs:ignore +
                                                  +
                                                  + +

                                                  Squiz.Commenting.FunctionCommentThrowTag.WrongNumber

                                                  +
                                                  + +
                                                  +
                                                  + +
                                                  Return values
                                                  + bool + — +

                                                  true if the operation succeeded false otherwise

                                                  +
                                                  + + +
                                                  +
                                                  +

                                                  + setSingleOptin() + +

                                                  + + +

                                                  Set the single optin status for an email +on the crm

                                                  + + + public + static setSingleOptin(string $email, bool $opt_in) : bool + + +
                                                  Parameters
                                                  +
                                                  +
                                                  + $email + : string +
                                                  +
                                                  + +
                                                  +
                                                  + $opt_in + : bool +
                                                  +
                                                  + +
                                                  +
                                                  + + +
                                                  + Tags + +
                                                  +
                                                  +
                                                  + throws +
                                                  +
                                                  + ValidationException + +

                                                  If a field email could not be validated.

                                                  +
                                                  + +
                                                  +
                                                  + throws +
                                                  +
                                                  + CrmException + +

                                                  If an error occurs on server side or on getting response.

                                                  +
                                                  + +
                                                  +
                                                  + throws +
                                                  +
                                                  + ApiErrorException + +

                                                  If any error or \LDC\LDCCRM\Enums\ApiError occurs. +Possibles are : - singleOptinCustomerExists, If a customer exists with this email.

                                                  +
                                                  + +
                                                  +
                                                  + +
                                                  Return values
                                                  + bool + — +

                                                  true if the operation succeeded false otherwise

                                                  +
                                                  + + +
                                                  +
                                                  +

                                                  + toggleUserOptin() + +

                                                  + + +

                                                  Toggle the current user optin value +on the current user and the crm

                                                  + + + public + static toggleUserOptin() : bool + + + + +
                                                  + Tags + +
                                                  +
                                                  +
                                                  + throws +
                                                  +
                                                  + CrmException + +

                                                  If a critical error occured.

                                                  +
                                                  + +
                                                  +
                                                  + throws +
                                                  +
                                                  + ApiErrorException + +

                                                  If any error or \LDC\LDCCRM\Enums\ApiError occurs. +Possibles are : - modelNotFound, If this customer hashcode could not be found.

                                                  +
                                                  + +
                                                  +
                                                  + phpcs:ignore +
                                                  +
                                                  + +

                                                  Squiz.Commenting.FunctionCommentThrowTag.WrongNumber

                                                  +
                                                  + +
                                                  +
                                                  + +
                                                  Return values
                                                  + bool + — +

                                                  true if the operation succeeded

                                                  +
                                                  + + +
                                                  +
                                                  +

                                                  + unsetActiveUser() + +

                                                  + + +

                                                  Remove active user +to prevent WPCrm::check to return true

                                                  + + + public + static unsetActiveUser() : void + + + + + +
                                                  Return values
                                                  + void + — + + +
                                                  +
                                                  +

                                                  + bootSessionIfNeeded() + +

                                                  + + +

                                                  Boot the php session if needed

                                                  + + + private + static bootSessionIfNeeded() : void + + + + + +
                                                  Return values
                                                  + void + — + + +
                                                  +
                                                  +

                                                  + deleteUserFromTable() + +

                                                  + + +

                                                  Save or update the user to the table

                                                  + + + private + static deleteUserFromTable() : int + + + + + +
                                                  Return values
                                                  + int + — +

                                                  The number of row removed from the table.

                                                  +
                                                  + + +
                                                  +
                                                  +

                                                  + getCustomer() + +

                                                  + + +

                                                  Get all customer infos

                                                  + + + private + static getCustomer() : Customer|null + + + + + +
                                                  Return values
                                                  + Customer|null + — + + +
                                                  +
                                                  +

                                                  + getWpDb() + +

                                                  + + +

                                                  Get WP 'pdo instance'

                                                  + + + private + static getWpDb() : object + + + + + +
                                                  Return values
                                                  + object + — +

                                                  The $wpdb variable

                                                  +
                                                  + + +
                                                  +
                                                  +

                                                  + initLdcApi() + +

                                                  + + +

                                                  Get the initialized API object

                                                  + + + private + static initLdcApi() : CrmApiV2 + + + + +
                                                  + Tags + +
                                                  +
                                                  +
                                                  + throws +
                                                  +
                                                  + ErrorException + +

                                                  If php does not have extension curl.

                                                  +
                                                  + +
                                                  +
                                                  + +
                                                  Return values
                                                  + CrmApiV2 + — + + +
                                                  +
                                                  +

                                                  + loginUserWithApi() + +

                                                  + + +

                                                  Check customer credentials using the CRM.

                                                  + + + private + static loginUserWithApi(string $email, string $password) : bool + + +
                                                  Parameters
                                                  +
                                                  +
                                                  + $email + : string +
                                                  +
                                                  +

                                                  The customer email.

                                                  +
                                                  + +
                                                  +
                                                  + $password + : string +
                                                  +
                                                  +

                                                  The customer password.

                                                  +
                                                  + +
                                                  +
                                                  + + +
                                                  + Tags + +
                                                  +
                                                  +
                                                  + throws +
                                                  +
                                                  + CrmException + +

                                                  If an error occurs on server side or on getting response.

                                                  +
                                                  + +
                                                  +
                                                  + throws +
                                                  +
                                                  + ApiErrorException + +

                                                  If any error or \LDC\LDCCRM\Enums\ApiError occurs. +Possibles are : - authFailed, If credentials are not valid. +- customerNotActivated, If the account is not activated.

                                                  +
                                                  + +
                                                  +
                                                  + +
                                                  Return values
                                                  + bool + — + + +
                                                  +
                                                  +

                                                  + makeApiV2Call() + +

                                                  + + +

                                                  Make a call using apiV2

                                                  + + + private + static makeApiV2Call(object|string $obj, string $method[, array<string|int, mixed> $arguments = [] ]) : mixed|false + + +
                                                  Parameters
                                                  +
                                                  +
                                                  + $obj + : object|string +
                                                  +
                                                  +

                                                  An object or a class name.

                                                  +
                                                  + +
                                                  +
                                                  + $method + : string +
                                                  +
                                                  +

                                                  The method to call.

                                                  +
                                                  + +
                                                  +
                                                  + $arguments + : array<string|int, mixed> + = []
                                                  +
                                                  +

                                                  Arguments to pass.

                                                  +
                                                  + +
                                                  +
                                                  + + +
                                                  + Tags + +
                                                  +
                                                  +
                                                  + throws +
                                                  +
                                                  + ApiErrorException + +

                                                  If any of this exception is thrown.

                                                  +
                                                  + +
                                                  +
                                                  + throws +
                                                  +
                                                  + CrmException + +

                                                  If a critical error occured.

                                                  +
                                                  + +
                                                  +
                                                  + +
                                                  Return values
                                                  + mixed|false + — + + +
                                                  +
                                                  +

                                                  + query() + +

                                                  + + +

                                                  Query in DB

                                                  + + + private + static query(string $query[, array<string|int, mixed> $params = [] ]) : int|bool + + +
                                                  Parameters
                                                  +
                                                  +
                                                  + $query + : string +
                                                  +
                                                  +

                                                  La request avec les variables en points d'interrogation.

                                                  +
                                                  + +
                                                  +
                                                  + $params + : array<string|int, mixed> + = []
                                                  +
                                                  +

                                                  Les paramètres des la requète.

                                                  +
                                                  + +
                                                  +
                                                  + + + +
                                                  Return values
                                                  + int|bool + — +

                                                  Boolean true for CREATE, ALTER, TRUNCATE and DROP queries. +Number of rows affected/selected for all other queries. Boolean false on error.

                                                  +
                                                  + + +
                                                  +
                                                  +

                                                  + saveOrUpdateUserToTable() + +

                                                  + + +

                                                  Save or update the user to the table

                                                  + + + private + static saveOrUpdateUserToTable() : int + + + + + +
                                                  Return values
                                                  + int + — +

                                                  The number of row affected on the table.

                                                  +
                                                  + + +
                                                  +
                                                  +

                                                  + setUser() + +

                                                  + + +

                                                  Create a user +stores it to the session +and finally saves it to the database if it does not exists

                                                  + + + private + static setUser(Customer $customer) : void + + +
                                                  Parameters
                                                  +
                                                  +
                                                  + $customer + : Customer +
                                                  +
                                                  + +
                                                  +
                                                  + + + +
                                                  Return values
                                                  + void + — + + +
                                                  +
                                                  + + + + +
                                                  +
                                                  +
                                                  +
                                                  +

                                                  Search results

                                                  + +
                                                  +
                                                  +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    + + +
                                                    + + + + + + + + diff --git a/documentation/classes/LDC-LDCCRM-WordPress-WPCrmAnswer.html b/documentation/classes/LDC-LDCCRM-WordPress-WPCrmAnswer.html new file mode 100644 index 0000000..c4deb24 --- /dev/null +++ b/documentation/classes/LDC-LDCCRM-WordPress-WPCrmAnswer.html @@ -0,0 +1,415 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                    +

                                                    CRM V2

                                                    + + + + + +
                                                    + +
                                                    +
                                                    + + + + +
                                                    + + +
                                                    +

                                                    + WPCrmAnswer + + +
                                                    + in package + +
                                                    + + +

                                                    + + + +

                                                    Class de gestion de la segmentation question avec Wordpress (ce truc immonde)

                                                    + + + +
                                                    + Tags + +
                                                    +
                                                    +
                                                    + category +
                                                    +
                                                    + +

                                                    API

                                                    +
                                                    + +
                                                    +
                                                    + subpackage +
                                                    +
                                                    + +

                                                    Wordpress

                                                    +
                                                    + +
                                                    +
                                                    + author +
                                                    +
                                                    + +

                                                    Jérémy Munsch jeremy.munsch@ldc.fr

                                                    +
                                                    + +
                                                    +
                                                    + license +
                                                    +
                                                    + +

                                                    MIT https://opensource.org/licenses/MIT

                                                    +
                                                    + +
                                                    +
                                                    + link +
                                                    +
                                                    + / + +
                                                    +
                                                    + + + + + + +

                                                    + Table of Contents + +

                                                    + +
                                                    +
                                                    + setQuestionAnswers() + +  : bool +
                                                    +
                                                    Set answers to a question for a specific user
                                                    + +
                                                    + + + + + + + +
                                                    +

                                                    + Methods + +

                                                    +
                                                    +

                                                    + setQuestionAnswers() + +

                                                    + + +

                                                    Set answers to a question for a specific user

                                                    + + + public + setQuestionAnswers(WPCrmUser $user, int $questionId, array<string|int, mixed> $answersId) : bool + + +
                                                    Parameters
                                                    +
                                                    +
                                                    + $user + : WPCrmUser +
                                                    +
                                                    + +
                                                    +
                                                    + $questionId + : int +
                                                    +
                                                    +

                                                    The question id .

                                                    +
                                                    + +
                                                    +
                                                    + $answersId + : array<string|int, mixed> +
                                                    +
                                                    +

                                                    An array with answers id .

                                                    +
                                                    + +
                                                    +
                                                    + + +
                                                    + Tags + +
                                                    +
                                                    +
                                                    + throws +
                                                    +
                                                    + CrmException + +

                                                    If an error occurs on server side or on getting response.

                                                    +
                                                    + +
                                                    +
                                                    + throws +
                                                    +
                                                    + ValidationException + +

                                                    If $user hashcode is not a valid UUID.

                                                    +
                                                    + +
                                                    +
                                                    + throws +
                                                    +
                                                    + ValidationException + +

                                                    If any of the provided ids are invalid.

                                                    +
                                                    + +
                                                    +
                                                    + throws +
                                                    +
                                                    + ApiErrorException + +

                                                    If any error \LDC\LDCCRM\Enums\ApiError occurs. +Possibles are : - validationFailed, If given ids are wrong(CRM side).

                                                    +
                                                    + +
                                                    +
                                                    + phpcs:ignore +
                                                    +
                                                    + +

                                                    Squiz.Commenting.FunctionCommentThrowTag.WrongNumber

                                                    +
                                                    + +
                                                    +
                                                    + +
                                                    Return values
                                                    + bool + — +

                                                    true if succeeded

                                                    +
                                                    + + +
                                                    +
                                                    + + + + +
                                                    +
                                                    +
                                                    +
                                                    +

                                                    Search results

                                                    + +
                                                    +
                                                    +
                                                      +
                                                      +
                                                      +
                                                      +
                                                      +
                                                      + + +
                                                      + + + + + + + + diff --git a/documentation/classes/LDC-LDCCRM-WordPress-WPCrmQuestion.html b/documentation/classes/LDC-LDCCRM-WordPress-WPCrmQuestion.html new file mode 100644 index 0000000..26d41ce --- /dev/null +++ b/documentation/classes/LDC-LDCCRM-WordPress-WPCrmQuestion.html @@ -0,0 +1,570 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                      +

                                                      CRM V2

                                                      + + + + + +
                                                      + +
                                                      +
                                                      + + + + +
                                                      + + +
                                                      +

                                                      + WPCrmQuestion + + +
                                                      + in package + +
                                                      + + +

                                                      + + + +

                                                      Class de gestion de la segmentation question avec Wordpress (ce truc immonde)

                                                      + + + +
                                                      + Tags + +
                                                      +
                                                      +
                                                      + category +
                                                      +
                                                      + +

                                                      API

                                                      +
                                                      + +
                                                      +
                                                      + subpackage +
                                                      +
                                                      + +

                                                      Wordpress

                                                      +
                                                      + +
                                                      +
                                                      + author +
                                                      +
                                                      + +

                                                      Jérémy Munsch jeremy.munsch@ldc.fr

                                                      +
                                                      + +
                                                      +
                                                      + license +
                                                      +
                                                      + +

                                                      MIT https://opensource.org/licenses/MIT

                                                      +
                                                      + +
                                                      +
                                                      + link +
                                                      +
                                                      + / + +
                                                      +
                                                      + + + + + + +

                                                      + Table of Contents + +

                                                      + +
                                                      +
                                                      + allWithCustomerAnswers() + +  : array<string|int, mixed> +
                                                      +
                                                      Get all the questions with user answers
                                                      + +
                                                      + getAll() + +  : array<string|int, mixed> +
                                                      +
                                                      Get all questions only
                                                      + +
                                                      + unansweredBy() + +  : array<string|int, Question> +
                                                      +
                                                      Get unanswered question for a specific customer
                                                      + +
                                                      + + + + + + + +
                                                      +

                                                      + Methods + +

                                                      +
                                                      +

                                                      + allWithCustomerAnswers() + +

                                                      + + +

                                                      Get all the questions with user answers

                                                      + + + public + static allWithCustomerAnswers(WPCrmUser $user) : array<string|int, mixed> + + +
                                                      Parameters
                                                      +
                                                      +
                                                      + $user + : WPCrmUser +
                                                      +
                                                      + +
                                                      +
                                                      + + +
                                                      + Tags + +
                                                      +
                                                      +
                                                      + throws +
                                                      +
                                                      + CrmException + +

                                                      If an error occurs on server side or on getting response.

                                                      +
                                                      + +
                                                      +
                                                      + throws +
                                                      +
                                                      + ValidationException + +

                                                      If a hashcode is not a valid UUID.

                                                      +
                                                      + +
                                                      +
                                                      + throws +
                                                      +
                                                      + ValidationException + +

                                                      If any of the provided ids are invalid.

                                                      +
                                                      + +
                                                      +
                                                      + throws +
                                                      +
                                                      + ApiErrorException + +

                                                      If any error or \LDC\LDCCRM\Enums\ApiError occurs. +Possibles are : - modelNotFound, If the customer could not be found(CRM side).

                                                      +
                                                      + +
                                                      +
                                                      + phpcs:ignore +
                                                      +
                                                      + +

                                                      Squiz.Commenting.FunctionCommentThrowTag.WrongNumber

                                                      +
                                                      + +
                                                      +
                                                      + +
                                                      Return values
                                                      + array<string|int, mixed> + — +

                                                      Of \LDC\LDCCRM\Models\Question and their \LDC\LDCCRM\Models\Answer.

                                                      +
                                                      + + +
                                                      +
                                                      +

                                                      + getAll() + +

                                                      + + +

                                                      Get all questions only

                                                      + + + public + static getAll() : array<string|int, mixed> + + + + +
                                                      + Tags + +
                                                      +
                                                      +
                                                      + throws +
                                                      +
                                                      + CrmException + +

                                                      If an error occurs on server side or on getting response.

                                                      +
                                                      + +
                                                      +
                                                      + throws +
                                                      +
                                                      + ApiErrorException + +

                                                      If any error or \LDC\LDCCRM\Enums\ApiError occurs.

                                                      +
                                                      + +
                                                      +
                                                      + phpcs:ignore +
                                                      +
                                                      + +

                                                      Squiz.Commenting.FunctionCommentThrowTag.WrongNumber

                                                      +
                                                      + +
                                                      +
                                                      + +
                                                      Return values
                                                      + array<string|int, mixed> + — +

                                                      Of \LDC\LDCCRM\Models\Question

                                                      +
                                                      + + +
                                                      +
                                                      +

                                                      + unansweredBy() + +

                                                      + + +

                                                      Get unanswered question for a specific customer

                                                      + + + public + static unansweredBy(WPCrmUser $user) : array<string|int, Question> + + +
                                                      Parameters
                                                      +
                                                      +
                                                      + $user + : WPCrmUser +
                                                      +
                                                      + +
                                                      +
                                                      + + +
                                                      + Tags + +
                                                      +
                                                      +
                                                      + throws +
                                                      +
                                                      + CrmException + +

                                                      If an error occurs on server side or on getting response.

                                                      +
                                                      + +
                                                      +
                                                      + throws +
                                                      +
                                                      + ValidationException + +

                                                      If $user hashcode is not a valid UUID.

                                                      +
                                                      + +
                                                      +
                                                      + throws +
                                                      +
                                                      + ApiErrorException + +

                                                      If any error or \LDC\LDCCRM\Enums\ApiError occurs. +Possibles are : - modelNotFound, If the customer could not be found(CRM side).

                                                      +
                                                      + +
                                                      +
                                                      + phpcs:ignore +
                                                      +
                                                      + +

                                                      Squiz.Commenting.FunctionCommentThrowTag.WrongNumber

                                                      +
                                                      + +
                                                      +
                                                      + +
                                                      Return values
                                                      + array<string|int, Question> + — + + +
                                                      +
                                                      + + + + +
                                                      +
                                                      +
                                                      +
                                                      +

                                                      Search results

                                                      + +
                                                      +
                                                      +
                                                        +
                                                        +
                                                        +
                                                        +
                                                        +
                                                        + + +
                                                        + + + + + + + + diff --git a/documentation/classes/LDC-LDCCRM-WordPress-WPCrmUser.html b/documentation/classes/LDC-LDCCRM-WordPress-WPCrmUser.html new file mode 100644 index 0000000..331fbdd --- /dev/null +++ b/documentation/classes/LDC-LDCCRM-WordPress-WPCrmUser.html @@ -0,0 +1,1779 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                        +

                                                        CRM V2

                                                        + + + + + +
                                                        + +
                                                        +
                                                        + + + + +
                                                        + + +
                                                        +

                                                        + WPCrmUser + + +
                                                        + in package + +
                                                        + + + implements + JsonSerializable + +

                                                        + + + +

                                                        Class de gestion des users en session avec Wordpress (ce truc immonde)

                                                        + + + +
                                                        + Tags + +
                                                        +
                                                        +
                                                        + category +
                                                        +
                                                        + +

                                                        API

                                                        +
                                                        + +
                                                        +
                                                        + subpackage +
                                                        +
                                                        + +

                                                        Wordpress

                                                        +
                                                        + +
                                                        +
                                                        + author +
                                                        +
                                                        + +

                                                        Jérémy Munsch jeremy.munsch@ldc.fr

                                                        +
                                                        + +
                                                        +
                                                        + license +
                                                        +
                                                        + +

                                                        MIT https://opensource.org/licenses/MIT

                                                        +
                                                        + +
                                                        +
                                                        + link +
                                                        +
                                                        + / + +
                                                        +
                                                        + + + + +

                                                        + Interfaces, Classes and Traits + +

                                                        + +
                                                        +
                                                        JsonSerializable
                                                        +
                                                        + + +
                                                        + + +

                                                        + Table of Contents + +

                                                        + +
                                                        +
                                                        + $address + +  : string +
                                                        +
                                                        + +
                                                        + $address2 + +  : string +
                                                        +
                                                        + +
                                                        + $birth_date + +  : string +
                                                        +
                                                        + +
                                                        + $city + +  : string +
                                                        +
                                                        + +
                                                        + $country + +  : Country +
                                                        +
                                                        + +
                                                        + $email + +  : string +
                                                        +
                                                        + +
                                                        + $firstname + +  : string +
                                                        +
                                                        + +
                                                        + $hashcode + +  : string +
                                                        +
                                                        + +
                                                        + $last_connection + +  : string +
                                                        +
                                                        + +
                                                        + $lastname + +  : string +
                                                        +
                                                        + +
                                                        + $opt_in + +  : bool +
                                                        +
                                                        + +
                                                        + $password + +  : string +
                                                        +
                                                        + +
                                                        + $phone + +  : string +
                                                        +
                                                        + +
                                                        + $postcode + +  : string +
                                                        +
                                                        + +
                                                        + $status + +  : bool +
                                                        +
                                                        + +
                                                        + $uuidToken + +  : string +
                                                        +
                                                        + +
                                                        + $info + +  : Customer +
                                                        +
                                                        The CRM customer info (the api response)
                                                        + +
                                                        + $pemail + +  : string +
                                                        +
                                                        The CRM customer email
                                                        + +
                                                        + $phashcode + +  : string +
                                                        +
                                                        The CRM hashcode (UUID)
                                                        + +
                                                        + $uuidToken + +  : string +
                                                        +
                                                        The CRM customer temp uuidToken to validate transactions
                                                        + +
                                                        + __construct() + +  : mixed +
                                                        +
                                                        WPCrmUser construct
                                                        + +
                                                        + __get() + +  : bool|string|Country|null +
                                                        +
                                                        Generic accessor
                                                        + +
                                                        + __set() + +  : void +
                                                        +
                                                        Generic mutator
                                                        + +
                                                        + activate() + +  : bool +
                                                        +
                                                        Activate the account in the crm
                                                        + +
                                                        + delete() + +  : bool +
                                                        +
                                                        Delete current customer to +the local database and on crm
                                                        + +
                                                        + jsonSerialize() + +  : array<string|int, mixed> +
                                                        +
                                                        Serialize this object to an array
                                                        + +
                                                        + parseFromJson() + +  : WPCrmUser +
                                                        +
                                                        Generate a user from session data
                                                        + +
                                                        + save() + +  : bool +
                                                        +
                                                        Save current customer to +the local database and on crm
                                                        + +
                                                        + setInfo() + +  : void +
                                                        +
                                                        Set the customer info +with api response
                                                        + +
                                                        + toggleOptin() + +  : bool +
                                                        +
                                                        Toggle the current user optin value +on the current user and the crm
                                                        + +
                                                        + + + + + + +
                                                        +

                                                        + Properties + +

                                                        +
                                                        +

                                                        + $address + + + +

                                                        + + + + + public + string + $address + + +

                                                        The account address (street number, name, build, flat number)

                                                        +
                                                        + +
                                                        + + + +
                                                        +
                                                        +

                                                        + $address2 + + + +

                                                        + + + + + public + string + $address2 + + +

                                                        — The account phone (address complement)

                                                        +
                                                        + +
                                                        + + + +
                                                        +
                                                        +

                                                        + $birth_date + + + +

                                                        + + + + + public + string + $birth_date + + +

                                                        — The account birth date 'yyyy-mm-dd'

                                                        +
                                                        + +
                                                        + + + +
                                                        +
                                                        +

                                                        + $city + + + +

                                                        + + + + + public + string + $city + + +

                                                        — The account city name

                                                        +
                                                        + +
                                                        + + + +
                                                        +
                                                        +

                                                        + $country + + + +

                                                        + + + + + public + Country + $country + + +

                                                        — The account country residence

                                                        +
                                                        + +
                                                        + + + +
                                                        +
                                                        +

                                                        + $email + + + +

                                                        + + + + + public + string + $email + + +

                                                        — Must be a rfc valid email on a valid domain name

                                                        +
                                                        + +
                                                        + + + +
                                                        +
                                                        +

                                                        + $firstname + + + +

                                                        + + + + + public + string + $firstname + + +

                                                        — The account first name

                                                        +
                                                        + +
                                                        + + + +
                                                        +
                                                        +

                                                        + $hashcode + + + +

                                                        + + + + + public + string + $hashcode + + +

                                                        — The crm hashcode this is a readonly field

                                                        +
                                                        + +
                                                        + + + +
                                                        +
                                                        +

                                                        + $last_connection + + + +

                                                        + + + + + public + string + $last_connection + + +

                                                        the last time user was connected 'yyyy-mm-dd HH:ii:ss'

                                                        +
                                                        + +
                                                        + + + +
                                                        +
                                                        +

                                                        + $lastname + + + +

                                                        + + + + + public + string + $lastname + + +

                                                        — The account last name

                                                        +
                                                        + +
                                                        + + + +
                                                        +
                                                        +

                                                        + $opt_in + + + +

                                                        + + + + + public + bool + $opt_in + + +

                                                        — true if the account is opt in

                                                        +
                                                        + +
                                                        + + + +
                                                        +
                                                        +

                                                        + $password + + + +

                                                        + + + + + public + string + $password + + +

                                                        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

                                                        +
                                                        + +
                                                        + + + +
                                                        +
                                                        +

                                                        + $phone + + + +

                                                        + + + + + public + string + $phone + + +

                                                        — The account phone

                                                        +
                                                        + +
                                                        + + + +
                                                        +
                                                        +

                                                        + $postcode + + + +

                                                        + + + + + public + string + $postcode + + +

                                                        — The account city postcode

                                                        +
                                                        + +
                                                        + + + +
                                                        +
                                                        +

                                                        + $status + + + +

                                                        + + + + + public + bool + $status + + +

                                                        — true if the account is activated

                                                        +
                                                        + +
                                                        + + + +
                                                        +
                                                        +

                                                        + $uuidToken + + + +

                                                        + + + + + public + string + $uuidToken + + +

                                                        — A local transaction token for this user

                                                        +
                                                        + +
                                                        + + + +
                                                        +
                                                        +

                                                        + $info + + + +

                                                        + + +

                                                        The CRM customer info (the api response)

                                                        + + + protected + Customer + $info + = null + + + + + +
                                                        +
                                                        +

                                                        + $pemail + + + +

                                                        + + +

                                                        The CRM customer email

                                                        + + + protected + string + $pemail + = null + + + + + +
                                                        +
                                                        +

                                                        + $phashcode + + + +

                                                        + + +

                                                        The CRM hashcode (UUID)

                                                        + + + protected + string + $phashcode + = null + + + + + +
                                                        +
                                                        +

                                                        + $uuidToken + + + +

                                                        + + +

                                                        The CRM customer temp uuidToken to validate transactions

                                                        + + + protected + string + $uuidToken + = null + + +

                                                        UUID

                                                        +
                                                        + + + +
                                                        +
                                                        + +
                                                        +

                                                        + Methods + +

                                                        +
                                                        +

                                                        + __construct() + +

                                                        + + +

                                                        WPCrmUser construct

                                                        + + + public + __construct([string $hashcode = null ][, string $email = null ]) : mixed + + +
                                                        Parameters
                                                        +
                                                        +
                                                        + $hashcode + : string + = null
                                                        +
                                                        +

                                                        The customer hashcode (UUID).

                                                        +
                                                        + +
                                                        +
                                                        + $email + : string + = null
                                                        +
                                                        +

                                                        The customer email.

                                                        +
                                                        + +
                                                        +
                                                        + + + +
                                                        Return values
                                                        + mixed + — + + +
                                                        +
                                                        +

                                                        + __get() + +

                                                        + + +

                                                        Generic accessor

                                                        + + + public + __get(string $prop) : bool|string|Country|null + + +
                                                        Parameters
                                                        +
                                                        +
                                                        + $prop + : string +
                                                        +
                                                        +

                                                        The prop to get.

                                                        +
                                                        + +
                                                        +
                                                        + + + +
                                                        Return values
                                                        + bool|string|Country|null + — + + +
                                                        +
                                                        +

                                                        + __set() + +

                                                        + + +

                                                        Generic mutator

                                                        + + + public + __set(string $prop, mixed $value) : void + + +
                                                        Parameters
                                                        +
                                                        +
                                                        + $prop + : string +
                                                        +
                                                        +

                                                        The property to assign.

                                                        +
                                                        + +
                                                        +
                                                        + $value + : mixed +
                                                        +
                                                        +

                                                        The value to set.

                                                        +
                                                        + +
                                                        +
                                                        + + + +
                                                        Return values
                                                        + void + — + + +
                                                        +
                                                        +

                                                        + activate() + +

                                                        + + +

                                                        Activate the account in the crm

                                                        + + + public + activate() : bool + + + + +
                                                        + Tags + +
                                                        +
                                                        +
                                                        + throws +
                                                        +
                                                        + ValidationException + +

                                                        If a customer's hashcode could not be validated.

                                                        +
                                                        + +
                                                        +
                                                        + throws +
                                                        +
                                                        + CrmException + +

                                                        If an error occurs on server side or on getting response.

                                                        +
                                                        + +
                                                        +
                                                        + throws +
                                                        +
                                                        + ApiErrorException + +

                                                        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.

                                                        +
                                                        + +
                                                        +
                                                        + +
                                                        Return values
                                                        + bool + — +

                                                        true if succeeded

                                                        +
                                                        + + +
                                                        +
                                                        +

                                                        + delete() + +

                                                        + + +

                                                        Delete current customer to +the local database and on crm

                                                        + + + public + delete() : bool + + + + +
                                                        + Tags + +
                                                        +
                                                        +
                                                        + throws +
                                                        +
                                                        + CrmException + +

                                                        If a critical error occured.

                                                        +
                                                        + +
                                                        +
                                                        + throws +
                                                        +
                                                        + ApiErrorException + +

                                                        If any error or \LDC\LDCCRM\Enums\ApiError occurs. +Possibles are : - modelNotFound, If this customer hashcode could not be found.

                                                        +
                                                        + +
                                                        +
                                                        + +
                                                        Return values
                                                        + bool + — +

                                                        true if the operation succeeded false otherwise

                                                        +
                                                        + + +
                                                        +
                                                        +

                                                        + jsonSerialize() + +

                                                        + + +

                                                        Serialize this object to an array

                                                        + + + public + jsonSerialize() : array<string|int, mixed> + + + + + +
                                                        Return values
                                                        + array<string|int, mixed> + — + + +
                                                        +
                                                        +

                                                        + parseFromJson() + +

                                                        + + +

                                                        Generate a user from session data

                                                        + + + public + static parseFromJson(string $string) : WPCrmUser + + +
                                                        Parameters
                                                        +
                                                        +
                                                        + $string + : string +
                                                        +
                                                        +

                                                        The json data stored in session.

                                                        +
                                                        + +
                                                        +
                                                        + + +
                                                        + Tags + +
                                                        +
                                                        +
                                                        + throws +
                                                        +
                                                        + WpCrmInvalidJsonUserInfo + +

                                                        If the json string does no +contain the needed information.

                                                        +
                                                        + +
                                                        +
                                                        + +
                                                        Return values
                                                        + WPCrmUser + — + + +
                                                        +
                                                        +

                                                        + save() + +

                                                        + + +

                                                        Save current customer to +the local database and on crm

                                                        + + + public + save() : bool + + + + +
                                                        + Tags + +
                                                        +
                                                        +
                                                        + throws +
                                                        +
                                                        + CrmException + +

                                                        If a critical error occured.

                                                        +
                                                        + +
                                                        +
                                                        + throws +
                                                        +
                                                        + ApiErrorException + +

                                                        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.

                                                        +
                                                        + +
                                                        +
                                                        + +
                                                        Return values
                                                        + bool + — +

                                                        true if the operation succeeded false otherwise

                                                        +
                                                        + + +
                                                        +
                                                        +

                                                        + setInfo() + +

                                                        + + +

                                                        Set the customer info +with api response

                                                        + + + public + setInfo(Customer $customer) : void + + +
                                                        Parameters
                                                        +
                                                        +
                                                        + $customer + : Customer +
                                                        +
                                                        +

                                                        The Api object reponse (user).

                                                        +
                                                        + +
                                                        +
                                                        + + + +
                                                        Return values
                                                        + void + — + + +
                                                        +
                                                        +

                                                        + toggleOptin() + +

                                                        + + +

                                                        Toggle the current user optin value +on the current user and the crm

                                                        + + + public + toggleOptin() : bool + + + + +
                                                        + Tags + +
                                                        +
                                                        +
                                                        + throws +
                                                        +
                                                        + CrmException + +

                                                        If a critical error occured.

                                                        +
                                                        + +
                                                        +
                                                        + throws +
                                                        +
                                                        + ApiErrorException + +

                                                        If any error or \LDC\LDCCRM\Enums\ApiError occurs. +Possibles are : - modelNotFound, If this customer hashcode could not be found.

                                                        +
                                                        + +
                                                        +
                                                        + +
                                                        Return values
                                                        + bool + — +

                                                        true if the operation succeeded

                                                        +
                                                        + + +
                                                        +
                                                        + + + + +
                                                        +
                                                        +
                                                        +
                                                        +

                                                        Search results

                                                        + +
                                                        +
                                                        +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          + + +
                                                          + + + + + + + + diff --git a/documentation/css/base.css b/documentation/css/base.css new file mode 100644 index 0000000..db4e807 --- /dev/null +++ b/documentation/css/base.css @@ -0,0 +1,1087 @@ + +:root { + /* Typography */ + --font-primary: 'Source Sans Pro', Helvetica, Arial, sans-serif; + --font-secondary: 'Source Sans Pro', Helvetica, Arial, sans-serif; + --font-monospace: 'Source Code Pro', monospace; + --line-height--primary: 1.6; + --letter-spacing--primary: .05rem; + --text-base-size: 1em; + --text-scale-ratio: 1.2; + + --text-xxs: calc(var(--text-base-size) / var(--text-scale-ratio) / var(--text-scale-ratio) / var(--text-scale-ratio)); + --text-xs: calc(var(--text-base-size) / var(--text-scale-ratio) / var(--text-scale-ratio)); + --text-sm: calc(var(--text-base-size) / var(--text-scale-ratio)); + --text-md: var(--text-base-size); + --text-lg: calc(var(--text-base-size) * var(--text-scale-ratio)); + --text-xl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio)); + --text-xxl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio)); + --text-xxxl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio)); + --text-xxxxl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio)); + --text-xxxxxl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio)); + + /* Colors */ + --primary-color: hsl(96, 57%, 60%); + --primary-color-darken: hsl(96, 57%, 40%); + --primary-color-darker: hsl(96, 57%, 20%); + --primary-color-darkest: hsl(96, 57%, 10%); + --primary-color-lighten: hsl(96, 57%, 80%); + --primary-color-lighter: hsl(96, 57%, 99%); + --dark-gray: #d1d1d1; + --light-gray: #f0f0f0; + + --text-color: var(--primary-color-darkest); + + --header-height: var(--spacing-xxxxl); + --header-bg-color: var(--primary-color); + --code-background-color: #f7faf5; + --code-border-color: #d6e7cb; + --button-border-color: var(--primary-color-darken); + --button-color: transparent; + --button-color-primary: var(--primary-color); + --button-text-color: #555; + --button-text-color-primary: white; + --popover-background-color: rgba(255, 255, 255, 0.75); + --link-color-primary: var(--primary-color-darken); + --link-hover-color-primary: var(--primary-color-darker); + --form-field-border-color: var(--dark-gray); + --form-field-color: #fff; + --admonition-success-color: var(--primary-color); + --admonition-border-color: silver; + --table-separator-color: var(--primary-color-lighten); + --title-text-color: var(--primary-color); + + --sidebar-border-color: var(--primary-color-lighten); + + /* Grid */ + --container-width: 1400px; + + /* Spacing */ + --spacing-base-size: 1rem; + --spacing-scale-ratio: 1.5; + + --spacing-xxxs: calc(var(--spacing-base-size) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio)); + --spacing-xxs: calc(var(--spacing-base-size) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio)); + --spacing-xs: calc(var(--spacing-base-size) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio)); + --spacing-sm: calc(var(--spacing-base-size) / var(--spacing-scale-ratio)); + --spacing-md: var(--spacing-base-size); + --spacing-lg: calc(var(--spacing-base-size) * var(--spacing-scale-ratio)); + --spacing-xl: calc(var(--spacing-base-size) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio)); + --spacing-xxl: calc(var(--spacing-base-size) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio)); + --spacing-xxxl: calc(var(--spacing-base-size) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio)); + --spacing-xxxxl: calc(var(--spacing-base-size) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio)); + + --border-radius-base-size: 3px; +} + +/* Base Styles +-------------------------------------------------- */ +body { + color: var(--text-color); + font-family: var(--font-primary); + font-size: var(--text-md); + letter-spacing: var(--letter-spacing--primary); + line-height: var(--line-height--primary); +} + +.phpdocumentor h1, +.phpdocumentor h2, +.phpdocumentor h3, +.phpdocumentor h4, +.phpdocumentor h5, +.phpdocumentor h6 { + margin-bottom: var(--spacing-lg); + margin-top: var(--spacing-lg); + font-weight: 600; +} + +.phpdocumentor h1 { + font-size: var(--text-xxxxl); + letter-spacing: var(--letter-spacing--primary); + line-height: 1.2; + margin-top: 0; +} + +.phpdocumentor h2 { + font-size: var(--text-xxxl); + letter-spacing: var(--letter-spacing--primary); + line-height: 1.25; +} + +.phpdocumentor h3 { + font-size: var(--text-xxl); + letter-spacing: var(--letter-spacing--primary); + line-height: 1.3; +} + +.phpdocumentor h4 { + font-size: var(--text-xl); + letter-spacing: calc(var(--letter-spacing--primary) / 2); + line-height: 1.35; + margin-bottom: var(--spacing-md); +} + +.phpdocumentor h5 { + font-size: var(--text-lg); + letter-spacing: calc(var(--letter-spacing--primary) / 4); + line-height: 1.5; + margin-bottom: var(--spacing-md); + margin-top: var(--spacing-md); +} + +.phpdocumentor h6 { + font-size: var(--text-md); + letter-spacing: 0; + line-height: var(--line-height--primary); + margin-bottom: var(--spacing-md); + margin-top: var(--spacing-md); +} + +.phpdocumentor h1 .headerlink, +.phpdocumentor h2 .headerlink, +.phpdocumentor h3 .headerlink, +.phpdocumentor h4 .headerlink, +.phpdocumentor h5 .headerlink, +.phpdocumentor h6 .headerlink +{ + transition: all .3s ease-in-out; + opacity: 0; + text-decoration: none; + color: silver; + font-size: 80%; +} + +.phpdocumentor h1:hover .headerlink, +.phpdocumentor h2:hover .headerlink, +.phpdocumentor h3:hover .headerlink, +.phpdocumentor h4:hover .headerlink, +.phpdocumentor h5:hover .headerlink, +.phpdocumentor h6:hover .headerlink +{ + opacity: 1; +} +.phpdocumentor p { + margin-top: 0; + margin-bottom: var(--spacing-md); +} +.phpdocumentor figure { + margin-bottom: var(--spacing-md); +} + +.phpdocumentor figcaption { + text-align: center; + font-style: italic; + font-size: 80%; +} +.phpdocumentor-line { + border-top: 1px solid #E1E1E1; + border-width: 0; + margin-bottom: var(--spacing-xxl); + margin-top: var(--spacing-xxl); +} +.phpdocumentor-section { + box-sizing: border-box; + margin: 0 auto; + max-width: var(--container-width); + padding: 0 var(--spacing-lg); + position: relative; + width: 100%; +} + +@media (min-width: 1200px) { + .phpdocumentor-section { + padding: 0; + width: 95%; + } +} +.phpdocumentor-column { + box-sizing: border-box; + float: left; + width: 100%; +} + +@media (min-width: 550px) { + .phpdocumentor-column { + margin-left: 4%; + } + + .phpdocumentor-column:first-child { + margin-left: 0; + } + + .-one.phpdocumentor-column { + width: 4.66666666667%; + } + + .-two.phpdocumentor-column { + width: 13.3333333333%; + } + + .-three.phpdocumentor-column { + width: 22%; + } + + .-four.phpdocumentor-column { + width: 30.6666666667%; + } + + .-five.phpdocumentor-column { + width: 39.3333333333%; + } + + .-six.phpdocumentor-column { + width: 48%; + } + + .-seven.phpdocumentor-column { + width: 56.6666666667%; + } + + .-eight.phpdocumentor-column { + width: 65.3333333333%; + } + + .-nine.phpdocumentor-column { + width: 74.0%; + } + + .-ten.phpdocumentor-column { + width: 82.6666666667%; + } + + .-eleven.phpdocumentor-column { + width: 91.3333333333%; + } + + .-twelve.phpdocumentor-column { + margin-left: 0; + width: 100%; + } + + .-one-third.phpdocumentor-column { + width: 30.6666666667%; + } + + .-two-thirds.phpdocumentor-column { + width: 65.3333333333%; + } + + .-one-half.phpdocumentor-column { + width: 48%; + } + + /* Offsets */ + .-offset-by-one.phpdocumentor-column { + margin-left: 8.66666666667%; + } + + .-offset-by-two.phpdocumentor-column { + margin-left: 17.3333333333%; + } + + .-offset-by-three.phpdocumentor-column { + margin-left: 26%; + } + + .-offset-by-four.phpdocumentor-column { + margin-left: 34.6666666667%; + } + + .-offset-by-five.phpdocumentor-column { + margin-left: 43.3333333333%; + } + + .-offset-by-six.phpdocumentor-column { + margin-left: 52%; + } + + .-offset-by-seven.phpdocumentor-column { + margin-left: 60.6666666667%; + } + + .-offset-by-eight.phpdocumentor-column { + margin-left: 69.3333333333%; + } + + .-offset-by-nine.phpdocumentor-column { + margin-left: 78.0%; + } + + .-offset-by-ten.phpdocumentor-column { + margin-left: 86.6666666667%; + } + + .-offset-by-eleven.phpdocumentor-column { + margin-left: 95.3333333333%; + } + + .-offset-by-one-third.phpdocumentor-column { + margin-left: 34.6666666667%; + } + + .-offset-by-two-thirds.phpdocumentor-column { + margin-left: 69.3333333333%; + } + + .-offset-by-one-half.phpdocumentor-column { + margin-left: 52%; + } +} +.phpdocumentor a { + color: var(--link-color-primary); +} + +.phpdocumentor a:hover { + color: var(--link-hover-color-primary); +} +.phpdocumentor-button { + background-color: var(--button-color); + border: 1px solid var(--button-border-color); + border-radius: var(--border-radius-base-size); + box-sizing: border-box; + color: var(--button-text-color); + cursor: pointer; + display: inline-block; + font-size: var(--text-sm); + font-weight: 600; + height: 38px; + letter-spacing: .1rem; + line-height: 38px; + padding: 0 var(--spacing-xxl); + text-align: center; + text-decoration: none; + text-transform: uppercase; + white-space: nowrap; + margin-bottom: var(--spacing-md); +} + +.phpdocumentor-button .-wide { + width: 100%; +} + +.phpdocumentor-button:hover, +.phpdocumentor-button:focus { + border-color: #888; + color: #333; + outline: 0; +} + +.phpdocumentor-button.-primary { + background-color: var(--button-color-primary); + border-color: var(--button-color-primary); + color: var(--button-text-color-primary); +} + +.phpdocumentor-button.-primary:hover, +.phpdocumentor-button.-primary:focus { + background-color: var(--link-color-primary); + border-color: var(--link-color-primary); + color: var(--button-text-color-primary); +} +.phpdocumentor form { + margin-bottom: var(--spacing-md); +} + +.phpdocumentor-field { + background-color: var(--form-field-color); + border: 1px solid var(--form-field-border-color); + border-radius: var(--border-radius-base-size); + box-shadow: none; + box-sizing: border-box; + height: 38px; + padding: var(--spacing-xxxs) var(--spacing-xxs); /* The 6px vertically centers text on FF, ignored by Webkit */ + margin-bottom: var(--spacing-md); +} + +/* Removes awkward default styles on some inputs for iOS */ +input[type="email"], +input[type="number"], +input[type="search"], +input[type="text"], +input[type="tel"], +input[type="url"], +input[type="password"], +textarea { + -moz-appearance: none; + -webkit-appearance: none; + appearance: none; +} + +.phpdocumentor-textarea { + min-height: 65px; + padding-bottom: var(--spacing-xxxs); + padding-top: var(--spacing-xxxs); +} + +.phpdocumentor-field:focus { + border: 1px solid var(--button-color-primary); + outline: 0; +} + +.phpdocumentor-label { + display: block; + margin-bottom: var(--spacing-xs); +} + +.phpdocumentor-fieldset { + border-width: 0; + padding: 0; +} + +input[type="checkbox"].phpdocumentor-field, +input[type="radio"].phpdocumentor-field { + display: inline; +} +div.phpdocumentor-list > ul, +ul.phpdocumentor-list { + list-style: circle inside; +} + +ol.phpdocumentor-list { + list-style: decimal inside; +} + +div.phpdocumentor-list > ul, +ol.phpdocumentor-list, +ul.phpdocumentor-list { + margin-top: 0; + padding-left: 0; + margin-bottom: var(--spacing-md); +} + +dl { + margin-bottom: var(--spacing-md); +} + +div.phpdocumentor-list > ul ul, +ul.phpdocumentor-list ul.phpdocumentor-list, +ul.phpdocumentor-list ol.phpdocumentor-list, +ol.phpdocumentor-list ol.phpdocumentor-list, +ol.phpdocumentor-list ul.phpdocumentor-list { + font-size: var(--text-sm); + margin: var(--spacing-xs) 0 var(--spacing-xs) calc(var(--spacing-xs) * 2); +} + +li.phpdocumentor-list { + margin-bottom: var(--spacing-md); +} + +.phpdocumentor dl dt { + margin-bottom: var(--spacing-xs); +} + +.phpdocumentor dl dd { + margin-bottom: var(--spacing-md); +} +.phpdocumentor pre { + margin-bottom: var(--spacing-md); +} + +.phpdocumentor-code { + font-family: var(--font-monospace); + background: var(--code-background-color); + border: 1px solid var(--code-border-color); + border-radius: var(--border-radius-base-size); + font-size: var(--text-sm); + padding: var(--spacing-sm) var(--spacing-md); + width: 100%; + box-sizing: border-box; +} + +.phpdocumentor-code.-dark { + background: var(--primary-color-darkest); + color: var(--light-gray); + box-shadow: 0 2px 3px var(--dark-gray); +} + +pre > .phpdocumentor-code { + display: block; + white-space: pre; +} +.phpdocumentor blockquote { + border-left: 4px solid var(--primary-color-darken); + margin: var(--spacing-md) 0; + padding: var(--spacing-xs) var(--spacing-sm); + color: var(--primary-color-darker); + font-style: italic; +} + +.phpdocumentor blockquote p:last-of-type { + margin-bottom: 0; +} +.phpdocumentor table { + margin-bottom: var(--spacing-md); +} + +th.phpdocumentor-heading, +td.phpdocumentor-cell { + border-bottom: 1px solid var(--table-separator-color); + padding: var(--spacing-sm) var(--spacing-md); + text-align: left; +} + +th.phpdocumentor-heading:first-child, +td.phpdocumentor-cell:first-child { + padding-left: 0; +} + +th.phpdocumentor-heading:last-child, +td.phpdocumentor-cell:last-child { + padding-right: 0; +} + +.phpdocumentor-header { + display: flex; + flex-direction: row; + align-items: stretch; + flex-wrap: wrap; + justify-content: space-between; + height: auto; + padding: var(--spacing-md) var(--spacing-md); +} + +.phpdocumentor-header__menu-button { + position: absolute; + top: -100%; + left: -100%; +} + +.phpdocumentor-header__menu-icon { + font-size: 2rem; + color: var(--primary-color); +} + +.phpdocumentor-header__menu-button:checked ~ .phpdocumentor-topnav { + max-height: 250px; + padding-top: var(--spacing-md); +} + +@media (min-width: 1000px) { + .phpdocumentor-header { + flex-direction: row; + padding: var(--spacing-lg) var(--spacing-lg); + min-height: var(--header-height); + } + + .phpdocumentor-header__menu-icon { + display: none; + } +} + +@media (min-width: 1000px) { + .phpdocumentor-header { + padding-top: 0; + padding-bottom: 0; + } +} +@media (min-width: 1200px) { + .phpdocumentor-header { + padding: 0; + } +} +.phpdocumentor-title { + box-sizing: border-box; + color: var(--title-text-color); + font-size: var(--text-xxl); + letter-spacing: .05rem; + font-weight: normal; + width: auto; + margin: 0; + display: flex; + align-items: center; +} + +.phpdocumentor-title.-without-divider { + border: none; +} + +.phpdocumentor-title__link { + transition: all .3s ease-out; + display: flex; + color: var(--title-text-color); + text-decoration: none; + font-weight: normal; + white-space: nowrap; + transform: scale(.75); + transform-origin: left; +} + +.phpdocumentor-title__link:hover { + transform: perspective(15rem) translateX(.5rem); + font-weight: 600; +} + +@media (min-width: 1000px) { + .phpdocumentor-title { + width: 30.6666666667%; + border-right: var(--sidebar-border-color) solid 1px; + } + + .phpdocumentor-title__link { + transform-origin: left; + } +} + +@media (min-width: 1000px) { + .phpdocumentor-title__link { + transform: scale(.85); + } +} + +@media (min-width: 1200px) { + .phpdocumentor-title__link { + transform: scale(1); + } +} +.phpdocumentor-topnav { + display: flex; + align-items: center; + margin: 0; + max-height: 0; + overflow: hidden; + transition: max-height 0.2s ease-out; + flex-basis: 100%; +} + +.phpdocumentor-topnav__menu { + text-align: right; + list-style: none; + margin: 0; + padding: 0; + flex: 1; + display: flex; + flex-flow: row wrap; + justify-content: center; +} + +.phpdocumentor-topnav__menu-item { + margin: 0; + width: 100%; + display: inline-block; + text-align: center; + padding: var(--spacing-sm) 0 +} + +.phpdocumentor-topnav__menu-item.-social { + width: auto; + padding: var(--spacing-sm) +} + +.phpdocumentor-topnav__menu-item a { + display: inline-block; + color: var(--text-color); + text-decoration: none; + font-size: var(--text-lg); + transition: all .3s ease-out; + border-bottom: 1px dotted transparent; + line-height: 1; +} + +.phpdocumentor-topnav__menu-item a:hover { + transform: perspective(15rem) translateY(.1rem); + border-bottom: 1px dotted var(--text-color); +} + +@media (min-width: 1000px) { + .phpdocumentor-topnav { + max-height: none; + overflow: visible; + flex-basis: auto; + } + + .phpdocumentor-topnav__menu { + display: flex; + flex-flow: row wrap; + justify-content: flex-end; + } + + .phpdocumentor-topnav__menu-item, + .phpdocumentor-topnav__menu-item.-social { + width: auto; + display: inline; + text-align: right; + padding: 0 0 0 var(--spacing-md) + } +} +.phpdocumentor-sidebar { + margin: 0; + overflow: hidden; + max-height: 0; +} + +.phpdocumentor .phpdocumentor-sidebar .phpdocumentor-list { + padding: var(--spacing-xs) var(--spacing-md); + list-style: none; + margin: 0; +} + +.phpdocumentor .phpdocumentor-sidebar li { + white-space: nowrap; + text-overflow: ellipsis; + overflow: hidden; + padding: 0 0 var(--spacing-xxxs) var(--spacing-md); +} + +.phpdocumentor .phpdocumentor-sidebar abbr, +.phpdocumentor .phpdocumentor-sidebar a { + text-decoration: none; + border-bottom: none; + color: var(--text-color); + font-size: var(--text-md); + padding-left: 0; + transition: padding-left .4s ease-out; +} + +.phpdocumentor .phpdocumentor-sidebar a:hover { + padding-left: 5px; + font-weight: 600; +} + +.phpdocumentor .phpdocumentor-sidebar__category > * { + border-left: 1px solid var(--primary-color-lighten); +} + +.phpdocumentor .phpdocumentor-sidebar__category { + margin-bottom: var(--spacing-lg); +} + +.phpdocumentor .phpdocumentor-sidebar__category-header { + font-size: var(--text-md); + margin-bottom: var(--spacing-xs); + color: var(--link-color-primary); + font-weight: 600; + border-left: 0; +} + +.phpdocumentor .phpdocumentor-sidebar__root-package, +.phpdocumentor .phpdocumentor-sidebar__root-namespace { + font-size: var(--text-md); + margin: 0; + padding-top: var(--spacing-xs); + padding-left: var(--spacing-md); + color: var(--text-color); + font-weight: normal; +} + +@media (min-width: 550px) { + .phpdocumentor-sidebar { + border-right: var(--sidebar-border-color) solid 1px; + } +} + +.phpdocumentor-sidebar__menu-button { + position: absolute; + top: -100%; + left: -100%; +} + +.phpdocumentor-sidebar__menu-icon { + font-size: var(--text-md); + font-weight: 600; + background: var(--primary-color); + color: white; + margin: 0 0 var(--spacing-lg); + display: block; + padding: var(--spacing-sm); + text-align: center; + border-radius: 3px; + text-transform: uppercase; + letter-spacing: .15rem; +} + +.phpdocumentor-sidebar__menu-button:checked ~ .phpdocumentor-sidebar { + max-height: 100%; + padding-top: var(--spacing-md); +} + +@media (min-width: 550px) { + .phpdocumentor-sidebar { + overflow: visible; + max-height: 100%; + } + + .phpdocumentor-sidebar__menu-icon { + display: none; + } +} +.phpdocumentor-admonition { + border: 1px solid var(--admonition-border-color); + border-radius: var(--border-radius-base-size); + border-color: var(--primary-color-lighten); + background-color: var(--primary-color-lighter); + padding: var(--spacing-lg); + margin: var(--spacing-lg) 0; + display: flex; + flex-direction: row; + align-items: flex-start; +} + +.phpdocumentor-admonition p:last-of-type { + margin-bottom: 0; +} + +.phpdocumentor-admonition--success, +.phpdocumentor-admonition.-success { + border-color: var(--admonition-success-color); +} + +.phpdocumentor-admonition__icon { + margin-right: var(--spacing-md); + color: var(--primary-color); + max-width: 3rem; +} +.phpdocumentor ul.phpdocumentor-breadcrumbs { + font-size: var(--text-md); + list-style: none; + margin: 0; + padding: 0; +} + +.phpdocumentor ul.phpdocumentor-breadcrumbs a { + color: var(--text-color); + text-decoration: none; +} + +.phpdocumentor ul.phpdocumentor-breadcrumbs > li { + display: inline-block; + margin: 0; +} + +.phpdocumentor ul.phpdocumentor-breadcrumbs > li + li:before { + color: var(--dark-gray); + content: "\\\A0"; + padding: 0; +} +.phpdocumentor .phpdocumentor-back-to-top { + position: fixed; + bottom: 2rem; + font-size: 2.5rem; + opacity: .25; + transition: all .3s ease-in-out; + right: 2rem; +} + +.phpdocumentor .phpdocumentor-back-to-top:hover { + color: var(--link-color-primary); + opacity: 1; +} +.phpdocumentor-search { + position: relative; + display: none; /** disable by default for non-js flow */ + opacity: .3; /** white-out default for loading indication */ + transition: opacity .3s, background .3s; + margin: var(--spacing-sm) 0; + flex: 1; + min-width: 100%; +} + +.phpdocumentor-search label { + display: flex; + align-items: center; + flex: 1; +} + +.phpdocumentor-search__icon { + color: var(--primary-color); + margin-right: var(--spacing-sm); + width: 1rem; + height: 1rem; +} + +.phpdocumentor-search--enabled { + display: flex; +} + +.phpdocumentor-search--active { + opacity: 1; +} + +.phpdocumentor-search input:disabled { + background-color: lightgray; +} + +.phpdocumentor-search__field:focus, +.phpdocumentor-search__field { + margin-bottom: 0; + border: 0; + border-bottom: 2px solid var(--primary-color); + padding: 0; + border-radius: 0; + flex: 1; +} + +@media (min-width: 1000px) { + .phpdocumentor-search { + min-width: auto; + max-width: 20rem; + margin: 0 0 0 auto; + } +} +.phpdocumentor-content { + position: relative; +} + +.phpdocumentor-search-results { + backdrop-filter: blur(5px); + background: var(--popover-background-color); + position: fixed; + top: 0; + left: 0; + right: 0; + bottom: 0; + padding: 0; + opacity: 1; + pointer-events: all; + + transition: opacity .3s, background .3s; +} + +.phpdocumentor-search-results--hidden { + background: transparent; + backdrop-filter: blur(0); + opacity: 0; + pointer-events: none; +} + +.phpdocumentor-search-results__dialog { + width: 100%; + background: white; + max-height: 100%; + display: flex; + flex-direction: column; +} + +.phpdocumentor-search-results__body { + overflow: auto; +} + +.phpdocumentor-search-results__header { + padding: var(--spacing-lg); + display: flex; + justify-content: space-between; + background: var(--primary-color-darken); + color: white; + align-items: center; +} + +.phpdocumentor-search-results__close { + font-size: var(--text-xl); + background: none; + border: none; + padding: 0; + margin: 0; +} + +.phpdocumentor .phpdocumentor-search-results__title { + font-size: var(--text-xl); + margin-bottom: 0; +} + +.phpdocumentor-search-results__entries { + list-style: none; + padding: 0 var(--spacing-lg); + margin: 0; +} + +.phpdocumentor-search-results__entry { + border-bottom: 1px solid var(--table-separator-color); + padding: var(--spacing-sm) 0; + text-align: left; +} + +.phpdocumentor-search-results__entry a { + display: block; +} + +.phpdocumentor-search-results__entry small { + margin-top: var(--spacing-xs); + margin-bottom: var(--spacing-md); + color: var(--primary-color-darker); + display: block; + word-break: break-word; +} + +.phpdocumentor-search-results__entry h3 { + font-size: var(--text-lg); + margin: 0; +} + +@media (min-width: 550px) { + .phpdocumentor-search-results { + padding: 0 var(--spacing-lg); + } + + .phpdocumentor-search-results__entry h3 { + font-size: var(--text-xxl); + } + + .phpdocumentor-search-results__dialog { + margin: var(--spacing-xl) auto; + max-width: 40rem; + background: white; + border: 1px solid silver; + box-shadow: 0 2px 5px silver; + max-height: 40rem; + border-radius: 3px; + } +} +.phpdocumentor-modal { + position: fixed; + width: 100vw; + height: 100vh; + opacity: 0; + visibility: hidden; + transition: all 0.3s ease; + top: 0; + left: 0; + display: flex; + align-items: center; + justify-content: center; +} + +.phpdocumentor-modal__open { + visibility: visible; + opacity: 1; + transition-delay: 0s; +} + +.phpdocumentor-modal-bg { + position: absolute; + background: gray; + opacity: 50%; + width: 100%; + height: 100%; +} + +.phpdocumentor-modal-container { + border-radius: 1em; + background: #fff; + position: relative; + padding: 2em; +} + +.phpdocumentor-modal__close { + position: absolute; + right: 0.75em; + top: 0.75em; + outline: none; + appearance: none; + color: var(--primary-color); + background: none; + border: 0px; + font-weight: bold; + cursor: pointer; +} + +/* Used for screen readers and such */ +.visually-hidden { + display: none; +} + +.float-right { + float: right; +} + +.float-left { + float: left; +} diff --git a/documentation/css/normalize.css b/documentation/css/normalize.css new file mode 100644 index 0000000..579152b --- /dev/null +++ b/documentation/css/normalize.css @@ -0,0 +1,427 @@ +/*! normalize.css v3.0.2 | MIT License | git.io/normalize */ + +/** + * 1. Set default font family to sans-serif. + * 2. Prevent iOS text size adjust after orientation change, without disabling + * user zoom. + */ + +html { + font-family: sans-serif; /* 1 */ + -ms-text-size-adjust: 100%; /* 2 */ + -webkit-text-size-adjust: 100%; /* 2 */ +} + +/** + * Remove default margin. + */ + +body { + margin: 0; +} + +/* HTML5 display definitions + ========================================================================== */ + +/** + * Correct `block` display not defined for any HTML5 element in IE 8/9. + * Correct `block` display not defined for `details` or `summary` in IE 10/11 + * and Firefox. + * Correct `block` display not defined for `main` in IE 11. + */ + +article, +aside, +details, +figcaption, +figure, +footer, +header, +hgroup, +main, +menu, +nav, +section, +summary { + display: block; +} + +/** + * 1. Correct `inline-block` display not defined in IE 8/9. + * 2. Normalize vertical alignment of `progress` in Chrome, Firefox, and Opera. + */ + +audio, +canvas, +progress, +video { + display: inline-block; /* 1 */ + vertical-align: baseline; /* 2 */ +} + +/** + * Prevent modern browsers from displaying `audio` without controls. + * Remove excess height in iOS 5 devices. + */ + +audio:not([controls]) { + display: none; + height: 0; +} + +/** + * Address `[hidden]` styling not present in IE 8/9/10. + * Hide the `template` element in IE 8/9/11, Safari, and Firefox < 22. + */ + +[hidden], +template { + display: none; +} + +/* Links + ========================================================================== */ + +/** + * Remove the gray background color from active links in IE 10. + */ + +a { + background-color: transparent; +} + +/** + * Improve readability when focused and also mouse hovered in all browsers. + */ + +a:active, +a:hover { + outline: 0; +} + +/* Text-level semantics + ========================================================================== */ + +/** + * Address styling not present in IE 8/9/10/11, Safari, and Chrome. + */ + +abbr[title] { + border-bottom: 1px dotted; +} + +/** + * Address style set to `bolder` in Firefox 4+, Safari, and Chrome. + */ + +b, +strong { + font-weight: bold; +} + +/** + * Address styling not present in Safari and Chrome. + */ + +dfn { + font-style: italic; +} + +/** + * Address variable `h1` font-size and margin within `section` and `article` + * contexts in Firefox 4+, Safari, and Chrome. + */ + +h1 { + font-size: 2em; + margin: 0.67em 0; +} + +/** + * Address styling not present in IE 8/9. + */ + +mark { + background: #ff0; + color: #000; +} + +/** + * Address inconsistent and variable font size in all browsers. + */ + +small { + font-size: 80%; +} + +/** + * Prevent `sub` and `sup` affecting `line-height` in all browsers. + */ + +sub, +sup { + font-size: 75%; + line-height: 0; + position: relative; + vertical-align: baseline; +} + +sup { + top: -0.5em; +} + +sub { + bottom: -0.25em; +} + +/* Embedded content + ========================================================================== */ + +/** + * Remove border when inside `a` element in IE 8/9/10. + */ + +img { + border: 0; +} + +/** + * Correct overflow not hidden in IE 9/10/11. + */ + +svg:not(:root) { + overflow: hidden; +} + +/* Grouping content + ========================================================================== */ + +/** + * Address margin not present in IE 8/9 and Safari. + */ + +figure { + margin: 1em 40px; +} + +/** + * Address differences between Firefox and other browsers. + */ + +hr { + -moz-box-sizing: content-box; + box-sizing: content-box; + height: 0; +} + +/** + * Contain overflow in all browsers. + */ + +pre { + overflow: auto; +} + +/** + * Address odd `em`-unit font size rendering in all browsers. + */ + +code, +kbd, +pre, +samp { + font-family: var(--font-monospace); + font-size: 1em; +} + +/* Forms + ========================================================================== */ + +/** + * Known limitation: by default, Chrome and Safari on OS X allow very limited + * styling of `select`, unless a `border` property is set. + */ + +/** + * 1. Correct color not being inherited. + * Known issue: affects color of disabled elements. + * 2. Correct font properties not being inherited. + * 3. Address margins set differently in Firefox 4+, Safari, and Chrome. + */ + +button, +input, +optgroup, +select, +textarea { + color: inherit; /* 1 */ + font: inherit; /* 2 */ + margin: 0; /* 3 */ +} + +/** + * Address `overflow` set to `hidden` in IE 8/9/10/11. + */ + +button { + overflow: visible; +} + +/** + * Address inconsistent `text-transform` inheritance for `button` and `select`. + * All other form control elements do not inherit `text-transform` values. + * Correct `button` style inheritance in Firefox, IE 8/9/10/11, and Opera. + * Correct `select` style inheritance in Firefox. + */ + +button, +select { + text-transform: none; +} + +/** + * 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio` + * and `video` controls. + * 2. Correct inability to style clickable `input` types in iOS. + * 3. Improve usability and consistency of cursor style between image-type + * `input` and others. + */ + +button, +html input[type="button"], /* 1 */ +input[type="reset"], +input[type="submit"] { + -webkit-appearance: button; /* 2 */ + cursor: pointer; /* 3 */ +} + +/** + * Re-set default cursor for disabled elements. + */ + +button[disabled], +html input[disabled] { + cursor: default; +} + +/** + * Remove inner padding and border in Firefox 4+. + */ + +button::-moz-focus-inner, +input::-moz-focus-inner { + border: 0; + padding: 0; +} + +/** + * Address Firefox 4+ setting `line-height` on `input` using `!important` in + * the UA stylesheet. + */ + +input { + line-height: normal; +} + +/** + * It's recommended that you don't attempt to style these elements. + * Firefox's implementation doesn't respect box-sizing, padding, or width. + * + * 1. Address box sizing set to `content-box` in IE 8/9/10. + * 2. Remove excess padding in IE 8/9/10. + */ + +input[type="checkbox"], +input[type="radio"] { + box-sizing: border-box; /* 1 */ + padding: 0; /* 2 */ +} + +/** + * Fix the cursor style for Chrome's increment/decrement buttons. For certain + * `font-size` values of the `input`, it causes the cursor style of the + * decrement button to change from `default` to `text`. + */ + +input[type="number"]::-webkit-inner-spin-button, +input[type="number"]::-webkit-outer-spin-button { + height: auto; +} + +/** + * 1. Address `appearance` set to `searchfield` in Safari and Chrome. + * 2. Address `box-sizing` set to `border-box` in Safari and Chrome + * (include `-moz` to future-proof). + */ + +input[type="search"] { + -webkit-appearance: textfield; /* 1 */ + -moz-box-sizing: content-box; + -webkit-box-sizing: content-box; /* 2 */ + box-sizing: content-box; +} + +/** + * Remove inner padding and search cancel button in Safari and Chrome on OS X. + * Safari (but not Chrome) clips the cancel button when the search input has + * padding (and `textfield` appearance). + */ + +input[type="search"]::-webkit-search-cancel-button, +input[type="search"]::-webkit-search-decoration { + -webkit-appearance: none; +} + +/** + * Define consistent border, margin, and padding. + */ + +fieldset { + border: 1px solid #c0c0c0; + margin: 0 2px; + padding: 0.35em 0.625em 0.75em; +} + +/** + * 1. Correct `color` not being inherited in IE 8/9/10/11. + * 2. Remove padding so people aren't caught out if they zero out fieldsets. + */ + +legend { + border: 0; /* 1 */ + padding: 0; /* 2 */ +} + +/** + * Remove default vertical scrollbar in IE 8/9/10/11. + */ + +textarea { + overflow: auto; +} + +/** + * Don't inherit the `font-weight` (applied by a rule above). + * NOTE: the default cannot safely be changed in Chrome and Safari on OS X. + */ + +optgroup { + font-weight: bold; +} + +/* Tables + ========================================================================== */ + +/** + * Remove most spacing between table cells. + */ + +table { + border-collapse: collapse; + border-spacing: 0; +} + +td, +th { + padding: 0; +} diff --git a/documentation/css/template.css b/documentation/css/template.css new file mode 100644 index 0000000..31f00e3 --- /dev/null +++ b/documentation/css/template.css @@ -0,0 +1,188 @@ +.phpdocumentor-summary { + font-style: italic; +} +.phpdocumentor-description { + margin-bottom: var(--spacing-md); +} +.phpdocumentor-element { + position: relative; +} + +.phpdocumentor .phpdocumentor-element__name { + line-height: 1; +} + +.phpdocumentor-element__package, +.phpdocumentor-element__extends, +.phpdocumentor-element__implements { + display: block; + font-size: var(--text-xxs); + font-weight: normal; + opacity: .7; +} + +.phpdocumentor-element__package .phpdocumentor-breadcrumbs { + display: inline; +} + +.phpdocumentor-element:not(:last-child) { + border-bottom: 1px solid var(--primary-color-lighten); + padding-bottom: var(--spacing-lg); +} + +.phpdocumentor-element.-deprecated .phpdocumentor-element__name { + text-decoration: line-through; +} + +.phpdocumentor-element__modifier { + font-size: var(--text-xxs); + padding: calc(var(--spacing-base-size) / 4) calc(var(--spacing-base-size) / 2); + color: var(--text-color); + background-color: var(--light-gray); + border-radius: 3px; + text-transform: uppercase; +} +.phpdocumentor-signature { + display: inline-block; + font-size: var(--text-sm); + margin-bottom: var(--spacing-md); +} + +.phpdocumentor-signature.-deprecated .phpdocumentor-signature__name { + text-decoration: line-through; +} +.phpdocumentor-table-of-contents { +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry { + padding-top: var(--spacing-xs); + margin-left: 2rem; + display: flex; +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry > a { + flex: 0 1 auto; +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry > span { + flex: 1; + white-space: nowrap; + text-overflow: ellipsis; + overflow: hidden; +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry:after { + content: ''; + height: 12px; + width: 12px; + left: 16px; + position: absolute; +} +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-private:after { + background: url('data:image/svg+xml;utf8,') no-repeat; +} +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-protected:after { + left: 13px; + background: url('data:image/svg+xml;utf8,') no-repeat; +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry:before { + width: 1.25rem; + height: 1.25rem; + line-height: 1.25rem; + background: transparent url('data:image/svg+xml;utf8,') no-repeat center center; + content: ''; + position: absolute; + left: 0; + border-radius: 50%; + font-weight: 600; + color: white; + text-align: center; + font-size: .75rem; + margin-top: .2rem; +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-method:before { + content: 'M'; + background-image: url('data:image/svg+xml;utf8,'); +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-function:before { + content: 'M'; + background-image: url('data:image/svg+xml;utf8,'); +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-property:before { + content: 'P' +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-constant:before { + content: 'C'; + background-color: transparent; + background-image: url('data:image/svg+xml;utf8,'); +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-class:before { + content: 'C' +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-interface:before { + content: 'I' +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-trait:before { + content: 'T' +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-namespace:before { + content: 'N' +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-package:before { + content: 'P' +} + +.phpdocumentor-table-of-contents dd { + font-style: italic; + margin-left: 2rem; +} +.phpdocumentor-element-found-in { + position: absolute; + top: 0; + right: 0; + font-size: var(--text-sm); + color: gray; +} + +.phpdocumentor-element-found-in .phpdocumentor-element-found-in__source { + flex: 0 1 auto; + display: inline-flex; +} + +.phpdocumentor-element-found-in .phpdocumentor-element-found-in__source:after { + width: 1.25rem; + height: 1.25rem; + line-height: 1.25rem; + background: transparent url('data:image/svg+xml;utf8,') no-repeat center center; + content: ''; + left: 0; + border-radius: 50%; + font-weight: 600; + text-align: center; + font-size: .75rem; + margin-top: .2rem; +} +.phpdocumentor-class-graph { + width: 100%; height: 600px; border:1px solid black; overflow: hidden +} + +.phpdocumentor-class-graph__graph { + width: 100%; +} +.phpdocumentor-tag-list__definition { + display: flex; +} + +.phpdocumentor-tag-link { + margin-right: var(--spacing-sm); +} diff --git a/documentation/files/examples-customerexample.html b/documentation/files/examples-customerexample.html new file mode 100644 index 0000000..7bb0da2 --- /dev/null +++ b/documentation/files/examples-customerexample.html @@ -0,0 +1,140 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                          +

                                                          CRM V2

                                                          + + + + + +
                                                          + +
                                                          +
                                                          + + + + +
                                                          +
                                                            +
                                                          + +
                                                          +

                                                          CustomerExample.php

                                                          + + +
                                                          + + + + + + + + + + + + + + +
                                                          +
                                                          +
                                                          +
                                                          +

                                                          Search results

                                                          + +
                                                          +
                                                          +
                                                            +
                                                            +
                                                            +
                                                            +
                                                            +
                                                            + + +
                                                            + + + + + + + + diff --git a/documentation/files/src-crmapiv2.html b/documentation/files/src-crmapiv2.html new file mode 100644 index 0000000..9e3241b --- /dev/null +++ b/documentation/files/src-crmapiv2.html @@ -0,0 +1,151 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                            +

                                                            CRM V2

                                                            + + + + + +
                                                            + +
                                                            +
                                                            + + + + +
                                                            +
                                                              +
                                                            + +
                                                            +

                                                            CrmApiV2.php

                                                            + + +
                                                            + + + + + + +

                                                            + Interfaces, Classes and Traits + +

                                                            + +
                                                            + +
                                                            CrmApiV2
                                                            +
                                                            This is the main class to interact with the CRM
                                                            + +
                                                            + + + + + + + + +
                                                            +
                                                            +
                                                            +
                                                            +

                                                            Search results

                                                            + +
                                                            +
                                                            +
                                                              +
                                                              +
                                                              +
                                                              +
                                                              +
                                                              + + +
                                                              + + + + + + + + diff --git a/documentation/files/src-enums-apierror.html b/documentation/files/src-enums-apierror.html new file mode 100644 index 0000000..2ac8a83 --- /dev/null +++ b/documentation/files/src-enums-apierror.html @@ -0,0 +1,151 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                              +

                                                              CRM V2

                                                              + + + + + +
                                                              + +
                                                              +
                                                              + + + + +
                                                              +
                                                                +
                                                              + +
                                                              +

                                                              ApiError.php

                                                              + + +
                                                              + + + + + + +

                                                              + Interfaces, Classes and Traits + +

                                                              + +
                                                              + +
                                                              ApiError
                                                              +
                                                              This describes an API error.
                                                              + +
                                                              + + + + + + + + +
                                                              +
                                                              +
                                                              +
                                                              +

                                                              Search results

                                                              + +
                                                              +
                                                              +
                                                                +
                                                                +
                                                                +
                                                                +
                                                                +
                                                                + + +
                                                                + + + + + + + + diff --git a/documentation/files/src-enums-apistatus.html b/documentation/files/src-enums-apistatus.html new file mode 100644 index 0000000..bcd330c --- /dev/null +++ b/documentation/files/src-enums-apistatus.html @@ -0,0 +1,151 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                +

                                                                CRM V2

                                                                + + + + + +
                                                                + +
                                                                +
                                                                + + + + +
                                                                +
                                                                  +
                                                                + +
                                                                +

                                                                ApiStatus.php

                                                                + + +
                                                                + + + + + + +

                                                                + Interfaces, Classes and Traits + +

                                                                + +
                                                                + +
                                                                ApiStatus
                                                                +
                                                                + +
                                                                + + + + + + + + +
                                                                +
                                                                +
                                                                +
                                                                +

                                                                Search results

                                                                + +
                                                                +
                                                                +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  + + +
                                                                  + + + + + + + + diff --git a/documentation/files/src-enums-arcadiamailtype.html b/documentation/files/src-enums-arcadiamailtype.html new file mode 100644 index 0000000..62f8966 --- /dev/null +++ b/documentation/files/src-enums-arcadiamailtype.html @@ -0,0 +1,151 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                  +

                                                                  CRM V2

                                                                  + + + + + +
                                                                  + +
                                                                  +
                                                                  + + + + +
                                                                  +
                                                                    +
                                                                  + +
                                                                  +

                                                                  ArcadiaMailType.php

                                                                  + + +
                                                                  + + + + + + +

                                                                  + Interfaces, Classes and Traits + +

                                                                  + +
                                                                  + +
                                                                  ArcadiaMailType
                                                                  +
                                                                  + +
                                                                  + + + + + + + + +
                                                                  +
                                                                  +
                                                                  +
                                                                  +

                                                                  Search results

                                                                  + +
                                                                  +
                                                                  +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    + + +
                                                                    + + + + + + + + diff --git a/documentation/files/src-enums-arcadiaordertype.html b/documentation/files/src-enums-arcadiaordertype.html new file mode 100644 index 0000000..62c8d5b --- /dev/null +++ b/documentation/files/src-enums-arcadiaordertype.html @@ -0,0 +1,151 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                    +

                                                                    CRM V2

                                                                    + + + + + +
                                                                    + +
                                                                    +
                                                                    + + + + +
                                                                    +
                                                                      +
                                                                    + +
                                                                    +

                                                                    ArcadiaOrderType.php

                                                                    + + +
                                                                    + + + + + + +

                                                                    + Interfaces, Classes and Traits + +

                                                                    + +
                                                                    + +
                                                                    ArcadiaOrderType
                                                                    +
                                                                    + +
                                                                    + + + + + + + + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +

                                                                    Search results

                                                                    + +
                                                                    +
                                                                    +
                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      + + +
                                                                      + + + + + + + + diff --git a/documentation/files/src-enums-country.html b/documentation/files/src-enums-country.html new file mode 100644 index 0000000..d2050f9 --- /dev/null +++ b/documentation/files/src-enums-country.html @@ -0,0 +1,151 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                      +

                                                                      CRM V2

                                                                      + + + + + +
                                                                      + +
                                                                      +
                                                                      + + + + +
                                                                      +
                                                                        +
                                                                      + +
                                                                      +

                                                                      Country.php

                                                                      + + +
                                                                      + + + + + + +

                                                                      + Interfaces, Classes and Traits + +

                                                                      + +
                                                                      + +
                                                                      Country
                                                                      +
                                                                      Liste de Pays
                                                                      + +
                                                                      + + + + + + + + +
                                                                      +
                                                                      +
                                                                      +
                                                                      +

                                                                      Search results

                                                                      + +
                                                                      +
                                                                      +
                                                                        +
                                                                        +
                                                                        +
                                                                        +
                                                                        +
                                                                        + + +
                                                                        + + + + + + + + diff --git a/documentation/files/src-enums-httpmethods.html b/documentation/files/src-enums-httpmethods.html new file mode 100644 index 0000000..92d2516 --- /dev/null +++ b/documentation/files/src-enums-httpmethods.html @@ -0,0 +1,140 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                        +

                                                                        CRM V2

                                                                        + + + + + +
                                                                        + +
                                                                        +
                                                                        + + + + +
                                                                        +
                                                                          +
                                                                        + +
                                                                        +

                                                                        HttpMethods.php

                                                                        + + +
                                                                        + + + + + + + + + + + + + + +
                                                                        +
                                                                        +
                                                                        +
                                                                        +

                                                                        Search results

                                                                        + +
                                                                        +
                                                                        +
                                                                          +
                                                                          +
                                                                          +
                                                                          +
                                                                          +
                                                                          + + +
                                                                          + + + + + + + + diff --git a/documentation/files/src-enums-loglevel.html b/documentation/files/src-enums-loglevel.html new file mode 100644 index 0000000..8834ad0 --- /dev/null +++ b/documentation/files/src-enums-loglevel.html @@ -0,0 +1,151 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                          +

                                                                          CRM V2

                                                                          + + + + + +
                                                                          + +
                                                                          +
                                                                          + + + + +
                                                                          +
                                                                            +
                                                                          + +
                                                                          +

                                                                          LogLevel.php

                                                                          + + +
                                                                          + + + + + + +

                                                                          + Interfaces, Classes and Traits + +

                                                                          + +
                                                                          + +
                                                                          LogLevel
                                                                          +
                                                                          + +
                                                                          + + + + + + + + +
                                                                          +
                                                                          +
                                                                          +
                                                                          +

                                                                          Search results

                                                                          + +
                                                                          +
                                                                          +
                                                                            +
                                                                            +
                                                                            +
                                                                            +
                                                                            +
                                                                            + + +
                                                                            + + + + + + + + diff --git a/documentation/files/src-enums-questiontype.html b/documentation/files/src-enums-questiontype.html new file mode 100644 index 0000000..0a94cc6 --- /dev/null +++ b/documentation/files/src-enums-questiontype.html @@ -0,0 +1,151 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                            +

                                                                            CRM V2

                                                                            + + + + + +
                                                                            + +
                                                                            +
                                                                            + + + + +
                                                                            +
                                                                              +
                                                                            + +
                                                                            +

                                                                            QuestionType.php

                                                                            + + +
                                                                            + + + + + + +

                                                                            + Interfaces, Classes and Traits + +

                                                                            + +
                                                                            + +
                                                                            QuestionType
                                                                            +
                                                                            + +
                                                                            + + + + + + + + +
                                                                            +
                                                                            +
                                                                            +
                                                                            +

                                                                            Search results

                                                                            + +
                                                                            +
                                                                            +
                                                                              +
                                                                              +
                                                                              +
                                                                              +
                                                                              +
                                                                              + + +
                                                                              + + + + + + + + diff --git a/documentation/files/src-exceptions-accesserror.html b/documentation/files/src-exceptions-accesserror.html new file mode 100644 index 0000000..b2a7afa --- /dev/null +++ b/documentation/files/src-exceptions-accesserror.html @@ -0,0 +1,151 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                              +

                                                                              CRM V2

                                                                              + + + + + +
                                                                              + +
                                                                              +
                                                                              + + + + +
                                                                              +
                                                                                +
                                                                              + +
                                                                              +

                                                                              AccessError.php

                                                                              + + +
                                                                              + + + + + + +

                                                                              + Interfaces, Classes and Traits + +

                                                                              + +
                                                                              + +
                                                                              AccessError
                                                                              +
                                                                              This is thrown when trying to set a value on an object property that does not exist.
                                                                              + +
                                                                              + + + + + + + + +
                                                                              +
                                                                              +
                                                                              +
                                                                              +

                                                                              Search results

                                                                              + +
                                                                              +
                                                                              +
                                                                                +
                                                                                +
                                                                                +
                                                                                +
                                                                                +
                                                                                + + +
                                                                                + + + + + + + + diff --git a/documentation/files/src-exceptions-apierrorexception.html b/documentation/files/src-exceptions-apierrorexception.html new file mode 100644 index 0000000..549805d --- /dev/null +++ b/documentation/files/src-exceptions-apierrorexception.html @@ -0,0 +1,153 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                                +

                                                                                CRM V2

                                                                                + + + + + +
                                                                                + +
                                                                                +
                                                                                + + + + +
                                                                                +
                                                                                  +
                                                                                + +
                                                                                +

                                                                                ApiErrorException.php

                                                                                + + +
                                                                                + + + + + + +

                                                                                + Interfaces, Classes and Traits + +

                                                                                + +
                                                                                + +
                                                                                ApiErrorException
                                                                                +
                                                                                This would be thrown if any of the case +referenced in \LDC\LDCCRM\Enums\ApiError would +occur within the crm
                                                                                + +
                                                                                + + + + + + + + +
                                                                                +
                                                                                +
                                                                                +
                                                                                +

                                                                                Search results

                                                                                + +
                                                                                +
                                                                                +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  + + +
                                                                                  + + + + + + + + diff --git a/documentation/files/src-exceptions-crmexception.html b/documentation/files/src-exceptions-crmexception.html new file mode 100644 index 0000000..d83c57f --- /dev/null +++ b/documentation/files/src-exceptions-crmexception.html @@ -0,0 +1,151 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                                  +

                                                                                  CRM V2

                                                                                  + + + + + +
                                                                                  + +
                                                                                  +
                                                                                  + + + + +
                                                                                  +
                                                                                    +
                                                                                  + +
                                                                                  +

                                                                                  CrmException.php

                                                                                  + + +
                                                                                  + + + + + + +

                                                                                  + Interfaces, Classes and Traits + +

                                                                                  + +
                                                                                  + +
                                                                                  CrmException
                                                                                  +
                                                                                  This is a critical error.
                                                                                  + +
                                                                                  + + + + + + + + +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +

                                                                                  Search results

                                                                                  + +
                                                                                  +
                                                                                  +
                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    + + +
                                                                                    + + + + + + + + diff --git a/documentation/files/src-exceptions-skipvalidationexception.html b/documentation/files/src-exceptions-skipvalidationexception.html new file mode 100644 index 0000000..e8418f4 --- /dev/null +++ b/documentation/files/src-exceptions-skipvalidationexception.html @@ -0,0 +1,151 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                                    +

                                                                                    CRM V2

                                                                                    + + + + + +
                                                                                    + +
                                                                                    +
                                                                                    + + + + +
                                                                                    +
                                                                                      +
                                                                                    + +
                                                                                    +

                                                                                    SkipValidationException.php

                                                                                    + + +
                                                                                    + + + + + + +

                                                                                    + Interfaces, Classes and Traits + +

                                                                                    + +
                                                                                    + +
                                                                                    SkipValidationException
                                                                                    +
                                                                                    Used only for internal validator
                                                                                    + +
                                                                                    + + + + + + + + +
                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    +

                                                                                    Search results

                                                                                    + +
                                                                                    +
                                                                                    +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      + + +
                                                                                      + + + + + + + + diff --git a/documentation/files/src-exceptions-validationexception.html b/documentation/files/src-exceptions-validationexception.html new file mode 100644 index 0000000..3b7a967 --- /dev/null +++ b/documentation/files/src-exceptions-validationexception.html @@ -0,0 +1,152 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                                      +

                                                                                      CRM V2

                                                                                      + + + + + +
                                                                                      + +
                                                                                      +
                                                                                      + + + + +
                                                                                      +
                                                                                        +
                                                                                      + +
                                                                                      +

                                                                                      ValidationException.php

                                                                                      + + +
                                                                                      + + + + + + +

                                                                                      + Interfaces, Classes and Traits + +

                                                                                      + +
                                                                                      + +
                                                                                      ValidationException
                                                                                      +
                                                                                      This would be thrown if a data could not be validated +on any models
                                                                                      + +
                                                                                      + + + + + + + + +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +

                                                                                      Search results

                                                                                      + +
                                                                                      +
                                                                                      +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        + + +
                                                                                        + + + + + + + + diff --git a/documentation/files/src-exceptions-wpcrminvalidjsonuserinfo.html b/documentation/files/src-exceptions-wpcrminvalidjsonuserinfo.html new file mode 100644 index 0000000..b8ff99e --- /dev/null +++ b/documentation/files/src-exceptions-wpcrminvalidjsonuserinfo.html @@ -0,0 +1,151 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                                        +

                                                                                        CRM V2

                                                                                        + + + + + +
                                                                                        + +
                                                                                        +
                                                                                        + + + + +
                                                                                        +
                                                                                          +
                                                                                        + +
                                                                                        +

                                                                                        WpCrmInvalidJsonUserInfo.php

                                                                                        + + +
                                                                                        + + + + + + +

                                                                                        + Interfaces, Classes and Traits + +

                                                                                        + +
                                                                                        + +
                                                                                        WpCrmInvalidJsonUserInfo
                                                                                        +
                                                                                        This is thrown when trying to read WP customer from DB json data.
                                                                                        + +
                                                                                        + + + + + + + + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +

                                                                                        Search results

                                                                                        + +
                                                                                        +
                                                                                        +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          + + +
                                                                                          + + + + + + + + diff --git a/documentation/files/src-models-answer.html b/documentation/files/src-models-answer.html new file mode 100644 index 0000000..3ef11b1 --- /dev/null +++ b/documentation/files/src-models-answer.html @@ -0,0 +1,152 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                                          +

                                                                                          CRM V2

                                                                                          + + + + + +
                                                                                          + +
                                                                                          +
                                                                                          + + + + +
                                                                                          +
                                                                                            +
                                                                                          + +
                                                                                          +

                                                                                          Answer.php

                                                                                          + + +
                                                                                          + + + + + + +

                                                                                          + Interfaces, Classes and Traits + +

                                                                                          + +
                                                                                          + +
                                                                                          Answer
                                                                                          +
                                                                                          This class represents an answer +It has a method to submit answers
                                                                                          + +
                                                                                          + + + + + + + + +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          +

                                                                                          Search results

                                                                                          + +
                                                                                          +
                                                                                          +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            + + +
                                                                                            + + + + + + + + diff --git a/documentation/files/src-models-arcadiamaildefault.html b/documentation/files/src-models-arcadiamaildefault.html new file mode 100644 index 0000000..da2f75e --- /dev/null +++ b/documentation/files/src-models-arcadiamaildefault.html @@ -0,0 +1,152 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                                            +

                                                                                            CRM V2

                                                                                            + + + + + +
                                                                                            + +
                                                                                            +
                                                                                            + + + + +
                                                                                            +
                                                                                              +
                                                                                            + +
                                                                                            +

                                                                                            ArcadiaMailDefault.php

                                                                                            + + +
                                                                                            + + + + + + +

                                                                                            + Interfaces, Classes and Traits + +

                                                                                            + +
                                                                                            + +
                                                                                            ArcadiaMailDefault
                                                                                            +
                                                                                            This class represents the customer info with +the account validation status
                                                                                            + +
                                                                                            + + + + + + + + +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            +

                                                                                            Search results

                                                                                            + +
                                                                                            +
                                                                                            +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              + + +
                                                                                              + + + + + + + + diff --git a/documentation/files/src-models-arcadiamailgame.html b/documentation/files/src-models-arcadiamailgame.html new file mode 100644 index 0000000..1a1c378 --- /dev/null +++ b/documentation/files/src-models-arcadiamailgame.html @@ -0,0 +1,152 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                                              +

                                                                                              CRM V2

                                                                                              + + + + + +
                                                                                              + +
                                                                                              +
                                                                                              + + + + +
                                                                                              +
                                                                                                +
                                                                                              + +
                                                                                              +

                                                                                              ArcadiaMailGame.php

                                                                                              + + +
                                                                                              + + + + + + +

                                                                                              + Interfaces, Classes and Traits + +

                                                                                              + +
                                                                                              + +
                                                                                              ArcadiaMailGame
                                                                                              +
                                                                                              This class represents the customer info with +the account validation status
                                                                                              + +
                                                                                              + + + + + + + + +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              +

                                                                                              Search results

                                                                                              + +
                                                                                              +
                                                                                              +
                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                + + +
                                                                                                + + + + + + + + diff --git a/documentation/files/src-models-crmclientmodel.html b/documentation/files/src-models-crmclientmodel.html new file mode 100644 index 0000000..612a8b5 --- /dev/null +++ b/documentation/files/src-models-crmclientmodel.html @@ -0,0 +1,140 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                                                +

                                                                                                CRM V2

                                                                                                + + + + + +
                                                                                                + +
                                                                                                +
                                                                                                + + + + +
                                                                                                +
                                                                                                  +
                                                                                                + +
                                                                                                +

                                                                                                CrmClientModel.php

                                                                                                + + +
                                                                                                + + + + + + + + + + + + + + +
                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                +

                                                                                                Search results

                                                                                                + +
                                                                                                +
                                                                                                +
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  + + +
                                                                                                  + + + + + + + + diff --git a/documentation/files/src-models-customer.html b/documentation/files/src-models-customer.html new file mode 100644 index 0000000..12a8e23 --- /dev/null +++ b/documentation/files/src-models-customer.html @@ -0,0 +1,153 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                                                  +

                                                                                                  CRM V2

                                                                                                  + + + + + +
                                                                                                  + +
                                                                                                  +
                                                                                                  + + + + +
                                                                                                  +
                                                                                                    +
                                                                                                  + +
                                                                                                  +

                                                                                                  Customer.php

                                                                                                  + + +
                                                                                                  + + + + + + +

                                                                                                  + Interfaces, Classes and Traits + +

                                                                                                  + +
                                                                                                  + +
                                                                                                  Customer
                                                                                                  +
                                                                                                  This class represents the customer info with +the account validation status. You can use it as +a standalone class but beware of catching exceptions
                                                                                                  + +
                                                                                                  + + + + + + + + +
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  +

                                                                                                  Search results

                                                                                                  + +
                                                                                                  +
                                                                                                  +
                                                                                                    +
                                                                                                    +
                                                                                                    +
                                                                                                    +
                                                                                                    +
                                                                                                    + + +
                                                                                                    + + + + + + + + diff --git a/documentation/files/src-models-question.html b/documentation/files/src-models-question.html new file mode 100644 index 0000000..1fa880c --- /dev/null +++ b/documentation/files/src-models-question.html @@ -0,0 +1,152 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                                                    +

                                                                                                    CRM V2

                                                                                                    + + + + + +
                                                                                                    + +
                                                                                                    +
                                                                                                    + + + + +
                                                                                                    +
                                                                                                      +
                                                                                                    + +
                                                                                                    +

                                                                                                    Question.php

                                                                                                    + + +
                                                                                                    + + + + + + +

                                                                                                    + Interfaces, Classes and Traits + +

                                                                                                    + +
                                                                                                    + +
                                                                                                    Question
                                                                                                    +
                                                                                                    This class represents a question +It has some static methods to retrieve questions and answers
                                                                                                    + +
                                                                                                    + + + + + + + + +
                                                                                                    +
                                                                                                    +
                                                                                                    +
                                                                                                    +

                                                                                                    Search results

                                                                                                    + +
                                                                                                    +
                                                                                                    +
                                                                                                      +
                                                                                                      +
                                                                                                      +
                                                                                                      +
                                                                                                      +
                                                                                                      + + +
                                                                                                      + + + + + + + + diff --git a/documentation/files/src-models-singleoptin.html b/documentation/files/src-models-singleoptin.html new file mode 100644 index 0000000..47579b5 --- /dev/null +++ b/documentation/files/src-models-singleoptin.html @@ -0,0 +1,151 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                                                      +

                                                                                                      CRM V2

                                                                                                      + + + + + +
                                                                                                      + +
                                                                                                      +
                                                                                                      + + + + +
                                                                                                      +
                                                                                                        +
                                                                                                      + +
                                                                                                      +

                                                                                                      SingleOptin.php

                                                                                                      + + +
                                                                                                      + + + + + + +

                                                                                                      + Interfaces, Classes and Traits + +

                                                                                                      + +
                                                                                                      + +
                                                                                                      SingleOptin
                                                                                                      +
                                                                                                      This class allows to handle single opt in
                                                                                                      + +
                                                                                                      + + + + + + + + +
                                                                                                      +
                                                                                                      +
                                                                                                      +
                                                                                                      +

                                                                                                      Search results

                                                                                                      + +
                                                                                                      +
                                                                                                      +
                                                                                                        +
                                                                                                        +
                                                                                                        +
                                                                                                        +
                                                                                                        +
                                                                                                        + + +
                                                                                                        + + + + + + + + diff --git a/documentation/files/src-models-stats.html b/documentation/files/src-models-stats.html new file mode 100644 index 0000000..9858cca --- /dev/null +++ b/documentation/files/src-models-stats.html @@ -0,0 +1,151 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                                                        +

                                                                                                        CRM V2

                                                                                                        + + + + + +
                                                                                                        + +
                                                                                                        +
                                                                                                        + + + + +
                                                                                                        +
                                                                                                          +
                                                                                                        + +
                                                                                                        +

                                                                                                        Stats.php

                                                                                                        + + +
                                                                                                        + + + + + + +

                                                                                                        + Interfaces, Classes and Traits + +

                                                                                                        + +
                                                                                                        + +
                                                                                                        Stats
                                                                                                        +
                                                                                                        This class is used to get stats from CRM
                                                                                                        + +
                                                                                                        + + + + + + + + +
                                                                                                        +
                                                                                                        +
                                                                                                        +
                                                                                                        +

                                                                                                        Search results

                                                                                                        + +
                                                                                                        +
                                                                                                        +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          + + +
                                                                                                          + + + + + + + + diff --git a/documentation/files/src-transport-apiinterface.html b/documentation/files/src-transport-apiinterface.html new file mode 100644 index 0000000..3dff3ea --- /dev/null +++ b/documentation/files/src-transport-apiinterface.html @@ -0,0 +1,140 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                                                          +

                                                                                                          CRM V2

                                                                                                          + + + + + +
                                                                                                          + +
                                                                                                          +
                                                                                                          + + + + +
                                                                                                          +
                                                                                                            +
                                                                                                          + +
                                                                                                          +

                                                                                                          ApiInterface.php

                                                                                                          + + +
                                                                                                          + + + + + + + + + + + + + + +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          +

                                                                                                          Search results

                                                                                                          + +
                                                                                                          +
                                                                                                          +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            + + +
                                                                                                            + + + + + + + + diff --git a/documentation/files/src-transport-request.html b/documentation/files/src-transport-request.html new file mode 100644 index 0000000..013412c --- /dev/null +++ b/documentation/files/src-transport-request.html @@ -0,0 +1,152 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                                                            +

                                                                                                            CRM V2

                                                                                                            + + + + + +
                                                                                                            + +
                                                                                                            +
                                                                                                            + + + + +
                                                                                                            +
                                                                                                              +
                                                                                                            + +
                                                                                                            +

                                                                                                            Request.php

                                                                                                            + + +
                                                                                                            + + + + + + +

                                                                                                            + Interfaces, Classes and Traits + +

                                                                                                            + +
                                                                                                            + +
                                                                                                            Request
                                                                                                            +
                                                                                                            The LDC CRM request +Contains the http method, the requested url and data to pass
                                                                                                            + +
                                                                                                            + + + + + + + + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +

                                                                                                            Search results

                                                                                                            + +
                                                                                                            +
                                                                                                            +
                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              + + +
                                                                                                              + + + + + + + + diff --git a/documentation/files/src-transport-response.html b/documentation/files/src-transport-response.html new file mode 100644 index 0000000..f261368 --- /dev/null +++ b/documentation/files/src-transport-response.html @@ -0,0 +1,151 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                                                              +

                                                                                                              CRM V2

                                                                                                              + + + + + +
                                                                                                              + +
                                                                                                              +
                                                                                                              + + + + +
                                                                                                              +
                                                                                                                +
                                                                                                              + +
                                                                                                              +

                                                                                                              Response.php

                                                                                                              + + +
                                                                                                              + + + + + + +

                                                                                                              + Interfaces, Classes and Traits + +

                                                                                                              + +
                                                                                                              + +
                                                                                                              Response
                                                                                                              +
                                                                                                              + +
                                                                                                              + + + + + + + + +
                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              +

                                                                                                              Search results

                                                                                                              + +
                                                                                                              +
                                                                                                              +
                                                                                                                +
                                                                                                                +
                                                                                                                +
                                                                                                                +
                                                                                                                +
                                                                                                                + + +
                                                                                                                + + + + + + + + diff --git a/documentation/files/src-utils.html b/documentation/files/src-utils.html new file mode 100644 index 0000000..4d0ea3b --- /dev/null +++ b/documentation/files/src-utils.html @@ -0,0 +1,151 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                                                                +

                                                                                                                CRM V2

                                                                                                                + + + + + +
                                                                                                                + +
                                                                                                                +
                                                                                                                + + + + +
                                                                                                                +
                                                                                                                  +
                                                                                                                + +
                                                                                                                +

                                                                                                                Utils.php

                                                                                                                + + +
                                                                                                                + + + + + + +

                                                                                                                + Interfaces, Classes and Traits + +

                                                                                                                + +
                                                                                                                + +
                                                                                                                Utils
                                                                                                                +
                                                                                                                This is the LDCCRM utility class
                                                                                                                + +
                                                                                                                + + + + + + + + +
                                                                                                                +
                                                                                                                +
                                                                                                                +
                                                                                                                +

                                                                                                                Search results

                                                                                                                + +
                                                                                                                +
                                                                                                                +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  + + +
                                                                                                                  + + + + + + + + diff --git a/documentation/files/src-wordpress-wpcrm.html b/documentation/files/src-wordpress-wpcrm.html new file mode 100644 index 0000000..031f504 --- /dev/null +++ b/documentation/files/src-wordpress-wpcrm.html @@ -0,0 +1,191 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                                                                  +

                                                                                                                  CRM V2

                                                                                                                  + + + + + +
                                                                                                                  + +
                                                                                                                  +
                                                                                                                  + + + + +
                                                                                                                  +
                                                                                                                    +
                                                                                                                  + +
                                                                                                                  +

                                                                                                                  WPCrm.php

                                                                                                                  + +

                                                                                                                  LDCCRM For Wordpress usage

                                                                                                                  + + + +
                                                                                                                  + Tags + +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  + category +
                                                                                                                  +
                                                                                                                  + +

                                                                                                                  API

                                                                                                                  +
                                                                                                                  + +
                                                                                                                  +
                                                                                                                  + author +
                                                                                                                  +
                                                                                                                  + +

                                                                                                                  Jérémy Munsch jeremy.munsch@ldc.fr

                                                                                                                  +
                                                                                                                  + +
                                                                                                                  +
                                                                                                                  + license +
                                                                                                                  +
                                                                                                                  + +

                                                                                                                  MIT https://opensource.org/licenses/MIT

                                                                                                                  +
                                                                                                                  + +
                                                                                                                  +
                                                                                                                  + link +
                                                                                                                  +
                                                                                                                  + / + +
                                                                                                                  +
                                                                                                                  + + + + +

                                                                                                                  + Interfaces, Classes and Traits + +

                                                                                                                  + +
                                                                                                                  + +
                                                                                                                  WPCrm
                                                                                                                  +
                                                                                                                  Class de gestion des users en session avec Wordpress (ce truc immonde)
                                                                                                                  + +
                                                                                                                  + + + + + + + + +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +

                                                                                                                  Search results

                                                                                                                  + +
                                                                                                                  +
                                                                                                                  +
                                                                                                                    +
                                                                                                                    +
                                                                                                                    +
                                                                                                                    +
                                                                                                                    +
                                                                                                                    + + +
                                                                                                                    + + + + + + + + diff --git a/documentation/files/src-wordpress-wpcrmanswer.html b/documentation/files/src-wordpress-wpcrmanswer.html new file mode 100644 index 0000000..7bb8cd6 --- /dev/null +++ b/documentation/files/src-wordpress-wpcrmanswer.html @@ -0,0 +1,191 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                                                                    +

                                                                                                                    CRM V2

                                                                                                                    + + + + + +
                                                                                                                    + +
                                                                                                                    +
                                                                                                                    + + + + +
                                                                                                                    +
                                                                                                                      +
                                                                                                                    + +
                                                                                                                    +

                                                                                                                    WPCrmAnswer.php

                                                                                                                    + +

                                                                                                                    LDCCRM For Wordpress usage

                                                                                                                    + + + +
                                                                                                                    + Tags + +
                                                                                                                    +
                                                                                                                    +
                                                                                                                    + category +
                                                                                                                    +
                                                                                                                    + +

                                                                                                                    API

                                                                                                                    +
                                                                                                                    + +
                                                                                                                    +
                                                                                                                    + author +
                                                                                                                    +
                                                                                                                    + +

                                                                                                                    Jérémy Munsch jeremy.munsch@ldc.fr

                                                                                                                    +
                                                                                                                    + +
                                                                                                                    +
                                                                                                                    + license +
                                                                                                                    +
                                                                                                                    + +

                                                                                                                    MIT https://opensource.org/licenses/MIT

                                                                                                                    +
                                                                                                                    + +
                                                                                                                    +
                                                                                                                    + link +
                                                                                                                    +
                                                                                                                    + / + +
                                                                                                                    +
                                                                                                                    + + + + +

                                                                                                                    + Interfaces, Classes and Traits + +

                                                                                                                    + +
                                                                                                                    + +
                                                                                                                    WPCrmAnswer
                                                                                                                    +
                                                                                                                    Class de gestion de la segmentation question avec Wordpress (ce truc immonde)
                                                                                                                    + +
                                                                                                                    + + + + + + + + +
                                                                                                                    +
                                                                                                                    +
                                                                                                                    +
                                                                                                                    +

                                                                                                                    Search results

                                                                                                                    + +
                                                                                                                    +
                                                                                                                    +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      + + +
                                                                                                                      + + + + + + + + diff --git a/documentation/files/src-wordpress-wpcrmquestion.html b/documentation/files/src-wordpress-wpcrmquestion.html new file mode 100644 index 0000000..92c554a --- /dev/null +++ b/documentation/files/src-wordpress-wpcrmquestion.html @@ -0,0 +1,191 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                                                                      +

                                                                                                                      CRM V2

                                                                                                                      + + + + + +
                                                                                                                      + +
                                                                                                                      +
                                                                                                                      + + + + +
                                                                                                                      +
                                                                                                                        +
                                                                                                                      + +
                                                                                                                      +

                                                                                                                      WPCrmQuestion.php

                                                                                                                      + +

                                                                                                                      LDCCRM For Wordpress usage

                                                                                                                      + + + +
                                                                                                                      + Tags + +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      + category +
                                                                                                                      +
                                                                                                                      + +

                                                                                                                      API

                                                                                                                      +
                                                                                                                      + +
                                                                                                                      +
                                                                                                                      + author +
                                                                                                                      +
                                                                                                                      + +

                                                                                                                      Jérémy Munsch jeremy.munsch@ldc.fr

                                                                                                                      +
                                                                                                                      + +
                                                                                                                      +
                                                                                                                      + license +
                                                                                                                      +
                                                                                                                      + +

                                                                                                                      MIT https://opensource.org/licenses/MIT

                                                                                                                      +
                                                                                                                      + +
                                                                                                                      +
                                                                                                                      + link +
                                                                                                                      +
                                                                                                                      + / + +
                                                                                                                      +
                                                                                                                      + + + + +

                                                                                                                      + Interfaces, Classes and Traits + +

                                                                                                                      + +
                                                                                                                      + +
                                                                                                                      WPCrmQuestion
                                                                                                                      +
                                                                                                                      Class de gestion de la segmentation question avec Wordpress (ce truc immonde)
                                                                                                                      + +
                                                                                                                      + + + + + + + + +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      +

                                                                                                                      Search results

                                                                                                                      + +
                                                                                                                      +
                                                                                                                      +
                                                                                                                        +
                                                                                                                        +
                                                                                                                        +
                                                                                                                        +
                                                                                                                        +
                                                                                                                        + + +
                                                                                                                        + + + + + + + + diff --git a/documentation/files/src-wordpress-wpcrmuser.html b/documentation/files/src-wordpress-wpcrmuser.html new file mode 100644 index 0000000..bc4a864 --- /dev/null +++ b/documentation/files/src-wordpress-wpcrmuser.html @@ -0,0 +1,191 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                                                                        +

                                                                                                                        CRM V2

                                                                                                                        + + + + + +
                                                                                                                        + +
                                                                                                                        +
                                                                                                                        + + + + +
                                                                                                                        +
                                                                                                                          +
                                                                                                                        + +
                                                                                                                        +

                                                                                                                        WPCrmUser.php

                                                                                                                        + +

                                                                                                                        LDCCRM For Wordpress usage

                                                                                                                        + + + +
                                                                                                                        + Tags + +
                                                                                                                        +
                                                                                                                        +
                                                                                                                        + category +
                                                                                                                        +
                                                                                                                        + +

                                                                                                                        API

                                                                                                                        +
                                                                                                                        + +
                                                                                                                        +
                                                                                                                        + author +
                                                                                                                        +
                                                                                                                        + +

                                                                                                                        Jérémy Munsch jeremy.munsch@ldc.fr

                                                                                                                        +
                                                                                                                        + +
                                                                                                                        +
                                                                                                                        + license +
                                                                                                                        +
                                                                                                                        + +

                                                                                                                        MIT https://opensource.org/licenses/MIT

                                                                                                                        +
                                                                                                                        + +
                                                                                                                        +
                                                                                                                        + link +
                                                                                                                        +
                                                                                                                        + / + +
                                                                                                                        +
                                                                                                                        + + + + +

                                                                                                                        + Interfaces, Classes and Traits + +

                                                                                                                        + +
                                                                                                                        + +
                                                                                                                        WPCrmUser
                                                                                                                        +
                                                                                                                        Class de gestion des users en session avec Wordpress (ce truc immonde)
                                                                                                                        + +
                                                                                                                        + + + + + + + + +
                                                                                                                        +
                                                                                                                        +
                                                                                                                        +
                                                                                                                        +

                                                                                                                        Search results

                                                                                                                        + +
                                                                                                                        +
                                                                                                                        +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          + + +
                                                                                                                          + + + + + + + + diff --git a/documentation/graphs/classes.html b/documentation/graphs/classes.html new file mode 100644 index 0000000..9d638db --- /dev/null +++ b/documentation/graphs/classes.html @@ -0,0 +1,117 @@ + + + + + CRM V2 + + + + + + + + +
                                                                                                                          +

                                                                                                                          CRM V2

                                                                                                                          + + + + + +
                                                                                                                          + +
                                                                                                                          +
                                                                                                                          + + + + +
                                                                                                                          +
                                                                                                                          + +
                                                                                                                          + +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          +

                                                                                                                          Search results

                                                                                                                          + +
                                                                                                                          +
                                                                                                                          +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            + + +
                                                                                                                            + + + + + + + + diff --git a/documentation/index.html b/documentation/index.html new file mode 100644 index 0000000..c2a146c --- /dev/null +++ b/documentation/index.html @@ -0,0 +1,145 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                                                                            +

                                                                                                                            CRM V2

                                                                                                                            + + + + + +
                                                                                                                            + +
                                                                                                                            +
                                                                                                                            + + + + +
                                                                                                                            +

                                                                                                                            Documentation

                                                                                                                            + + +

                                                                                                                            + Packages + +

                                                                                                                            + +
                                                                                                                            +
                                                                                                                            LDCCrmClient
                                                                                                                            +
                                                                                                                            None
                                                                                                                            +
                                                                                                                            + +

                                                                                                                            + Namespaces + +

                                                                                                                            + +
                                                                                                                            +
                                                                                                                            LDC
                                                                                                                            +
                                                                                                                            + + + + + + + +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +

                                                                                                                            Search results

                                                                                                                            + +
                                                                                                                            +
                                                                                                                            +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              + + +
                                                                                                                              + + + + + + + + diff --git a/documentation/indices/files.html b/documentation/indices/files.html new file mode 100644 index 0000000..e7538c2 --- /dev/null +++ b/documentation/indices/files.html @@ -0,0 +1,181 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                                                                              +

                                                                                                                              CRM V2

                                                                                                                              + + + + + +
                                                                                                                              + +
                                                                                                                              +
                                                                                                                              + + + + + +
                                                                                                                              + + +
                                                                                                                              + + + + + + + + diff --git a/documentation/js/search.js b/documentation/js/search.js new file mode 100644 index 0000000..093d6d0 --- /dev/null +++ b/documentation/js/search.js @@ -0,0 +1,173 @@ +// Search module for phpDocumentor +// +// This module is a wrapper around fuse.js that will use a given index and attach itself to a +// search form and to a search results pane identified by the following data attributes: +// +// 1. data-search-form +// 2. data-search-results +// +// The data-search-form is expected to have a single input element of type 'search' that will trigger searching for +// a series of results, were the data-search-results pane is expected to have a direct UL child that will be populated +// with rendered results. +// +// The search has various stages, upon loading this stage the data-search-form receives the CSS class +// 'phpdocumentor-search--enabled'; this indicates that JS is allowed and indices are being loaded. It is recommended +// to hide the form by default and show it when it receives this class to achieve progressive enhancement for this +// feature. +// +// After loading this module, it is expected to load a search index asynchronously, for example: +// +// +// +// In this script the generated index should attach itself to the search module using the `appendIndex` function. By +// doing it like this the page will continue loading, unhindered by the loading of the search. +// +// After the page has fully loaded, and all these deferred indexes loaded, the initialization of the search module will +// be called and the form will receive the class 'phpdocumentor-search--active', indicating search is ready. At this +// point, the input field will also have it's 'disabled' attribute removed. +var Search = (function () { + var fuse; + var index = []; + var options = { + shouldSort: true, + threshold: 0.6, + location: 0, + distance: 100, + maxPatternLength: 32, + minMatchCharLength: 1, + keys: [ + "fqsen", + "name", + "summary", + "url" + ] + }; + + // Credit David Walsh (https://davidwalsh.name/javascript-debounce-function) + // Returns a function, that, as long as it continues to be invoked, will not + // be triggered. The function will be called after it stops being called for + // N milliseconds. If `immediate` is passed, trigger the function on the + // leading edge, instead of the trailing. + function debounce(func, wait, immediate) { + var timeout; + + return function executedFunction() { + var context = this; + var args = arguments; + + var later = function () { + timeout = null; + if (!immediate) func.apply(context, args); + }; + + var callNow = immediate && !timeout; + clearTimeout(timeout); + timeout = setTimeout(later, wait); + if (callNow) func.apply(context, args); + }; + } + + function close() { + // Start scroll prevention: https://css-tricks.com/prevent-page-scrolling-when-a-modal-is-open/ + const scrollY = document.body.style.top; + document.body.style.position = ''; + document.body.style.top = ''; + window.scrollTo(0, parseInt(scrollY || '0') * -1); + // End scroll prevention + + var form = document.querySelector('[data-search-form]'); + var searchResults = document.querySelector('[data-search-results]'); + + form.classList.toggle('phpdocumentor-search--has-results', false); + searchResults.classList.add('phpdocumentor-search-results--hidden'); + var searchField = document.querySelector('[data-search-form] input[type="search"]'); + searchField.blur(); + } + + function search(event) { + // Start scroll prevention: https://css-tricks.com/prevent-page-scrolling-when-a-modal-is-open/ + document.body.style.position = 'fixed'; + document.body.style.top = `-${window.scrollY}px`; + // End scroll prevention + + // prevent enter's from autosubmitting + event.stopPropagation(); + + var form = document.querySelector('[data-search-form]'); + var searchResults = document.querySelector('[data-search-results]'); + var searchResultEntries = document.querySelector('[data-search-results] .phpdocumentor-search-results__entries'); + + searchResultEntries.innerHTML = ''; + + if (!event.target.value) { + close(); + return; + } + + form.classList.toggle('phpdocumentor-search--has-results', true); + searchResults.classList.remove('phpdocumentor-search-results--hidden'); + var results = fuse.search(event.target.value, {limit: 25}); + + results.forEach(function (result) { + var entry = document.createElement("li"); + entry.classList.add("phpdocumentor-search-results__entry"); + entry.innerHTML += '

                                                                                                                              ' + result.name + "

                                                                                                                              \n"; + entry.innerHTML += '' + result.fqsen + "\n"; + entry.innerHTML += '
                                                                                                                              ' + result.summary + '
                                                                                                                              '; + searchResultEntries.appendChild(entry) + }); + } + + function appendIndex(added) { + index = index.concat(added); + + // re-initialize search engine when appending an index after initialisation + if (typeof fuse !== 'undefined') { + fuse = new Fuse(index, options); + } + } + + function init() { + fuse = new Fuse(index, options); + + var form = document.querySelector('[data-search-form]'); + var searchField = document.querySelector('[data-search-form] input[type="search"]'); + + var closeButton = document.querySelector('.phpdocumentor-search-results__close'); + closeButton.addEventListener('click', function() { close() }.bind(this)); + + var searchResults = document.querySelector('[data-search-results]'); + searchResults.addEventListener('click', function() { close() }.bind(this)); + + form.classList.add('phpdocumentor-search--active'); + + searchField.setAttribute('placeholder', 'Search (Press "/" to focus)'); + searchField.removeAttribute('disabled'); + searchField.addEventListener('keyup', debounce(search, 300)); + + window.addEventListener('keyup', function (event) { + if (event.key === '/') { + searchField.focus(); + } + if (event.code === 'Escape') { + close(); + } + }.bind(this)); + } + + return { + appendIndex, + init + } +})(); + +window.addEventListener('DOMContentLoaded', function () { + var form = document.querySelector('[data-search-form]'); + + // When JS is supported; show search box. Must be before including the search for it to take effect immediately + form.classList.add('phpdocumentor-search--enabled'); +}); + +window.addEventListener('load', function () { + Search.init(); +}); diff --git a/documentation/js/searchIndex.js b/documentation/js/searchIndex.js new file mode 100644 index 0000000..e52735a --- /dev/null +++ b/documentation/js/searchIndex.js @@ -0,0 +1,1344 @@ +Search.appendIndex( + [ + { + "fqsen": "\\LDC\\LDCCRM\\CrmApiV2", + "name": "CrmApiV2", + "summary": "This\u0020is\u0020the\u0020main\u0020class\u0020to\u0020interact\u0020with\u0020the\u0020CRM", + "url": "classes/LDC-LDCCRM-CrmApiV2.html" + }, { + "fqsen": "\\LDC\\LDCCRM\\CrmApiV2\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "CrmApiV2", + "url": "classes/LDC-LDCCRM-CrmApiV2.html#method___construct" + }, { + "fqsen": "\\LDC\\LDCCRM\\CrmApiV2\u003A\u003Aping\u0028\u0029", + "name": "ping", + "summary": "Use\u0020this\u0020the\u0020ping\u0020the\u0020crm\u0020and\u0020know\u0020its\u0020current\u0020status", + "url": "classes/LDC-LDCCRM-CrmApiV2.html#method_ping" + }, { + "fqsen": "\\LDC\\LDCCRM\\CrmApiV2\u003A\u003AgetCustomerOrNew\u0028\u0029", + "name": "getCustomerOrNew", + "summary": "Get\u0020a\u0020customer\u0020from\u0020its\u0020hashcode\u0020or\u0020email\nIf\u0020it\u0020does\u0020not\u0020exists\u0020a\u0020new\u0020instance\nwill\u0020be\u0020returned.\u0020You\u0020would\u0020have\nto\u0020call\u0020its\u0020save\u0020method\u0020later\u0020on.", + "url": "classes/LDC-LDCCRM-CrmApiV2.html#method_getCustomerOrNew" + }, { + "fqsen": "\\LDC\\LDCCRM\\CrmApiV2\u003A\u003AgetCustomer\u0028\u0029", + "name": "getCustomer", + "summary": "Get\u0020a\u0020customer\u0020from\u0020its\u0020hashcode\u0020or\u0020email\nIf\u0020it\u0020does\u0020not\u0020exists\u0020a\u0020new\u0020instance\nwill\u0020be\u0020returned.\u0020You\u0020would\u0020have\nto\u0020call\u0020its\u0020save\u0020method\u0020later\u0020on.", + "url": "classes/LDC-LDCCRM-CrmApiV2.html#method_getCustomer" + }, { + "fqsen": "\\LDC\\LDCCRM\\CrmApiV2\u003A\u003AsetStatus\u0028\u0029", + "name": "setStatus", + "summary": "Set\u0020the\u0020single\u0020optin\u0020status\u0020for\u0020an\u0020email", + "url": "classes/LDC-LDCCRM-CrmApiV2.html#method_setStatus" + }, { + "fqsen": "\\LDC\\LDCCRM\\CrmApiV2\u003A\u003Alogin\u0028\u0029", + "name": "login", + "summary": "Test\u0020a\u0020customer\u0020credentials\u0020to\u0020see\u0020if\u0020it\u0020can\u0020login", + "url": "classes/LDC-LDCCRM-CrmApiV2.html#method_login" + }, { + "fqsen": "\\LDC\\LDCCRM\\CrmApiV2\u003A\u003A\u0024apiInterface", + "name": "apiInterface", + "summary": "The\u0020Api\u0020object\u0020that\u0020will\u0020handle\u0020requests\u0020and\u0020responses", + "url": "classes/LDC-LDCCRM-CrmApiV2.html#property_apiInterface" + }, { + "fqsen": "\\LDC\\LDCCRM\\Enums\\ApiError", + "name": "ApiError", + "summary": "This\u0020describes\u0020an\u0020API\u0020error.", + "url": "classes/LDC-LDCCRM-Enums-ApiError.html" + }, { + "fqsen": "\\LDC\\LDCCRM\\Enums\\ApiError\u003A\u003Avalues\u0028\u0029", + "name": "values", + "summary": "Valeurs\u0020des\u0020possibilit\u00E9s\u0020de\u0020cet\u0020\u00E9num\u00E9ration\u0020\u0028value\u0029", + "url": "classes/LDC-LDCCRM-Enums-ApiError.html#method_values" + }, { + "fqsen": "\\LDC\\LDCCRM\\Enums\\ApiError\u003A\u003Alabels\u0028\u0029", + "name": "labels", + "summary": "Libell\u00E9s\u0020des\u0020possibilit\u00E9s\u0020de\u0020cet\u0020\u00E9num\u00E9ration\u0020\u0028label\u0029", + "url": "classes/LDC-LDCCRM-Enums-ApiError.html#method_labels" + }, { + "fqsen": "\\LDC\\LDCCRM\\Enums\\ApiStatus", + "name": "ApiStatus", + "summary": "", + "url": "classes/LDC-LDCCRM-Enums-ApiStatus.html" + }, { + "fqsen": "\\LDC\\LDCCRM\\Enums\\ArcadiaMailType", + "name": "ArcadiaMailType", + "summary": "", + "url": "classes/LDC-LDCCRM-Enums-ArcadiaMailType.html" + }, { + "fqsen": "\\LDC\\LDCCRM\\Enums\\ArcadiaMailType\u003A\u003Avalues\u0028\u0029", + "name": "values", + "summary": "Valeurs\u0020des\u0020possibilit\u00E9s\u0020de\u0020cet\u0020\u00E9num\u00E9ration\u0020\u0028value\u0029", + "url": "classes/LDC-LDCCRM-Enums-ArcadiaMailType.html#method_values" + }, { + "fqsen": "\\LDC\\LDCCRM\\Enums\\ArcadiaOrderType", + "name": "ArcadiaOrderType", + "summary": "", + "url": "classes/LDC-LDCCRM-Enums-ArcadiaOrderType.html" + }, { + "fqsen": "\\LDC\\LDCCRM\\Enums\\ArcadiaOrderType\u003A\u003Avalues\u0028\u0029", + "name": "values", + "summary": "Valeurs\u0020des\u0020possibilit\u00E9s\u0020de\u0020cet\u0020\u00E9num\u00E9ration\u0020\u0028value\u0029", + "url": "classes/LDC-LDCCRM-Enums-ArcadiaOrderType.html#method_values" + }, { + "fqsen": "\\LDC\\LDCCRM\\Enums\\Country", + "name": "Country", + "summary": "Liste\u0020de\u0020Pays", + "url": "classes/LDC-LDCCRM-Enums-Country.html" + }, { + "fqsen": "\\LDC\\LDCCRM\\Enums\\Country\u003A\u003Avalues\u0028\u0029", + "name": "values", + "summary": "Valeurs\u0020des\u0020possibilit\u00E9s\u0020de\u0020cet\u0020\u00E9num\u00E9ration\u0020\u0028value\u0029", + "url": "classes/LDC-LDCCRM-Enums-Country.html#method_values" + }, { + "fqsen": "\\LDC\\LDCCRM\\Enums\\Country\u003A\u003Alabels\u0028\u0029", + "name": "labels", + "summary": "Libell\u00E9s\u0020des\u0020possibilit\u00E9s\u0020de\u0020cet\u0020\u00E9num\u00E9ration\u0020\u0028label\u0029", + "url": "classes/LDC-LDCCRM-Enums-Country.html#method_labels" + }, { + "fqsen": "\\LDC\\LDCCRM\\Enums\\LogLevel", + "name": "LogLevel", + "summary": "", + "url": "classes/LDC-LDCCRM-Enums-LogLevel.html" + }, { + "fqsen": "\\LDC\\LDCCRM\\Enums\\LogLevel\u003A\u003Avalues\u0028\u0029", + "name": "values", + "summary": "Valeurs\u0020des\u0020possibilit\u00E9s\u0020de\u0020cet\u0020\u00E9num\u00E9ration\u0020\u0028value\u0029", + "url": "classes/LDC-LDCCRM-Enums-LogLevel.html#method_values" + }, { + "fqsen": "\\LDC\\LDCCRM\\Enums\\QuestionType", + "name": "QuestionType", + "summary": "", + "url": "classes/LDC-LDCCRM-Enums-QuestionType.html" + }, { + "fqsen": "\\LDC\\LDCCRM\\Enums\\QuestionType\u003A\u003Avalues\u0028\u0029", + "name": "values", + "summary": "Valeurs\u0020des\u0020possibilit\u00E9s\u0020de\u0020cet\u0020\u00E9num\u00E9ration\u0020\u0028value\u0029", + "url": "classes/LDC-LDCCRM-Enums-QuestionType.html#method_values" + }, { + "fqsen": "\\LDC\\LDCCRM\\Exceptions\\ApiErrorException", + "name": "ApiErrorException", + "summary": "This\u0020would\u0020be\u0020thrown\u0020if\u0020any\u0020of\u0020the\u0020case\nreferenced\u0020in\u0020\\LDC\\LDCCRM\\Enums\\ApiError\u0020would\noccur\u0020within\u0020the\u0020crm", + "url": "classes/LDC-LDCCRM-Exceptions-ApiErrorException.html" + }, { + "fqsen": "\\LDC\\LDCCRM\\Exceptions\\ApiErrorException\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Create\u0020a\u0020new\u0020exception\u0020base\u0020on\u0020ApiError\u0020enum.", + "url": "classes/LDC-LDCCRM-Exceptions-ApiErrorException.html#method___construct" + }, { + "fqsen": "\\LDC\\LDCCRM\\Exceptions\\ApiErrorException\u003A\u003AgetApiError\u0028\u0029", + "name": "getApiError", + "summary": "Get\u0020the\u0020Api\u0020Error", + "url": "classes/LDC-LDCCRM-Exceptions-ApiErrorException.html#method_getApiError" + }, { + "fqsen": "\\LDC\\LDCCRM\\Exceptions\\ApiErrorException\u003A\u003AgetStatusCode\u0028\u0029", + "name": "getStatusCode", + "summary": "Get\u0020the\u0020http\u0020code", + "url": "classes/LDC-LDCCRM-Exceptions-ApiErrorException.html#method_getStatusCode" + }, { + "fqsen": "\\LDC\\LDCCRM\\Exceptions\\ApiErrorException\u003A\u003Areport\u0028\u0029", + "name": "report", + "summary": "This\u0020is\u0020used\u0020by\u0020laravel\u0020only.", + "url": "classes/LDC-LDCCRM-Exceptions-ApiErrorException.html#method_report" + }, { + "fqsen": "\\LDC\\LDCCRM\\Exceptions\\ApiErrorException\u003A\u003A\u0024error", + "name": "error", + "summary": "Api\u0020Error\nThis\u0020value\u0020makes\u0020the\u0020error\u0020more\u0020explicit.", + "url": "classes/LDC-LDCCRM-Exceptions-ApiErrorException.html#property_error" + }, { + "fqsen": "\\LDC\\LDCCRM\\Exceptions\\ApiErrorException\u003A\u003A\u0024message", + "name": "message", + "summary": "This\u0020is\u0020an\u0020explicit\u0020error\u0020message,\nou\u0020may\u0020print\u0020this\u0020to\u0020the\u0020front\u0020or\u0020not\u0020depending\non\u0020\u0024error\u0020value", + "url": "classes/LDC-LDCCRM-Exceptions-ApiErrorException.html#property_message" + }, { + "fqsen": "\\LDC\\LDCCRM\\Exceptions\\ApiErrorException\u003A\u003A\u0024httpCode", + "name": "httpCode", + "summary": "This\u0020is\u0020the\u0020http\u0020code\u0020returned\u0020by\u0020the\u0020crm.", + "url": "classes/LDC-LDCCRM-Exceptions-ApiErrorException.html#property_httpCode" + }, { + "fqsen": "\\LDC\\LDCCRM\\Exceptions\\CrmException", + "name": "CrmException", + "summary": "This\u0020is\u0020a\u0020critical\u0020error.", + "url": "classes/LDC-LDCCRM-Exceptions-CrmException.html" + }, { + "fqsen": "\\LDC\\LDCCRM\\Exceptions\\CrmException\u003A\u003Areport\u0028\u0029", + "name": "report", + "summary": "This\u0020is\u0020used\u0020by\u0020laravel\u0020only.", + "url": "classes/LDC-LDCCRM-Exceptions-CrmException.html#method_report" + }, { + "fqsen": "\\LDC\\LDCCRM\\Exceptions\\ValidationException", + "name": "ValidationException", + "summary": "This\u0020would\u0020be\u0020thrown\u0020if\u0020a\u0020data\u0020could\u0020not\u0020be\u0020validated\non\u0020any\u0020models", + "url": "classes/LDC-LDCCRM-Exceptions-ValidationException.html" + }, { + "fqsen": "\\LDC\\LDCCRM\\Exceptions\\ValidationException\u003A\u003Areport\u0028\u0029", + "name": "report", + "summary": "This\u0020is\u0020used\u0020by\u0020laravel\u0020only.", + "url": "classes/LDC-LDCCRM-Exceptions-ValidationException.html#method_report" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Answer", + "name": "Answer", + "summary": "This\u0020class\u0020represents\u0020an\u0020answer\nIt\u0020has\u0020a\u0020method\u0020to\u0020submit\u0020answers", + "url": "classes/LDC-LDCCRM-Models-Answer.html" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Answer\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Answer", + "url": "classes/LDC-LDCCRM-Models-Answer.html#method___construct" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Answer\u003A\u003AsetQuestionAnswers\u0028\u0029", + "name": "setQuestionAnswers", + "summary": "Set\u0020unanswered\u0020question\u0020for\u0020a\u0020specific\u0020customer", + "url": "classes/LDC-LDCCRM-Models-Answer.html#method_setQuestionAnswers" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Answer\u003A\u003AjsonSerialize\u0028\u0029", + "name": "jsonSerialize", + "summary": "Serialize\u0020this\u0020object\u0020to\u0020an\u0020array", + "url": "classes/LDC-LDCCRM-Models-Answer.html#method_jsonSerialize" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Answer\u003A\u003A\u0024id", + "name": "id", + "summary": "The\u0020question\u0020id", + "url": "classes/LDC-LDCCRM-Models-Answer.html#property_id" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Answer\u003A\u003A\u0024answer", + "name": "answer", + "summary": "The\u0020actual\u0020answer\u0020as\u0020a\u0020string", + "url": "classes/LDC-LDCCRM-Models-Answer.html#property_answer" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Answer\u003A\u003A\u0024modelFields", + "name": "modelFields", + "summary": "The\u0020crm\u0020customer\u0020fields", + "url": "classes/LDC-LDCCRM-Models-Answer.html#property_modelFields" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Answer\u003A\u003A\u0024validation", + "name": "validation", + "summary": "Validation\u0020rules", + "url": "classes/LDC-LDCCRM-Models-Answer.html#property_validation" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailDefault", + "name": "ArcadiaMailDefault", + "summary": "This\u0020class\u0020represents\u0020the\u0020customer\u0020info\u0020with\nthe\u0020account\u0020validation\u0020status", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailDefault.html" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailDefault\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "ArcadiaMailDefault", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailDefault.html#method___construct" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailDefault\u003A\u003A__get\u0028\u0029", + "name": "__get", + "summary": "Generic\u0020accessor", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailDefault.html#method___get" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailDefault\u003A\u003A__set\u0028\u0029", + "name": "__set", + "summary": "Set\u0020prop", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailDefault.html#method___set" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailDefault\u003A\u003Afill\u0028\u0029", + "name": "fill", + "summary": "Fill\u0020data\u0020into\u0020this\u0020model\nusing\u0020validation\u0020rules", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailDefault.html#method_fill" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailDefault\u003A\u003AvalidateAllValues\u0028\u0029", + "name": "validateAllValues", + "summary": "Validate\u0020all\u0020model\u0020properties", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailDefault.html#method_validateAllValues" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailDefault\u003A\u003Asend\u0028\u0029", + "name": "send", + "summary": "Send\u0020The\u0020actual\u0020mail", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailDefault.html#method_send" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailDefault\u003A\u003AjsonSerialize\u0028\u0029", + "name": "jsonSerialize", + "summary": "Serialize\u0020this\u0020object\u0020to\u0020an\u0020array", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailDefault.html#method_jsonSerialize" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailDefault\u003A\u003A\u0024email", + "name": "email", + "summary": "An\u0020RFC\u0020Valid\u0020Email", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailDefault.html#property_email" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailDefault\u003A\u003A\u0024firstname", + "name": "firstname", + "summary": "First\u0020name", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailDefault.html#property_firstname" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailDefault\u003A\u003A\u0024lastname", + "name": "lastname", + "summary": "Last\u0020name", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailDefault.html#property_lastname" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailDefault\u003A\u003A\u0024phone", + "name": "phone", + "summary": "The\u0020user\u0020phone", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailDefault.html#property_phone" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailDefault\u003A\u003A\u0024address", + "name": "address", + "summary": "The\u0020user\u0020address\u0020\u0028street\u0020number,\u0020name,\u0020etc\u0029", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailDefault.html#property_address" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailDefault\u003A\u003A\u0024address2", + "name": "address2", + "summary": "The\u0020user\u0020address\u00202nd\u0020part\u0020\u0028street\u0020number,\u0020name,\u0020more,\u0020etc\u0029", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailDefault.html#property_address2" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailDefault\u003A\u003A\u0024city", + "name": "city", + "summary": "The\u0020user\u0020address\u0020city", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailDefault.html#property_city" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailDefault\u003A\u003A\u0024postcode", + "name": "postcode", + "summary": "The\u0020user\u0020address\u0020postcode", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailDefault.html#property_postcode" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailDefault\u003A\u003A\u0024operation", + "name": "operation", + "summary": "The\u0020arcadia\u0020operation\u0020code", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailDefault.html#property_operation" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailDefault\u003A\u003A\u0024support_code", + "name": "support_code", + "summary": "The\u0020arcadia\u0020support\u0020code", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailDefault.html#property_support_code" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailDefault\u003A\u003A\u0024label_type_support", + "name": "label_type_support", + "summary": "The\u0020arcadia\u0020type\u0020support\u0020label", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailDefault.html#property_label_type_support" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailDefault\u003A\u003A\u0024order_date", + "name": "order_date", + "summary": "The\u0020arcadia\u0020order\u0020date", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailDefault.html#property_order_date" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailDefault\u003A\u003A\u0024order_num", + "name": "order_num", + "summary": "The\u0020arcadia\u0020order\u0020number", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailDefault.html#property_order_num" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailDefault\u003A\u003A\u0024state_order", + "name": "state_order", + "summary": "The\u0020arcadia\u0020state\u0020order", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailDefault.html#property_state_order" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailDefault\u003A\u003A\u0024package_unit_weight", + "name": "package_unit_weight", + "summary": "The\u0020arcadia\u0020package\u0020unit\u0020weight", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailDefault.html#property_package_unit_weight" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailDefault\u003A\u003A\u0024modelFields", + "name": "modelFields", + "summary": "The\u0020crm\u0020customer\u0020fields", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailDefault.html#property_modelFields" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailDefault\u003A\u003A\u0024validation", + "name": "validation", + "summary": "Validation\u0020rules", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailDefault.html#property_validation" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailGame", + "name": "ArcadiaMailGame", + "summary": "This\u0020class\u0020represents\u0020the\u0020customer\u0020info\u0020with\nthe\u0020account\u0020validation\u0020status", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailGame.html" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailGame\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "ArcadiaMailGame", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailGame.html#method___construct" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailGame\u003A\u003A__set\u0028\u0029", + "name": "__set", + "summary": "Set\u0020prop", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailGame.html#method___set" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailGame\u003A\u003Afill\u0028\u0029", + "name": "fill", + "summary": "Fill\u0020data\u0020into\u0020this\u0020model\nusing\u0020validation\u0020rules", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailGame.html#method_fill" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailGame\u003A\u003Asend\u0028\u0029", + "name": "send", + "summary": "Send\u0020The\u0020actual\u0020mail", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailGame.html#method_send" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailGame\u003A\u003AjsonSerialize\u0028\u0029", + "name": "jsonSerialize", + "summary": "Serialize\u0020this\u0020object\u0020to\u0020an\u0020array", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailGame.html#method_jsonSerialize" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailGame\u003A\u003A\u0024email", + "name": "email", + "summary": "An\u0020RFC\u0020Valid\u0020Email", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailGame.html#property_email" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailGame\u003A\u003A\u0024firstname", + "name": "firstname", + "summary": "First\u0020name", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailGame.html#property_firstname" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailGame\u003A\u003A\u0024lastname", + "name": "lastname", + "summary": "Last\u0020name", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailGame.html#property_lastname" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailGame\u003A\u003A\u0024phone", + "name": "phone", + "summary": "The\u0020user\u0020phone", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailGame.html#property_phone" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailGame\u003A\u003A\u0024address", + "name": "address", + "summary": "The\u0020user\u0020address\u0020\u0028street\u0020number,\u0020name,\u0020etc\u0029", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailGame.html#property_address" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailGame\u003A\u003A\u0024address2", + "name": "address2", + "summary": "The\u0020user\u0020address\u00202nd\u0020part\u0020\u0028street\u0020number,\u0020name,\u0020more,\u0020etc\u0029", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailGame.html#property_address2" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailGame\u003A\u003A\u0024city", + "name": "city", + "summary": "The\u0020user\u0020address\u0020city", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailGame.html#property_city" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailGame\u003A\u003A\u0024postcode", + "name": "postcode", + "summary": "The\u0020user\u0020address\u0020postcode", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailGame.html#property_postcode" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailGame\u003A\u003A\u0024operation", + "name": "operation", + "summary": "The\u0020arcadia\u0020operation\u0020code", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailGame.html#property_operation" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailGame\u003A\u003A\u0024support_code", + "name": "support_code", + "summary": "The\u0020arcadia\u0020support\u0020code", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailGame.html#property_support_code" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailGame\u003A\u003A\u0024label_type_support", + "name": "label_type_support", + "summary": "The\u0020arcadia\u0020type\u0020support\u0020label", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailGame.html#property_label_type_support" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailGame\u003A\u003A\u0024order_date", + "name": "order_date", + "summary": "The\u0020arcadia\u0020order\u0020date", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailGame.html#property_order_date" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailGame\u003A\u003A\u0024code_unique", + "name": "code_unique", + "summary": "The\u0020arcadia\u0020code\u0020unique", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailGame.html#property_code_unique" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailGame\u003A\u003A\u0024code_on_pack", + "name": "code_on_pack", + "summary": "The\u0020arcadia\u0020code\u0020on\u0020pack", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailGame.html#property_code_on_pack" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailGame\u003A\u003A\u0024modelFields", + "name": "modelFields", + "summary": "The\u0020crm\u0020customer\u0020fields", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailGame.html#property_modelFields" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\ArcadiaMailGame\u003A\u003A\u0024validation", + "name": "validation", + "summary": "Validation\u0020rules", + "url": "classes/LDC-LDCCRM-Models-ArcadiaMailGame.html#property_validation" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Customer", + "name": "Customer", + "summary": "This\u0020class\u0020represents\u0020the\u0020customer\u0020info\u0020with\nthe\u0020account\u0020validation\u0020status.\u0020You\u0020can\u0020use\u0020it\u0020as\na\u0020standalone\u0020class\u0020but\u0020beware\u0020of\u0020catching\u0020exceptions", + "url": "classes/LDC-LDCCRM-Models-Customer.html" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Customer\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Customer", + "url": "classes/LDC-LDCCRM-Models-Customer.html#method___construct" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Customer\u003A\u003A__get\u0028\u0029", + "name": "__get", + "summary": "Generic\u0020accessor", + "url": "classes/LDC-LDCCRM-Models-Customer.html#method___get" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Customer\u003A\u003A__set\u0028\u0029", + "name": "__set", + "summary": "Set\u0020prop\u0020on\u0020the\u0020model.", + "url": "classes/LDC-LDCCRM-Models-Customer.html#method___set" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Customer\u003A\u003Afill\u0028\u0029", + "name": "fill", + "summary": "Fill\u0020values\u0020into\u0020model\u0020using\u0020validation\u0020rules.", + "url": "classes/LDC-LDCCRM-Models-Customer.html#method_fill" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Customer\u003A\u003AvalidateAllValues\u0028\u0029", + "name": "validateAllValues", + "summary": "Validate\u0020all\u0020model\u0020properties", + "url": "classes/LDC-LDCCRM-Models-Customer.html#method_validateAllValues" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Customer\u003A\u003Afind\u0028\u0029", + "name": "find", + "summary": "Find\u0020a\u0020customer\u0020using\u0020its\u0020hashcode\u0020in\u0020the\u0020crm", + "url": "classes/LDC-LDCCRM-Models-Customer.html#method_find" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Customer\u003A\u003AfindWithEmail\u0028\u0029", + "name": "findWithEmail", + "summary": "Find\u0020a\u0020customer\u0020using\u0020its\u0020email\u0020in\u0020the\u0020crm\nThis\u0020is\u0020an\u0020alias\u0020of\u0020Customer\u003A\u003Afind\u0028\u0029", + "url": "classes/LDC-LDCCRM-Models-Customer.html#method_findWithEmail" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Customer\u003A\u003Asave\u0028\u0029", + "name": "save", + "summary": "Save\u0020the\u0020customer\u0020on\u0020CRM.", + "url": "classes/LDC-LDCCRM-Models-Customer.html#method_save" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Customer\u003A\u003Astore\u0028\u0029", + "name": "store", + "summary": "Calls\u0020api\u0020store\u0020customer\u0020method", + "url": "classes/LDC-LDCCRM-Models-Customer.html#method_store" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Customer\u003A\u003Aupdate\u0028\u0029", + "name": "update", + "summary": "Calls\u0020api\u0020update\u0020customer\u0020method", + "url": "classes/LDC-LDCCRM-Models-Customer.html#method_update" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Customer\u003A\u003Adelete\u0028\u0029", + "name": "delete", + "summary": "Removes\u0020the\u0020customer\u0020from\u0020CRM.", + "url": "classes/LDC-LDCCRM-Models-Customer.html#method_delete" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Customer\u003A\u003Aactivate\u0028\u0029", + "name": "activate", + "summary": "Active\u0020the\u0020customer\u0020on\u0020CRM.", + "url": "classes/LDC-LDCCRM-Models-Customer.html#method_activate" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Customer\u003A\u003AtoggleOptin\u0028\u0029", + "name": "toggleOptin", + "summary": "Toggle\u0020the\u0020account\u0020optin\u0020value\u0020in\u0020the\u0020crm", + "url": "classes/LDC-LDCCRM-Models-Customer.html#method_toggleOptin" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Customer\u003A\u003Alogin\u0028\u0029", + "name": "login", + "summary": "Test\u0020customer\u0020credentials", + "url": "classes/LDC-LDCCRM-Models-Customer.html#method_login" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Customer\u003A\u003AjsonSerialize\u0028\u0029", + "name": "jsonSerialize", + "summary": "Serialize\u0020this\u0020object\u0020to\u0020an\u0020array", + "url": "classes/LDC-LDCCRM-Models-Customer.html#method_jsonSerialize" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Customer\u003A\u003A\u0024hashcode", + "name": "hashcode", + "summary": "The\u0020user\u0020hashcode,\u0020this\u0020is\u0020link\u0020with\u0020the\u0020customer\u0020and\u0020the\u0020brand\u0020it\u0020is\u0020related\u0020to\nIt\u0020is\u0020used\u0020to\u0020identify\u0020the\u0020customer\u0020itself.", + "url": "classes/LDC-LDCCRM-Models-Customer.html#property_hashcode" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Customer\u003A\u003A\u0024email", + "name": "email", + "summary": "An\u0020RFC\u0020Valid\u0020Email", + "url": "classes/LDC-LDCCRM-Models-Customer.html#property_email" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Customer\u003A\u003A\u0024password", + "name": "password", + "summary": "The\u0020user\u0020password\nThis\u0020is\u0020set\u0020only\u0020when\u0020creating\u0020a\u0020user\nOtherwise\u0020it\u0020has\u0020to\u0020be\u0020set\u0020to\u0020null", + "url": "classes/LDC-LDCCRM-Models-Customer.html#property_password" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Customer\u003A\u003A\u0024firstname", + "name": "firstname", + "summary": "First\u0020name", + "url": "classes/LDC-LDCCRM-Models-Customer.html#property_firstname" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Customer\u003A\u003A\u0024lastname", + "name": "lastname", + "summary": "Last\u0020name", + "url": "classes/LDC-LDCCRM-Models-Customer.html#property_lastname" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Customer\u003A\u003A\u0024birth_date", + "name": "birth_date", + "summary": "Birth\u0020date", + "url": "classes/LDC-LDCCRM-Models-Customer.html#property_birth_date" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Customer\u003A\u003A\u0024phone", + "name": "phone", + "summary": "The\u0020user\u0020phone", + "url": "classes/LDC-LDCCRM-Models-Customer.html#property_phone" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Customer\u003A\u003A\u0024address", + "name": "address", + "summary": "The\u0020user\u0020address\u0020\u0028street\u0020number,\u0020name,\u0020etc\u0029", + "url": "classes/LDC-LDCCRM-Models-Customer.html#property_address" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Customer\u003A\u003A\u0024address2", + "name": "address2", + "summary": "The\u0020user\u0020address\u00202nd\u0020part\u0020\u0028street\u0020number,\u0020name,\u0020more,\u0020etc\u0029", + "url": "classes/LDC-LDCCRM-Models-Customer.html#property_address2" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Customer\u003A\u003A\u0024city", + "name": "city", + "summary": "The\u0020user\u0020address\u0020city", + "url": "classes/LDC-LDCCRM-Models-Customer.html#property_city" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Customer\u003A\u003A\u0024postcode", + "name": "postcode", + "summary": "The\u0020user\u0020address\u0020postcode", + "url": "classes/LDC-LDCCRM-Models-Customer.html#property_postcode" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Customer\u003A\u003A\u0024country", + "name": "country", + "summary": "The\u0020user\u0020address\u0020postcode", + "url": "classes/LDC-LDCCRM-Models-Customer.html#property_country" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Customer\u003A\u003A\u0024opt_in", + "name": "opt_in", + "summary": "The\u0020user\u0020optin\u0020choice", + "url": "classes/LDC-LDCCRM-Models-Customer.html#property_opt_in" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Customer\u003A\u003A\u0024status", + "name": "status", + "summary": "Is\u0020the\u0020account\u0020activated\u0020\u003F", + "url": "classes/LDC-LDCCRM-Models-Customer.html#property_status" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Customer\u003A\u003A\u0024last_connection", + "name": "last_connection", + "summary": "The\u0020last\u0020time\u0020the\u0020account\u0020was\u0020connected", + "url": "classes/LDC-LDCCRM-Models-Customer.html#property_last_connection" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Customer\u003A\u003A\u0024modelFields", + "name": "modelFields", + "summary": "The\u0020crm\u0020customer\u0020fields", + "url": "classes/LDC-LDCCRM-Models-Customer.html#property_modelFields" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Customer\u003A\u003A\u0024invisibleFields", + "name": "invisibleFields", + "summary": "The\u0020crm\u0020customer\u0020fields\nthe\u0020should\u0020not\u0020be\u0020visible", + "url": "classes/LDC-LDCCRM-Models-Customer.html#property_invisibleFields" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Customer\u003A\u003A\u0024validation", + "name": "validation", + "summary": "Validation\u0020rules", + "url": "classes/LDC-LDCCRM-Models-Customer.html#property_validation" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Question", + "name": "Question", + "summary": "This\u0020class\u0020represents\u0020a\u0020question\nIt\u0020has\u0020some\u0020static\u0020methods\u0020to\u0020retrieve\u0020questions\u0020and\u0020answers", + "url": "classes/LDC-LDCCRM-Models-Question.html" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Question\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Question", + "url": "classes/LDC-LDCCRM-Models-Question.html#method___construct" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Question\u003A\u003A__get\u0028\u0029", + "name": "__get", + "summary": "General\u0020accessor", + "url": "classes/LDC-LDCCRM-Models-Question.html#method___get" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Question\u003A\u003A__set\u0028\u0029", + "name": "__set", + "summary": "Set\u0020prop\u0020on\u0020the\u0020model.", + "url": "classes/LDC-LDCCRM-Models-Question.html#method___set" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Question\u003A\u003Afill\u0028\u0029", + "name": "fill", + "summary": "Fill\u0020values\u0020into\u0020model\u0020using\u0020validation\u0020rules.", + "url": "classes/LDC-LDCCRM-Models-Question.html#method_fill" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Question\u003A\u003AvalidateAllValues\u0028\u0029", + "name": "validateAllValues", + "summary": "Validate\u0020all\u0020model\u0020properties", + "url": "classes/LDC-LDCCRM-Models-Question.html#method_validateAllValues" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Question\u003A\u003Aall\u0028\u0029", + "name": "all", + "summary": "Get\u0020all\u0020questions\u0020only", + "url": "classes/LDC-LDCCRM-Models-Question.html#method_all" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Question\u003A\u003AallWithCustomerAnswers\u0028\u0029", + "name": "allWithCustomerAnswers", + "summary": "Get\u0020all\u0020the\u0020questions\u0020with\u0020customer\u0020answers", + "url": "classes/LDC-LDCCRM-Models-Question.html#method_allWithCustomerAnswers" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Question\u003A\u003AunansweredBy\u0028\u0029", + "name": "unansweredBy", + "summary": "Get\u0020unanswered\u0020question\u0020for\u0020a\u0020specific\u0020customer", + "url": "classes/LDC-LDCCRM-Models-Question.html#method_unansweredBy" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Question\u003A\u003AjsonSerialize\u0028\u0029", + "name": "jsonSerialize", + "summary": "Serialize\u0020this\u0020object\u0020to\u0020an\u0020array", + "url": "classes/LDC-LDCCRM-Models-Question.html#method_jsonSerialize" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Question\u003A\u003A\u0024id", + "name": "id", + "summary": "The\u0020question\u0020id", + "url": "classes/LDC-LDCCRM-Models-Question.html#property_id" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Question\u003A\u003A\u0024question", + "name": "question", + "summary": "The\u0020actual\u0020question\u0020as\u0020a\u0020string", + "url": "classes/LDC-LDCCRM-Models-Question.html#property_question" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Question\u003A\u003A\u0024type", + "name": "type", + "summary": "The\u0020question\u0020type", + "url": "classes/LDC-LDCCRM-Models-Question.html#property_type" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Question\u003A\u003A\u0024answers", + "name": "answers", + "summary": "The\u0020question\u0020answers", + "url": "classes/LDC-LDCCRM-Models-Question.html#property_answers" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Question\u003A\u003A\u0024modelFields", + "name": "modelFields", + "summary": "The\u0020crm\u0020customer\u0020fields", + "url": "classes/LDC-LDCCRM-Models-Question.html#property_modelFields" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Question\u003A\u003A\u0024validation", + "name": "validation", + "summary": "Validation\u0020rules", + "url": "classes/LDC-LDCCRM-Models-Question.html#property_validation" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\SingleOptin", + "name": "SingleOptin", + "summary": "This\u0020class\u0020allows\u0020to\u0020handle\u0020single\u0020opt\u0020in", + "url": "classes/LDC-LDCCRM-Models-SingleOptin.html" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\SingleOptin\u003A\u003AsetStatus\u0028\u0029", + "name": "setStatus", + "summary": "Set\u0020the\u0020single\u0020opt\u0020in\u0020status\u0020for\u0020an\u0020email", + "url": "classes/LDC-LDCCRM-Models-SingleOptin.html#method_setStatus" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\SingleOptin\u003A\u003A\u0024validation", + "name": "validation", + "summary": "Validation\u0020rules", + "url": "classes/LDC-LDCCRM-Models-SingleOptin.html#property_validation" + }, { + "fqsen": "\\LDC\\LDCCRM\\Transport\\Request", + "name": "Request", + "summary": "The\u0020LDC\u0020CRM\u0020request\nContains\u0020the\u0020http\u0020method,\u0020the\u0020requested\u0020url\u0020and\u0020data\u0020to\u0020pass", + "url": "classes/LDC-LDCCRM-Transport-Request.html" + }, { + "fqsen": "\\LDC\\LDCCRM\\Transport\\Request\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Request", + "url": "classes/LDC-LDCCRM-Transport-Request.html#method___construct" + }, { + "fqsen": "\\LDC\\LDCCRM\\Transport\\Request\u003A\u003A__get\u0028\u0029", + "name": "__get", + "summary": "Generic\u0020accessor", + "url": "classes/LDC-LDCCRM-Transport-Request.html#method___get" + }, { + "fqsen": "\\LDC\\LDCCRM\\Transport\\Request\u003A\u003AmakeRequest\u0028\u0029", + "name": "makeRequest", + "summary": "make\u0020the\u0020guzzle\u0020request", + "url": "classes/LDC-LDCCRM-Transport-Request.html#method_makeRequest" + }, { + "fqsen": "\\LDC\\LDCCRM\\Transport\\Request\u003A\u003AsetEndpoint\u0028\u0029", + "name": "setEndpoint", + "summary": "Set\u0020the\u0020api\u0020endpoint\u0020to\u0020the\u0020request", + "url": "classes/LDC-LDCCRM-Transport-Request.html#method_setEndpoint" + }, { + "fqsen": "\\LDC\\LDCCRM\\Transport\\Request\u003A\u003Acall\u0028\u0029", + "name": "call", + "summary": "Make\u0020the\u0020Http\u0020request", + "url": "classes/LDC-LDCCRM-Transport-Request.html#method_call" + }, { + "fqsen": "\\LDC\\LDCCRM\\Transport\\Request\u003A\u003AaddHeaders\u0028\u0029", + "name": "addHeaders", + "summary": "Add\u0020headers\u0020to\u0020the\u0020request", + "url": "classes/LDC-LDCCRM-Transport-Request.html#method_addHeaders" + }, { + "fqsen": "\\LDC\\LDCCRM\\Transport\\Request\u003A\u003AaddData\u0028\u0029", + "name": "addData", + "summary": "Add\u0020data\u0020to\u0020the\u0020request", + "url": "classes/LDC-LDCCRM-Transport-Request.html#method_addData" + }, { + "fqsen": "\\LDC\\LDCCRM\\Transport\\Request\u003A\u003A\u0024client", + "name": "client", + "summary": "GuzzleHttp\u0020client", + "url": "classes/LDC-LDCCRM-Transport-Request.html#property_client" + }, { + "fqsen": "\\LDC\\LDCCRM\\Transport\\Request\u003A\u003A\u0024method", + "name": "method", + "summary": "The\u0020http\u0020method", + "url": "classes/LDC-LDCCRM-Transport-Request.html#property_method" + }, { + "fqsen": "\\LDC\\LDCCRM\\Transport\\Request\u003A\u003A\u0024uri", + "name": "uri", + "summary": "The\u0020http\u0020url", + "url": "classes/LDC-LDCCRM-Transport-Request.html#property_uri" + }, { + "fqsen": "\\LDC\\LDCCRM\\Transport\\Request\u003A\u003A\u0024headers", + "name": "headers", + "summary": "Data\u0020to\u0020pass\u0020to\u0020the\u0020http\u0020headers", + "url": "classes/LDC-LDCCRM-Transport-Request.html#property_headers" + }, { + "fqsen": "\\LDC\\LDCCRM\\Transport\\Request\u003A\u003A\u0024data", + "name": "data", + "summary": "Data\u0020to\u0020pass\u0020to\u0020the\u0020http\u0020body", + "url": "classes/LDC-LDCCRM-Transport-Request.html#property_data" + }, { + "fqsen": "\\LDC\\LDCCRM\\Transport\\Request\u003A\u003A\u0024request", + "name": "request", + "summary": "Guzzle\u0020request", + "url": "classes/LDC-LDCCRM-Transport-Request.html#property_request" + }, { + "fqsen": "\\LDC\\LDCCRM\\Transport\\Request\u003A\u003A\u0024endpoint", + "name": "endpoint", + "summary": "The\u0020Api\u0020endpoint", + "url": "classes/LDC-LDCCRM-Transport-Request.html#property_endpoint" + }, { + "fqsen": "\\LDC\\LDCCRM\\Transport\\Response", + "name": "Response", + "summary": "", + "url": "classes/LDC-LDCCRM-Transport-Response.html" + }, { + "fqsen": "\\LDC\\LDCCRM\\Transport\\Response\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Response", + "url": "classes/LDC-LDCCRM-Transport-Response.html#method___construct" + }, { + "fqsen": "\\LDC\\LDCCRM\\Transport\\Response\u003A\u003A__get\u0028\u0029", + "name": "__get", + "summary": "Generic\u0020accessor", + "url": "classes/LDC-LDCCRM-Transport-Response.html#method___get" + }, { + "fqsen": "\\LDC\\LDCCRM\\Transport\\Response\u003A\u003AtryDecodeJson\u0028\u0029", + "name": "tryDecodeJson", + "summary": "Try\u0020to\u0020decode\u0020json\u0020and\u0020return\u0020false\u0020if\u0020it\u0020is\nnot\u0020a\u0020valid\u0020json", + "url": "classes/LDC-LDCCRM-Transport-Response.html#method_tryDecodeJson" + }, { + "fqsen": "\\LDC\\LDCCRM\\Transport\\Response\u003A\u003AcheckVersion\u0028\u0029", + "name": "checkVersion", + "summary": "This\u0020checks\u0020if\u0020the\u0020crm\u0020version\u0020is\u0020way\u0020far\u0020beyond\u0020the\u0020client\u0020version.", + "url": "classes/LDC-LDCCRM-Transport-Response.html#method_checkVersion" + }, { + "fqsen": "\\LDC\\LDCCRM\\Transport\\Response\u003A\u003A\u0024status", + "name": "status", + "summary": "The\u0020response\u0020status", + "url": "classes/LDC-LDCCRM-Transport-Response.html#property_status" + }, { + "fqsen": "\\LDC\\LDCCRM\\Transport\\Response\u003A\u003A\u0024apiError", + "name": "apiError", + "summary": "The\u0020api\u0020error", + "url": "classes/LDC-LDCCRM-Transport-Response.html#property_apiError" + }, { + "fqsen": "\\LDC\\LDCCRM\\Transport\\Response\u003A\u003A\u0024httpCode", + "name": "httpCode", + "summary": "The\u0020response\u0020http\u0020code", + "url": "classes/LDC-LDCCRM-Transport-Response.html#property_httpCode" + }, { + "fqsen": "\\LDC\\LDCCRM\\Transport\\Response\u003A\u003A\u0024headers", + "name": "headers", + "summary": "The\u0020response\u0020headers", + "url": "classes/LDC-LDCCRM-Transport-Response.html#property_headers" + }, { + "fqsen": "\\LDC\\LDCCRM\\Transport\\Response\u003A\u003A\u0024body", + "name": "body", + "summary": "The\u0020response\u0020body", + "url": "classes/LDC-LDCCRM-Transport-Response.html#property_body" + }, { + "fqsen": "\\LDC\\LDCCRM\\Transport\\Response\u003A\u003A\u0024message", + "name": "message", + "summary": "The\u0020interface\u0020message", + "url": "classes/LDC-LDCCRM-Transport-Response.html#property_message" + }, { + "fqsen": "\\LDC\\LDCCRM\\Transport\\Response\u003A\u003A\u0024response", + "name": "response", + "summary": "PSR\u0020response", + "url": "classes/LDC-LDCCRM-Transport-Response.html#property_response" + }, { + "fqsen": "\\LDC\\LDCCRM\\Utils", + "name": "Utils", + "summary": "This\u0020is\u0020the\u0020LDCCRM\u0020utility\u0020class", + "url": "classes/LDC-LDCCRM-Utils.html" + }, { + "fqsen": "\\LDC\\LDCCRM\\Utils\u003A\u003AmakeValidator\u0028\u0029", + "name": "makeValidator", + "summary": "Create\u0020a\u0020new\u0020Validator\u0020instance.", + "url": "classes/LDC-LDCCRM-Utils.html#method_makeValidator" + }, { + "fqsen": "\\LDC\\LDCCRM\\Utils\u003A\u003AmakeValidatorFromRule\u0028\u0029", + "name": "makeValidatorFromRule", + "summary": "Generate\u0020a\u0020validator", + "url": "classes/LDC-LDCCRM-Utils.html#method_makeValidatorFromRule" + }, { + "fqsen": "\\LDC\\LDCCRM\\Utils\u003A\u003AvalidationRequired\u0028\u0029", + "name": "validationRequired", + "summary": "Make\u0020Required\u0020validator", + "url": "classes/LDC-LDCCRM-Utils.html#method_validationRequired" + }, { + "fqsen": "\\LDC\\LDCCRM\\Utils\u003A\u003AvalidationNullable\u0028\u0029", + "name": "validationNullable", + "summary": "Make\u0020Nullable\u0020validator", + "url": "classes/LDC-LDCCRM-Utils.html#method_validationNullable" + }, { + "fqsen": "\\LDC\\LDCCRM\\Utils\u003A\u003AvalidationSometimes\u0028\u0029", + "name": "validationSometimes", + "summary": "Make\u0020Sometimes\u0020validator", + "url": "classes/LDC-LDCCRM-Utils.html#method_validationSometimes" + }, { + "fqsen": "\\LDC\\LDCCRM\\Utils\u003A\u003AvalidationInt\u0028\u0029", + "name": "validationInt", + "summary": "Make\u0020Int\u0020validator", + "url": "classes/LDC-LDCCRM-Utils.html#method_validationInt" + }, { + "fqsen": "\\LDC\\LDCCRM\\Utils\u003A\u003AvalidationString\u0028\u0029", + "name": "validationString", + "summary": "Make\u0020String\u0020validator", + "url": "classes/LDC-LDCCRM-Utils.html#method_validationString" + }, { + "fqsen": "\\LDC\\LDCCRM\\Utils\u003A\u003AvalidationBool\u0028\u0029", + "name": "validationBool", + "summary": "Make\u0020Bool\u0020validator", + "url": "classes/LDC-LDCCRM-Utils.html#method_validationBool" + }, { + "fqsen": "\\LDC\\LDCCRM\\Utils\u003A\u003AvalidationMin\u0028\u0029", + "name": "validationMin", + "summary": "Make\u0020Min\u0020validator", + "url": "classes/LDC-LDCCRM-Utils.html#method_validationMin" + }, { + "fqsen": "\\LDC\\LDCCRM\\Utils\u003A\u003AvalidationMax\u0028\u0029", + "name": "validationMax", + "summary": "Make\u0020Max\u0020validator", + "url": "classes/LDC-LDCCRM-Utils.html#method_validationMax" + }, { + "fqsen": "\\LDC\\LDCCRM\\Utils\u003A\u003AvalidationUuid\u0028\u0029", + "name": "validationUuid", + "summary": "Make\u0020Uuid\u0020validator", + "url": "classes/LDC-LDCCRM-Utils.html#method_validationUuid" + }, { + "fqsen": "\\LDC\\LDCCRM\\Utils\u003A\u003AvalidationMixedCase\u0028\u0029", + "name": "validationMixedCase", + "summary": "Make\u0020MixedCase\u0020validator", + "url": "classes/LDC-LDCCRM-Utils.html#method_validationMixedCase" + }, { + "fqsen": "\\LDC\\LDCCRM\\Utils\u003A\u003AvalidationContainDigit\u0028\u0029", + "name": "validationContainDigit", + "summary": "Make\u0020ContainDigit\u0020validator", + "url": "classes/LDC-LDCCRM-Utils.html#method_validationContainDigit" + }, { + "fqsen": "\\LDC\\LDCCRM\\Utils\u003A\u003AvalidationContainSymbol\u0028\u0029", + "name": "validationContainSymbol", + "summary": "Make\u0020ContainSymbol\u0020validator", + "url": "classes/LDC-LDCCRM-Utils.html#method_validationContainSymbol" + }, { + "fqsen": "\\LDC\\LDCCRM\\Utils\u003A\u003AvalidationDate\u0028\u0029", + "name": "validationDate", + "summary": "Make\u0020Date\u0020validator", + "url": "classes/LDC-LDCCRM-Utils.html#method_validationDate" + }, { + "fqsen": "\\LDC\\LDCCRM\\Utils\u003A\u003AvalidationDateFormat\u0028\u0029", + "name": "validationDateFormat", + "summary": "Make\u0020DateFormat\u0020validator", + "url": "classes/LDC-LDCCRM-Utils.html#method_validationDateFormat" + }, { + "fqsen": "\\LDC\\LDCCRM\\Utils\u003A\u003AvalidationEmail\u0028\u0029", + "name": "validationEmail", + "summary": "Make\u0020Email\u0020validator", + "url": "classes/LDC-LDCCRM-Utils.html#method_validationEmail" + }, { + "fqsen": "\\LDC\\LDCCRM\\Utils\u003A\u003AvalidationArray\u0028\u0029", + "name": "validationArray", + "summary": "Make\u0020Array\u0020validator", + "url": "classes/LDC-LDCCRM-Utils.html#method_validationArray" + }, { + "fqsen": "\\LDC\\LDCCRM\\Utils\u003A\u003AvalidationClosure\u0028\u0029", + "name": "validationClosure", + "summary": "Make\u0020Closure\u0020validator", + "url": "classes/LDC-LDCCRM-Utils.html#method_validationClosure" + }, { + "fqsen": "\\LDC\\LDCCRM\\Utils\u003A\u003AgetConfig\u0028\u0029", + "name": "getConfig", + "summary": "This\u0020is\u0020only\u0020used\u0020for\u0020unit\u0020tests.", + "url": "classes/LDC-LDCCRM-Utils.html#method_getConfig" + }, { + "fqsen": "\\LDC\\LDCCRM\\Utils\u003A\u003AgetResquest\u0028\u0029", + "name": "getResquest", + "summary": "Generate\u0020a\u0020Request\u0020from\u0020the\u0020route\u0020name", + "url": "classes/LDC-LDCCRM-Utils.html#method_getResquest" + }, { + "fqsen": "\\LDC\\LDCCRM\\Utils\u003A\u003AgetPackageInfo\u0028\u0029", + "name": "getPackageInfo", + "summary": "Get\u0020composer.json\u0020infos", + "url": "classes/LDC-LDCCRM-Utils.html#method_getPackageInfo" + }, { + "fqsen": "\\LDC\\LDCCRM\\Utils\u003A\u003Atranslate\u0028\u0029", + "name": "translate", + "summary": "Translation\u0020a\u0020string\u0020using\u0020php\u0020file\u0020lang", + "url": "classes/LDC-LDCCRM-Utils.html#method_translate" + }, { + "fqsen": "\\LDC\\LDCCRM\\Utils\u003A\u003Alog\u0028\u0029", + "name": "log", + "summary": "Write\u0020log\u0020using\u0020syslog\nIt\u0020also\u0020write\u0020log\u0020using\u0020\\Illuminate\\Support\\Facades\\Log\nif\u0020it\u0020is\u0020present", + "url": "classes/LDC-LDCCRM-Utils.html#method_log" + }, { + "fqsen": "\\LDC\\LDCCRM\\Utils\u003A\u003AsetRawProperty\u0028\u0029", + "name": "setRawProperty", + "summary": "Set\u0020a\u0020property\u0020without\u0020any\u0020validation.", + "url": "classes/LDC-LDCCRM-Utils.html#method_setRawProperty" + }, { + "fqsen": "\\LDC\\LDCCRM\\Utils\u003A\u003AgetRawProperty\u0028\u0029", + "name": "getRawProperty", + "summary": "Get\u0020a\u0020property\u0020of\u0020an\u0020object.", + "url": "classes/LDC-LDCCRM-Utils.html#method_getRawProperty" + }, { + "fqsen": "\\LDC\\LDCCRM\\Utils\u003A\u003A\u0024packageInfos", + "name": "packageInfos", + "summary": "Package\u0020infos", + "url": "classes/LDC-LDCCRM-Utils.html#property_packageInfos" + }, { + "fqsen": "\\LDC\\LDCCRM\\Utils\u003A\u003A\u0024translations", + "name": "translations", + "summary": "Loaded\u0020translations", + "url": "classes/LDC-LDCCRM-Utils.html#property_translations" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrm", + "name": "WPCrm", + "summary": "Class\u0020de\u0020gestion\u0020des\u0020users\u0020en\u0020session\u0020avec\u0020Wordpress\u0020\u0028ce\u0020truc\u0020immonde\u0029", + "url": "classes/LDC-LDCCRM-WordPress-WPCrm.html" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrm\u003A\u003AgetUser\u0028\u0029", + "name": "getUser", + "summary": "Get\u0020the\u0020current\u0020user\nreturn\u0020null\u0020if\u0020the\u0020user\u0020is\u0020not\u0020logged\u0020in", + "url": "classes/LDC-LDCCRM-WordPress-WPCrm.html#method_getUser" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrm\u003A\u003AforceLogin\u0028\u0029", + "name": "forceLogin", + "summary": "Manually\u0020login\u0020a\u0020user\nIf\u0020self\u003A\u003A\u0024user\u0020is\u0020already\u0020set.", + "url": "classes/LDC-LDCCRM-WordPress-WPCrm.html#method_forceLogin" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrm\u003A\u003AgetUserFromApi\u0028\u0029", + "name": "getUserFromApi", + "summary": "Get\u0020the\u0020current\u0020user\nreturn\u0020api\u0020response\u0020code\u0020if\u0020an\u0020error\u0020occurs", + "url": "classes/LDC-LDCCRM-WordPress-WPCrm.html#method_getUserFromApi" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrm\u003A\u003Alogin\u0028\u0029", + "name": "login", + "summary": "Try\u0020to\u0020login\u0020with\u0020CRM\u0020API\nA\u0020session\u0020will\u0020be\u0020started\u0020if\u0020credentials\u0020are\u0020valid.", + "url": "classes/LDC-LDCCRM-WordPress-WPCrm.html#method_login" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrm\u003A\u003Alogout\u0028\u0029", + "name": "logout", + "summary": "Destroy\u0020the\u0020customer\u0020from\u0020session\nand\u0020therefore\u0020logout", + "url": "classes/LDC-LDCCRM-WordPress-WPCrm.html#method_logout" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrm\u003A\u003Acheck\u0028\u0029", + "name": "check", + "summary": "Check\u0020if\u0020the\u0020user\u0020is\u0020logged\u0020in.", + "url": "classes/LDC-LDCCRM-WordPress-WPCrm.html#method_check" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrm\u003A\u003AsaveUser\u0028\u0029", + "name": "saveUser", + "summary": "Save\u0020current\u0020customer\u0020to\nthe\u0020local\u0020database\u0020and\u0020on\u0020crm", + "url": "classes/LDC-LDCCRM-WordPress-WPCrm.html#method_saveUser" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrm\u003A\u003AdeleteUser\u0028\u0029", + "name": "deleteUser", + "summary": "Delete\u0020current\u0020customer\u0020from\nthe\u0020local\u0020database\u0020and\u0020the\u0020crm", + "url": "classes/LDC-LDCCRM-WordPress-WPCrm.html#method_deleteUser" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrm\u003A\u003AtoggleUserOptin\u0028\u0029", + "name": "toggleUserOptin", + "summary": "Toggle\u0020the\u0020current\u0020user\u0020optin\u0020value\non\u0020the\u0020current\u0020user\u0020and\u0020the\u0020crm", + "url": "classes/LDC-LDCCRM-WordPress-WPCrm.html#method_toggleUserOptin" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrm\u003A\u003AsetSingleOptin\u0028\u0029", + "name": "setSingleOptin", + "summary": "Set\u0020the\u0020single\u0020optin\u0020status\u0020for\u0020an\u0020email\non\u0020the\u0020crm", + "url": "classes/LDC-LDCCRM-WordPress-WPCrm.html#method_setSingleOptin" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrm\u003A\u003AactivateUser\u0028\u0029", + "name": "activateUser", + "summary": "Toggle\u0020the\u0020current\u0020user\u0020optin\u0020value\non\u0020the\u0020current\u0020user\u0020and\u0020the\u0020crm", + "url": "classes/LDC-LDCCRM-WordPress-WPCrm.html#method_activateUser" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrm\u003A\u003AgetNewUser\u0028\u0029", + "name": "getNewUser", + "summary": "Generate\u0020a\u0020new\u0020user", + "url": "classes/LDC-LDCCRM-WordPress-WPCrm.html#method_getNewUser" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrm\u003A\u003AunsetActiveUser\u0028\u0029", + "name": "unsetActiveUser", + "summary": "Remove\u0020active\u0020user\nto\u0020prevent\u0020WPCrm\u003A\u003Acheck\u0020to\u0020return\u0020true", + "url": "classes/LDC-LDCCRM-WordPress-WPCrm.html#method_unsetActiveUser" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrm\u003A\u003AloginUserWithApi\u0028\u0029", + "name": "loginUserWithApi", + "summary": "Check\u0020customer\u0020credentials\u0020using\u0020the\u0020CRM.", + "url": "classes/LDC-LDCCRM-WordPress-WPCrm.html#method_loginUserWithApi" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrm\u003A\u003AgetCustomer\u0028\u0029", + "name": "getCustomer", + "summary": "Get\u0020all\u0020customer\u0020infos", + "url": "classes/LDC-LDCCRM-WordPress-WPCrm.html#method_getCustomer" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrm\u003A\u003AsetUser\u0028\u0029", + "name": "setUser", + "summary": "Create\u0020a\u0020user\nstores\u0020it\u0020to\u0020the\u0020session\nand\u0020finally\u0020saves\u0020it\u0020to\u0020the\u0020database\u0020if\u0020it\u0020does\u0020not\u0020exists", + "url": "classes/LDC-LDCCRM-WordPress-WPCrm.html#method_setUser" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrm\u003A\u003AinitLdcApi\u0028\u0029", + "name": "initLdcApi", + "summary": "Get\u0020the\u0020initialized\u0020API\u0020object", + "url": "classes/LDC-LDCCRM-WordPress-WPCrm.html#method_initLdcApi" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrm\u003A\u003AmakeApiV2Call\u0028\u0029", + "name": "makeApiV2Call", + "summary": "Make\u0020a\u0020call\u0020using\u0020apiV2", + "url": "classes/LDC-LDCCRM-WordPress-WPCrm.html#method_makeApiV2Call" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrm\u003A\u003AbootSessionIfNeeded\u0028\u0029", + "name": "bootSessionIfNeeded", + "summary": "Boot\u0020the\u0020php\u0020session\u0020if\u0020needed", + "url": "classes/LDC-LDCCRM-WordPress-WPCrm.html#method_bootSessionIfNeeded" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrm\u003A\u003AgetUserFromTable\u0028\u0029", + "name": "getUserFromTable", + "summary": "Get\u0020a\u0020customer\u0020from\u0020table", + "url": "classes/LDC-LDCCRM-WordPress-WPCrm.html#method_getUserFromTable" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrm\u003A\u003AgetUserFromTableByEmail\u0028\u0029", + "name": "getUserFromTableByEmail", + "summary": "Get\u0020a\u0020customer\u0020from\u0020table\u0020by\u0020an\u0020email", + "url": "classes/LDC-LDCCRM-WordPress-WPCrm.html#method_getUserFromTableByEmail" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrm\u003A\u003AgetUserFromTableByUuid\u0028\u0029", + "name": "getUserFromTableByUuid", + "summary": "Get\u0020a\u0020customer\u0020from\u0020table\u0020by\u0020an\u0020email", + "url": "classes/LDC-LDCCRM-WordPress-WPCrm.html#method_getUserFromTableByUuid" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrm\u003A\u003AsaveOrUpdateUserToTable\u0028\u0029", + "name": "saveOrUpdateUserToTable", + "summary": "Save\u0020or\u0020update\u0020the\u0020user\u0020to\u0020the\u0020table", + "url": "classes/LDC-LDCCRM-WordPress-WPCrm.html#method_saveOrUpdateUserToTable" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrm\u003A\u003AdeleteUserFromTable\u0028\u0029", + "name": "deleteUserFromTable", + "summary": "Save\u0020or\u0020update\u0020the\u0020user\u0020to\u0020the\u0020table", + "url": "classes/LDC-LDCCRM-WordPress-WPCrm.html#method_deleteUserFromTable" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrm\u003A\u003Aquery\u0028\u0029", + "name": "query", + "summary": "Query\u0020in\u0020DB", + "url": "classes/LDC-LDCCRM-WordPress-WPCrm.html#method_query" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrm\u003A\u003AgetWpDb\u0028\u0029", + "name": "getWpDb", + "summary": "Get\u0020WP\u0020\u0027pdo\u0020instance\u0027", + "url": "classes/LDC-LDCCRM-WordPress-WPCrm.html#method_getWpDb" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrm\u003A\u003A\u0024sessionKey", + "name": "sessionKey", + "summary": "The\u0020session\u0020key\u0020name", + "url": "classes/LDC-LDCCRM-WordPress-WPCrm.html#property_sessionKey" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrm\u003A\u003A\u0024sessionDestroyed", + "name": "sessionDestroyed", + "summary": "The\u0020session\u0020live\u0020status", + "url": "classes/LDC-LDCCRM-WordPress-WPCrm.html#property_sessionDestroyed" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrm\u003A\u003A\u0024api", + "name": "api", + "summary": "The\u0020user\u0020object", + "url": "classes/LDC-LDCCRM-WordPress-WPCrm.html#property_api" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrm\u003A\u003A\u0024user", + "name": "user", + "summary": "The\u0020user\u0020object", + "url": "classes/LDC-LDCCRM-WordPress-WPCrm.html#property_user" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrmAnswer", + "name": "WPCrmAnswer", + "summary": "Class\u0020de\u0020gestion\u0020de\u0020la\u0020segmentation\u0020question\u0020avec\u0020Wordpress\u0020\u0028ce\u0020truc\u0020immonde\u0029", + "url": "classes/LDC-LDCCRM-WordPress-WPCrmAnswer.html" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrmAnswer\u003A\u003AsetQuestionAnswers\u0028\u0029", + "name": "setQuestionAnswers", + "summary": "Set\u0020answers\u0020to\u0020a\u0020question\u0020for\u0020a\u0020specific\u0020user", + "url": "classes/LDC-LDCCRM-WordPress-WPCrmAnswer.html#method_setQuestionAnswers" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrmQuestion", + "name": "WPCrmQuestion", + "summary": "Class\u0020de\u0020gestion\u0020de\u0020la\u0020segmentation\u0020question\u0020avec\u0020Wordpress\u0020\u0028ce\u0020truc\u0020immonde\u0029", + "url": "classes/LDC-LDCCRM-WordPress-WPCrmQuestion.html" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrmQuestion\u003A\u003AgetAll\u0028\u0029", + "name": "getAll", + "summary": "Get\u0020all\u0020questions\u0020only", + "url": "classes/LDC-LDCCRM-WordPress-WPCrmQuestion.html#method_getAll" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrmQuestion\u003A\u003AallWithCustomerAnswers\u0028\u0029", + "name": "allWithCustomerAnswers", + "summary": "Get\u0020all\u0020the\u0020questions\u0020with\u0020user\u0020answers", + "url": "classes/LDC-LDCCRM-WordPress-WPCrmQuestion.html#method_allWithCustomerAnswers" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrmQuestion\u003A\u003AunansweredBy\u0028\u0029", + "name": "unansweredBy", + "summary": "Get\u0020unanswered\u0020question\u0020for\u0020a\u0020specific\u0020customer", + "url": "classes/LDC-LDCCRM-WordPress-WPCrmQuestion.html#method_unansweredBy" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrmUser", + "name": "WPCrmUser", + "summary": "Class\u0020de\u0020gestion\u0020des\u0020users\u0020en\u0020session\u0020avec\u0020Wordpress\u0020\u0028ce\u0020truc\u0020immonde\u0029", + "url": "classes/LDC-LDCCRM-WordPress-WPCrmUser.html" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrmUser\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "WPCrmUser\u0020construct", + "url": "classes/LDC-LDCCRM-WordPress-WPCrmUser.html#method___construct" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrmUser\u003A\u003A__get\u0028\u0029", + "name": "__get", + "summary": "Generic\u0020accessor", + "url": "classes/LDC-LDCCRM-WordPress-WPCrmUser.html#method___get" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrmUser\u003A\u003A__set\u0028\u0029", + "name": "__set", + "summary": "Generic\u0020mutator", + "url": "classes/LDC-LDCCRM-WordPress-WPCrmUser.html#method___set" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrmUser\u003A\u003AsetInfo\u0028\u0029", + "name": "setInfo", + "summary": "Set\u0020the\u0020customer\u0020info\nwith\u0020api\u0020response", + "url": "classes/LDC-LDCCRM-WordPress-WPCrmUser.html#method_setInfo" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrmUser\u003A\u003AparseFromJson\u0028\u0029", + "name": "parseFromJson", + "summary": "Generate\u0020a\u0020user\u0020from\u0020session\u0020data", + "url": "classes/LDC-LDCCRM-WordPress-WPCrmUser.html#method_parseFromJson" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrmUser\u003A\u003AjsonSerialize\u0028\u0029", + "name": "jsonSerialize", + "summary": "Serialize\u0020this\u0020object\u0020to\u0020an\u0020array", + "url": "classes/LDC-LDCCRM-WordPress-WPCrmUser.html#method_jsonSerialize" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrmUser\u003A\u003Asave\u0028\u0029", + "name": "save", + "summary": "Save\u0020current\u0020customer\u0020to\nthe\u0020local\u0020database\u0020and\u0020on\u0020crm", + "url": "classes/LDC-LDCCRM-WordPress-WPCrmUser.html#method_save" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrmUser\u003A\u003Adelete\u0028\u0029", + "name": "delete", + "summary": "Delete\u0020current\u0020customer\u0020to\nthe\u0020local\u0020database\u0020and\u0020on\u0020crm", + "url": "classes/LDC-LDCCRM-WordPress-WPCrmUser.html#method_delete" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrmUser\u003A\u003AtoggleOptin\u0028\u0029", + "name": "toggleOptin", + "summary": "Toggle\u0020the\u0020current\u0020user\u0020optin\u0020value\non\u0020the\u0020current\u0020user\u0020and\u0020the\u0020crm", + "url": "classes/LDC-LDCCRM-WordPress-WPCrmUser.html#method_toggleOptin" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrmUser\u003A\u003Aactivate\u0028\u0029", + "name": "activate", + "summary": "Activate\u0020the\u0020account\u0020in\u0020the\u0020crm", + "url": "classes/LDC-LDCCRM-WordPress-WPCrmUser.html#method_activate" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrmUser\u003A\u003A\u0024phashcode", + "name": "phashcode", + "summary": "The\u0020CRM\u0020hashcode\u0020\u0028UUID\u0029", + "url": "classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_phashcode" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrmUser\u003A\u003A\u0024pemail", + "name": "pemail", + "summary": "The\u0020CRM\u0020customer\u0020email", + "url": "classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_pemail" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrmUser\u003A\u003A\u0024info", + "name": "info", + "summary": "The\u0020CRM\u0020customer\u0020info\u0020\u0028the\u0020api\u0020response\u0029", + "url": "classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_info" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress\\WPCrmUser\u003A\u003A\u0024uuidToken", + "name": "uuidToken", + "summary": "The\u0020CRM\u0020customer\u0020temp\u0020uuidToken\u0020to\u0020validate\u0020transactions", + "url": "classes/LDC-LDCCRM-WordPress-WPCrmUser.html#property_uuidToken" + }, { + "fqsen": "\\LDC\\LDCCRM\\Exceptions\\AccessError", + "name": "AccessError", + "summary": "This\u0020is\u0020thrown\u0020when\u0020trying\u0020to\u0020set\u0020a\u0020value\u0020on\u0020an\u0020object\u0020property\u0020that\u0020does\u0020not\u0020exist.", + "url": "classes/LDC-LDCCRM-Exceptions-AccessError.html" + }, { + "fqsen": "\\LDC\\LDCCRM\\Exceptions\\AccessError\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "AccessError", + "url": "classes/LDC-LDCCRM-Exceptions-AccessError.html#method___construct" + }, { + "fqsen": "\\LDC\\LDCCRM\\Exceptions\\SkipValidationException", + "name": "SkipValidationException", + "summary": "Used\u0020only\u0020for\u0020internal\u0020validator", + "url": "classes/LDC-LDCCRM-Exceptions-SkipValidationException.html" + }, { + "fqsen": "\\LDC\\LDCCRM\\Exceptions\\WpCrmInvalidJsonUserInfo", + "name": "WpCrmInvalidJsonUserInfo", + "summary": "This\u0020is\u0020thrown\u0020when\u0020trying\u0020to\u0020read\u0020WP\u0020customer\u0020from\u0020DB\u0020json\u0020data.", + "url": "classes/LDC-LDCCRM-Exceptions-WpCrmInvalidJsonUserInfo.html" + }, { + "fqsen": "\\LDC\\LDCCRM\\Exceptions\\WpCrmInvalidJsonUserInfo\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "WpCrmInvalidJsonUserInfo", + "url": "classes/LDC-LDCCRM-Exceptions-WpCrmInvalidJsonUserInfo.html#method___construct" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Stats", + "name": "Stats", + "summary": "This\u0020class\u0020is\u0020used\u0020to\u0020get\u0020stats\u0020from\u0020CRM", + "url": "classes/LDC-LDCCRM-Models-Stats.html" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Stats\u003A\u003AgetBrandStats\u0028\u0029", + "name": "getBrandStats", + "summary": "Get\u0020brand\u0020stats\u0020ordered\u0020by\u0020ascendent\u0020days", + "url": "classes/LDC-LDCCRM-Models-Stats.html#method_getBrandStats" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Stats\u003A\u003AgetQuestionStats\u0028\u0029", + "name": "getQuestionStats", + "summary": "Get\u0020brand\u0020stats\u0020ordered\u0020by\u0020ascendent\u0020days", + "url": "classes/LDC-LDCCRM-Models-Stats.html#method_getQuestionStats" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models\\Stats\u003A\u003A\u0024validation", + "name": "validation", + "summary": "Validation\u0020rules", + "url": "classes/LDC-LDCCRM-Models-Stats.html#property_validation" + }, { + "fqsen": "\\", + "name": "\\", + "summary": "", + "url": "namespaces/default.html" + }, { + "fqsen": "\\LDC\\LDCCRM", + "name": "LDCCRM", + "summary": "", + "url": "namespaces/ldc-ldccrm.html" + }, { + "fqsen": "\\LDC", + "name": "LDC", + "summary": "", + "url": "namespaces/ldc.html" + }, { + "fqsen": "\\LDC\\LDCCRM\\Enums", + "name": "Enums", + "summary": "", + "url": "namespaces/ldc-ldccrm-enums.html" + }, { + "fqsen": "\\LDC\\LDCCRM\\Exceptions", + "name": "Exceptions", + "summary": "", + "url": "namespaces/ldc-ldccrm-exceptions.html" + }, { + "fqsen": "\\LDC\\LDCCRM\\Models", + "name": "Models", + "summary": "", + "url": "namespaces/ldc-ldccrm-models.html" + }, { + "fqsen": "\\LDC\\LDCCRM\\Transport", + "name": "Transport", + "summary": "", + "url": "namespaces/ldc-ldccrm-transport.html" + }, { + "fqsen": "\\LDC\\LDCCRM\\WordPress", + "name": "WordPress", + "summary": "", + "url": "namespaces/ldc-ldccrm-wordpress.html" + } ] +); diff --git a/documentation/namespaces/default.html b/documentation/namespaces/default.html new file mode 100644 index 0000000..2bf9621 --- /dev/null +++ b/documentation/namespaces/default.html @@ -0,0 +1,140 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                                                                              +

                                                                                                                              CRM V2

                                                                                                                              + + + + + +
                                                                                                                              + +
                                                                                                                              +
                                                                                                                              + + + + +
                                                                                                                              +
                                                                                                                                +
                                                                                                                              + +
                                                                                                                              +

                                                                                                                              API Documentation

                                                                                                                              + + +

                                                                                                                              + Namespaces + +

                                                                                                                              + +
                                                                                                                              +
                                                                                                                              LDC
                                                                                                                              +
                                                                                                                              + + + + + + + +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              +

                                                                                                                              Search results

                                                                                                                              + +
                                                                                                                              +
                                                                                                                              +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                + + +
                                                                                                                                + + + + + + + + diff --git a/documentation/namespaces/ldc-ldccrm-enums.html b/documentation/namespaces/ldc-ldccrm-enums.html new file mode 100644 index 0000000..9d2d5a8 --- /dev/null +++ b/documentation/namespaces/ldc-ldccrm-enums.html @@ -0,0 +1,157 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                                                                                +

                                                                                                                                CRM V2

                                                                                                                                + + + + + +
                                                                                                                                + +
                                                                                                                                +
                                                                                                                                + + + + +
                                                                                                                                + + + +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                +

                                                                                                                                Search results

                                                                                                                                + +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  + + +
                                                                                                                                  + + + + + + + + diff --git a/documentation/namespaces/ldc-ldccrm-exceptions.html b/documentation/namespaces/ldc-ldccrm-exceptions.html new file mode 100644 index 0000000..aa3a198 --- /dev/null +++ b/documentation/namespaces/ldc-ldccrm-exceptions.html @@ -0,0 +1,158 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                                                                                  +

                                                                                                                                  CRM V2

                                                                                                                                  + + + + + +
                                                                                                                                  + +
                                                                                                                                  +
                                                                                                                                  + + + + +
                                                                                                                                  + + +
                                                                                                                                  +

                                                                                                                                  Exceptions

                                                                                                                                  + + + +

                                                                                                                                  + Interfaces, Classes and Traits + +

                                                                                                                                  + +
                                                                                                                                  + +
                                                                                                                                  ApiErrorException
                                                                                                                                  +
                                                                                                                                  This would be thrown if any of the case +referenced in \LDC\LDCCRM\Enums\ApiError would +occur within the crm
                                                                                                                                  +
                                                                                                                                  CrmException
                                                                                                                                  +
                                                                                                                                  This is a critical error.
                                                                                                                                  +
                                                                                                                                  ValidationException
                                                                                                                                  +
                                                                                                                                  This would be thrown if a data could not be validated +on any models
                                                                                                                                  +
                                                                                                                                  AccessError
                                                                                                                                  +
                                                                                                                                  This is thrown when trying to set a value on an object property that does not exist.
                                                                                                                                  +
                                                                                                                                  SkipValidationException
                                                                                                                                  +
                                                                                                                                  Used only for internal validator
                                                                                                                                  +
                                                                                                                                  WpCrmInvalidJsonUserInfo
                                                                                                                                  +
                                                                                                                                  This is thrown when trying to read WP customer from DB json data.
                                                                                                                                  + +
                                                                                                                                  + + + + + + +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  +

                                                                                                                                  Search results

                                                                                                                                  + +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                    + + +
                                                                                                                                    + + + + + + + + diff --git a/documentation/namespaces/ldc-ldccrm-models.html b/documentation/namespaces/ldc-ldccrm-models.html new file mode 100644 index 0000000..6bd80e0 --- /dev/null +++ b/documentation/namespaces/ldc-ldccrm-models.html @@ -0,0 +1,163 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                                                                                    +

                                                                                                                                    CRM V2

                                                                                                                                    + + + + + +
                                                                                                                                    + +
                                                                                                                                    +
                                                                                                                                    + + + + +
                                                                                                                                    + + +
                                                                                                                                    +

                                                                                                                                    Models

                                                                                                                                    + + + +

                                                                                                                                    + Interfaces, Classes and Traits + +

                                                                                                                                    + +
                                                                                                                                    + +
                                                                                                                                    Answer
                                                                                                                                    +
                                                                                                                                    This class represents an answer +It has a method to submit answers
                                                                                                                                    +
                                                                                                                                    ArcadiaMailDefault
                                                                                                                                    +
                                                                                                                                    This class represents the customer info with +the account validation status
                                                                                                                                    +
                                                                                                                                    ArcadiaMailGame
                                                                                                                                    +
                                                                                                                                    This class represents the customer info with +the account validation status
                                                                                                                                    +
                                                                                                                                    Customer
                                                                                                                                    +
                                                                                                                                    This class represents the customer info with +the account validation status. You can use it as +a standalone class but beware of catching exceptions
                                                                                                                                    +
                                                                                                                                    Question
                                                                                                                                    +
                                                                                                                                    This class represents a question +It has some static methods to retrieve questions and answers
                                                                                                                                    +
                                                                                                                                    SingleOptin
                                                                                                                                    +
                                                                                                                                    This class allows to handle single opt in
                                                                                                                                    +
                                                                                                                                    Stats
                                                                                                                                    +
                                                                                                                                    This class is used to get stats from CRM
                                                                                                                                    + +
                                                                                                                                    + + + + + + +
                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                    +

                                                                                                                                    Search results

                                                                                                                                    + +
                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      + + +
                                                                                                                                      + + + + + + + + diff --git a/documentation/namespaces/ldc-ldccrm-transport.html b/documentation/namespaces/ldc-ldccrm-transport.html new file mode 100644 index 0000000..ffd9cb5 --- /dev/null +++ b/documentation/namespaces/ldc-ldccrm-transport.html @@ -0,0 +1,148 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                                                                                      +

                                                                                                                                      CRM V2

                                                                                                                                      + + + + + +
                                                                                                                                      + +
                                                                                                                                      +
                                                                                                                                      + + + + +
                                                                                                                                      + + +
                                                                                                                                      +

                                                                                                                                      Transport

                                                                                                                                      + + + +

                                                                                                                                      + Interfaces, Classes and Traits + +

                                                                                                                                      + +
                                                                                                                                      + +
                                                                                                                                      Request
                                                                                                                                      +
                                                                                                                                      The LDC CRM request +Contains the http method, the requested url and data to pass
                                                                                                                                      +
                                                                                                                                      Response
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      + + + + + + +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +

                                                                                                                                      Search results

                                                                                                                                      + +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        + + +
                                                                                                                                        + + + + + + + + diff --git a/documentation/namespaces/ldc-ldccrm-wordpress.html b/documentation/namespaces/ldc-ldccrm-wordpress.html new file mode 100644 index 0000000..ac69193 --- /dev/null +++ b/documentation/namespaces/ldc-ldccrm-wordpress.html @@ -0,0 +1,151 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                                                                                        +

                                                                                                                                        CRM V2

                                                                                                                                        + + + + + +
                                                                                                                                        + +
                                                                                                                                        +
                                                                                                                                        + + + + +
                                                                                                                                        + + +
                                                                                                                                        +

                                                                                                                                        WordPress

                                                                                                                                        + + + +

                                                                                                                                        + Interfaces, Classes and Traits + +

                                                                                                                                        + +
                                                                                                                                        + +
                                                                                                                                        WPCrm
                                                                                                                                        +
                                                                                                                                        Class de gestion des users en session avec Wordpress (ce truc immonde)
                                                                                                                                        +
                                                                                                                                        WPCrmAnswer
                                                                                                                                        +
                                                                                                                                        Class de gestion de la segmentation question avec Wordpress (ce truc immonde)
                                                                                                                                        +
                                                                                                                                        WPCrmQuestion
                                                                                                                                        +
                                                                                                                                        Class de gestion de la segmentation question avec Wordpress (ce truc immonde)
                                                                                                                                        +
                                                                                                                                        WPCrmUser
                                                                                                                                        +
                                                                                                                                        Class de gestion des users en session avec Wordpress (ce truc immonde)
                                                                                                                                        + +
                                                                                                                                        + + + + + + +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        +

                                                                                                                                        Search results

                                                                                                                                        + +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          + + +
                                                                                                                                          + + + + + + + + diff --git a/documentation/namespaces/ldc-ldccrm.html b/documentation/namespaces/ldc-ldccrm.html new file mode 100644 index 0000000..eeab387 --- /dev/null +++ b/documentation/namespaces/ldc-ldccrm.html @@ -0,0 +1,158 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                                                                                          +

                                                                                                                                          CRM V2

                                                                                                                                          + + + + + +
                                                                                                                                          + +
                                                                                                                                          +
                                                                                                                                          + + + + +
                                                                                                                                          + + +
                                                                                                                                          +

                                                                                                                                          LDCCRM

                                                                                                                                          + + +

                                                                                                                                          + Namespaces + +

                                                                                                                                          + +
                                                                                                                                          +
                                                                                                                                          Enums
                                                                                                                                          +
                                                                                                                                          Exceptions
                                                                                                                                          +
                                                                                                                                          Models
                                                                                                                                          +
                                                                                                                                          Transport
                                                                                                                                          +
                                                                                                                                          WordPress
                                                                                                                                          +
                                                                                                                                          + +

                                                                                                                                          + Interfaces, Classes and Traits + +

                                                                                                                                          + +
                                                                                                                                          + +
                                                                                                                                          CrmApiV2
                                                                                                                                          +
                                                                                                                                          This is the main class to interact with the CRM
                                                                                                                                          +
                                                                                                                                          Utils
                                                                                                                                          +
                                                                                                                                          This is the LDCCRM utility class
                                                                                                                                          + +
                                                                                                                                          + + + + + + +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +

                                                                                                                                          Search results

                                                                                                                                          + +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                            +
                                                                                                                                            +
                                                                                                                                            +
                                                                                                                                            +
                                                                                                                                            +
                                                                                                                                            + + +
                                                                                                                                            + + + + + + + + diff --git a/documentation/namespaces/ldc.html b/documentation/namespaces/ldc.html new file mode 100644 index 0000000..c8f2e29 --- /dev/null +++ b/documentation/namespaces/ldc.html @@ -0,0 +1,140 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                                                                                            +

                                                                                                                                            CRM V2

                                                                                                                                            + + + + + +
                                                                                                                                            + +
                                                                                                                                            +
                                                                                                                                            + + + + +
                                                                                                                                            +
                                                                                                                                              +
                                                                                                                                            + +
                                                                                                                                            +

                                                                                                                                            LDC

                                                                                                                                            + + +

                                                                                                                                            + Namespaces + +

                                                                                                                                            + +
                                                                                                                                            +
                                                                                                                                            LDCCRM
                                                                                                                                            +
                                                                                                                                            + + + + + + + +
                                                                                                                                            +
                                                                                                                                            +
                                                                                                                                            +
                                                                                                                                            +

                                                                                                                                            Search results

                                                                                                                                            + +
                                                                                                                                            +
                                                                                                                                            +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              + + +
                                                                                                                                              + + + + + + + + diff --git a/documentation/packages/LDCCrmClient-Wordpress.html b/documentation/packages/LDCCrmClient-Wordpress.html new file mode 100644 index 0000000..fbab47b --- /dev/null +++ b/documentation/packages/LDCCrmClient-Wordpress.html @@ -0,0 +1,150 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                                                                                              +

                                                                                                                                              CRM V2

                                                                                                                                              + + + + + +
                                                                                                                                              + +
                                                                                                                                              +
                                                                                                                                              + + + + +
                                                                                                                                              + + +
                                                                                                                                              +

                                                                                                                                              Wordpress

                                                                                                                                              + + + +

                                                                                                                                              + Interfaces, Classes and Traits + +

                                                                                                                                              + +
                                                                                                                                              + +
                                                                                                                                              WPCrm
                                                                                                                                              +
                                                                                                                                              Class de gestion des users en session avec Wordpress (ce truc immonde)
                                                                                                                                              +
                                                                                                                                              WPCrmAnswer
                                                                                                                                              +
                                                                                                                                              Class de gestion de la segmentation question avec Wordpress (ce truc immonde)
                                                                                                                                              +
                                                                                                                                              WPCrmQuestion
                                                                                                                                              +
                                                                                                                                              Class de gestion de la segmentation question avec Wordpress (ce truc immonde)
                                                                                                                                              +
                                                                                                                                              WPCrmUser
                                                                                                                                              +
                                                                                                                                              Class de gestion des users en session avec Wordpress (ce truc immonde)
                                                                                                                                              + +
                                                                                                                                              + + + + + + +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +

                                                                                                                                              Search results

                                                                                                                                              + +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                + + +
                                                                                                                                                + + + + + + + + diff --git a/documentation/packages/LDCCrmClient-enums.html b/documentation/packages/LDCCrmClient-enums.html new file mode 100644 index 0000000..e9eef39 --- /dev/null +++ b/documentation/packages/LDCCrmClient-enums.html @@ -0,0 +1,156 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                +

                                                                                                                                                CRM V2

                                                                                                                                                + + + + + +
                                                                                                                                                + +
                                                                                                                                                +
                                                                                                                                                + + + + +
                                                                                                                                                + + + +
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                +

                                                                                                                                                Search results

                                                                                                                                                + +
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + + +
                                                                                                                                                  + + + + + + + + diff --git a/documentation/packages/LDCCrmClient-exceptions.html b/documentation/packages/LDCCrmClient-exceptions.html new file mode 100644 index 0000000..bfa13ff --- /dev/null +++ b/documentation/packages/LDCCrmClient-exceptions.html @@ -0,0 +1,157 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                  +

                                                                                                                                                  CRM V2

                                                                                                                                                  + + + + + +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  + + + + +
                                                                                                                                                  + + +
                                                                                                                                                  +

                                                                                                                                                  exceptions

                                                                                                                                                  + + + +

                                                                                                                                                  + Interfaces, Classes and Traits + +

                                                                                                                                                  + +
                                                                                                                                                  + +
                                                                                                                                                  ApiErrorException
                                                                                                                                                  +
                                                                                                                                                  This would be thrown if any of the case +referenced in \LDC\LDCCRM\Enums\ApiError would +occur within the crm
                                                                                                                                                  +
                                                                                                                                                  CrmException
                                                                                                                                                  +
                                                                                                                                                  This is a critical error.
                                                                                                                                                  +
                                                                                                                                                  ValidationException
                                                                                                                                                  +
                                                                                                                                                  This would be thrown if a data could not be validated +on any models
                                                                                                                                                  +
                                                                                                                                                  AccessError
                                                                                                                                                  +
                                                                                                                                                  This is thrown when trying to set a value on an object property that does not exist.
                                                                                                                                                  +
                                                                                                                                                  SkipValidationException
                                                                                                                                                  +
                                                                                                                                                  Used only for internal validator
                                                                                                                                                  +
                                                                                                                                                  WpCrmInvalidJsonUserInfo
                                                                                                                                                  +
                                                                                                                                                  This is thrown when trying to read WP customer from DB json data.
                                                                                                                                                  + +
                                                                                                                                                  + + + + + + +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Search results

                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    + + +
                                                                                                                                                    + + + + + + + + diff --git a/documentation/packages/LDCCrmClient-models.html b/documentation/packages/LDCCrmClient-models.html new file mode 100644 index 0000000..69e64b0 --- /dev/null +++ b/documentation/packages/LDCCrmClient-models.html @@ -0,0 +1,162 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                    +

                                                                                                                                                    CRM V2

                                                                                                                                                    + + + + + +
                                                                                                                                                    + +
                                                                                                                                                    +
                                                                                                                                                    + + + + +
                                                                                                                                                    + + +
                                                                                                                                                    +

                                                                                                                                                    models

                                                                                                                                                    + + + +

                                                                                                                                                    + Interfaces, Classes and Traits + +

                                                                                                                                                    + +
                                                                                                                                                    + +
                                                                                                                                                    Answer
                                                                                                                                                    +
                                                                                                                                                    This class represents an answer +It has a method to submit answers
                                                                                                                                                    +
                                                                                                                                                    ArcadiaMailDefault
                                                                                                                                                    +
                                                                                                                                                    This class represents the customer info with +the account validation status
                                                                                                                                                    +
                                                                                                                                                    ArcadiaMailGame
                                                                                                                                                    +
                                                                                                                                                    This class represents the customer info with +the account validation status
                                                                                                                                                    +
                                                                                                                                                    Customer
                                                                                                                                                    +
                                                                                                                                                    This class represents the customer info with +the account validation status. You can use it as +a standalone class but beware of catching exceptions
                                                                                                                                                    +
                                                                                                                                                    Question
                                                                                                                                                    +
                                                                                                                                                    This class represents a question +It has some static methods to retrieve questions and answers
                                                                                                                                                    +
                                                                                                                                                    SingleOptin
                                                                                                                                                    +
                                                                                                                                                    This class allows to handle single opt in
                                                                                                                                                    +
                                                                                                                                                    Stats
                                                                                                                                                    +
                                                                                                                                                    This class is used to get stats from CRM
                                                                                                                                                    + +
                                                                                                                                                    + + + + + + +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    +

                                                                                                                                                    Search results

                                                                                                                                                    + +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      + + +
                                                                                                                                                      + + + + + + + + diff --git a/documentation/packages/LDCCrmClient-transport.html b/documentation/packages/LDCCrmClient-transport.html new file mode 100644 index 0000000..29218c0 --- /dev/null +++ b/documentation/packages/LDCCrmClient-transport.html @@ -0,0 +1,147 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                      +

                                                                                                                                                      CRM V2

                                                                                                                                                      + + + + + +
                                                                                                                                                      + +
                                                                                                                                                      +
                                                                                                                                                      + + + + +
                                                                                                                                                      + + +
                                                                                                                                                      +

                                                                                                                                                      transport

                                                                                                                                                      + + + +

                                                                                                                                                      + Interfaces, Classes and Traits + +

                                                                                                                                                      + +
                                                                                                                                                      + +
                                                                                                                                                      Request
                                                                                                                                                      +
                                                                                                                                                      The LDC CRM request +Contains the http method, the requested url and data to pass
                                                                                                                                                      +
                                                                                                                                                      Response
                                                                                                                                                      +
                                                                                                                                                      + +
                                                                                                                                                      + + + + + + +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      +

                                                                                                                                                      Search results

                                                                                                                                                      + +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        + + +
                                                                                                                                                        + + + + + + + + diff --git a/documentation/packages/LDCCrmClient-utilities.html b/documentation/packages/LDCCrmClient-utilities.html new file mode 100644 index 0000000..36df7b4 --- /dev/null +++ b/documentation/packages/LDCCrmClient-utilities.html @@ -0,0 +1,144 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                        +

                                                                                                                                                        CRM V2

                                                                                                                                                        + + + + + +
                                                                                                                                                        + +
                                                                                                                                                        +
                                                                                                                                                        + + + + +
                                                                                                                                                        + + +
                                                                                                                                                        +

                                                                                                                                                        utilities

                                                                                                                                                        + + + +

                                                                                                                                                        + Interfaces, Classes and Traits + +

                                                                                                                                                        + +
                                                                                                                                                        + +
                                                                                                                                                        Utils
                                                                                                                                                        +
                                                                                                                                                        This is the LDCCRM utility class
                                                                                                                                                        + +
                                                                                                                                                        + + + + + + +
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        +

                                                                                                                                                        Search results

                                                                                                                                                        + +
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          + + +
                                                                                                                                                          + + + + + + + + diff --git a/documentation/packages/LDCCrmClient.html b/documentation/packages/LDCCrmClient.html new file mode 100644 index 0000000..3f93f42 --- /dev/null +++ b/documentation/packages/LDCCrmClient.html @@ -0,0 +1,156 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                          +

                                                                                                                                                          CRM V2

                                                                                                                                                          + + + + + +
                                                                                                                                                          + +
                                                                                                                                                          +
                                                                                                                                                          + + + + +
                                                                                                                                                          +
                                                                                                                                                            +
                                                                                                                                                          + + +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          +

                                                                                                                                                          Search results

                                                                                                                                                          + +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            + + +
                                                                                                                                                            + + + + + + + + diff --git a/documentation/packages/None.html b/documentation/packages/None.html new file mode 100644 index 0000000..cbcdc70 --- /dev/null +++ b/documentation/packages/None.html @@ -0,0 +1,132 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                            +

                                                                                                                                                            CRM V2

                                                                                                                                                            + + + + + +
                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            + + + + +
                                                                                                                                                            +
                                                                                                                                                              +
                                                                                                                                                            + +
                                                                                                                                                            +

                                                                                                                                                            None

                                                                                                                                                            + + + + + + + + + +
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            +

                                                                                                                                                            Search results

                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              + + +
                                                                                                                                                              + + + + + + + + diff --git a/documentation/packages/default.html b/documentation/packages/default.html new file mode 100644 index 0000000..e64a362 --- /dev/null +++ b/documentation/packages/default.html @@ -0,0 +1,141 @@ + + + + + CRM V2 + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                              +

                                                                                                                                                              CRM V2

                                                                                                                                                              + + + + + +
                                                                                                                                                              + +
                                                                                                                                                              +
                                                                                                                                                              + + + + +
                                                                                                                                                              +
                                                                                                                                                                +
                                                                                                                                                              + +
                                                                                                                                                              +

                                                                                                                                                              API Documentation

                                                                                                                                                              + +

                                                                                                                                                              + Packages + +

                                                                                                                                                              + +
                                                                                                                                                              +
                                                                                                                                                              LDCCrmClient
                                                                                                                                                              +
                                                                                                                                                              None
                                                                                                                                                              +
                                                                                                                                                              + + + + + + + + +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +

                                                                                                                                                              Search results

                                                                                                                                                              + +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                + + +
                                                                                                                                                                + + + + + + + + diff --git a/documentation/reports/deprecated.html b/documentation/reports/deprecated.html new file mode 100644 index 0000000..cc64b57 --- /dev/null +++ b/documentation/reports/deprecated.html @@ -0,0 +1,130 @@ + + + + + CRM V2 » Deprecated elements + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                +

                                                                                                                                                                CRM V2

                                                                                                                                                                + + + + + +
                                                                                                                                                                + +
                                                                                                                                                                +
                                                                                                                                                                + + + + +
                                                                                                                                                                + + +
                                                                                                                                                                +

                                                                                                                                                                Deprecated

                                                                                                                                                                + + +
                                                                                                                                                                + No deprecated elements have been found in this project. +
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                +

                                                                                                                                                                Search results

                                                                                                                                                                + +
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  + + +
                                                                                                                                                                  + + + + + + + + diff --git a/documentation/reports/errors.html b/documentation/reports/errors.html new file mode 100644 index 0000000..9e5e6ad --- /dev/null +++ b/documentation/reports/errors.html @@ -0,0 +1,129 @@ + + + + + CRM V2 » Compilation errors + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                  +

                                                                                                                                                                  CRM V2

                                                                                                                                                                  + + + + + +
                                                                                                                                                                  + +
                                                                                                                                                                  +
                                                                                                                                                                  + + + + +
                                                                                                                                                                  + + +
                                                                                                                                                                  +

                                                                                                                                                                  Errors

                                                                                                                                                                  + + +
                                                                                                                                                                  No errors have been found in this project.
                                                                                                                                                                  + +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  +

                                                                                                                                                                  Search results

                                                                                                                                                                  + +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                    +
                                                                                                                                                                    +
                                                                                                                                                                    +
                                                                                                                                                                    +
                                                                                                                                                                    +
                                                                                                                                                                    + + +
                                                                                                                                                                    + + + + + + + + diff --git a/documentation/reports/markers.html b/documentation/reports/markers.html new file mode 100644 index 0000000..9955eeb --- /dev/null +++ b/documentation/reports/markers.html @@ -0,0 +1,768 @@ + + + + + CRM V2 » Markers + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                    +

                                                                                                                                                                    CRM V2

                                                                                                                                                                    + + + + + +
                                                                                                                                                                    + +
                                                                                                                                                                    +
                                                                                                                                                                    + + + + +
                                                                                                                                                                    + + +
                                                                                                                                                                    +

                                                                                                                                                                    Markers

                                                                                                                                                                    + +

                                                                                                                                                                    Table of Contents

                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                    examples/CustomerExample.php1
                                                                                                                                                                    src/Enums/ApiError.php2
                                                                                                                                                                    src/Enums/Country.php1
                                                                                                                                                                    src/Exceptions/ApiErrorException.php2
                                                                                                                                                                    src/Exceptions/CrmException.php1
                                                                                                                                                                    src/Models/Answer.php1
                                                                                                                                                                    src/Models/ArcadiaMailDefault.php3
                                                                                                                                                                    src/Models/ArcadiaMailGame.php2
                                                                                                                                                                    src/Models/CrmClientModel.php5
                                                                                                                                                                    src/Models/Customer.php5
                                                                                                                                                                    src/Models/Question.php3
                                                                                                                                                                    src/Transport/ApiInterface.php6
                                                                                                                                                                    src/Transport/Request.php1
                                                                                                                                                                    src/Transport/Response.php4
                                                                                                                                                                    src/Utils.php8
                                                                                                                                                                    src/WordPress/WPCrm.php8
                                                                                                                                                                    src/WordPress/WPCrmAnswer.php2
                                                                                                                                                                    src/WordPress/WPCrmQuestion.php6
                                                                                                                                                                    src/WordPress/WPCrmUser.php2
                                                                                                                                                                    + + +

                                                                                                                                                                    CustomerExample.php

                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                    TypeLineDescription
                                                                                                                                                                    53phpcs:ignore Squiz.PHP.DiscouragedFunctions.Found
                                                                                                                                                                    + +

                                                                                                                                                                    ApiError.php

                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                    TypeLineDescription
                                                                                                                                                                    53supportweb.ldc.fr
                                                                                                                                                                    59supportweb.ldc.fr
                                                                                                                                                                    + +

                                                                                                                                                                    Country.php

                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                    TypeLineDescription
                                                                                                                                                                    9datahub.io/core/country-list Data Hub country list
                                                                                                                                                                    + +

                                                                                                                                                                    ApiErrorException.php

                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                    TypeLineDescription
                                                                                                                                                                    100@codeCoverageIgnoreStart
                                                                                                                                                                    102@codeCoverageIgnoreEnd
                                                                                                                                                                    + +

                                                                                                                                                                    CrmException.php

                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                    TypeLineDescription
                                                                                                                                                                    11supportweb.ldc.fr
                                                                                                                                                                    + +

                                                                                                                                                                    Answer.php

                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                    TypeLineDescription
                                                                                                                                                                    80* PUBLIC METHODS
                                                                                                                                                                    + +

                                                                                                                                                                    ArcadiaMailDefault.php

                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                    TypeLineDescription
                                                                                                                                                                    325* Cast anyway
                                                                                                                                                                    349Use this to throw validation error.
                                                                                                                                                                    357* PUBLIC METHODS
                                                                                                                                                                    + +

                                                                                                                                                                    ArcadiaMailGame.php

                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                    TypeLineDescription
                                                                                                                                                                    294* Cast anyway
                                                                                                                                                                    301* PUBLIC METHODS
                                                                                                                                                                    + +

                                                                                                                                                                    CrmClientModel.php

                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                    TypeLineDescription
                                                                                                                                                                    118phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedCatch
                                                                                                                                                                    120Do nothing.
                                                                                                                                                                    148* Force boolean
                                                                                                                                                                    166end foreach
                                                                                                                                                                    167end if
                                                                                                                                                                    + +

                                                                                                                                                                    Customer.php

                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                    TypeLineDescription
                                                                                                                                                                    349* Cast anyway
                                                                                                                                                                    370Use this to throw validation error.
                                                                                                                                                                    378* PUBLIC METHODS
                                                                                                                                                                    399! Use fillRaw here because we cant validate comming
                                                                                                                                                                    400! from CRM since it has crappy data comming from the old crm (jellix).
                                                                                                                                                                    + +

                                                                                                                                                                    Question.php

                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                    TypeLineDescription
                                                                                                                                                                    158* Cast anyway
                                                                                                                                                                    179Use this to throw validation error.
                                                                                                                                                                    187* PUBLIC METHODS
                                                                                                                                                                    + +

                                                                                                                                                                    ApiInterface.php

                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                    TypeLineDescription
                                                                                                                                                                    78Handle HTTP Auth .
                                                                                                                                                                    97* Handle response Status.
                                                                                                                                                                    175! UTC date time.
                                                                                                                                                                    195%s%s',
                                                                                                                                                                    196Assume https if non provided, security first.
                                                                                                                                                                    221! Natural sort by keys.
                                                                                                                                                                    + +

                                                                                                                                                                    Request.php

                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                    TypeLineDescription
                                                                                                                                                                    169! Do not throw HTTP Exceptions.
                                                                                                                                                                    + +

                                                                                                                                                                    Response.php

                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                    TypeLineDescription
                                                                                                                                                                    97* Body should be json data.
                                                                                                                                                                    106* If Api Error.
                                                                                                                                                                    108* If CRM Exception or Any Exception.
                                                                                                                                                                    112* From here it should be an ApiErrorException.
                                                                                                                                                                    + +

                                                                                                                                                                    Utils.php

                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                    TypeLineDescription
                                                                                                                                                                    58end foreach
                                                                                                                                                                    59end foreach
                                                                                                                                                                    126end switch
                                                                                                                                                                    129* VALIDATION RULES
                                                                                                                                                                    502* END VALIDATION RULES
                                                                                                                                                                    534Convert bool to integer.
                                                                                                                                                                    641end switch
                                                                                                                                                                    643end if
                                                                                                                                                                    + +

                                                                                                                                                                    WPCrm.php

                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                    TypeLineDescription
                                                                                                                                                                    9opensource.org/licenses/MIT
                                                                                                                                                                    43opensource.org/licenses/MIT
                                                                                                                                                                    351* --- PRIVATE --- METHODS
                                                                                                                                                                    475If session identity is violated.
                                                                                                                                                                    477If session timed out.
                                                                                                                                                                    480* 15 minutes session.
                                                                                                                                                                    483Destroy session.
                                                                                                                                                                    621phpcs:ignore Squiz.PHP.GlobalKeyword.NotAllowed
                                                                                                                                                                    + +

                                                                                                                                                                    WPCrmAnswer.php

                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                    TypeLineDescription
                                                                                                                                                                    9opensource.org/licenses/MIT
                                                                                                                                                                    24opensource.org/licenses/MIT
                                                                                                                                                                    + +

                                                                                                                                                                    WPCrmQuestion.php

                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                    TypeLineDescription
                                                                                                                                                                    9opensource.org/licenses/MIT
                                                                                                                                                                    25opensource.org/licenses/MIT
                                                                                                                                                                    57* Force loading of user info from crm
                                                                                                                                                                    61* Get the raw customer
                                                                                                                                                                    80* Force loading of user info from crm
                                                                                                                                                                    84* Get the raw customer
                                                                                                                                                                    + +

                                                                                                                                                                    WPCrmUser.php

                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                    TypeLineDescription
                                                                                                                                                                    9opensource.org/licenses/MIT
                                                                                                                                                                    66opensource.org/licenses/MIT
                                                                                                                                                                    +
                                                                                                                                                                    +
                                                                                                                                                                    +
                                                                                                                                                                    +
                                                                                                                                                                    +

                                                                                                                                                                    Search results

                                                                                                                                                                    + +
                                                                                                                                                                    +
                                                                                                                                                                    +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      + + +
                                                                                                                                                                      + + + + + + + + diff --git a/src/Models/Customer.php b/src/Models/Customer.php index 78ba1b3..3d715f4 100644 --- a/src/Models/Customer.php +++ b/src/Models/Customer.php @@ -445,10 +445,14 @@ class Customer extends CrmClientModel Utils::setRawProperty($this, 'password', null); } return $saved; - } - if ($saved = $this->update()) { - $this->updatedValues = []; - Utils::setRawProperty($this, 'password', null); + } else { + if (empty($this->updatedValues)) { + return true; + } + if ($saved = $this->update()) { + $this->updatedValues = []; + Utils::setRawProperty($this, 'password', null); + } } return $saved; } diff --git a/src/Transport/ApiInterface.php b/src/Transport/ApiInterface.php index 0898dec..4041da9 100644 --- a/src/Transport/ApiInterface.php +++ b/src/Transport/ApiInterface.php @@ -65,6 +65,10 @@ class ApiInterface self::$bearerToken = self::$bearerToken ?: $bearerToken; self::$bearerPwd = self::$bearerPwd ?: $bearerPwd; + static::$bearerToken = static::$bearerToken ?: Utils::getConfig('crm.token'); + static::$bearerPwd = static::$bearerPwd ?: Utils::getConfig('crm.password'); + static::$endpoint = static::$endpoint ?: Utils::getConfig('crm.endpoint'); + if (!self::$bearerToken or !self::$bearerPwd or !self::$endpoint) { throw new CrmException( 'Either config or .env file need to have the token var set (crm.token, crm.password, crm.endpoint)' diff --git a/src/WordPress/WPCrm.php b/src/WordPress/WPCrm.php index 15d4d47..9c4601a 100644 --- a/src/WordPress/WPCrm.php +++ b/src/WordPress/WPCrm.php @@ -85,6 +85,21 @@ class WPCrm return self::$user; } + /** + * Manually login a user + * If self::$user is already set. + * + * @return \LDCCRM\WPCrmUser|null + */ + public static function forceLogin() + { + self::bootSessionIfNeeded(); + if ($user = self::getUser()) { + $_SESSION['wpcrm'][self::$sessionKey] = json_encode($user); + } + return $user; + } + /** * Get the current user * return api response code if an error occurs @@ -124,7 +139,7 @@ class WPCrm * @param string $email The customer email. * @param string $password The customer password. * - * @return \LDC\LDCCRM\WordPress\WPCrmUser|false + * @return boolean * @throws \LDC\LDCCRM\Exceptions\CrmException If an error occurs on server side or on getting response. * @throws \LDC\LDCCRM\Exceptions\ApiErrorException If any error or \LDC\LDCCRM\Enums\ApiError occurs. * Possibles are : - authFailed, If credentials are not valid. @@ -428,14 +443,14 @@ class WPCrm } catch (ApiErrorException $e) { switch ($e->getApiError()) { case ApiError::apiAuthFailed(): - Utils::log($e->getMessage(), LogLevel::EMERG()); + Utils::log($e->getMessage(), LogLevel::CRIT()); throw $e; default: Utils::log($e->getMessage(), LogLevel::DEBUG()); throw $e; } } catch (CrmException $e) { - Utils::log($e->getMessage(), LogLevel::EMERG()); + Utils::log($e->getMessage(), LogLevel::CRIT()); throw $e; } } @@ -450,12 +465,12 @@ class WPCrm self::$sessionKey = ($_SERVER['HTTP_USER_AGENT'] ?? '') . ($_SERVER['REMOTE_ADDR'] ?? ''); /** @var string self::$sessionKey */ self::$sessionKey = \strlen(self::$sessionKey) ? self::$sessionKey : (date('d') ? date('d') : ''); - if (!isset($_SESSION['wpcrm'])) { - $_SESSION['wpcrm'] = []; - } if (!session_id() && !self::$sessionDestroyed) { session_start(); } + if (!isset($_SESSION['wpcrm'])) { + $_SESSION['wpcrm'] = []; + } if ( // If session identity is violated. count($_SESSION['wpcrm']) > 1 or