Page MenuHomeWickedGov Phorge
Files F5977082

FSFileBackendList.php
No OneTemporary
Actions

Size
4 KB
Referenced Files
None
Subscribers
None

FSFileBackendList.php
View Options

<?php
/**
* @license GPL-2.0-or-later
* @file
* @ingroup FileBackend
*/
namespace Wikimedia\FileBackend\FileIteration;
use DirectoryIterator;
use FilesystemIterator;
use Iterator;
use RecursiveDirectoryIterator;
use RecursiveIteratorIterator;
use UnexpectedValueException;
use Wikimedia\FileBackend\FileBackendError;
/**
* Wrapper around RecursiveDirectoryIterator/DirectoryIterator that
* catches exception or does any custom behavior that we may want.
* Do not use this class from places outside FSFileBackend.
*
* @ingroup FileBackend
*/
abstract class FSFileBackendList implements Iterator {
/** @var Iterator|null */
protected $iter;
/** @var string */
protected $lastError;
/** @var int */
protected $suffixStart;
/** @var int */
protected $pos = 0;
/** @var array */
protected $params = [];
/**
* @param string $dir File system directory
* @param array $params
*/
public function __construct( $dir, array $params ) {
$path = realpath( $dir ); // normalize
if ( $path === false ) {
$path = $dir;
}
$this->suffixStart = strlen( $path ) + 1; // size of "path/to/dir/"
$this->params = $params;
try {
$this->iter = $this->initIterator( $path );
} catch ( UnexpectedValueException $e ) {
$this->iter = null; // bad permissions? deleted?
$this->lastError = $e->getMessage();
}
}
/**
* Return an appropriate iterator object to wrap
*
* @param string $dir File system directory
* @return Iterator
* @throws UnexpectedValueException
*/
protected function initIterator( $dir ) {
if ( !empty( $this->params['topOnly'] ) ) { // non-recursive
# Get an iterator that will get direct sub-nodes
return new DirectoryIterator( $dir );
} else { // recursive
# Get an iterator that will return leaf nodes (non-directories)
# RecursiveDirectoryIterator extends FilesystemIterator.
# FilesystemIterator::SKIP_DOTS default is inconsistent in PHP 5.3.x.
$flags = FilesystemIterator::CURRENT_AS_SELF | FilesystemIterator::SKIP_DOTS;
return new RecursiveIteratorIterator(
new RecursiveDirectoryIterator( $dir, $flags ),
RecursiveIteratorIterator::CHILD_FIRST // include dirs
);
}
}
/**
* @see Iterator::key()
* @return int
*/
public function key(): int {
return $this->pos;
}
/**
* @see Iterator::current()
* @return string|false
*/
#[\ReturnTypeWillChange]
public function current() {
return $this->getRelPath( $this->iter->current()->getPathname() );
}
/**
* @see Iterator::next()
* @throws FileBackendError
*/
public function next(): void {
try {
$this->iter->next();
$this->filterViaNext();
} catch ( UnexpectedValueException $e ) { // bad permissions? deleted?
$this->lastError = $e->getMessage();
throw new FileBackendError( "File iterator gave UnexpectedValueException." );
}
++$this->pos;
}
/**
* @see Iterator::rewind()
* @throws FileBackendError
*/
public function rewind(): void {
$this->pos = 0;
try {
$this->iter->rewind();
$this->filterViaNext();
} catch ( UnexpectedValueException $e ) { // bad permissions? deleted?
$this->lastError = $e->getMessage();
throw new FileBackendError( "File iterator gave UnexpectedValueException." );
}
}
/**
* @see Iterator::valid()
* @return bool
*/
public function valid(): bool {
return $this->iter && $this->iter->valid();
}
/**
* @return string|null The last caught exception message
*/
public function getLastError() {
return $this->lastError;
}
/**
* Filter out items by advancing to the next ones
*/
protected function filterViaNext() {
}
/**
* Return only the relative path and normalize slashes to FileBackend-style.
* Uses the "real path" since the suffix is based upon that.
*
* @param string $dir
* @return string
*/
protected function getRelPath( $dir ) {
$path = realpath( $dir );
if ( $path === false ) {
$path = $dir;
}
return strtr( substr( $path, $this->suffixStart ), '\\', '/' );
}
}
/** @deprecated class alias since 1.43 */
class_alias( FSFileBackendList::class, 'FSFileBackendList' );

File Metadata

Mime Type
text/x-php
Expires
Sat, Oct 3, 19:39 (2 d, 20 h ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
2b/bd/36a1817b96d4800988636fde869d
Default Alt Text
FSFileBackendList.php (4 KB)

Event Timeline