$sid
$sid : string
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.
$configuration : \FACTFinder\Core\ConfigurationInterface
$request : \FACTFinder\Core\Server\Request
$urlBuilder : \FACTFinder\Core\Client\UrlBuilder
$lastResponse : \FACTFinder\Core\Server\Response
__construct(string $loggerClass, \FACTFinder\Core\ConfigurationInterface $configuration, \FACTFinder\Core\Server\Request $request, \FACTFinder\Core\Client\UrlBuilder $urlBuilder, \FACTFinder\Core\AbstractEncodingConverter $encodingConverter = null)
| 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 |
getResult() : \FACTFinder\Data\Result
getSingleWordSearch() : array<mixed,\FACTFinder\Data\SingleWordSearchItem>
getStatus() : \FACTFinder\Data\SearchStatus
getArticleNumberStatus() : \FACTFinder\Data\ArticleNumberSearchStatus
getAfterSearchNavigation() : \FACTFinder\Data\AfterSearchNavigation
getResultsPerPageOptions() : \FACTFinder\Data\ResultsPerPageOptions
createResultsPerPageOptions() : \FACTFinder\Data\ResultsPerPageOptions
getPaging() : \FACTFinder\Data\Paging
getSorting() : \FACTFinder\Data\Sorting
getSortingItems() : \FACTFinder\Data\SortingItems
getBreadCrumbTrail() : \FACTFinder\Data\BreadCrumbTrail
getCampaigns() : \FACTFinder\Data\CampaignIterator
getFollowSearchValue() : integer
Value for parameter "followSearch" for followups on initial search like filters, pagination, .
.. Either from search results searchParams, request parameters or from search results "simiFirstRecord". Returns 0 if no parameter "followSearch" could be acquired.
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.
| object | $callable | A function (or invokable object) that processes a single string parameter. |
if $callable is not callable.
fillCampaignWithFeedback(\FACTFinder\Data\Campaign $campaign, array<mixed,mixed> $campaignData)
| \FACTFinder\Data\Campaign | $campaign | The campaign object to be filled. |
| array<mixed,mixed> | $campaignData | An associative array corresponding to the JSON for that campaign. |
createResult() : \FACTFinder\Data\Result
createSingleWordSearch() : array<mixed,\FACTFinder\Data\SingleWordSearchItem>
createAfterSearchNavigation() : \FACTFinder\Data\AfterSearchNavigation
createFilterGroup(array<mixed,mixed> $groupData) : \FACTFinder\Data\FilterGroup
| array<mixed,mixed> | $groupData | An associative array corresponding to the JSON for a single filter group. |
createFilter(array<mixed,mixed> $filterData) : \FACTFinder\Data\Filter
| array<mixed,mixed> | $filterData | An associative array corresponding to the JSON for a single filter. |
createSliderFilter(array<mixed,mixed> $filterData) : \FACTFinder\Data\SliderFilter
| array<mixed,mixed> | $filterData | An associative array corresponding to the JSON for a single slider filter. |
createPaging() : \FACTFinder\Data\Paging
createPageItem(array<mixed,mixed> $pageData = null) : \FACTFinder\Data\Item
| array<mixed,mixed> | $pageData | An associative array corresponding to the JSON for a single page link. |
createSorting() : \FACTFinder\Data\Sorting
createSortingItems() : \FACTFinder\Data\SortingItems
createBreadCrumbTrail() : \FACTFinder\Data\BreadCrumbTrail
createCampaigns() : \FACTFinder\Data\CampaignIterator
createEmptyCampaignObject(array<mixed,mixed> $campaignData) : \FACTFinder\Data\Campaign
| array<mixed,mixed> | $campaignData | An associative array corresponding to the JSON for a single campaign. |
fillCampaignObject(\FACTFinder\Data\Campaign $campaign, array<mixed,mixed> $campaignData)
| \FACTFinder\Data\Campaign | $campaign | The campaign object to be filled. |
| array<mixed,mixed> | $campaignData | An associative array corresponding to the JSON for that campaign. |
fillCampaignWithPushedProducts(\FACTFinder\Data\Campaign $campaign, array<mixed,mixed> $campaignData)
| \FACTFinder\Data\Campaign | $campaign | The campaign object to be filled. |
| array<mixed,mixed> | $campaignData | An associative array corresponding to the JSON for that campaign. |
fillCampaignWithAdvisorData(\FACTFinder\Data\Campaign $campaign, array<mixed,mixed> $campaignData)
| \FACTFinder\Data\Campaign | $campaign | The campaign object to be filled. |
| array<mixed,mixed> | $campaignData | An associative array corresponding to the JSON for that campaign. |
createAdvisorQuestion(array<mixed,mixed> $questionData, boolean $recursive = false)
| array<mixed,mixed> | $questionData | An associative array corresponding to the JSON for a single advisor question. |
| boolean | $recursive | If this is set the entire advisor tree below this question will be created. Otherwise, follow-up questions of answers are omitted. |
createAdvisorAnswer(array<mixed,mixed> $answerData, boolean $recursive = false)
| array<mixed,mixed> | $answerData | An associative array corresponding to the JSON for a single advisor answer. |
| boolean | $recursive | If this is set the entire advisor tree below the subquestion of this ansewr will be created as well. |