1. class
  2. Alorel
  3. Dropbox
  4. Options
  5. Builder
  6. ListFolderOptions

ListFolderOptions

class ListFolderOptions extends GetMetadataOptions

Additional options for the ListFolder operation

Traits

RecursiveTrait
If true, the operation will apply to all subfolders, too. The default value is false.
IncludeDeletedTrait
If true, DeletedMetadata will be returned for deleted file or folder, otherwise LookupError.not_found will be returned. The default for this field is False.
IncludeHasExplicitSharedMembersTrait
If true, the results will include a flag for each file indicating whether or not that file has any explicit members. The default for this field is False.
IncludeMediaInfoTrait
If true, FileMetadata.media_info is set for photo and video. The default for this field is False.

Constants

DATETIME_FORMAT

A Dropbox-friendly timestamp wrapper

Methods

__construct( array $defaults = array())

Options constructor.

from Options
boolean
offsetExists( string $offset)

Whether a offset exists

from Options
mixed
offsetGet( string $offset)

Offset to retrieve

from Options
offsetSet( string $offset, mixed $value)

Offset to set

from Options
offsetUnset( string $offset)

Offset to unset

from Options
static  Options
merge( array $options)

Create an Options object from a combination of configuration arrays and other option objects

from Options
array
toArray()

Return the generated options

from Options
IncludeDeletedTrait
setIncludeDeleted( bool $set)

If true, DeletedMetadata will be returned for deleted file or folder, otherwise LookupError.not_found will be returned. The default for this field is False.

from IncludeDeletedTrait
IncludeHasExplicitSharedMembersTrait
setIncludeHasExplicitSharedMembers( bool $set)

If true, the results will include a flag for each file indicating whether or not that file has any explicit members. The default for this field is False.

from IncludeHasExplicitSharedMembersTrait
IncludeMediaInfoTrait
setIncludeMediaInfo( bool $set)

If true, FileMetadata.media_info is set for photo and video. The default for this field is False.

from IncludeMediaInfoTrait
RecursiveTrait
setRecursive( bool $set)

If true, the operation will apply to all subfolders, too. The default value is false.

from RecursiveTrait

Details

in Options at line line 41
__construct( array $defaults = array())

Options constructor.

Parameters

array $defaults Default options

in Options at line line 56
boolean offsetExists( string $offset)

Whether a offset exists

Parameters

string $offset An offset to check for.

Return Value

boolean true on success or false on failure. The return value will be casted to boolean if non-boolean was returned.

See also

http://php.net/manual/en/arrayaccess.offsetexists.php

in Options at line line 70
mixed offsetGet( string $offset)

Offset to retrieve

Parameters

string $offset The offset to retrieve.

Return Value

mixed Can return all value types.

See also

http://php.net/manual/en/arrayaccess.offsetget.php

in Options at line line 83
offsetSet( string $offset, mixed $value)

Offset to set

Parameters

string $offset The offset to assign the value to.
mixed $value The value to set.

See also

http://php.net/manual/en/arrayaccess.offsetset.php

in Options at line line 95
offsetUnset( string $offset)

Offset to unset

Parameters

string $offset The offset to unset.

See also

http://php.net/manual/en/arrayaccess.offsetunset.php

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

Parameters

array $options The items to merge

Return Value

Options

in Options at line line 128
array toArray()

Return the generated options

Return Value

array

in IncludeDeletedTrait at line line 29
IncludeDeletedTrait setIncludeDeleted( bool $set)

If true, DeletedMetadata will be returned for deleted file or folder, otherwise LookupError.not_found will be returned. The default for this field is False.

Parameters

bool $set The setting

Return Value

IncludeDeletedTrait

in IncludeHasExplicitSharedMembersTrait at line line 29
IncludeHasExplicitSharedMembersTrait setIncludeHasExplicitSharedMembers( bool $set)

If true, the results will include a flag for each file indicating whether or not that file has any explicit members. The default for this field is False.

Parameters

bool $set The setting

Return Value

IncludeHasExplicitSharedMembersTrait

in IncludeMediaInfoTrait at line line 27
IncludeMediaInfoTrait setIncludeMediaInfo( bool $set)

If true, FileMetadata.media_info is set for photo and video. The default for this field is False.

Parameters

bool $set The setting

Return Value

IncludeMediaInfoTrait

in RecursiveTrait at line line 27
RecursiveTrait setRecursive( bool $set)

If true, the operation will apply to all subfolders, too. The default value is false.

Parameters

bool $set The setting

Return Value

RecursiveTrait