class vfsStreamContainerIterator
Iterator for children of a directory container.
Hierarchy
- class \org\bovigo\vfs\vfsStreamContainerIterator implements \org\bovigo\vfs\Iterator
Expanded class hierarchy of vfsStreamContainerIterator
File
-
vendor/
mikey179/ vfsstream/ src/ main/ php/ org/ bovigo/ vfs/ vfsStreamContainerIterator.php, line 14
Namespace
org\bovigo\vfsView source
class vfsStreamContainerIterator implements \Iterator {
/**
* list of children from container to iterate over
*
* @type vfsStreamContent[]
*/
protected $children;
/**
* constructor
*
* @param vfsStreamContent[] $children
*/
public function __construct(array $children) {
$this->children = $children;
if (vfsStream::useDotfiles()) {
array_unshift($this->children, new DotDirectory('.'), new DotDirectory('..'));
}
reset($this->children);
}
/**
* resets children pointer
*/
public function rewind() {
reset($this->children);
}
/**
* returns the current child
*
* @return vfsStreamContent
*/
public function current() {
$child = current($this->children);
if (false === $child) {
return null;
}
return $child;
}
/**
* returns the name of the current child
*
* @return string
*/
public function key() {
$child = current($this->children);
if (false === $child) {
return null;
}
return $child->getName();
}
/**
* iterates to next child
*/
public function next() {
next($this->children);
}
/**
* checks if the current value is valid
*
* @return bool
*/
public function valid() {
return false !== current($this->children);
}
}
Members
Title Sort descending | Modifiers | Object type | Summary |
---|---|---|---|
vfsStreamContainerIterator::$children | protected | property | list of children from container to iterate over |
vfsStreamContainerIterator::current | public | function | returns the current child |
vfsStreamContainerIterator::key | public | function | returns the name of the current child |
vfsStreamContainerIterator::next | public | function | iterates to next child |
vfsStreamContainerIterator::rewind | public | function | resets children pointer |
vfsStreamContainerIterator::valid | public | function | checks if the current value is valid |
vfsStreamContainerIterator::__construct | public | function | constructor |