API Documentation
\
FACTFinder
Adapter
Core
Client
Server
Data
Util

\FACTFinder\DataCampaign

Summary

Methods
Properties
Constants
__construct()
getName()
getCategory()
hasRedirect()
getRedirectUrl()
addPushedProducts()
hasPushedProducts()
getPushedProducts()
addFeedback()
hasFeedback()
getFeedback()
getFeedbackArray()
addActiveQuestions()
hasActiveQuestions()
getActiveQuestions()
addToAdvisorTree()
hasAdvisorTree()
getAdvisorTree()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$name
$category
$redirectUrl
$pushedProducts
$feedback
$activeQuestions
$advisorTree
N/A

Properties

$name

$name : string

Type

string

$category

$category : string

Type

string

$redirectUrl

$redirectUrl : string

Type

string

$feedback

$feedback : array<mixed,string>

Type

array<mixed,string>

Methods

__construct()

__construct(string  $name, string  $category = '', string  $redirectUrl = '', array<mixed,\FACTFinder\Data\Record>  $pushedProducts = array(), array  $feedback = array(), array  $activeQuestions = array(), array  $advisorTree = array())

Parameters

string $name
string $category
string $redirectUrl
array<mixed,\FACTFinder\Data\Record> $pushedProducts
array $feedback
array $activeQuestions
array $advisorTree

getName()

getName() : string

Returns

string

getCategory()

getCategory() : string

Returns

string

hasRedirect()

hasRedirect() : boolean

Returns

boolean —

True, if a redirect link was set.

getRedirectUrl()

getRedirectUrl() : string

Returns

string

addPushedProducts()

addPushedProducts(array  $pushedProducts)

Parameters

array $pushedProducts

hasPushedProducts()

hasPushedProducts() : boolean

Returns

boolean —

True, if at least one pushed product exists.

getPushedProducts()

getPushedProducts() : array<mixed,\FACTFinder\Data\Record>

Returns

array<mixed,\FACTFinder\Data\Record>

addFeedback()

addFeedback(array  $feedback)

In case of a collision of keys, the existing feedback string will be overwritten.

Parameters

array $feedback

hasFeedback()

hasFeedback(string  $label = null) : boolean

Parameters

string $label

Optional label to check.

Returns

boolean —

If $label parameter is given, this returns true if there is any feedback for that particular label. If $label is ommitted, this returns true if there is any feedback at all.

getFeedback()

getFeedback(string  $label) : string

Parameters

string $label

Returns

string

getFeedbackArray()

getFeedbackArray() : array<mixed,string>

Returns

array<mixed,string>

addActiveQuestions()

addActiveQuestions(array<mixed,\FACTFinder\Data\AdvisorQuestion>  $activeQuestions)

Parameters

array<mixed,\FACTFinder\Data\AdvisorQuestion> $activeQuestions

hasActiveQuestions()

hasActiveQuestions() : boolean

Returns

boolean

addToAdvisorTree()

addToAdvisorTree(array<mixed,\FACTFinder\Data\AdvisorQuestion>  $advisorTree)

Add questions to the top level of the advisor tree.

Parameters

array<mixed,\FACTFinder\Data\AdvisorQuestion> $advisorTree

hasAdvisorTree()

hasAdvisorTree() : boolean

Returns

boolean