Documentation

BasicInput
in package
implements Input

Represents a single entry in the data file "i" (inputs) node.

Tags
author

DeviceAtlas Limited

Interfaces, Classes and Traits

Input

Table of Contents

$aIN  : mixed
$cSS  : mixed
$DOUBLE_QUOTE  : mixed
$eCHQ  : mixed
$EMPTY_CH_STRING  : mixed
$hS  : mixed
$k  : mixed
$s  : mixed
$SOURCE_CLIENT_SIDE  : mixed
$SOURCE_HEADER  : mixed
__construct()  : mixed
addAssociatedIdentifierName()  : mixed
This input may be an associated input to one or more identifier inputs.
canBeUsed()  : mixed
Can only use the input if it is present in the headers.
getAssociatedIdentifierNames()  : mixed
A given input may be a supporting associated input for an identifier. This method returns a collection of the associated parent identifier names that this input is associated to.
getAssociatedInputs()  : mixed
getIdentifierValue()  : mixed
Ensures the identifier value is wrapped in double quotes if required.
getKey()  : mixed
getSource()  : mixed
hasAssociatedInputs()  : mixed
isClientSideSource()  : mixed
isEmptyValue()  : mixed
isEnsureClientHintQuote()  : mixed
isHeaderSource()  : mixed

Properties

$DOUBLE_QUOTE

private static mixed $DOUBLE_QUOTE = '"'

$EMPTY_CH_STRING

private static mixed $EMPTY_CH_STRING = """"

$SOURCE_CLIENT_SIDE

private static mixed $SOURCE_CLIENT_SIDE = "c"

$SOURCE_HEADER

private static mixed $SOURCE_HEADER = "h"

Methods

__construct()

public __construct(mixed $key, mixed $source, mixed $ensureClientHintQuote) : mixed
Parameters
$key : mixed
$source : mixed
$ensureClientHintQuote : mixed
Return values
mixed —

addAssociatedIdentifierName()

This input may be an associated input to one or more identifier inputs.

public addAssociatedIdentifierName( $identifierName) : mixed

Record all the associated identifier inputs.

Parameters
$identifierName :
Return values
mixed —

canBeUsed()

Can only use the input if it is present in the headers.

public canBeUsed(mixed $headers) : mixed
Parameters
$headers : mixed
Return values
mixed —

getAssociatedIdentifierNames()

A given input may be a supporting associated input for an identifier. This method returns a collection of the associated parent identifier names that this input is associated to.

public getAssociatedIdentifierNames() : mixed
Return values
mixed —

getAssociatedInputs()

public getAssociatedInputs() : mixed
Return values
mixed —

getIdentifierValue()

Ensures the identifier value is wrapped in double quotes if required.

public getIdentifierValue(mixed $identifierValue) : mixed
Parameters
$identifierValue : mixed
Return values
mixed —

getKey()

public getKey() : mixed
Return values
mixed —

getSource()

public getSource() : mixed
Return values
mixed —

hasAssociatedInputs()

public hasAssociatedInputs() : mixed
Return values
mixed —

isClientSideSource()

public isClientSideSource() : mixed
Return values
mixed —

isEmptyValue()

public static isEmptyValue(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed —

isEnsureClientHintQuote()

public isEnsureClientHintQuote() : mixed
Return values
mixed —

isHeaderSource()

public isHeaderSource() : mixed
Return values
mixed —

Search results