upmind-automation / provision-provider-base Goto Github PK

Task
If there aren't any updates available to the package(s) we use for intl phone validation, then we will need some way of overriding for certain countries.
Valid phone numbers which currently throw validation errors:

Zimbabwe: [redacted]
Morocco: [redacted]
Ivory Coast: [redacted]

For example when registering a domain name, some TLDs require additional fields such as registrant type (individual/organisation).

This could be defined in the RegisterParams dataset rules() like so:

    return new Rules([
        // ...
        'additional_fields' => ['upmind_dynamic_rules:getRegisterAdditionalFieldRules'],
        // ...
    ]);

The argument passed to the upmind_dynamic_rules would specify where to get the validation rules from for the additional_fields object, so in this case we need to call the provider's getRegisterAdditionalFieldRules() method, which in-turn may specify which params it requires in order to return the rules we need, such as the tld.

This allows the provision system client to build a dynamic html form for domain registrations, once it knows which tld the customer wants to register a domain for, and once it has determined which provision provider to use.

Caching the dynamic rules (per provider + tld and perhaps per provision configuration) should negate any performance impact of the blocking call to getRegisterAdditionalFieldRules().

The idea here is that a provider can optionally specify which functions and/or parameters it supports, so that it's possible to know ahead of time whether to display a particular function or field in UIs when the provider is known and has specified its capabilities

Related: upmind-automation/provision-provider-domain-names#4

For example: for environments where it's not possible to determine the outgoing IP address(es) such as during background processes, or in less traditional environments / internal containers etc, this could be injected into the Provider using a setter method when constructing instances in ProviderFactory.

For embedding CTAs within the application to help users sign up for services that they want to sell

Currently attempting to serialize the registry (for caching) on PHP 7.4 throws an error due to it containing Reflection objects

Instead of re-throwing these as a generic "Internal provision provider error", throw a more appropriate error message.

I have found that readme has a string composer require upmind/provision-provider-shared-hosting
but composer.json is "name": "upmind/provision-provider-base",