CalendarImportOptions
in package
FinalYes
Calendar Import Options
Tags
Table of Contents
Constants
- ERROR_CONTINUE = 0
- ERROR_FAIL = 1
- ERROR_OPTIONS = [self::ERROR_CONTINUE, self::ERROR_FAIL]
- FORMATS = ['ical', 'jcal', 'xcal']
- VALIDATE_FAIL = 2
- VALIDATE_NONE = 0
- VALIDATE_OPTIONS = [self::VALIDATE_NONE, self::VALIDATE_SKIP, self::VALIDATE_FAIL]
- VALIDATE_SKIP = 1
Properties
- $errors : int
- $format : "ical"|"jcal"|"xcal"
- $supersede : bool
- $validate : int
Methods
- getErrors() : int
- Gets how to handle object errors
- getFormat() : "ical"|"jcal"|"xcal"
- Gets the import format
- getSupersede() : bool
- Gets whether to supersede existing objects
- getValidate() : int
- Gets how to handle object validation
- 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
ERROR_FAIL
public
mixed
ERROR_FAIL
= 1
ERROR_OPTIONS
public
mixed
ERROR_OPTIONS
= [self::ERROR_CONTINUE, self::ERROR_FAIL]
FORMATS
public
mixed
FORMATS
= ['ical', 'jcal', 'xcal']
VALIDATE_FAIL
public
mixed
VALIDATE_FAIL
= 2
VALIDATE_NONE
public
mixed
VALIDATE_NONE
= 0
VALIDATE_OPTIONS
public
mixed
VALIDATE_OPTIONS
= [self::VALIDATE_NONE, self::VALIDATE_SKIP, self::VALIDATE_FAIL]
VALIDATE_SKIP
public
mixed
VALIDATE_SKIP
= 1
Properties
$errors
private
int
$errors
= self::ERROR_FAIL
$format
private
"ical"|"jcal"|"xcal"
$format
= 'ical'
$supersede
private
bool
$supersede
= false
$validate
private
int
$validate
= self::VALIDATE_SKIP
Methods
getErrors()
Gets how to handle object errors
public
getErrors() : int
Return values
int —0 - continue, 1 - fail
getFormat()
Gets the import format
public
getFormat() : "ical"|"jcal"|"xcal"
Return values
"ical"|"jcal"|"xcal" —(defaults to ical)
getSupersede()
Gets whether to supersede existing objects
public
getSupersede() : bool
Return values
boolgetValidate()
Gets how to handle object validation
public
getValidate() : int
Return values
int —0 - no validation, 1 - validate and skip on issue, 2 - validate and fail on issue
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("ical"|"jcal"|"xcal" $value) : void
Parameters
- $value : "ical"|"jcal"|"xcal"
setSupersede()
Sets whether to supersede existing objects
public
setSupersede(bool $supersede) : void
Parameters
- $supersede : bool
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