1. class
  2. Windwalker
  3. Filesystem
  4. Path
  5. PathCollection

PathCollection

class PathCollection extends ArrayObject (View source)

A PathLocator collection class

Constants

STD_PROP_LIST

Properties of the object have their normal functionality when accessed as list (var_dump, foreach, etc.).
ARRAY_AS_PROPS

Entries can be accessed as properties (read and write).

Methods

__construct(array $paths = array())

PathCollection constructor.

boolean
__isset(mixed $key)

Returns whether the requested key exists

from ArrayObject
void|mixed
__set(mixed $key, mixed $value)

Sets the value at the specified key to value

from ArrayObject
void|mixed
__unset(mixed $key)

Unsets the value at the specified key

from ArrayObject
mixed
__get(mixed $key)

Returns the value at the specified key by reference

from ArrayObject
void
append(mixed $value)

Appends the value

from ArrayObject
void
asort()

Sort the entries by value

from ArrayObject
int
count()

Get the number of public properties in the ArrayObject

from ArrayObject
array
exchangeArray(array|ArrayObject $data)

Exchange the array for another one.

from ArrayObject
array
getArrayCopy()

Creates a copy of the ArrayObject.

from ArrayObject
int
getFlags()

Gets the behavior flags.

from ArrayObject
Iterator
getIterator()

Create a new iterator from an ArrayObject instance

from ArrayObject
string
getIteratorClass()

Gets the iterator classname for the ArrayObject.

from ArrayObject
void
ksort()

Sort the entries by key

from ArrayObject
void
natcasesort()

Sort an array using a case insensitive "natural order" algorithm

from ArrayObject
void
natsort()

Sort entries using a "natural order" algorithm

from ArrayObject
bool
offsetExists(mixed $key)

Returns whether the requested key exists

from ArrayObject
mixed
offsetGet(mixed $key)

Returns the value at the specified key

from ArrayObject
void
offsetSet(mixed $key, mixed $value)

Sets the value at the specified key to value

from ArrayObject
void
offsetUnset(mixed $key)

Unsets the value at the specified key

from ArrayObject
string
serialize()

Serialize an ArrayObject

from ArrayObject
void
setFlags(int $flags)

Sets the behavior flags

from ArrayObject
void
setIteratorClass(string $class)

Sets the iterator classname for the ArrayObject

from ArrayObject
void
uasort(callable $function)

Sort the entries with a user-defined comparison function and maintain key association

from ArrayObject
void
uksort(callable $function)

Sort the entries by keys using a user-defined comparison function

from ArrayObject
void
unserialize(string $data)

Unserialize an ArrayObject

from ArrayObject
PathCollection
addPaths(mixed $paths)

Batch add paths to bag.

PathCollection
addPath(mixed $path, string $key = null)

Add one path to bag.

PathCollection
removePath(string $key)

Using key to remove a path from bag.

array
getPaths()

Get all paths with key from bag.

PathLocator
getPath(string $key, string $default = null)

Using key to get a path.

AppendIterator
getAllChildren(boolean $recursive = false)

Get all files and folders as an iterator.

SplFileInfo
findOne(mixed $condition, boolean $recursive = false)

Find one file from all paths.

AppendIterator
find(mixed $condition, boolean $recursive = false)

Find all files from paths.

AppendIterator
getFiles(boolean $recursive = false)

Get file iterator of all paths

AppendIterator
getFolders(boolean $recursive = false)

Get folder iterator of all paths

PathCollection
setPrefix(string $prefix)

Set prefix to all paths.

PathCollection
appendAll(string $appended)

Append a new path to all paths.

PathCollection
prependAll(string $prepended)

Prepend a new path to all paths.

array
toArray(bool $reindex = false)

Convert paths bag to array, and every path to string.

boolean
isSubdir(PathLocator $path)

Is this path a subdir of another path in bag?

Details

at line line 41
__construct(array $paths = array())

PathCollection constructor.

Parameters

array $paths The PathLocator array.

in ArrayObject at line line 72
boolean __isset(mixed $key)

Returns whether the requested key exists

Parameters

mixed $key

Return Value

boolean

Exceptions

InvalidArgumentException

in ArrayObject at line line 96
void|mixed __set(mixed $key, mixed $value)

Sets the value at the specified key to value

Parameters

mixed $key
mixed $value

Return Value

void|mixed

Exceptions

InvalidArgumentException

in ArrayObject at line line 119
void|mixed __unset(mixed $key)

Unsets the value at the specified key

Parameters

mixed $key

Return Value

void|mixed

Exceptions

InvalidArgumentException

in ArrayObject at line line 142
mixed __get(mixed $key)

Returns the value at the specified key by reference

Parameters

mixed $key

Return Value

mixed

Exceptions

InvalidArgumentException

in ArrayObject at line line 168
void append(mixed $value)

Appends the value

Parameters

mixed $value

Return Value

void

in ArrayObject at line line 178
void asort()

Sort the entries by value

Return Value

void

in ArrayObject at line line 188
int count()

Get the number of public properties in the ArrayObject

Return Value

int

in ArrayObject at line line 201
array exchangeArray(array|ArrayObject $data)

Exchange the array for another one.

Parameters

array|ArrayObject $data

Return Value

array

Exceptions

InvalidArgumentException

in ArrayObject at line line 230
array getArrayCopy()

Creates a copy of the ArrayObject.

Return Value

array

in ArrayObject at line line 240
int getFlags()

Gets the behavior flags.

Return Value

int

in ArrayObject at line line 250
Iterator getIterator()

Create a new iterator from an ArrayObject instance

Return Value

Iterator

in ArrayObject at line line 262
string getIteratorClass()

Gets the iterator classname for the ArrayObject.

Return Value

string

in ArrayObject at line line 272
void ksort()

Sort the entries by key

Return Value

void

in ArrayObject at line line 282
void natcasesort()

Sort an array using a case insensitive "natural order" algorithm

Return Value

void

in ArrayObject at line line 292
void natsort()

Sort entries using a "natural order" algorithm

Return Value

void

in ArrayObject at line line 304
bool offsetExists(mixed $key)

Returns whether the requested key exists

Parameters

mixed $key

Return Value

bool

in ArrayObject at line line 316
mixed offsetGet(mixed $key)

Returns the value at the specified key

Parameters

mixed $key

Return Value

mixed

in ArrayObject at line line 338
void offsetSet(mixed $key, mixed $value)

Sets the value at the specified key to value

Parameters

mixed $key
mixed $value

Return Value

void

in ArrayObject at line line 350
void offsetUnset(mixed $key)

Unsets the value at the specified key

Parameters

mixed $key

Return Value

void

in ArrayObject at line line 363
string serialize()

Serialize an ArrayObject

Return Value

string

in ArrayObject at line line 375
void setFlags(int $flags)

Sets the behavior flags

Parameters

int $flags

Return Value

void

in ArrayObject at line line 388
void setIteratorClass(string $class)

Sets the iterator classname for the ArrayObject

Parameters

string $class

Return Value

void

Exceptions

InvalidArgumentException

in ArrayObject at line line 419
void uasort(callable $function)

Sort the entries with a user-defined comparison function and maintain key association

Parameters

callable $function

Return Value

void

in ArrayObject at line line 434
void uksort(callable $function)

Sort the entries by keys using a user-defined comparison function

Parameters

callable $function

Return Value

void

in ArrayObject at line line 449
void unserialize(string $data)

Unserialize an ArrayObject

Parameters

string $data

Return Value

void

at line line 55
PathCollection addPaths(mixed $paths)

Batch add paths to bag.

Parameters

mixed $paths Paths to add to path bag, string will be converted to PathLocator object.

Return Value

PathCollection Return this object to support chaining.

at line line 81
PathCollection addPath(mixed $path, string $key = null)

Add one path to bag.

Parameters

mixed $path The path your want to store in bag, have to be a string or PathLocator object.
string $key Path key, useful when you want to remove a path.

Return Value

PathCollection Return this object to support chaining.

Exceptions

InvalidArgumentException

at line line 121
PathCollection removePath(string $key)

Using key to remove a path from bag.

Parameters

string $key The key of path you want to remove.

Return Value

PathCollection Return this object to support chaining.

at line line 135
array getPaths()

Get all paths with key from bag.

Return Value

array An array includes all path objects.

at line line 152
PathLocator getPath(string $key, string $default = null)

Using key to get a path.

Parameters

string $key The key of path you want to get.
string $default If path not exists, return this default path. Default value can be PathLocator object string or null. String will auto wrapped by object, if is null, just return null.

Return Value

PathLocator The path which you want.

at line line 214
AppendIterator getAllChildren(boolean $recursive = false)

Get all files and folders as an iterator.

Parameters

boolean $recursive True to support recrusive.

Return Value

AppendIterator An OutterIterator contains all paths' iterator.

at line line 241
SplFileInfo findOne(mixed $condition, boolean $recursive = false)

Find one file from all paths.

Parameters

mixed $condition Finding condition, that can be a string, a regex or a callback function. Callback example: function($current, $key, $iterator) { return @preg_match('^Foo', $current->getFilename()) && ! $iterator->isDot(); }
boolean $recursive True to resursive.

Return Value

SplFileInfo Finded file info object.

at line line 272
AppendIterator find(mixed $condition, boolean $recursive = false)

Find all files from paths.

Parameters

mixed $condition Finding condition, that can be a string, a regex or a callback function. Callback example: function($current, $key, $iterator) { return @preg_match('^Foo', $current->getFilename()) && ! $iterator->isDot(); }
boolean $recursive True to resursive.

Return Value

AppendIterator Finded files or paths iterator.

at line line 289
AppendIterator getFiles(boolean $recursive = false)

Get file iterator of all paths

Parameters

boolean $recursive True to resursive.

Return Value

AppendIterator Iterator only include files.

at line line 306
AppendIterator getFolders(boolean $recursive = false)

Get folder iterator of all paths

Parameters

boolean $recursive True to resursive.

Return Value

AppendIterator Iterator only include dirs.

at line line 325
PathCollection setPrefix(string $prefix)

Set prefix to all paths.

Parameters

string $prefix The prefix path you want to prepend when path convert to string.

Return Value

PathCollection Return this object to support chaining.

at line line 344
PathCollection appendAll(string $appended)

Append a new path to all paths.

Parameters

string $appended Path to append.

Return Value

PathCollection Return this object to support chaining.

at line line 363
PathCollection prependAll(string $prepended)

Prepend a new path to all paths.

Parameters

string $prepended Path to prepend.

Return Value

PathCollection Return this object to support chaining.

at line line 382
array toArray(bool $reindex = false)

Convert paths bag to array, and every path to string.

Parameters

bool $reindex

Return Value

array Raw paths.

at line line 412
boolean isSubdir(PathLocator $path)

Is this path a subdir of another path in bag?

When running recursive scan dir, we have to avoid to re scan same dir.

Parameters

PathLocator $path The path to detect is subdir or not.

Return Value

boolean Is subdir or not.