UploadOptions
class UploadOptions extends Options
Additional options for the Upload operation
Traits
Constants
| DATETIME_FORMAT |
A Dropbox-friendly timestamp wrapper |
Methods
Create an Options object from a combination of configuration arrays and other option objects
Selects what to do if the file already exists. The default for this union is add.
If there's a conflict, as determined by mode, have the Dropbox server try to autorename the file to avoid conflict. The default for this field is False.
The value to store as the client_modified timestamp. Dropbox automatically records the time at which the file was written to the Dropbox servers. It can also record an additional timestamp, provided by Dropbox desktop clients, mobile clients, and API apps of when the file was actually created or modified.
Details
in Options at line line 41
__construct(
array $defaults = array())
Options constructor.
in Options at line line 56
boolean
offsetExists(
string $offset)
Whether a offset exists
in Options at line line 70
mixed
offsetGet(
string $offset)
Offset to retrieve
in Options at line line 83
offsetSet(
string $offset,
mixed $value)
Offset to set
in Options at line line 95
offsetUnset(
string $offset)
Offset to unset
in Options at line line 108
static
Options
merge(
array $options)
Create an Options object from a combination of configuration arrays and other option objects
in Options at line line 128
array
toArray()
Return the generated options
in WriteModeTrait at line line 52
WriteModeTrait
setWriteMode(
WriteMode $set)
Selects what to do if the file already exists. The default for this union is add.
Your intent when writing a file to some path. This is used to determine what constitutes a conflict and what the
autorename strategy is.
In some situations, the conflict behavior is identical:
- If the target path doesn't contain anything, the file is always written; no conflict.
- If the target path contains a folder, it's always a conflict.
- If the target path contains a file with identical contents, nothing gets written; no conflict
The conflict checking differs in the case where there's a file at the target path with contents different from the contents you're trying to write
in AutoRenameTrait at line line 29
AutoRenameTrait
setAutoRename(
bool $set)
If there's a conflict, as determined by mode, have the Dropbox server try to autorename the file to avoid conflict. The default for this field is False.
in ClientModifiedTrait at line line 33
ClientModifiedTrait
setClientModified(
DateTimeInterface $set)
The value to store as the client_modified timestamp. Dropbox automatically records the time at which the file was written to the Dropbox servers. It can also record an additional timestamp, provided by Dropbox desktop clients, mobile clients, and API apps of when the file was actually created or modified.
in MuteTrait at line line 31
MuteTrait
setMute(
bool $set)
Normally, users are made aware of any file modifications in their Dropbox account via notifications in the client software. If true, this tells the clients that this modification shouldn't result in a user notification. The default for this field is False.