AbstractResponse

Constructor

Translate the raw API response into its canonical form.

Brand-specific by the ResponseTranslator each subclass imports; $cmd is already sanitized.

Parse the translated response into the hash and build the column/record lists from it. Brand-specific because each brand's parser returns a different hash shape (CNR nests columns under PROPERTY, IBS is a flat key => value map). The sanitized command is available as $this->command, and the parser — the brand default or the injected substitute — as $this->parser.

Instantiate the response parser for this brand.

Factory hook mirroring {\CNIC\newRecord()} and {\CNIC\AbstractClient::newTransport()}: it supplies the default, and the constructor's $parser argument overrides it — so a substitute parser needs neither reflection nor a subclass. populate() must parse through $this->parser; instantiating a parser inline there behaves identically and silently closes the seam, which is why the guard is structural (tests/ResponseParserSeamTest.php).

Instantiate the record type for this brand.

Factory hook for addRecord(). Records share one shape across brands (array<string,mixed>), so every brand currently returns the same shared CNIC\Record — the hook stays abstract nonetheless, because it is the seam a brand needing genuinely different row behaviour would implement, and hard-coding the shared Record here would close it. (Unlike columns, whose value types diverge and so cannot use a param-typed factory at all — see registerColumn().)

Mask the brand's sensitive command keys (see $sensitiveFields) so their values can never be read back from the response (e.g. by custom loggers).

Matching is case-insensitive to stay robust against casing differences between what a brand documents and what it actually sends.

Assemble the record (row) list from the columns already added via addColumn(). Shared by all brands: each subclass populates the columns with its own Column type beforehand, while the row assembly is identical.

Get context data for the response

Get Request URL

Get Plain API response

Get API response as Hash

Register an already-constructed column into the list bookkeeping.

The bookkeeping ($columns/$columnKeys/$columnIndex) is identical for every brand; what differs is the column's value type. Rather than a param-typed newColumn() factory — which cannot stay type-clean under PHPStan L9 / Psalm L1, because CNR columns take string[] while IBS columns take mixed[] and a shared factory would have to narrow one into the other — each brand's addColumn() builds its own correctly-typed Column locally and hands the finished instance here, so this shared helper never sees the brand types.

Add a record to the record list

Get column by column name

Get Data by Column Name and Index

Get Column Names

Get List of Columns

Get Command used in this request

Get Command used in this request in plain text format

Get Record of current record index

Get next record in record list

Get Page Number of next list query

Get the number of pages available for this list query

Get object containing all paging data

Get Page Number of previous list query

Get previous record in record list

Get Record at given index

Get all Records

Get count of rows in this response

Reset index in record list back to zero

Check if the record list contains a record for the current record index in use

Check if the record list contains a next record for the current record index in use

Check if the record list contains a previous record for the current record index in use

Get a string value from the hash by key, returning a default if not found or not a string

Get an array value from the hash by key, returning an empty array if not found or not an array. The twin of {getHashString()} for the nested blocks a brand's populate() reads (e.g. CNR's PROPERTY).