\Econda\RecEngine\WidgetWidget

Summary

Methods

Properties

Constants

__construct()
setConfig()
getConfig()
getId()
setId()
getRenderer()
setRenderer()
getContext()
setContext()
setStartIndex()
getStartIndex()
setChunkSize()
getModel()
setModel()
setTemplate()
getTemplate()
setTemplatePath()
getTemplatePath()
render()
executeRequest()
getLastRequestInfo()

No public properties found

No constants found

initPropertiesFromArray()

$id
$config
$context
$model
$startIndex
$chunkSize
$template
$templatePath
$renderer
$client

N/A

No private methods found

No private properties found

N/A

File: RecEngine/Widget/Widget.php
Package: \Econda/RecEngine
Class hierarchy: \Econda\RecEngine\Widget\Widget

Properties

$id

$id : int

Widget ID as defined in cross sell management interface

Type

int

$config

$config : \Econda\RecEngine\Config\ConfigInterface

Configuration

Type

\Econda\RecEngine\Config\ConfigInterface

$context

$context : \Econda\RecEngine\Context\Context

Type

\Econda\RecEngine\Context\Context

$model

$model : \Econda\RecEngine\Widget\Model\ModelInterface

Data to render (result of request)

Type

\Econda\RecEngine\Widget\Model\ModelInterface

$startIndex

$startIndex : int

Index of first item, starting at 0

Type

int

$chunkSize

$chunkSize : int

Max numer of items to retrieve from rec service

Type

int

$template

$template : string

Template Html

Type

string

$templatePath

$templatePath : string

Path to file containing template html

Type

string

$renderer

$renderer : \Econda\RecEngine\Widget\Renderer\AbstractRenderer

Object to use to render this widget

Type

\Econda\RecEngine\Widget\Renderer\AbstractRenderer

$client

$client : \Econda\RecEngine\Client\Client

Reference to last used econda client

Type

\Econda\RecEngine\Client\Client

Methods

__construct()

__construct( $config)

Parameters

$config

setConfig()

setConfig(mixed $config) : \Econda\RecEngine\Widget\Widget

Set configuration

Parameters

mixed

$config

ConfigInterface or array

Throws

\Econda\RecEngine\Exception\InvalidArgumentException

Returns

\Econda\RecEngine\Widget\Widget

getConfig()

getConfig() : \Econda\RecEngine\Widget\ConfigInterface

Returns

\Econda\RecEngine\Widget\ConfigInterface

getId()

getId()

setId()

setId( $id)

Parameters

$id

getRenderer()

getRenderer()

setRenderer()

setRenderer(\Econda\RecEngine\Widget\Renderer\AbstractRenderer $renderer)

Parameters

\Econda\RecEngine\Widget\Renderer\AbstractRenderer

$renderer

getContext()

getContext()

setContext()

setContext( $context)

Parameters

$context

setStartIndex()

setStartIndex( $startIndex)

Parameters

$startIndex

getStartIndex()

getStartIndex()

setChunkSize()

setChunkSize( $chunkSize)

Parameters

$chunkSize

getModel()

getModel()

setModel()

setModel(\Econda\RecEngine\Widget\Model\ModelInterface $model)

Parameters

\Econda\RecEngine\Widget\Model\ModelInterface

$model

setTemplate()

setTemplate( $template)

Parameters

$template

getTemplate()

getTemplate()

setTemplatePath()

setTemplatePath( $path)

Parameters

$path

getTemplatePath()

getTemplatePath()

render()

render()

executeRequest()

executeRequest()

Get recommendations from rec service and write to model property.

getLastRequestInfo()

getLastRequestInfo( $asString)

Parameters

$asString

initPropertiesFromArray()

initPropertiesFromArray( $data)

Parameters

$data