SearchProductAction extends SearchAction
Class Action
Table of Contents
Methods
- __construct() : mixed
- className() : string
- Returns the fully qualified name of this class.
- configure() : void
- Configures action by additional params.
- convertKeysToCamelCase() : array<string|int, mixed>|mixed|string
- Converts keys of array to camel case notation.
- getArguments() : array<string|int, mixed>
- Returns list of action arguments.
- getBinder() : Binder
- getConfig() : array<string|int, mixed>
- getController() : Controller
- getCurrentUser() : mixed
- getErrorByCode() : Error
- Getting once error with the necessary code.
- getErrors() : array<string|int, Error>
- Getting array of errors.
- getName() : string
- provideData() : array<string|int, mixed>|array<string|int, ResultItem>
- BX.ajax.runAction("salescenter.api.product.search", { data: { searchQuery: "dress", options: {} } });
- run() : mixed
- runWithSourceParametersList() : mixed
- setArguments() : Binder
- Sets list of action arguments.
Methods
__construct()
public
__construct(mixed $name, Controller $controller[, mixed $config = array() ]) : mixed
Parameters
- $name : mixed
- $controller : Controller
- $config : mixed = array()
className()
Returns the fully qualified name of this class.
public
final static className() : string
Return values
stringconfigure()
Configures action by additional params.
public
configure(mixed $params) : void
The method will be invoked by controller and $params have to set in 'configureActions'
Parameters
- $params : mixed
convertKeysToCamelCase()
Converts keys of array to camel case notation.
public
convertKeysToCamelCase(mixed $data) : array<string|int, mixed>|mixed|string
Parameters
- $data : mixed
-
Data.
Tags
Return values
array<string|int, mixed>|mixed|stringgetArguments()
Returns list of action arguments.
public
final getArguments() : array<string|int, mixed>
It is associative array looks like argument name => value.
Tags
Return values
array<string|int, mixed>getBinder()
public
final getBinder() : Binder
Return values
BindergetConfig()
public
final getConfig() : array<string|int, mixed>
Return values
array<string|int, mixed>getController()
public
final getController() : Controller
Return values
ControllergetCurrentUser()
public
final getCurrentUser() : mixed
getErrorByCode()
Getting once error with the necessary code.
public
final getErrorByCode(string $code) : Error
Parameters
- $code : string
-
Code of error.
Return values
ErrorgetErrors()
Getting array of errors.
public
final getErrors() : array<string|int, Error>
Return values
array<string|int, Error>getName()
public
final getName() : string
Return values
stringprovideData()
BX.ajax.runAction("salescenter.api.product.search", { data: { searchQuery: "dress", options: {} } });
public
provideData(string $searchQuery[, array<string|int, mixed>|null $options = null ][, PageNavigation|null $pageNavigation = null ]) : array<string|int, mixed>|array<string|int, ResultItem>
Parameters
- $searchQuery : string
- $options : array<string|int, mixed>|null = null
- $pageNavigation : PageNavigation|null = null
Tags
Return values
array<string|int, mixed>|array<string|int, ResultItem>run()
public
final run(mixed $searchQuery[, array<string|int, mixed> $options = null ][, PageNavigation $pageNavigation = null ]) : mixed
Parameters
- $searchQuery : mixed
- $options : array<string|int, mixed> = null
- $pageNavigation : PageNavigation = null
runWithSourceParametersList()
public
runWithSourceParametersList() : mixed
setArguments()
Sets list of action arguments.
public
final setArguments(array<string|int, mixed> $arguments) : Binder
It is associative array looks like argument name => value. Be aware the method reset old values and set new arguments.
Parameters
- $arguments : array<string|int, mixed>
-
List of action arguments.