API Documentation
\
FACTFinder
Adapter
Core
Client
Server
Data
Util

\FACTFinder\AdapterRecommendation

Base class for all adapters which support the personalisation.

The adapter classes could conceivably be placed in the \Core\Server namespace, but that would potentially discourage fiddling with and extending these classes. The adapters are main components of the external API of this library. Most other classes are just used to make the adapters work.

Summary

Methods
Properties
Constants
__construct()
setSid()
setIdsOnly()
getError()
getStackTrace()
setRecordCount()
setProductIDs()
addProductIDs()
getRecommendations()
getRawRecommendations()
No public properties found
No constants found
usePassthroughResponseContentProcessor()
useJsonResponseContentProcessor()
useXmlResponseContentProcessor()
useResponseContentProcessor()
getResponseContent()
convertServerQueryToClientUrl()
isValidResponse()
$sid
$idsOnly
$configuration
$request
$parameters
$urlBuilder
$upToDate
N/A
createRecommendations()
createRecord()
$log
$responseContentProcessor
$lastResponse
$responseContent
$error
$stackTrace
$recommendations
N/A

Properties

$sid

$sid : string

Type

string

$idsOnly

$idsOnly : boolean

Type

boolean

$parameters

$parameters : \FACTFinder\Adapter\FACTFinder\Util\Parameters

Type

\FACTFinder\Adapter\FACTFinder\Util\Parameters

$upToDate

$upToDate : boolean

Type

boolean

$log

$log : \FACTFinder\Adapter\FACTFinder\Util\LoggerInterface

Type

\FACTFinder\Adapter\FACTFinder\Util\LoggerInterface

$responseContentProcessor

$responseContentProcessor : \FACTFinder\Util\ContentProcessorInterface

Type

\FACTFinder\Util\ContentProcessorInterface

$responseContent

$responseContent : object

Type

object — The processed response content.

$error

$error : string

Type

string — The last error message.

$stackTrace

$stackTrace : string

Type

string — The last stack trace.

$recommendations

$recommendations : \FACTFinder\Adapter\FACTFinder\Data\Result

Type

\FACTFinder\Adapter\FACTFinder\Data\Result

Methods

__construct()

__construct(string  $loggerClass, \FACTFinder\Core\ConfigurationInterface  $configuration, \FACTFinder\Core\Server\Request  $request, \FACTFinder\Core\Client\UrlBuilder  $urlBuilder, \FACTFinder\Core\AbstractEncodingConverter  $encodingConverter = null)

Parameters

string $loggerClass

Class name of logger to use. The class should implement FACTFinder\Util\LoggerInterface.
\FACTFinder\Core\ConfigurationInterface $configuration

Configuration object to use.
\FACTFinder\Core\Server\Request $request

The request object from which to obtain the server data.
\FACTFinder\Core\Client\UrlBuilder $urlBuilder

Client URL builder object to use.
\FACTFinder\Core\AbstractEncodingConverter $encodingConverter

Encoding converter object to use

setSid()

setSid(string  $sessionId)

Set the session id for personalization.

Parameters

string $sessionId

session id

setIdsOnly()

setIdsOnly(  $idsOnly)

Set this to true to only retrieve the IDs of products instead of full Record objects.

Parameters

$idsOnly

bool

getError()

getError() : string

Returns a message if an error occurred.

Returns

string

getStackTrace()

getStackTrace() : string

Returns the stack trace if an error occurred.

Returns

string

setRecordCount()

setRecordCount(integer  $recordCount)

Set the maximum amount of recommendations to be fetched.

Parameters

integer $recordCount

The number of records to be fetched. Something else than a positive integer is passed, the record count will be unlimited (or determined by FACT-Finder).

setProductIDs()

setProductIDs(string|array<mixed,string>  $productIDs)

Set one or multiple product IDs to base recommendation on, overwriting any IDs previously set.

Parameters

string|array<mixed,string> $productIDs

One or more product IDs.

addProductIDs()

addProductIDs(string|array<mixed,string>  $productIDs)

Add one or multiple product IDs to base recommendation on, in addition to any IDs previously set.

Parameters

string|array<mixed,string> $productIDs

One or more product IDs.

getRecommendations()

getRecommendations() : \FACTFinder\Data\Result

Returns recommendations for IDs previously specified. If no IDs have been set, there will be a warning raised and an empty result will be returned.

Returns

\FACTFinder\Data\Result

getRawRecommendations()

getRawRecommendations(string  $format = null, string  $callback = null) : string

Get the recommendations from FACT-Finder as the string returned by the server.

Parameters

string $format

Optional. Either 'json' or 'jsonp'. Use to overwrite the 'format' parameter.
string $callback

Optional name to overwrite the 'callback' parameter, which determines the name of the callback the response is wrapped in.

Returns

string

usePassthroughResponseContentProcessor()

usePassthroughResponseContentProcessor()

useJsonResponseContentProcessor()

useJsonResponseContentProcessor()

useXmlResponseContentProcessor()

useXmlResponseContentProcessor()

useResponseContentProcessor()

useResponseContentProcessor(object  $callable)

Pass in a function to process the response content. This method is not used within the library, but may be convenient when writing custom adapters.

Parameters

object $callable

A function (or invokable object) that processes a single string parameter.

Throws

\FACTFinder\Adapter\InvalidArgumentException

if $callable is not callable.

getResponseContent()

getResponseContent()

convertServerQueryToClientUrl()

convertServerQueryToClientUrl(  $query)

Parameters

$query

isValidResponse()

isValidResponse(  $jsonData) : boolean

Returns true if the response is valid or false if an error occurred.

Parameters

$jsonData

Returns

boolean

createRecommendations()

createRecommendations()

createRecord()

createRecord(  $recordData,   $position)

Parameters

$recordData
$position