PHP Class Spatie\Backup\Tasks\Backup\FileSelection

Show file Open project: spatie/laravel-backup Class Usage Examples

Protected Properties

Property Type Description
$excludeFilesAndDirectories Illuminate\Support\Collection
$includeFilesAndDirectories Illuminate\Support\Collection
$shouldFollowLinks boolean

Public Methods

Method Description
__construct ( array | string $includeFilesAndDirectories = [] )
create ( array | string $includeFilesAndDirectories = [] ) : FileSelection
excludeFilesFrom ( array | string $excludeFilesAndDirectories ) : FileSelection Do not included the given files and directories.
selectedFiles ( ) : Generator | string[]
shouldFollowLinks ( boolean $shouldFollowLinks ) : FileSelection Enable or disable the following of symlinks.

Protected Methods

Method Description
includedDirectories ( ) : array
includedFiles ( ) : array
sanitize ( string | array $paths ) : Collection
shouldExclude ( string $path ) : boolean

Method Details

__construct() public method

public __construct ( array | string $includeFilesAndDirectories = [] )
$includeFilesAndDirectories array | string

create() public static method

public static create ( array | string $includeFilesAndDirectories = [] ) : FileSelection
$includeFilesAndDirectories array | string
return FileSelection

excludeFilesFrom() public method

Do not included the given files and directories.
public excludeFilesFrom ( array | string $excludeFilesAndDirectories ) : FileSelection
$excludeFilesAndDirectories array | string
return FileSelection

includedDirectories() protected method

protected includedDirectories ( ) : array
return array

includedFiles() protected method

protected includedFiles ( ) : array
return array

sanitize() protected method

protected sanitize ( string | array $paths ) : Collection
$paths string | array
return Illuminate\Support\Collection

selectedFiles() public method

public selectedFiles ( ) : Generator | string[]
return Generator | string[]

shouldExclude() protected method

protected shouldExclude ( string $path ) : boolean
$path string
return boolean

Property Details

$excludeFilesAndDirectories protected property

protected Collection,Illuminate\Support $excludeFilesAndDirectories
return Illuminate\Support\Collection

$includeFilesAndDirectories protected property

protected Collection,Illuminate\Support $includeFilesAndDirectories
return Illuminate\Support\Collection