Documentation

FileSelection
in package

Table of Contents

$excludeFilesAndDirectories  : Collection
$includeFilesAndDirectories  : Collection
$shouldFollowLinks  : bool
__construct()  : mixed
create()  : FileSelection
excludeFilesFrom()  : FileSelection
Do not included the given files and directories.
selectedFiles()  : Generator|array<string|int, string>
shouldFollowLinks()  : self
includedDirectories()  : array<string|int, mixed>
includedFiles()  : array<string|int, mixed>
sanitize()  : Collection
shouldExclude()  : bool

Properties

$shouldFollowLinks

protected bool $shouldFollowLinks = false

Methods

__construct()

public __construct([array<string|int, mixed>|string $includeFilesAndDirectories = [] ]) : mixed
Parameters
$includeFilesAndDirectories : array<string|int, mixed>|string = []
Return values
mixed —

create()

public static create([array<string|int, mixed>|string $includeFilesAndDirectories = [] ]) : FileSelection
Parameters
$includeFilesAndDirectories : array<string|int, mixed>|string = []
Return values
FileSelection —

excludeFilesFrom()

Do not included the given files and directories.

public excludeFilesFrom(array<string|int, mixed>|string $excludeFilesAndDirectories) : FileSelection
Parameters
$excludeFilesAndDirectories : array<string|int, mixed>|string
Return values
FileSelection —

selectedFiles()

public selectedFiles() : Generator|array<string|int, string>
Return values
Generator|array<string|int, string> —

shouldFollowLinks()

public shouldFollowLinks(bool $shouldFollowLinks) : self
Parameters
$shouldFollowLinks : bool
Return values
self —

includedDirectories()

protected includedDirectories() : array<string|int, mixed>
Return values
array<string|int, mixed> —

includedFiles()

protected includedFiles() : array<string|int, mixed>
Return values
array<string|int, mixed> —

sanitize()

protected sanitize(string|array<string|int, mixed> $paths) : Collection
Parameters
$paths : string|array<string|int, mixed>
Return values
Collection —

shouldExclude()

protected shouldExclude(string $path) : bool
Parameters
$path : string
Return values
bool —

Search results