PHP Class Psecio\Parse\FileIterator

Inheritance: implements IteratorAggregat\IteratorAggregate, implements Countabl\Countable

Public Methods

Method	Description
__construct ( array $paths, array $ignorePaths = [], array $extensions = ['php'] )	Append paths to iterator
addExtensions ( array $extensions ) : void	Add list of file extensions to include when scanning dirs
addIgnorePath ( string $path ) : void	Add a path to the list of ignored paths
addPath ( string $path ) : void	Add a path to iterator
count ( ) : integer	Return a count of files in iterator
getIterator ( ) : ArrayIterator	Get iterator whith file paths as keys and File objects as values
getPaths ( ) : array	Get the full paths for the current files
toArray ( ) : array	Convert the interator to an array (return current files)

Method	Description
addDirectory ( string $directory ) : void	Recursicely add files in directory
addFile ( SplFileInfo $splFileInfo ) : void	Add a SplFileInfo object to iterator
isValidFile ( SplFileInfo $splFileInfo ) : boolean	Check of file should be included

Append paths to iterator

public __construct ( array $paths, array $ignorePaths = [], array $extensions = ['php'] )
$paths	array	List of paths to scan
$ignorePaths	array	List of paths to ignore
$extensions	array	List of file extensions to include when scanning dirs

Add list of file extensions to include when scanning dirs

public addExtensions ( array $extensions ) : void
$extensions	array
return	void

Non existing paths are silently skipped.

public addIgnorePath ( string $path ) : void
$path	string
return	void

Add a path to iterator

public addPath ( string $path ) : void
$path	string
return	void

Return a count of files in iterator

public count ( ) : integer
return	integer

Get iterator whith file paths as keys and File objects as values

public getIterator ( ) : ArrayIterator
return	ArrayIterator

Get the full paths for the current files

public getPaths ( ) : array
return	array	Set of file paths

Convert the interator to an array (return current files)

public toArray ( ) : array
return	array	Set of current files