AbstractAdapter Class Reference

TYPO3 7.6

Inheritance diagram for AbstractAdapter:

Public Member Functions
	isSupported ()

	setFollowLinks ($followLinks)

	setMode ($mode)

	setDepths (array $depths)

	setExclude (array $exclude)

	setNames (array $names)

	setNotNames (array $notNames)

	setContains (array $contains)

	setNotContains (array $notContains)

	setSizes (array $sizes)

	setDates (array $dates)

	setFilters (array $filters)

	setSort ($sort)

	setPath (array $paths)

	setNotPath (array $notPaths)

	ignoreUnreadableDirs ($ignore=true)

Public Member Functions inherited from AdapterInterface
	searchInDirectory ($dir)

	getName ()

Protected Member Functions
	canBeUsed ()

Protected Attributes
	$followLinks = false

	$mode = 0

	$minDepth = 0

	$maxDepth = PHP_INT_MAX

	$exclude = array()

	$names = array()

	$notNames = array()

	$contains = array()

	$notContains = array()

	$sizes = array()

	$dates = array()

	$filters = array()

	$sort = false

	$paths = array()

	$notPaths = array()

	$ignoreUnreadableDirs = false

Static Private Attributes
static	$areSupported = array()

Detailed Description

Interface for finder engine implementations.

Author: Jean-François Simon conta.nosp@m.ct@j.nosp@m.fsimo.nosp@m.n.fr

Definition at line 19 of file AbstractAdapter.php.

Member Function Documentation

canBeUsed ( )

abstractprotected

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.

See Also: isSupported()

Returns: bool Whether the adapter is supported

Referenced by AbstractAdapter\isSupported().

ignoreUnreadableDirs ( $ignore = true )

{

Parameters

bool $ignore

Returns: AdapterInterface Current instance

}

Implements AdapterInterface.

Definition at line 217 of file AbstractAdapter.php.

Referenced by PhpAdapter\searchInDirectory(), and AbstractFindAdapter\searchInDirectory().

isSupported ( )

{Tests adapter support for current platform.

Returns: bool

}

Implements AdapterInterface.

Definition at line 43 of file AbstractAdapter.php.

References AbstractAdapter\canBeUsed(), and AdapterInterface\getName().

setContains ( array $contains )

{

Parameters

array $contains

Returns: AdapterInterface Current instance

}

Implements AdapterInterface.

Definition at line 137 of file AbstractAdapter.php.

References AbstractAdapter\$contains.

setDates ( array $dates )

{

Parameters

array $dates

Returns: AdapterInterface Current instance

}

Implements AdapterInterface.

Definition at line 167 of file AbstractAdapter.php.

References AbstractAdapter\$dates.

setDepths ( array $depths )

{

Parameters

array $depths

Returns: AdapterInterface Current instance

}

Implements AdapterInterface.

Definition at line 77 of file AbstractAdapter.php.

setExclude ( array $exclude )

{

Parameters

array $exclude

Returns: AdapterInterface Current instance

}

Implements AdapterInterface.

Definition at line 107 of file AbstractAdapter.php.

References AbstractAdapter\$exclude.

setFilters ( array $filters )

{

Parameters

array $filters

Returns: AdapterInterface Current instance

}

Implements AdapterInterface.

Definition at line 177 of file AbstractAdapter.php.

References AbstractAdapter\$filters.

setFollowLinks ( $followLinks )

{

Parameters

bool $followLinks

Returns: AdapterInterface Current instance

}

Implements AdapterInterface.

Definition at line 57 of file AbstractAdapter.php.

References AbstractAdapter\$followLinks.

setMode ( $mode )

{

Parameters

int $mode

Returns: AdapterInterface Current instance

}

Implements AdapterInterface.

Definition at line 67 of file AbstractAdapter.php.

References AbstractAdapter\$mode.

setNames ( array $names )

{

Parameters

array $names

Returns: AdapterInterface Current instance

}

Implements AdapterInterface.

Definition at line 117 of file AbstractAdapter.php.

References AbstractAdapter\$names.

setNotContains ( array $notContains )

{

Parameters

array $notContains

Returns: AdapterInterface Current instance

}

Implements AdapterInterface.

Definition at line 147 of file AbstractAdapter.php.

References AbstractAdapter\$notContains.

setNotNames ( array $notNames )

{

Parameters

array $notNames

Returns: AdapterInterface Current instance

}

Implements AdapterInterface.

Definition at line 127 of file AbstractAdapter.php.

References AbstractAdapter\$notNames.

setNotPath ( array $notPaths )

{

Parameters

array $notPaths

Returns: AdapterInterface Current instance

}

Implements AdapterInterface.

Definition at line 207 of file AbstractAdapter.php.

References AbstractAdapter\$notPaths.

setPath ( array $paths )

{

Parameters

array $paths

Returns: AdapterInterface Current instance

}

Implements AdapterInterface.

Definition at line 197 of file AbstractAdapter.php.

References AbstractAdapter\$paths.

setSizes ( array $sizes )

{

Parameters

array $sizes

Returns: AdapterInterface Current instance

}

Implements AdapterInterface.

Definition at line 157 of file AbstractAdapter.php.

References AbstractAdapter\$sizes.

setSort ( $sort )

{

Parameters

\Closure | int $sort

Returns: AdapterInterface Current instance

}

Implements AdapterInterface.

Definition at line 187 of file AbstractAdapter.php.

References AbstractAdapter\$sort.

Member Data Documentation

$areSupported = array()

staticprivate

Definition at line 38 of file AbstractAdapter.php.

$contains = array()

protected

Definition at line 28 of file AbstractAdapter.php.

Referenced by AbstractAdapter\setContains().

$dates = array()

protected

Definition at line 31 of file AbstractAdapter.php.

Referenced by AbstractAdapter\setDates().

$exclude = array()

protected

Definition at line 25 of file AbstractAdapter.php.

Referenced by AbstractAdapter\setExclude().

$filters = array()

protected

Definition at line 32 of file AbstractAdapter.php.

Referenced by AbstractAdapter\setFilters().

$followLinks = false

protected

Definition at line 21 of file AbstractAdapter.php.

Referenced by AbstractAdapter\setFollowLinks().

$ignoreUnreadableDirs = false

protected

Definition at line 36 of file AbstractAdapter.php.

$maxDepth = PHP_INT_MAX

protected

Definition at line 24 of file AbstractAdapter.php.

$minDepth = 0

protected

Definition at line 23 of file AbstractAdapter.php.

$mode = 0

protected

Definition at line 22 of file AbstractAdapter.php.

Referenced by AbstractAdapter\setMode().

$names = array()

protected

Definition at line 26 of file AbstractAdapter.php.

Referenced by AbstractAdapter\setNames().

$notContains = array()

protected

Definition at line 29 of file AbstractAdapter.php.

Referenced by AbstractAdapter\setNotContains().

$notNames = array()

protected

Definition at line 27 of file AbstractAdapter.php.

Referenced by AbstractAdapter\setNotNames().

$notPaths = array()

protected

Definition at line 35 of file AbstractAdapter.php.

Referenced by AbstractAdapter\setNotPath().

$paths = array()

protected

Definition at line 34 of file AbstractAdapter.php.

Referenced by AbstractFindAdapter\searchInDirectory(), and AbstractAdapter\setPath().

$sizes = array()

protected

Definition at line 30 of file AbstractAdapter.php.

Referenced by AbstractAdapter\setSizes().

$sort = false

protected

Definition at line 33 of file AbstractAdapter.php.

Referenced by GnuFindAdapter\buildFormatSorting(), BsdFindAdapter\buildFormatSorting(), AbstractFindAdapter\buildSorting(), and AbstractAdapter\setSort().