Add support for custom template functions

nepada · Jan 5, 2020 · a16f27b · a16f27b
1 parent 7fbfb95
commit a16f27b
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -65,6 +65,16 @@ templateFactory:
         containerParam: %param%
 ```
 
+### Custom template functions
+
+Similarly to filters, you can also define callbacks for your custom template functions:
+
+```yaml
+templateFactory:
+    functions:
+        doStuff: [@someService, doStuff]
+```
+
 ### Configuration from another `CompilerExtension`
 
 Some extensions may need to install a Latte filter, or inject a parameter / service into template. This can be done in `beforeCompile()` phase by customizing setup of `TemplateConfigurator`.
@@ -73,6 +83,7 @@ Some extensions may need to install a Latte filter, or inject a parameter / serv
 $templateConfigurator = $containerBuilder->getByType(Nepada\TemplateFactory\TemplateConfigurator::class);
 $containerBuilder->getDefinition($templateConfigurator)
     ->addSetup('addFilter', ['filterName', $callback])
+    ->addSetup('addFunction', ['functionName', $callback])
     ->addSetup('addProvider', ['provider', $value])
     ->addSetup('addParameter', ['parameter', $value])
     ->addSetup('addParameter', ['parameter', '@someService']);

diff --git a/src/Bridges/TemplateFactoryDI/TemplateFactoryExtension.php b/src/Bridges/TemplateFactoryDI/TemplateFactoryExtension.php
@@ -15,6 +15,7 @@ public function getConfigSchema(): Nette\Schema\Schema
             'parameters' => Nette\Schema\Expect::array(),
             'providers' => Nette\Schema\Expect::array(),
             'filters' => Nette\Schema\Expect::array()->items('callable'),
+            'functions' => Nette\Schema\Expect::array()->items('callable'),
         ]);
     }
 
@@ -54,6 +55,10 @@ public function beforeCompile(): void
         foreach ($config->filters as $name => $filter) {
             $templateConfigurator->addSetup('addFilter', [$name, $filter]);
         }
+
+        foreach ($config->functions as $name => $function) {
+            $templateConfigurator->addSetup('addFunction', [$name, $function]);
+        }
     }
 
 }
diff --git a/src/TemplateFactory/TemplateConfigurator.php b/src/TemplateFactory/TemplateConfigurator.php
@@ -19,6 +19,9 @@ class TemplateConfigurator
     /** @var callable[] */
     private array $filters = [];
 
+    /** @var callable[] */
+    private array $functions = [];
+
     private ?Nette\Localization\ITranslator $translator = null;
 
     /**
@@ -64,6 +67,17 @@ public function addFilter(string $name, callable $filter): self
         return $this;
     }
 
+    /**
+     * @param string $name
+     * @param callable $function
+     * @return static
+     */
+    public function addFunction(string $name, callable $function): self
+    {
+        $this->functions[$name] = $function;
+        return $this;
+    }
+
     public function configure(Nette\Application\UI\ITemplate $template): void
     {
         if (! $template instanceof Nette\Bridges\ApplicationLatte\Template) {
@@ -84,6 +98,10 @@ public function configure(Nette\Application\UI\ITemplate $template): void
             $template->addFilter($name, $filter);
         }
 
+        foreach ($this->functions as $name => $function) {
+            $latte->addFunction($name, $function);
+        }
+
         $template->setParameters($this->parameters);
     }
 

diff --git a/tests/Bridges/TemplateFactoryDI/Fixtures/config.neon b/tests/Bridges/TemplateFactoryDI/Fixtures/config.neon
@@ -4,6 +4,8 @@ extensions:
 templateFactory:
     filters:
         lower: NepadaTests\Bridges\TemplateFactoryDI\Fixtures\Filters::lower
+    functions:
+        lower: Nette\Utils\Strings::lower
     providers:
         fooProvider: bar
     parameters:
@@ -17,6 +19,7 @@ services:
     templateFactory.templateConfigurator:
         setup:
             - addFilter(upper, NepadaTests\Bridges\TemplateFactoryDI\Fixtures\Filters::upper)
+            - addFunction(upper, Nette\Utils\Strings::upper)
             - addProvider(applicationProvider, @application.application)
             - addParameter(application, @application.application)
 

diff --git a/tests/Bridges/TemplateFactoryDI/TemplateFactoryExtensionTest.phpt b/tests/Bridges/TemplateFactoryDI/TemplateFactoryExtensionTest.phpt
@@ -49,6 +49,9 @@ class TemplateFactoryExtensionTest extends TestCase
 
         // translator
         Assert::same(MockTranslatorFactory::TRANSLATED_MESSAGE, $latte->invokeFilter('translate', ['message']));
+
+        // functions
+        Assert::same('LOREM ipsum', $template->renderToString('{=upper(Lorem)} {=lower(Ipsum)}'));
     }
 
     protected function setUp(): void