civicrm_cli_csv_deleter
extends civicrm_cli_csv_file
in package
class for processing records to delete used by csv/delete.php
Table of Contents
Properties
- $_action : mixed
- $_additional_arguments : mixed
- $_config : mixed
- $_entity : mixed
- $_errors : mixed
- $_joblog : mixed
- $_output : mixed
- $_params : array<string|int, mixed>
- array that is passed to civicrm_api
- $_password : mixed
- $_required_arguments : array<string|int, mixed>
- via the command line
- $_semicolon : mixed
- $_site : string
- optional arguments
- $_user : mixed
- $header : mixed
- $separator : mixed
Methods
- __construct() : mixed
- _accessing_from_cli() : bool
- Ensure function is being run from the cli.
- callApi() : bool
- convertLine() : array<string|int, mixed>
- initialize() : bool
- processline() : mixed
- run() : mixed
- Run CLI function.
Properties
$_action
public
mixed
$_action
= \NULL
$_additional_arguments
public
mixed
$_additional_arguments
= array()
$_config
public
mixed
$_config
$_entity
public
mixed
$_entity
= \NULL
$_errors
public
mixed
$_errors
= array()
$_joblog
public
mixed
$_joblog
= \FALSE
$_output
public
mixed
$_output
= \FALSE
$_params
array that is passed to civicrm_api
public
array<string|int, mixed>
$_params
= array('version' => 3)
$_password
public
mixed
$_password
= \NULL
$_required_arguments
via the command line
public
array<string|int, mixed>
$_required_arguments
= array('action', 'entity')
$_semicolon
public
mixed
$_semicolon
= \FALSE
$_site
optional arguments
public
string
$_site
= 'localhost'
$_user
public
mixed
$_user
= \NULL
$header
public
mixed
$header
$separator
public
mixed
$separator
= ','
Methods
__construct()
public
__construct() : mixed
_accessing_from_cli()
Ensure function is being run from the cli.
public
_accessing_from_cli() : bool
Return values
boolcallApi()
public
callApi() : bool
Return values
boolconvertLine()
public
convertLine(mixed $data) : array<string|int, mixed>
Parameters
- $data : mixed
Return values
array<string|int, mixed>initialize()
public
initialize() : bool
Return values
boolprocessline()
public
processline(array<string|int, mixed> $params) : mixed
Parameters
- $params : array<string|int, mixed>
run()
Run CLI function.
public
run() : mixed