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

SearchOptions

class SearchOptions extends Options

Options for the search operation

Traits

StartTrait
The starting index within the search results (used for paging). The default for this field is 0.
MaxResultsTrait
The maximum number of search results to return. The default for this field is 100.
SearchModeTrait
The search mode (filename, filenameandcontent, or deleted_filename). Note that searching file content is only available for Dropbox Business accounts. The default for this union is filename.

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
StartTrait
setStart( int $start)

The starting index within the search results (used for paging). The default for this field is 0.

from StartTrait
MaxResultsTrait
setMaxResults( int $set)

The maximum number of search results to return. The default for this field is 100.

from MaxResultsTrait
SearchModeTrait
setSearchMode( SearchMode $set)

The search mode (filename, filenameandcontent, or deleted_filename). Note that searching file content is only available for Dropbox Business accounts. The default for this union is filename.

from SearchModeTrait

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 StartTrait at line line 27
StartTrait setStart( int $start)

The starting index within the search results (used for paging). The default for this field is 0.

Parameters

int $start The start index

Return Value

StartTrait

in MaxResultsTrait at line line 27
MaxResultsTrait setMaxResults( int $set)

The maximum number of search results to return. The default for this field is 100.

Parameters

int $set The max number of results

Return Value

MaxResultsTrait

in SearchModeTrait at line line 30
SearchModeTrait setSearchMode( SearchMode $set)

The search mode (filename, filenameandcontent, or deleted_filename). Note that searching file content is only available for Dropbox Business accounts. The default for this union is filename.

Parameters

SearchMode $set The search mode

Return Value

SearchModeTrait