Merge pull request #72 from skwi/format-on-replace

Provides ability to specify formats for `replaceFile` method in `ImageManagerTrait`

Author: skwi

Manager/Traits/ImageManagerTrait.php

@@ -129,10 +129,11 @@ public function removeFiles(BaseEntityWithFile $entity, $properties = array(), $
      * @param string             $sourceFilepath The image source folder
      * @param string|null        $destFilepath   The image destination folder
      * @param string             $operation      'copy' or 'rename'
+     * @param array              $formatList     Format to override, all if left null (recommended)
      *
      * @return array|null An array containing informations about the copied file
      */
-    public function replaceFile(BaseEntityWithFile $entity, $propertyName, $sourceFilepath, $destFilepath = null, $operation = self::OPERATION_COPY)
+    public function replaceFile(BaseEntityWithFile $entity, $propertyName, $sourceFilepath, $destFilepath = null, $operation = self::OPERATION_COPY, array $formatList = null)
     {
         if (!in_array($operation, array(self::OPERATION_COPY, self::OPERATION_RENAME))) {
             throw new \InvalidArgumentException(sprintf('$operation only accept "%s" or "%s" value', self::OPERATION_COPY, self::OPERATION_RENAME));
@@ -149,7 +150,11 @@ public function replaceFile(BaseEntityWithFile $entity, $propertyName, $sourceFi
                 $entity->$propertyFileNameSetter($this->buildDestination($entity, $propertyName, $sourceFilepath, null));
             }
 
-            foreach ($this->imageFormatChoices[$propertyName] as $format) {
+            if (null === $formatList) {
+                $formatList = $this->imageFormatChoices[$propertyName];    
+            }
+            
+            foreach ($formatList as $format) {
 
                 $oldDestPath = $this->transformPathWithFormat($oldDestPathPattern, $format);
                 if (is_file($oldDestPath)) {

Tests/Units/Manager/BaseEntityWithImageManager.php

@@ -308,6 +308,36 @@ public function testReplaceFile()
                     ->string($entity->getUserPhotoFilename())->isEqualTo($this->workspace.'/dest/replacement_{-imgformat-}.png')
                     ->boolean(file_exists($this->workspace.'/image.png'))->isFalse()
 
+            ->assert('BaseEntityWithImageManager::replaceFile for specific format')
+                ->given(
+                    touch($this->workspace.'/my-photo_original.png'),
+                    touch($this->workspace.'/my-photo_format1Definition.png'),
+                    touch($this->workspace.'/my-photo_format2Definition.png'),
+                    $entity = $this->createMockEntity(array(
+                        'userPhoto' => $this->createMockFileType(__DIR__.'/../../data/image.png'),
+                        'userPhotoFilename' => 'my-photo_{-imgformat-}.png',
+                    ),
+                    $entityManager = $this->createMockEntityManager())
+                )
+                ->if(
+                    $testedClass = $this->createTestedClassInstance(array(
+                        'bundle.web' => $this->workspace.'/',
+                        'bundle.root' => $this->workspace.'/',
+                        'userPhoto' => '/{-origin-}_{-imgformat-}.{-ext-}',
+                    ), $entityManager)
+                )
+                ->when($fileProperties = $testedClass->replaceFile($entity, 'userPhoto', __DIR__.'/../../data/image.png', null, Manager\BaseEntityWithImageManager::OPERATION_COPY, ['format1Definition']))
+                ->then
+                    ->array($fileProperties)
+                        ->hasKeys(array('extension', 'original', 'size', 'mime'))
+                        ->string['extension']->isEqualTo('png')
+                        ->string['original']->isEqualTo('image.png')
+                        ->integer['size']->isGreaterThan(0)
+                    ->string($entity->getUserPhotoFilename())->isEqualTo('/image_{-imgformat-}.png')
+                    ->boolean(file_exists($this->workspace.'/image_original.png'))->isTrue()
+                    ->boolean(file_exists($this->workspace.'/image_format1Definition.png'))->isTrue()
+                    ->boolean(file_exists($this->workspace.'/image_format2Definition.png'))->isTrue()
+
             ->assert('BaseEntityWithImageManager::replaceFile with invalid file')
                 ->if(
                     $testedClass = $this->createTestedClassInstance(array(