API Documentation

Zend/Filter/File/Rename.php

Show: inherited
Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Filter  
Version
$Id: Rename.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Filter_File_Rename

Package: Zend\Filter

Implements
\Zend_Filter_Interface
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotected  $_files= 'array()'

Internal array of array(source, target, overwrite)

Default valuearray()Details
Type

Methods

methodpublic__construct( string|array $options ) : void

Class constructor

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 sourcefile 'overwrite' => Shall existing files be overwritten ?

Parameters
Name Type Description
$options string|array

Target file or directory to be renamed

methodprotected_convertOptions( array $options ) : array

Internal method for creating the file array Supports single and nested arrays

Parameters
Name Type Description
$options array
Returns
Type Description
array
methodprotected_getFileName( string $file ) : array

Internal method to resolve the requested source and return all other related parameters

Parameters
Name Type Description
$file string

Filename to get the informations for

Returns
Type Description
array
methodpublicaddFile( string|array $options ) : \Zend_Filter_File_Rename

Adds a new file or directory as target to the existing ones

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 ?

Parameters
Name Type Description
$options string|array

Old file or directory to be rewritten

Returns
Type Description
\Zend_Filter_File_Rename
methodpublicfilter( string $value ) : string

Defined by Zend_Filter_Interface

Renames the file $value to the new name set before Returns the file $value, removing all but digit characters

Parameters
Name Type Description
$value string

Full path of file to change

Returns
Type Description
string The new filename which has been set, or false when there were errors
Throws
Exception Description
\Zend_Filter_Exception
methodpublicgetFile( ) : array

Returns the files to rename and their new name and location

Returns
Type Description
array
methodpublicgetNewName( string $value, boolean $source = false ) : string

Returns only the new filename without moving it But existing files will be erased when the overwrite option is true

Parameters
Name Type Description
$value string

Full path of file to change

$source boolean

Return internal informations

Returns
Type Description
string The new filename which has been set
methodpublicsetFile( string|array $options ) : \Zend_Filter_File_Rename

Sets a new file or directory as target, deleting existing ones

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 ?

Parameters
Name Type Description
$options string|array

Old file or directory to be rewritten

Returns
Type Description
\Zend_Filter_File_Rename
Documentation was generated by DocBlox 0.15.1.