SocketConfig

Seed the runtime state that depends on the brand's property defaults.

Both seeds have to happen after the subclass's property initialisers, which is why they are here and not inline defaults: {$url} starts at the brand's {$liveUrl} (LIVE is the default system) and {$curlOptions} at the brand's {\CNIC\getDefaultCurlOpts()}.

Set account name to use

Get current login

Set account password to use

Get the endpoint API requests are sent to — the effective URL.

The stored {$url}, with the loopback rewrite applied when high-performance mode is on. That rewrite is resolved here on every read rather than burnt into {$url}, so switching systems afterwards keeps it and {\CNIC\getSystem()} still knows which system was selected.

Note the asymmetry with {\CNIC\setURL()}, which is deliberate: this returns where requests go, while setURL()/{\CNIC\getSystem()}/{@see \CNIC\isOTE()} operate on which endpoint was selected. The two differ only under high-performance routing, and only in that direction — so do not round-trip one into the other: setURL($cfg->getURL()) burns the loopback rewrite into the selection and loses the system, which is the very drift this class exists to prevent.

Set another connection url to be used for API communication.

This replaces the endpoint selection wholesale, so a URL that is neither {$oteUrl} nor {$liveUrl} leaves {\CNIC\getSystem()} answering null — the SDK cannot know which system an arbitrary host fronts, and answering with the last selection is how a stored flag comes to disagree with the URL in use.

Get OT&E endpoint URL

Get LIVE endpoint URL

Get the API system currently in use, or null when the configured URL is neither of the brand's two known endpoints.

Derived from {$url}, never stored — a stored copy is a second answer waiting to contradict the first. The null case is honest rather than defensive: after setURL("https://staging.example/") the client is on a system the SDK has no name for, and a caller branching on OT&E-vs-LIVE needs to see that rather than be told "LIVE".

Check whether the OT&E endpoint is in use

Select the OT&E system for API communication

Select the LIVE system for API communication (the default)

Route API requests through the co-located high-performance proxy on loopback.

Recorded as a flag and applied by {\CNIC\getURL()} on every read, not by rewriting {$url} once: an eager rewrite silently costs the caller isOTE()/getSystem(). It therefore also survives a later useOTESystem()/useLIVESystem()/setURL() — high-performance routing is a property of how to reach the endpoint, not of which endpoint. There is no disable method; construct a fresh client if you need one without it.

Whether high-performance (loopback proxy) routing is switched on

Set the proxy to use for API communication

Get the proxy configured for API communication, or null for a direct connection

Set the Referer to send with API requests

Get the Referer sent with API requests, or null when none is sent

Brand-default cURL options, used to seed and to reset {$curlOptions}.

No brand overrides this, and new overrides should be resisted — transport tuning is the caller's decision via {\CNIC\setExtraCurlOptions()}, and a brand default that papers over one environment's networking does not qualify. The bar is a genuinely protocol-mandatory option. The hook is kept because it is the seam {\CNIC\resetCurlOptions()} is defined in terms of: reset restores these defaults rather than blindly wiping the bag. Guarded by ClientConfigSeamTest::testNoBrandOverridesTheDefaultCurlOptsHook().

Merge additional cURL options into the bag, overriding existing values on key collision (including brand defaults). Use {resetCurlOptions()} to restore the brand defaults afterwards.

What lands here reaches the wire: {\CNIC\HttpTransport::post()} applies the bag over its own defaults, so an option of yours wins on collision. Two sets of keys are refused rather than allowed to become a second answer or a silent loser:

• {\CNIC\MANAGED_OPTIONS} — CURLOPT_TIMEOUT, USERAGENT, PROXY and REFERER each already have a setter that owns them. Rejected here, immediately, naming the setter to use instead.
• {\CNIC\HttpTransport::PROTECTED_OPTIONS} — the request envelope (CURLOPT_URL/POST/POSTFIELDS/RETURNTRANSFER/HEADER) and the TLS verification posture (SSL_VERIFYPEER/SSL_VERIFYHOST). Those belong to the transport, which rejects them on the next request; the config does not pre-empt that check, because the transport is injectable ({\CNIC\TransportInterface}) and which options it owns is its own business.

CURLOPT_HTTPHEADER is additive at the transport: your lines are appended, and restating one of the transport's own throws.

Restore the cURL option bag to the brand defaults ({getDefaultCurlOpts()}), discarding anything previously handed to {setExtraCurlOptions()}.

Scope note: options only. The proxy and the referer are not bag keys ({$proxy}/{@see $referer}), so this does not forget them — reset those explicitly with setProxy()/setReferer() if that is what you meant.

It restores the defaults rather than clearing the bag, so a brand default would survive; no brand declares one, so today this empties the bag.

The cURL options to hand the transport for a request: the dedicated proxy/referer state plus the caller's bag.

The dedicated state goes on the left of the union — the side PHP's + keeps on a duplicate key — so what {\CNIC\getProxy()} reports is what goes on the wire, structurally rather than by convention. Do not "simplify" the order on the grounds that {\CNIC\setExtraCurlOptions()} already refuses those two keys: that guard is not the only writer of {$curlOptions}, since {\CNIC\getDefaultCurlOpts()} seeds it through the constructor and {\CNIC\resetCurlOptions()} re-seeds it, neither passing through the guard. A brand default of CURLOPT_PROXY would then leave the getter reporting the setter's value while the request used the default. Pinned by AbstractClientConfigDriftTest::testDedicatedProxyStateBeatsABrandDefaultOnTheWire().

Get socket timeout in seconds

Set the socket timeout in seconds — the ceiling on a whole API request.

The single home for the request timeout: the bag rejects CURLOPT_TIMEOUT ({\CNIC\MANAGED_OPTIONS}), so this is the only way in and {\CNIC\getSocketTimeout()} the only answer. {\CNIC\AbstractClient::setSocketTimeout()} forwards here.

0 carries cURL's meaning — no timeout — and is passed through unchanged. A negative value is rejected rather than forwarded: cURL refuses it by returning false from curl_setopt(), whose result curl_setopt_array() does not surface, so forwarding it would drop the setting with no signal.

Mask the values of the brand's sensitive command keys (see $sensitiveFields) so command-level secrets — e.g. a domain transfer authorization code — never reach the debug log in cleartext. Matching is case-insensitive to stay robust against casing differences between what a brand documents and what it actually sends. null values are left untouched (they are dropped from the request, not logged).

Get POST data container of connection data

Create POST data string out of connection data.

Purely the encoding step: every parameter, including brand-specific ones, comes from {\CNIC\getPOSTDataParams()}. Do not reintroduce brand knowledge at this level — CNR's persistent=1 is appended by its own getPOSTDataParams(), which is why this method knows nothing brand-specific.