Bitrix API

ProcessMergeByMapAction extends Action

Class SearchAction

Tags
example

BX.ajax.runAction("crm.api.entity.processMergeByMap", { data: { params: { entityTypeId: 3, seedEntityIds: {100, 101}, targEntityId: 99, map: { "TYPE_ID" => { "SOURCE_ENTITY_IDS" => [100] } } } } });

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
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
string

configure()

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
see
Converter::OUTPUT_JSON_FORMAT
Return values
array<string|int, mixed>|mixed|string

getArguments()

Returns list of action arguments.

public final getArguments() : array<string|int, mixed>

It is associative array looks like argument name => value.

Tags
throws
SystemException
Return values
array<string|int, mixed>

getConfig()

public final getConfig() : array<string|int, mixed>
Return values
array<string|int, mixed>

getCurrentUser()

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
Error

getErrors()

Getting array of errors.

public final getErrors() : array<string|int, Error>
Return values
array<string|int, Error>

getName()

public final getName() : string
Return values
string

run()

public final run(array<string|int, mixed> $params) : mixed
Parameters
$params : array<string|int, mixed>

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.

Tags
throws
SystemException
Return values
Binder

        
On this page

Search results