abstract class AbstractAdapter implements AdapterInterface

deprecated since 2.8, to be removed in 3.0. Use Finder instead.

Interface for finder engine implementations.

Properties

$followLinks
protected $mode
protected $minDepth
protected $maxDepth
protected $exclude
protected $names
protected $notNames
protected $contains
protected $notContains
protected $sizes
protected $dates
protected $filters
protected $sort
protected $paths
protected $notPaths
protected $ignoreUnreadableDirs

Methods

bool
isSupported()

Tests adapter support for current platform.

$this
setFollowLinks(bool $followLinks)

No description

$this
setMode(int $mode)

No description

$this
setDepths(array $depths)

No description

$this
setExclude(array $exclude)

No description

$this
setNames(array $names)

No description

$this
setNotNames(array $notNames)

No description

$this
setContains(array $contains)

No description

$this
setNotContains(array $notContains)

No description

$this
setSizes(array $sizes)

No description

$this
setDates(array $dates)

No description

$this
setFilters(array $filters)

No description

$this
setSort(Closure|int $sort)

No description

$this
setPath(array $paths)

No description

$this
setNotPath(array $notPaths)

No description

$this
ignoreUnreadableDirs(bool $ignore = true)

No description

bool
canBeUsed()

Returns whether the adapter is supported in the current environment.

Details

at line 47
bool isSupported()

Tests adapter support for current platform.

Return Value

bool

Parameters

bool $followLinks

Return Value

$this

at line 71
$this setMode(int $mode)

Parameters

int $mode

Return Value

$this

at line 81
$this setDepths(array $depths)

Parameters

array $depths

Return Value

$this

at line 111
$this setExclude(array $exclude)

Parameters

array $exclude

Return Value

$this

at line 121
$this setNames(array $names)

Parameters

array $names

Return Value

$this

at line 131
$this setNotNames(array $notNames)

Parameters

array $notNames

Return Value

$this

at line 141
$this setContains(array $contains)

Parameters

array $contains

Return Value

$this

at line 151
$this setNotContains(array $notContains)

Parameters

array $notContains

Return Value

$this

at line 161
$this setSizes(array $sizes)

Parameters

array $sizes

Return Value

$this

at line 171
$this setDates(array $dates)

Parameters

array $dates

Return Value

$this

at line 181
$this setFilters(array $filters)

Parameters

array $filters

Return Value

$this

at line 191
$this setSort(Closure|int $sort)

Parameters

Closure|int $sort

Return Value

$this

at line 201
$this setPath(array $paths)

Parameters

array $paths

Return Value

$this

at line 211
$this setNotPath(array $notPaths)

Parameters

array $notPaths

Return Value

$this

at line 221
$this ignoreUnreadableDirs(bool $ignore = true)

Parameters

bool $ignore

Return Value

$this

at line 239
abstract protected bool canBeUsed()

Returns whether the adapter is supported in the current environment.

This method should be implemented in all adapters. Do not implement isSupported in the adapters as the generic implementation provides a cache layer.

Return Value

bool Whether the adapter is supported

See also

isSupported()