ContactsImportOptions
in package
FinalYes
Contacts Import Options
Tags
Table of Contents
Constants
- ERROR_CONTINUE : mixed = 0
- ERROR_FAIL : mixed = 1
- ERROR_OPTIONS : mixed = [self::ERROR_CONTINUE, self::ERROR_FAIL]
- FORMATS : mixed = ['vcf', 'jcf', 'xcf']
- VALIDATE_FAIL : mixed = 2
- VALIDATE_NONE : mixed = 0
- VALIDATE_OPTIONS : mixed = [self::VALIDATE_NONE, self::VALIDATE_SKIP, self...
- VALIDATE_SKIP : mixed = 1
Properties
- $counts : bool
- $errors : int
- $format : "vcf"|"jcf"|"xcf"
- $supersede : bool
- $validate : int
Methods
- getCounts() : bool
- Gets whether to include object counts as the first yielded value
- getErrors() : int
- Gets how to handle object errors
- getFormat() : "vcf"|"jcf"|"xcf"
- Gets the import format
- getSupersede() : bool
- Gets whether to supersede existing objects
- getValidate() : int
- Gets how to handle object validation
- setCounts() : void
- Sets whether to include object counts as the first yielded value
- setErrors() : void
- Sets how to handle object errors
- setFormat() : void
- Sets the import format
- setSupersede() : void
- Sets whether to supersede existing objects
- setValidate() : void
- Sets how to handle object validation
Constants
ERROR_CONTINUE
public
mixed
ERROR_CONTINUE
= 0
Tags
ERROR_FAIL
public
mixed
ERROR_FAIL
= 1
Tags
ERROR_OPTIONS
public
mixed
ERROR_OPTIONS
= [self::ERROR_CONTINUE, self::ERROR_FAIL]
Tags
FORMATS
public
mixed
FORMATS
= ['vcf', 'jcf', 'xcf']
Tags
VALIDATE_FAIL
public
mixed
VALIDATE_FAIL
= 2
Tags
VALIDATE_NONE
public
mixed
VALIDATE_NONE
= 0
Tags
VALIDATE_OPTIONS
public
mixed
VALIDATE_OPTIONS
= [self::VALIDATE_NONE, self::VALIDATE_SKIP, self::VALIDATE_FAIL]
Tags
VALIDATE_SKIP
public
mixed
VALIDATE_SKIP
= 1
Tags
Properties
$counts
private
bool
$counts
= false
$errors
private
int
$errors
= self::ERROR_FAIL
$format
private
"vcf"|"jcf"|"xcf"
$format
= 'vcf'
$supersede
private
bool
$supersede
= false
$validate
private
int
$validate
= self::VALIDATE_SKIP
Methods
getCounts()
Gets whether to include object counts as the first yielded value
public
getCounts() : bool
Tags
Return values
boolgetErrors()
Gets how to handle object errors
public
getErrors() : int
Tags
Return values
int —0 - continue, 1 - fail
getFormat()
Gets the import format
public
getFormat() : "vcf"|"jcf"|"xcf"
Tags
Return values
"vcf"|"jcf"|"xcf" —(defaults to vcf)
getSupersede()
Gets whether to supersede existing objects
public
getSupersede() : bool
Tags
Return values
boolgetValidate()
Gets how to handle object validation
public
getValidate() : int
Tags
Return values
int —0 - no validation, 1 - validate and skip on issue, 2 - validate and fail on issue
setCounts()
Sets whether to include object counts as the first yielded value
public
setCounts(bool $counts) : void
Parameters
- $counts : bool
Tags
setErrors()
Sets how to handle object errors
public
setErrors(int $value) : void
Parameters
- $value : int
-
0 - continue, 1 - fail
Tags
setFormat()
Sets the import format
public
setFormat("vcf"|"jcf"|"xcf" $value) : void
Parameters
- $value : "vcf"|"jcf"|"xcf"
Tags
setSupersede()
Sets whether to supersede existing objects
public
setSupersede(bool $supersede) : void
Parameters
- $supersede : bool
Tags
setValidate()
Sets how to handle object validation
public
setValidate(int $value) : void
Parameters
- $value : int
-
0 - no validation, 1 - validate and skip on issue, 2 - validate and fail on issue