implement config option to disable mtime check

Author: GenieTim

Tests/DependencyInjection/BernhardWebstudioPlaceholderExtensionTest.php

@@ -78,6 +78,9 @@ public function testSqipConfig()
         $this->assertEquals($config['service'], 'bewe_placeholder.generator.sqip');
         $this->assertNotEmpty($config['iterations']);
         $this->assertEquals($config['iterations'], 13);
+        // test default
+        $this->assertNotEmpty($config['ignore_mtime']);
+        $this->assertEquals($config['ignore_mtime'], false);
     }
 
     /**
@@ -94,6 +97,8 @@ public function testPrimitiveConfig()
         $this->assertEquals($config['service'], 'bewe_placeholder.generator.primitive');
         $this->assertNotEmpty($config['iterations']);
         $this->assertEquals($config['iterations'], 13);
+        $this->assertNotEmpty($config['ignore_mtime']);
+        $this->assertEquals($config['ignore_mtime'], true);
     }
 
     /**

Tests/DependencyInjection/Fixtures/primitive-test.yml

@@ -1,4 +1,5 @@
 bewe_placeholder:
   bin: primitive
   service: bewe_placeholder.generator.primitive
-  iterations: 13
+  iterations: 13
+  ignore_mtime: true

src/Commands/PlaceholderPrepareCommand.php

@@ -25,7 +25,7 @@ protected function configure()
         // the name of the command (the part after "bin/console")
             ->setName('bewe:placeholder:prepare')
             ->addOption('dry')
-            ->addOption('ignore-exist')
+            ->addOption('ignore-mtime')
 
         // the short description shown while running "php bin/console list"
             ->setDescription('Creates placeholders for all the images.')
@@ -53,7 +53,8 @@ protected function execute(InputInterface $input, OutputInterface $output)
             $inputPath = $image->getRealPath();
             $outputPath = $this->provider->getOutputPath($inputPath);
             // only output if not already done in another session
-            if (!\file_exists($outputPath) || (!$input->getOption('ignore-exist') && filemtime($inputPath) > filemtime($outputPath))) {
+            // TODO: accept ignore_mtime in parameters too
+            if (!\file_exists($outputPath) || (!$input->getOption('ignore-mtime') && filemtime($inputPath) > filemtime($outputPath))) {
                 if (!$dry) {
                     // do output images
                     try {

src/DependencyInjection/BernhardWebstudioPlaceholderExtension.php

@@ -34,6 +34,10 @@ public function load(array $defaultConfigs, ContainerBuilder $container)
             $providerDefinition->replaceArgument(2, $output_path);
         }
 
+        if (\array_key_exists('ignore_mtime', $config)) {
+            $providerDefinition->replaceArgument(3, $config['ignore_mtime']);
+        }
+
         $service = $config['service'];
         $serviceDefinition = $container->getDefinition($config['service']);
 

src/DependencyInjection/Configuration.php

@@ -22,6 +22,7 @@ public function getConfigTreeBuilder()
             ->scalarNode('bin')->end()
             ->scalarNode('node_bin')->end()
             ->scalarNode('output_path')->end()
+            ->scalarNode('ignore_mtime')->end()
             ->end();
 
         return $treeBuilder;

src/Resources/config/services.yaml

@@ -23,7 +23,8 @@ services:
             - '@bewe_placeholder.generator'
             - ["."]
             - ~
-            # - '@logger'
+            - false
+            
     bewe_placeholder.generator.sqip:
         class: BernhardWebstudio\PlaceholderBundle\Service\SqipPlaceholderGenerator
         autowire: false
@@ -39,4 +40,4 @@ services:
         arguments:
           - 'primitive'
           - ~
-          - 10
+          - 10

src/Service/PlaceholderProviderService.php

@@ -13,6 +13,7 @@ class PlaceholderProviderService
     protected $generator;
     protected $loadPaths;
     protected $outputPath;
+    protected $ignoreMtime;
 
     /**
      * The modes how a placeholder can be fetched
@@ -25,11 +26,13 @@ class PlaceholderProviderService
     public function __construct(
         PlaceholderGeneratorInterface $generator,
         array $loadPaths = array(),
-        string $outputPath = null
+        string $outputPath = null,
+        $ignoreMtime = false
     ) {
         $this->generator = $generator;
         $this->loadPaths = $loadPaths;
         $this->outputPath = $outputPath;
+        $this->ignoreMtime = $ignoreMtime;
     }
 
     /**
@@ -49,7 +52,7 @@ public function getPlaceholder(string $inputfile, string $mode = '')
             return;
         }
         $outputfile = $this->getOutputPath($inputfile);
-        if (!\file_exists($outputfile) || filemtime($inputfile) > filemtime($outputfile)) {
+        if (!\file_exists($outputfile) || (!$this->ignoreMtime && filemtime($inputfile) > filemtime($outputfile))) {
             // the following line may throw exceptions. do they have to be catched?
             // if so: what to do with the error?
             $this->generator->generate($inputfile, $outputfile);