class FileMetadata extends BaseModel (View source)

Properties

protected array $data Model Data from BaseModel
protected string $id A unique identifier of the file
protected string $name The last component of the path (including extension).
protected string $rev A unique identifier for the current revision of a file.
protected int $size The file size in bytes.
protected string $path_lower The lowercased full path in the user's Dropbox.
protected MediaInfo $media_info Additional information if the file is a photo or video.
protected FileSharingInfo $sharing_info Set if this file is contained in a shared folder.
protected string $path_display The cased path to be used for display purposes only.
protected DateTime $client_modified For files, this is the modification time set by the desktop client when the file was added to Dropbox.
protected DateTime $server_modified The last time the file was modified on Dropbox.
protected bool $has_explicit_shared_members This flag will only be present if includehasexplicitsharedmembers is true in listfolder or getmetadata. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder.

Methods

__construct(array $data)

Create a new FileMetadata instance

array
getData()

Get the Model data

from BaseModel
mixed
getDataProperty(string $property)

Get Data Property

from BaseModel
mixed|null
__get(string $property)

Handle calls to undefined properties.

from BaseModel
mixed|null
__set(string $property, string $value)

Handle calls to undefined properties.

from BaseModel
string
getId()

Get the 'id' property of the file model.

string
getName()

Get the 'name' property of the file model.

string
getRev()

Get the 'rev' property of the file model.

int
getSize()

Get the 'size' property of the file model.

string
getPathLower()

Get the 'path_lower' property of the file model.

getMediaInfo()

Get the 'media_info' property of the file model.

getSharingInfo()

Get the 'sharing_info' property of the file model.

string
getPathDisplay()

Get the 'path_display' property of the file model.

DateTime
getClientModified()

Get the 'client_modified' property of the file model.

DateTime
getServerModified()

Get the 'server_modified' property of the file model.

bool
hasExplicitSharedMembers()

Get the 'hasexplicitshared_members' property of the file model.

Details

at line line 99
__construct(array $data)

Create a new FileMetadata instance

Parameters

array $data

in BaseModel at line line 29
array getData()

Get the Model data

Return Value

array

in BaseModel at line line 41
mixed getDataProperty(string $property)

Get Data Property

Parameters

string $property

Return Value

mixed

in BaseModel at line line 56
mixed|null __get(string $property)

Handle calls to undefined properties.

Check whether an item with the key, same as the property, is available on the data property.

Parameters

string $property

Return Value

mixed|null

in BaseModel at line line 75
mixed|null __set(string $property, string $value)

Handle calls to undefined properties.

Sets an item with the defined value on the data property.

Parameters

string $property
string $value

Return Value

mixed|null

at line line 130
string getId()

Get the 'id' property of the file model.

Return Value

string

at line line 140
string getName()

Get the 'name' property of the file model.

Return Value

string

at line line 150
string getRev()

Get the 'rev' property of the file model.

Return Value

string

at line line 160
int getSize()

Get the 'size' property of the file model.

Return Value

int

at line line 170
string getPathLower()

Get the 'path_lower' property of the file model.

Return Value

string

at line line 180
MediaInfo getMediaInfo()

Get the 'media_info' property of the file model.

Return Value

MediaInfo

at line line 190
FileSharingInfo getSharingInfo()

Get the 'sharing_info' property of the file model.

Return Value

FileSharingInfo

at line line 200
string getPathDisplay()

Get the 'path_display' property of the file model.

Return Value

string

at line line 210
DateTime getClientModified()

Get the 'client_modified' property of the file model.

Return Value

DateTime

at line line 220
DateTime getServerModified()

Get the 'server_modified' property of the file model.

Return Value

DateTime

at line line 230
bool hasExplicitSharedMembers()

Get the 'hasexplicitshared_members' property of the file model.

Return Value

bool