WindowsPath
Read onlyYes
FinalYes
Methods
- __construct() : mixed
- addPartitions() : self
- basename() : string
- basenamePrefix() : self
- endsWith() : bool
- extension() : string|false
- extractPlaceholderPartitions() : Partitions
- Extracts partitions from a concrete path by matching it against partition placeholders in this path.
- filename() : string
- glob() : string
- Path with partition placeholders replaced by glob wildcards, suitable for glob-based listing.
- isEqual() : bool
- isPattern() : bool
- matches() : bool
- options() : Options
- parentDirectory() : self
- partitionPlaceholders() : array<string|int, string>
- partitions() : Partitions
- partitionsPaths() : array<int, self>
- path() : string
- protocol() : string
- randomize() : self
- realpath() : self
- rootDirectoryName() : string|null
- setExtension() : self
- skipDirectories() : self|null
- staticPart() : self
- suffix() : self
- uri() : string
- withOptions() : self
Methods
__construct()
public
__construct(string $uri[, array<string|int, null|bool|float|int|string|UnitEnum>|Options $options = [] ]) : mixed
Parameters
- $uri : string
- $options : array<string|int, null|bool|float|int|string|UnitEnum>|Options = []
addPartitions()
public
addPartitions(Partition $partition, Partition ...$partitions) : self
Parameters
Return values
selfbasename()
public
basename() : string
Return values
stringbasenamePrefix()
public
basenamePrefix(string $prefix) : self
Parameters
- $prefix : string
Return values
selfendsWith()
public
endsWith(string $string) : bool
Parameters
- $string : string
Return values
boolextension()
public
extension() : string|false
Return values
string|falseextractPlaceholderPartitions()
Extracts partitions from a concrete path by matching it against partition placeholders in this path.
public
extractPlaceholderPartitions(self $path) : Partitions
Values that would not be valid partitions (e.g. produced by files not written through partitioning) are skipped.
Parameters
- $path : self
Return values
Partitionsfilename()
public
filename() : string
Return values
stringglob()
Path with partition placeholders replaced by glob wildcards, suitable for glob-based listing.
public
glob() : string
Return values
stringisEqual()
public
isEqual(self $path) : bool
Parameters
- $path : self
Return values
boolisPattern()
public
isPattern() : bool
Return values
boolmatches()
public
matches(self $path) : bool
Parameters
- $path : self
Return values
booloptions()
public
options() : Options
Return values
OptionsparentDirectory()
public
parentDirectory() : self
Return values
selfpartitionPlaceholders()
public
partitionPlaceholders() : array<string|int, string>
Return values
array<string|int, string>partitions()
public
partitions() : Partitions
Return values
PartitionspartitionsPaths()
public
partitionsPaths() : array<int, self>
Return values
array<int, self>path()
public
path() : string
Return values
stringprotocol()
public
protocol() : string
Return values
stringrandomize()
public
randomize() : self
Return values
selfrealpath()
public
static realpath(string $path[, array<string|int, null|bool|float|int|string|UnitEnum>|Options $options = [] ]) : self
Parameters
- $path : string
- $options : array<string|int, null|bool|float|int|string|UnitEnum>|Options = []
Tags
Return values
selfrootDirectoryName()
public
rootDirectoryName() : string|null
Return values
string|nullsetExtension()
public
setExtension(string $extension) : self
Parameters
- $extension : string
Return values
selfskipDirectories()
public
skipDirectories(int $count) : self|null
Parameters
- $count : int
Return values
self|nullstaticPart()
public
staticPart() : self
Return values
selfsuffix()
public
suffix(string $string) : self
Parameters
- $string : string
Return values
selfuri()
public
uri() : string
Return values
stringwithOptions()
public
withOptions(Options $options) : self
Parameters
- $options : Options