__construct()
__invoke()
addFile()
filter()
getFile()
getNewName()
getOptions()
hasPcreUnicodeSupport()
setFile()
setOptions()
_convertOptions()
_getFileName()
isOptions()
$files
$options
__construct(string | array | \Traversable $options)
Options argument may be either a string, a Zend_Config object, or an array. If an array or Zend_Config object, it accepts the following keys: 'source' => Source filename or directory which will be renamed 'target' => Target filename or directory, the new name of the source file 'overwrite' => Shall existing files be overwritten ? 'randomize' => Shall target files have a random postfix attached?
stringarray\TraversableTarget file or directory to be renamed
\Zend\Filter\Exception\InvalidArgumentException |
|---|
__invoke(mixed $value) : mixed
Proxies to filter()
| inherited_from | \Zend\Filter\AbstractFilter::__invoke() |
|---|
mixed
\Zend\Filter\Exception\ExceptionInterface |
If filtering $value is impossible |
|---|
mixedaddFile(string | array $options) : \Zend\Filter\File\Rename
Array accepts the following keys: 'source' => Source filename or directory which will be renamed 'target' => Target filename or directory, the new name of the sourcefile 'overwrite' => Shall existing files be overwritten? 'randomize' => Shall target files have a random postfix attached?
stringarrayOld file or directory to be rewritten
\Zend\Filter\Exception\InvalidArgumentException |
|---|
filter(string | array $value) : string | array
Renames the file $value to the new name set before Returns the file $value, removing all but digit characters
stringarrayFull path of file to change or $_FILES data array
\Zend\Filter\Exception\RuntimeException |
|---|
stringarrayThe new filename which has been setgetFile() : array
arraygetNewName(string $value, bool $source) : string
stringFull path of file to change
boolReturn internal informations
\Zend\Filter\Exception\InvalidArgumentException |
If the target file already exists. |
|---|
stringThe new filename which has been setgetOptions() : array
| inherited_from | \Zend\Filter\AbstractFilter::getOptions() |
|---|
arrayhasPcreUnicodeSupport() : bool
| inherited_from | \Zend\Filter\AbstractFilter::hasPcreUnicodeSupport() |
|---|
boolsetFile(string | array $options) : \Zend\Filter\File\Rename
Array accepts the following keys: 'source' => Source filename or directory which will be renamed 'target' => Target filename or directory, the new name of the sourcefile 'overwrite' => Shall existing files be overwritten? 'randomize' => Shall target files have a random postfix attached?
stringarrayOld file or directory to be rewritten
setOptions(array | \Traversable $options) : \Zend\Filter\AbstractFilter
| inherited_from | \Zend\Filter\AbstractFilter::setOptions() |
|---|
array\Traversable
\Zend\Filter\Exception\InvalidArgumentException |
|---|
_convertOptions(array $options) : array
array
array_getFileName(string $file) : array | string
stringFilename to get the informations for
arraystring
isOptions(mixed $options) : bool
| inherited_from | \Zend\Filter\AbstractFilter::isOptions() |
|---|
mixed
bool$files