Overview
  • Package
  • Class
  • Tree
  • Todo

Packages

  • AddonValue
    • Interfaces
  • AdminAccess
    • Collections
    • Deleters
    • Entities
    • Exceptions
    • Factories
    • Interfaces
    • Managers
    • Readers
    • Writers
  • AdminHttpViewControllers
  • ApiV2Controllers
  • Authentication
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Strategies
  • Category
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • Customer
    • Address
    • Country
    • CountryZone
    • Interfaces
    • Storages
    • Validation
    • ValueObjects
  • CustomerGroup
    • Entities
    • Factories
    • Interfaces
    • Repositories
    • Serializers
    • Services
    • ValueObjects
  • Email
    • Collections
    • Entities
    • Exceptions
    • Interfaces
    • Repository
    • ValueObjects
  • Extensions
    • Customers
    • Emails
    • Geschaeftskundenversand
    • Helpers
    • Invoices
    • Orders
    • ParcelShopFinder
    • QuickEdit
    • Serializers
    • Templates
  • Geschaeftskundenversand
    • Exceptions
  • Http
    • Collections
    • Exceptions
    • Factories
    • Interfaces
    • ValueObjects
  • HttpViewControllers
  • InfoBox
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
  • Invoice
    • Interfaces
    • ValueObjects
  • Loaders
    • CrossCuttingLoader
    • GXCoreLoader
    • Interfaces
  • Manufacturer
    • Entities
    • Factories
    • Interfaces
    • Repositories
  • Modules
    • Collections
    • Controllers
    • Interfaces
  • None
  • Order
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
    • Storages
    • ValueObjects
  • OrderStatus
    • Collections
    • Entities
    • Exceptions
    • Factories
    • Interfaces
    • Repositories
  • Precheck
  • Product
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • ProductModule
    • Collections
    • Deleter
    • Entities
    • Factories
    • Interface
    • Interfaces
    • Reader
    • Repositories
    • Writer
  • QuantityUnit
    • Entities
    • Factories
    • Repositories
  • QuickEdit
    • Interfaces
    • Repositories
  • Review
    • Entities
    • Factories
    • Interfaces
    • Repositories
    • Services
    • ValueObjects
  • Shared
    • ClassFinder
    • Exceptions
    • FileSystem
    • Interfaces
    • Storage
    • Types
  • SharedShoppingCart
    • Interfaces
  • Slider
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
    • Storages
  • Smarty
    • plugins
  • StaticSeoUrl
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
  • StaticSeoUrls
  • Statistics
    • Interfaces
  • UserConfiguration
    • Interfaces
    • Repository
  • VersionInfo
    • Factories
    • Reader
    • ValueObjects
  • VPE
    • Entities
    • Factories
    • Repositories
  • Withdrawal
    • Entities
    • Factories
    • Interfaces
    • Repositories
    • Services
    • ValueObjects

Classes

  • ActiveRecordParcelTrackingCode
  • ApiV2Authenticator
  • CustomerConfigurationProvider
  • CustomerConfigurationSettings
  • CustomerDisplaySettings
  • CustomerErrorMessageSettings
  • CustomerMaxLengthSettings
  • CustomerMinLengthSettings
  • EmailConfigurationProvider
  • EmailMailerSettings
  • FontAwesomeIconClassProvider
  • GXModuleCenterModuleButtonActionsAjaxController
  • GXModuleConfigurationStorage
  • GXModuleController
  • GXParcelTrackingCode
  • GXParcelTrackingCodeWriter
  • GXSmarty
  • ManufacturerServiceFactory
  • OrderConfigurationProvider
  • OrderParcelTrackingCode
  • OrderStatusAjaxController
  • ParcelTrackingCodeComment
  • ParcelTrackingCodeDeleter
  • ParcelTrackingCodeDeleteService
  • ParcelTrackingCodeFactory
  • ParcelTrackingCodeFinder
  • ParcelTrackingCodeId
  • ParcelTrackingCodeLanguageId
  • ParcelTrackingCodeOrderId
  • ParcelTrackingCodeRepository
  • ParcelTrackingCodeServiceId
  • ParcelTrackingCodeServiceName
  • ParcelTrackingCodeUrl
  • ProductRepositoryDeleteHelper
  • ShopOfflineController
  • Smarty_Resource_Get_Usermod
  • ZonesController

Traits

  • ContentManagerContentNavigationTrait
  • HtmlUtilityTrait
  • StringUtilityTrait
  • XtcUtilityTrait

Exceptions

  • CountryZoneNotFoundException
  • ShipcloudWebhookException

Functions

  • smarty_function_check_magna_execute
  • smarty_function_check_mailbeez_menu
  • smarty_function_get_sub_categories
  • smarty_function_gm_footer
  • smarty_function_gm_get_conf
  • smarty_function_gm_gmotion
  • smarty_function_gm_gprint
  • smarty_function_gm_menuboxes
  • smarty_function_html_shop_offline
  • smarty_function_is_filemanager_available
  • smarty_function_load_env_array
  • smarty_function_load_language_text
  • smarty_function_object_product_list
  • smarty_function_page_url
  • smarty_function_pre_black_container
  • smarty_modifier_gm_get_conf
  • smarty_modifier_gm_get_env_info
  • smarty_modifier_has_children
  • smarty_modifier_xtc_href_link
  • smarty_outputfilter_note
  • smarty_php_tag

Class CustomerConfigurationProvider

Class CustomerConfigurationProvider

Located at Services/Core/Customer/CustomerConfigurationProvider.inc.php

Methods summary

public
# __construct( CI_DB_query_builder $db, LanguageTextManager $languageTextManager )

CustomerConfigurationProvider constructor.

CustomerConfigurationProvider constructor.

Parameters

$db
Database access, required to fetch configurations.
$languageTextManager
Text manager to fetch error messages.
public integer
# minLength( StringType $configField )

Minimum length of provided configuration field. Allowed fields are 'firstName', 'lastName', 'dateOfBirth', 'dob', 'email', 'street', 'houseNumber', 'company', 'postcode', 'city', 'countryZone', 'suburb', 'state', 'telephone', 'password'.

Minimum length of provided configuration field. Allowed fields are 'firstName', 'lastName', 'dateOfBirth', 'dob', 'email', 'street', 'houseNumber', 'company', 'postcode', 'city', 'countryZone', 'suburb', 'state', 'telephone', 'password'.

Parameters

$configField
Determines for which configuration field the minimum length should be provided.

Returns

integer
Minimum length of provided configuration field.
public boolean
# display( StringType $configField )

Should the provided configuration field be displayed? Allowed fields are 'gender', 'dob', 'dateOfBirth', 'company', 'state', 'telephone', 'fax', 'suburb'.

Should the provided configuration field be displayed? Allowed fields are 'gender', 'dob', 'dateOfBirth', 'company', 'state', 'telephone', 'fax', 'suburb'.

Parameters

$configField
Determines for which configuration field the display check should be performed.

Returns

boolean
True if provided configuration field should be displayed and false otherwise.
public string
# errorMessage( StringType $configField )

Error message for provided configuration field. Allowed fields are 'gender', 'firstName', 'lastName', 'dateOfBirth', 'company', 'vatNumber', 'email', 'emailAddressCheck', 'emailConfirmation', 'emailExists', 'street', 'houseNumber', 'postcode', 'city', 'country', 'countryZone', 'countryZoneSelection', 'telephone', 'password', 'passwordMismatch', 'privacy', 'invalidInput'.

Error message for provided configuration field. Allowed fields are 'gender', 'firstName', 'lastName', 'dateOfBirth', 'company', 'vatNumber', 'email', 'emailAddressCheck', 'emailConfirmation', 'emailExists', 'street', 'houseNumber', 'postcode', 'city', 'country', 'countryZone', 'countryZoneSelection', 'telephone', 'password', 'passwordMismatch', 'privacy', 'invalidInput'.

Parameters

$configField
Determines for which configuration field the error message should be provided.

Returns

string
Error message of provided configuration field.
public boolean
# configuration( StringType $configField )

Checks if given configuration is enabled. Allowed fields are 'acceptPrivacy', 'optionalNames', 'splitStreetInformation'.

Checks if given configuration is enabled. Allowed fields are 'acceptPrivacy', 'optionalNames', 'splitStreetInformation'.

Parameters

$configField
Determines for which configuration field should be checked.

Returns

boolean
True if configuration is enabled and false otherwise.
public integer
# defaultStatusId( StringType $configField )

Provides the default status id for customers and guests. Allowed fields are 'customer' and 'guest'.

Provides the default status id for customers and guests. Allowed fields are 'customer' and 'guest'.

Parameters

$configField
Either 'guest' or 'customer'.

Returns

integer
Default status id of given config field.
protected
# checkIfFieldExists( StringType $configField, array $fields )

Checks if given configuration field exists.

Checks if given configuration field exists.

Parameters

$configField
Expected configuration field.
$fields
Allowed configuration fields.

Returns


$this|\CustomerConfigurationProvider Same instance for chained method calls.

Throws

InvalidArgumentException
If provided config field do not exist.
API documentation generated by ApiGen