Zend でこれを行うのは、いくつかの理由で困難です。
- ファイルがアップロード先に移動された後にファイルの名前を変更すると、書き換えたくないファイルが上書きされた可能性があります。
たとえば、/path/to/my/pics という宛先ディレクトリがあるとします。2 人のユーザーが同時に「me.png」という名前の画像をアップロードすると、お互いを上書きする可能性があります。これは、ファイルが /path/to/my/pics に移動された後に名前変更フィルターが適用されるためです。したがって、新しいファイルのアップロードによって上書きされる前に名前が変更されない場合があります。
- Zend の名前変更フィルターを使用すると、元のファイル拡張子を保持できません。
私が行った方法は次のとおりです。 1. http 転送アダプターを拡張して、名前変更フィルターに元のファイル名を渡します。通常の http 転送アダプターは、一時的な名前を tmp ディレクトリに渡し、ファイル拡張子はありません。
- 名前変更フィルターを拡張して、元のファイル拡張子を保持するかどうかを指定できるようにします。
その後、使用しているフォームにプレフィックスを追加して、フォームがアダプターを見つけられるようにし、作成した新しい名前変更フィルターをアダプターが見つけられるようにする必要があります。
このようにした理由は、宛先ディレクトリにユーザーごとに 1 つの写真があり、各写真の名前が「user1.jpg」または「user2.png」であるためです。保持したいディレクトリ内の他のファイルを上書きしないように、ファイルを移動すると同時にファイルの名前を変更したかったのです。
これが私が使用したコードです。
class My_File_Transfer_Adapter_Http
extends Zend_File_Transfer_Adapter_Http
{
/**
* Receive the file from the client (Upload)
* This differs from the Zend adapter in that
* the adapter passes in the files actual
* name to the rename filter so that when
* it is renamed, the renamer can use the extension
* of the file and keep it or change it.
*
* @param string|array $files (Optional) Files to receive
* @return bool
*/
public function receive($files = null)
{
if (!$this->isValid($files)) {
return false;
}
$check = $this->_getFiles($files);
foreach ($check as $file => $content) {
if (!$content['received']) {
$directory = '';
$destination = $this->getDestination($file);
if ($destination !== null) {
$directory = $destination . DIRECTORY_SEPARATOR;
}
/******************************************/
// The original transfer adapter
// passes content['tmp_name']
// but we'll pass in content['name'] instead
// to have access to the extension
/******************************************/
$filename = $directory . $content['name'];
$rename = $this->getFilter('File_Rename');
if ($rename !== null) {
$tmp = $rename->getNewName($content['name']);
if ($tmp != $content['name']) {
$filename = $tmp;
}
if (dirname($filename) == '.') {
$filename = $directory . $filename;
}
$key = array_search(get_class($rename), $this->_files[$file]['filters']);
unset($this->_files[$file]['filters'][$key]);
}
// Should never return false when it's tested by the upload validator
if (!move_uploaded_file($content['tmp_name'], $filename)) {
if ($content['options']['ignoreNoFile']) {
$this->_files[$file]['received'] = true;
$this->_files[$file]['filtered'] = true;
continue;
}
$this->_files[$file]['received'] = false;
return false;
}
if ($rename !== null) {
$this->_files[$file]['destination'] = dirname($filename);
$this->_files[$file]['name'] = basename($filename);
}
$this->_files[$file]['tmp_name'] = $filename;
$this->_files[$file]['received'] = true;
}
if (!$content['filtered']) {
if (!$this->_filter($file)) {
$this->_files[$file]['filtered'] = false;
return false;
}
$this->_files[$file]['filtered'] = true;
}
}
return true;
}
}
それがアダプターで、今度はフィルターです。
class My_Filter_File_Rename
extends Zend_Filter_File_Rename
{
/**
* Internal array of array(source, target, overwrite)
*/
protected $_files = array( );
/**
* 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 ?
* 'keepExtension' => Should the files original extension be kept
*
* @param string|array $options Target file or directory to be renamed
* @param string $target Source filename or directory (deprecated)
* @param bool $overwrite Should existing files be overwritten (deprecated)
* @return void
*/
public function __construct( $options )
{
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 setFile( $options );
}
/**
* Returns the files to rename and their new name and location
*
* @return array
*/
public function getFile()
{
return $this->_files;
}
/**
* 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 ?
* 'keepExtension' => Should the files original extension be kept
*
* @param string|array $options Old file or directory to be rewritten
* @return Zend_Filter_File_Rename
*/
public function setFile( $options )
{
$this->_files = array( );
$this->addFile( $options );
return $this;
}
/**
* 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 ?
* 'keepExtension' => Should the files original extension be kept
*
* @param string|array $options Old file or directory to be rewritten
* @return Zend_Filter_File_Rename
*/
public function addFile( $options )
{
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;
}
/**
* Returns only the new filename without moving it
* But existing files will be erased when the overwrite option is true
*
* @param string $value Full path of file to change
* @param boolean $source Return internal informations
* @return string The new filename which has been set
*/
public function getNewName( $value,
$source = false )
{
$file = $this->_getFileName( $value );
if( $file[ 'source' ] == $file[ 'target' ] )
{
return $value;
}
if( !file_exists( $file[ 'source' ] ) && !$file['keepExtension'] )
{
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' ];
}
/**
* Defined by Zend_Filter_Interface
*
* Renames the file $value to the new name set before
* Returns the file $value, removing all but digit characters
*
* @param string $value Full path of file to change
* @throws Zend_Filter_Exception
* @return string The new filename which has been set, or false when there were errors
*/
public function filter( $value )
{
$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 ) );
}
/**
* Internal method for creating the file array
* Supports single and nested arrays
*
* @param array $options
* @return array
*/
protected function _convertOptions( $options )
{
$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;
case 'keepExtension':
$files[ 'keepExtension' ] = ( 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;
}
if( empty( $files[ 'keepExtension' ] ) )
{
$files[ 'keepExtension' ] = true;
}
$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;
}
/**
* Internal method to resolve the requested source
* and return all other related parameters
*
* @param string $file Filename to get the informations for
* @return array
*/
protected function _getFileName( $file )
{
$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;
}
if( !is_dir( $rename['target'] ) || $rename[ 'keepExtension' ] )
{
$name = basename( $rename[ 'source' ] );
$parts = explode( '.', $name );
$extension = $parts[count( $parts ) - 1];
$rename[ 'target' ] .= '.' . $extension;
}
return $rename;
}
}
次に、ファイルをアップロードするために作成したファイル要素にプレフィックス パスを追加する必要があります。
$fileElement->addPrefixPath('My_File_Transfer_Adapter', 'My/File/Transfer/Adapter', Zend_Form_Element_File::TRANSFER_ADAPTER );
$fileElement->addPrefixPath( 'My_Filter', 'My/Filter', Zend_Form_Element_File::FILTER );
フィルターをファイル要素に追加するときは、次の方法で行う必要があります
$fileElement->addFilter(
'File_Rename',
array(
'target' => $this->_getPictureDestination() . DIRECTORY_SEPARATOR . "user$userId",
'overwrite' => true,
'keepExtension' => true
)
)
ここで、ファイルが新しいディレクトリに移動されると、元のファイル拡張子が付けられ、ファイル要素にフィルターを追加したときに指定した新しい名前が付けられます。
これがわかりにくかったら教えてください。これを行うためにZendで何が起こっているのかを理解するのにしばらく時間がかかりました.