1. class
  2. Civi
  3. \
  4. Api4
  5. \
  6. Generic
  7. \
  8. BasicReplaceAction

BasicReplaceAction

class BasicReplaceAction extends AbstractBatchAction

Given a set of records, will appropriately update the database.

Properties

protected int $version Api version number; cannot be changed. from AbstractAction
protected array $chain Additional api requests - will be called once per result. from AbstractAction
protected bool $checkPermissions Whether to enforce acl permissions based on the current user. from AbstractAction
protected string $_entityName from AbstractAction
protected string $_actionName from AbstractAction
protected array $where Criteria for selecting items to process. from AbstractBatchAction
protected array $orderBy Array of field(s) to use in ordering the results from AbstractQueryAction
protected int $limit Maximum number of results to return. from AbstractQueryAction
protected int $offset Zero-based index of first result to return. from AbstractQueryAction
protected array $records Array of records.
protected array $defaults Array of default values.
protected bool $reload Reload records after saving.

Methods

__construct(string $entityName, string $actionName, string|array $select = 'id')

BatchAction constructor.

from AbstractBatchAction
__set($name, $value)

Strictly enforce api parameters

from AbstractAction
$this
setVersion(int $val)

No description

from AbstractAction
$this
addChain(string $name, AbstractAction $apiRequest, string|int $index = NULL)

No description

from AbstractAction
AbstractAction|mixed
__call($name, $arguments)

Magic function to provide addFoo, getFoo and setFoo for params.

from AbstractAction
Result
execute()

No description

_run(Result $result)

No description

array
getParams()

Serialize this object's params into an array

from AbstractAction
array
getParamInfo(string $param = NULL)

Get documentation for one or all params

from AbstractAction
string
getEntityName()

No description

from AbstractAction
string
getActionName()

No description

from AbstractAction
bool
paramExists(string $param)

No description

from AbstractAction
array
getParamDefaults()

No description

from AbstractAction
offsetExists($offset)

No description

from AbstractAction
offsetGet($offset)

No description

from AbstractAction
offsetSet($offset, $value)

No description

from AbstractAction
offsetUnset($offset)

No description

from AbstractAction
bool
isAuthorized()

Is this api call permitted?

from AbstractAction
array
getPermissions()

No description

from AbstractAction
array
entityFields()

Returns schema fields for this entity & action.

from AbstractAction
ReflectionClass
reflect()

No description

from AbstractAction
array
checkRequiredFields($values)

Validates required fields for actions which create a new object.

from AbstractAction
bool
evaluateCondition(string $expr, array $vars)

This function is used internally for evaluating field annotations.

from AbstractAction
bool
getCheckPermissions()

No description

from AbstractAction
array
getChain()

No description

from AbstractAction
$this
addWhere(string $field, string $op, mixed $value = NULL)

No description

from AbstractQueryAction
$this
addClause(string $operator, mixed $condition1)

Adds one or more AND/OR/NOT clause groups

from AbstractQueryAction
$this
addOrderBy(string $field, string $direction = 'ASC')

No description

from AbstractQueryAction
string
whereClauseToString(array $whereClause = NULL, string $op = 'AND')

A human-readable where clause, for the reading enjoyment of you humans.

from AbstractQueryAction
array
getWhere()

No description

from AbstractQueryAction
array
getOrderBy()

No description

from AbstractQueryAction
int
getLimit()

No description

from AbstractQueryAction
int
getOffset()

No description

from AbstractQueryAction
array
getBatchRecords()

No description

from AbstractBatchAction
array
getSelect()

No description

from AbstractBatchAction
array
getRecords()

No description

array
getDefaults()

No description

bool
getReload()

No description

Details

in AbstractBatchAction at line 69
__construct(string $entityName, string $actionName, string|array $select = 'id')

BatchAction constructor.

Parameters

string $entityName
string $actionName
string|array $select One or more fields to load for each item.

in AbstractAction at line 149
__set($name, $value)

Strictly enforce api parameters

Parameters

$name
$value

Exceptions

Exception

in AbstractAction at line 158
$this setVersion(int $val)

Parameters

int $val

Return Value

$this

Exceptions

API_Exception

in AbstractAction at line 174
$this addChain(string $name, AbstractAction $apiRequest, string|int $index = NULL)

Parameters

string $name Unique name for this chained request
AbstractAction $apiRequest
string|int $index Either a string for how the results should be indexed e.g. 'name' or the index of a single result to return e.g. 0 for the first result.

Return Value

$this

in AbstractAction at line 187
AbstractAction|mixed __call($name, $arguments)

Magic function to provide addFoo, getFoo and setFoo for params.

Parameters

$name
$arguments

Return Value

AbstractAction|mixed

Exceptions

API_Exception

at line 90
Result execute()

Return Value

Result

at line 97
_run(Result $result)

Parameters

Result $result

in AbstractAction at line 247
array getParams()

Serialize this object's params into an array

Return Value

array

in AbstractAction at line 265
array getParamInfo(string $param = NULL)

Get documentation for one or all params

Parameters

string $param

Return Value

array of arrays [description, type, default, (comment)]

in AbstractAction at line 282
string getEntityName()

Return Value

string

in AbstractAction at line 290
string getActionName()

Return Value

string

in AbstractAction at line 298
bool paramExists(string $param)

Parameters

string $param

Return Value

bool

in AbstractAction at line 305
protected array getParamDefaults()

Return Value

array

in AbstractAction at line 312
offsetExists($offset)

Parameters

$offset

in AbstractAction at line 319
offsetGet($offset)

Parameters

$offset

in AbstractAction at line 344
offsetSet($offset, $value)

Parameters

$offset
$value

in AbstractAction at line 359
offsetUnset($offset)

Parameters

$offset

in AbstractAction at line 373
bool isAuthorized()

Is this api call permitted?

This function is called if checkPermissions is set to true.

Return Value

bool

in AbstractAction at line 381
array getPermissions()

Return Value

array

in AbstractAction at line 410
array entityFields()

Returns schema fields for this entity & action.

Here we bypass the api wrapper and execute the getFields action directly. This is because we DON'T want the wrapper to check permissions as this is an internal op, but we DO want permissions to be checked inside the getFields request so e.g. the api_key field can be conditionally included.

Return Value

array

See also

GetFields

in AbstractAction at line 429
ReflectionClass reflect()

Return Value

ReflectionClass

in AbstractAction at line 443
protected array checkRequiredFields($values)

Validates required fields for actions which create a new object.

Parameters

$values

Return Value

array

Exceptions

API_Exception

in AbstractAction at line 473
protected bool evaluateCondition(string $expr, array $vars)

This function is used internally for evaluating field annotations.

It should never be passed raw user input.

Parameters

string $expr Conditional in php format e.g. $foo > $bar
array $vars Variable name => value

Return Value

bool

Exceptions

API_Exception
Exception

in AbstractAction at line 50
bool getCheckPermissions()

Return Value

bool

in AbstractAction at line 50
array getChain()

Return Value

array

in AbstractQueryAction at line 104
$this addWhere(string $field, string $op, mixed $value = NULL)

Parameters

string $field
string $op
mixed $value

Return Value

$this

Exceptions

API_Exception

in AbstractQueryAction at line 122
$this addClause(string $operator, mixed $condition1)

Adds one or more AND/OR/NOT clause groups

Parameters

string $operator
mixed $condition1 ... $conditionN Either a nested array of arguments, or a variable number of arguments passed to this function.

Return Value

$this

Exceptions

API_Exception

in AbstractQueryAction at line 135
$this addOrderBy(string $field, string $direction = 'ASC')

Parameters

string $field
string $direction

Return Value

$this

in AbstractQueryAction at line 147
protected string whereClauseToString(array $whereClause = NULL, string $op = 'AND')

A human-readable where clause, for the reading enjoyment of you humans.

Parameters

array $whereClause
string $op

Return Value

string

in AbstractQueryAction at line 54
array getWhere()

Return Value

array

in AbstractQueryAction at line 54
array getOrderBy()

Return Value

array

in AbstractQueryAction at line 54
int getLimit()

Return Value

int

in AbstractQueryAction at line 54
int getOffset()

Return Value

int

in AbstractBatchAction at line 77
protected array getBatchRecords()

Return Value

array

in AbstractBatchAction at line 95
protected array getSelect()

Return Value

array

at line 55
array getRecords()

Return Value

array

at line 55
array getDefaults()

Return Value

array

at line 55
bool getReload()

Return Value

bool