Zend_Filter_File_Rename Class Reference

Inheritance diagram for Zend_Filter_File_Rename:

Public Member Functions
	__construct ($options)
	getFile ()
	setFile ($options)
	addFile ($options)
	getNewName ($value, $source=false)
	filter ($value)

Protected Member Functions
	_convertOptions ($options)
	_getFileName ($file)

Protected Attributes
	$_files = array()

Detailed Description

Definition at line 33 of file Rename.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options

)

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

string | array	$options	Target file or directory to be renamed
string	$target	Source filename or directory (deprecated)
bool	$overwrite	Should existing files be overwritten (deprecated)

Returns

void

Definition at line 54 of file Rename.php.

    {
        if ($options instanceof Zend_Config) {
            $options = $options->toArray();
        } elseif (is_string($options)) {
            $options = array('target' => $options);
        } elseif (!is_array($options)) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception('Invalid options argument provided to filter');
        }

        if (1 < func_num_args()) {
            $argv = func_get_args();
            array_shift($argv);
            $source    = array_shift($argv);
            $overwrite = false;
            if (!empty($argv)) {
                $overwrite = array_shift($argv);
            }
            $options['source']    = $source;
            $options['overwrite'] = $overwrite;
        }

        $this->setFile($options);
    }

Member Function Documentation

_convertOptions()

_convertOptions (   $options )

protected

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

Parameters

array

$options

Returns

array

Definition at line 208 of file Rename.php.

                                                 {
        $files = array();
        foreach ($options as $key => $value) {
            if (is_array($value)) {
                $this->_convertOptions($value);
                continue;
            }

            switch ($key) {
                case "source":
                    $files['source'] = (string) $value;
                    break;

                case 'target' :
                    $files['target'] = (string) $value;
                    break;

                case 'overwrite' :
                    $files['overwrite'] = (boolean) $value;
                    break;

                default:
                    break;
            }
        }

        if (empty($files)) {
            return $this;
        }

        if (empty($files['source'])) {
            $files['source'] = '*';
        }

        if (empty($files['target'])) {
            $files['target'] = '*';
        }

        if (empty($files['overwrite'])) {
            $files['overwrite'] = false;
        }

        $found = false;
        foreach ($this->_files as $key => $value) {
            if ($value['source'] == $files['source']) {
                $this->_files[$key] = $files;
                $found              = true;
            }
        }

        if (!$found) {
            $count                = count($this->_files);
            $this->_files[$count] = $files;
        }

        return $this;
    }

_getFileName()

_getFileName (   $file )

protected

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

Parameters

string

$file

Filename to get the informations for

Returns

array

Definition at line 273 of file Rename.php.

    {
        $rename = array();
        foreach ($this->_files as $value) {
            if ($value['source'] == '*') {
                if (!isset($rename['source'])) {
                    $rename           = $value;
                    $rename['source'] = $file;
                }
            }

            if ($value['source'] == $file) {
                $rename = $value;
            }
        }

        if (!isset($rename['source'])) {
            return $file;
        }

        if (!isset($rename['target']) or ($rename['target'] == '*')) {
            $rename['target'] = $rename['source'];
        }

        if (is_dir($rename['target'])) {
            $name = basename($rename['source']);
            $last = $rename['target'][strlen($rename['target']) - 1];
            if (($last != '/') and ($last != '\\')) {
                $rename['target'] .= DIRECTORY_SEPARATOR;
            }

            $rename['target'] .= $name;
        }

        return $rename;
    }

addFile()

addFile

(

$options

)

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

string | array

$options

Old file or directory to be rewritten

Returns

Zend_Filter_File_Rename

Definition at line 120 of file Rename.php.

    {
        if (is_string($options)) {
            $options = array('target' => $options);
        } elseif (!is_array($options)) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception ('Invalid options to rename filter provided');
        }

        $this->_convertOptions($options);

        return $this;
    }

filter()

filter

(

$value

)

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

string

$value

Full path of file to change

Exceptions

Zend_Filter_Exception

Returns

string The new filename which has been set, or false when there were errors

Implements Zend_Filter_Interface.

Definition at line 184 of file Rename.php.

    {
        $file   = $this->getNewName($value, true);
        if (is_string($file)) {
            return $file;
        }

        $result = rename($file['source'], $file['target']);

        if ($result === true) {
            return $file['target'];
        }

        #require_once 'Zend/Filter/Exception.php';
        throw new Zend_Filter_Exception(sprintf("File '%s' could not be renamed. An error occured while processing the file.", $value));
    }

getFile()

getFile

(

)

Returns the files to rename and their new name and location

Returns

array

Definition at line 85 of file Rename.php.

    {
        return $this->_files;
    }

getNewName()

getNewName	(		$value,
			$source = false
	)

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

Parameters

string	$value	Full path of file to change
boolean	$source	Return internal informations

Returns

string The new filename which has been set

Definition at line 142 of file Rename.php.

    {
        $file = $this->_getFileName($value);

        if (!is_array($file) || !array_key_exists('source', $file) || !array_key_exists('target', $file)) {
            return $value;
        }

        if ($file['source'] == $file['target']) {
            return $value;
        }

        if (!file_exists($file['source'])) {
            return $value;
        }

        if (($file['overwrite'] == true) && (file_exists($file['target']))) {
            unlink($file['target']);
        }

        if (file_exists($file['target'])) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception(sprintf("File '%s' could not be renamed. It already exists.", $value));
        }

        if ($source) {
            return $file;
        }

        return $file['target'];
    }

setFile()

setFile

(

$options

)

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

string | array

$options

Old file or directory to be rewritten

Returns

Zend_Filter_File_Rename

Definition at line 101 of file Rename.php.

    {
        $this->_files = array();
        $this->addFile($options);

        return $this;
    }

Field Documentation

$_files

$_files = array()

protected

Internal array of array(source, target, overwrite)

Definition at line 38 of file Rename.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Filter/File/Rename.php