Zend\Filter\File\Rename
Synopsis
class Rename
extends AbstractFilter
{
- // members
- protected array $files;
- // Inherited members from AbstractFilter
- protected array $options;
- // methods
- public void __construct()
- public array getFile()
- public self setFile()
- public Rename addFile()
- public string getNewName()
- public string|array filter()
- protected array _convertOptions()
- protected array|string _getFileName()
- // Inherited methods from AbstractFilter
- public static bool hasPcreUnicodeSupport()
- public self setOptions()
- public array getOptions()
- public mixed __invoke()
- protected static bool isOptions()
Hierarchy
Extends
Members
protected
-
$files
Internal array of array(source, target, overwrite) - $options
—
array
Filter options
Methods
protected
- _convertOptions() — Internal method for creating the file array Supports single and nested arrays
- _getFileName() — Internal method to resolve the requested source and return all other related parameters
public
- __construct() — Class constructor
- addFile() — Adds a new file or directory as target to the existing ones
- filter() — Defined by Zend\Filter\Filter
- getFile() — Returns the files to rename and their new name and location
- getNewName() — Returns only the new filename without moving it But existing files will be erased when the overwrite option is true
- setFile() — Sets a new file or directory as target, deleting existing ones
Inherited from Zend\Filter\AbstractFilter
protected
public
- __invoke() — Invoke filter as a command
- getOptions() — Retrieve options representing object state
- hasPcreUnicodeSupport()
- setOptions()