From d428d849fbe4846ae54cd09355a5a6c92f940dc5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Frank=20Br=C3=BCckner?= Date: Fri, 4 Nov 2022 13:45:17 +0100 Subject: [PATCH 1/3] Adds cookbook recipe for using input filters in forms MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Frank Brückner --- docs/book/cookbook/input-filter-in-forms.md | 143 ++++++++++++++++++++ mkdocs.yml | 2 + 2 files changed, 145 insertions(+) create mode 100644 docs/book/cookbook/input-filter-in-forms.md diff --git a/docs/book/cookbook/input-filter-in-forms.md b/docs/book/cookbook/input-filter-in-forms.md new file mode 100644 index 00000000..3df880c9 --- /dev/null +++ b/docs/book/cookbook/input-filter-in-forms.md @@ -0,0 +1,143 @@ +# Using Input Filters in Forms of laminas-form + +The following examples shows _two_ potential use cases of laminas-inputfilter within forms of [laminas-form](https://docs.laminas.dev/laminas-form/). + +## Define the Input Filter in a Form + +An input filter can be [defined directly in a form class](https://docs.laminas.dev/laminas-form/v3/quick-start/#hinting-to-the-input-filter) itself, using `Laminas\InputFilter\InputFilterProviderInterface`. +This interface provides one method (`getInputFilterSpecification()`) that is used by a form of laminas-form to create an input filter. + +[Create a form as separate class](https://docs.laminas.dev/laminas-form/v3/quick-start/#factory-backed-form-extension) using the [`init` method](https://docs.laminas.dev/laminas-form/v3/advanced/#initialization), implement the interface `Laminas\InputFilter\InputFilterProviderInterface` and define the inputs via configuration array, e.g. `module/Album/src/Form/AlbumForm.php`: + + +

+namespace Album\Form;
+
+use Laminas\Filter\StringTrim;
+use Laminas\Filter\StripTags;
+use Laminas\Form\Element\Text;
+use Laminas\Form\Form;
+use Laminas\InputFilter\InputFilterProviderInterface;
+use Laminas\Validator\StringLength;
+
+final class AlbumForm extends Form implements InputFilterProviderInterface
+{
+    public function init(): void
+    {
+        // Add form elements
+        $this->add([
+            'name'    => 'title',
+            'type'    => Text::class,
+            'options' => [
+                'label' => 'Title',
+            ],
+        ]);
+
+        // …
+    }
+
+    public function getInputFilterSpecification(): array
+    {
+        return [
+            // Add inputs
+            [
+                'name'    => 'title',
+                'filters' => [
+                    ['name' => StripTags::class],
+                    ['name' => StringTrim::class],
+                ],
+                'validators' => [
+                    [
+                        'name'    => StringLength::class,
+                        'options' => [
+                            'min' => 1,
+                            'max' => 100,
+                        ],
+                    ],
+                ],
+            ],
+            // …
+        ];
+    }
+}
+
+ + +## Adding an Input Filter Defined as a Separate Class to a Form + +### Create Input Filter + +[Create an input filter as separate class](../intro.md), e.g. `module/Album/src/InputFilter/AlbumInputFilter.php`: + +```php +namespace Album\InputFilter; + +use Laminas\Filter\StringTrim; +use Laminas\Filter\StripTags; +use Laminas\Validator\StringLength; +use Laminas\InputFilter\InputFilter; + +final class AlbumInputFilter extends InputFilter +{ + public function init(): void + { + // Add inputs + $this->add( + [ + 'name' => 'title', + 'filters' => [ + ['name' => StripTags::class], + ['name' => StringTrim::class], + ], + 'validators' => [ + [ + 'name' => StringLength::class, + 'options' => [ + 'min' => 1, + 'max' => 100, + ], + ], + ], + ] + ); + + // … + } +} +``` + +### Create Form and Add Input Filter + +An input filter can be added directly in a form class itself, using the class name of the input filter or whatever name the input filter is registered under. + +Create a form as separate class using the `init` method and set the input filter via the `setInputFilterByName()` method of `Laminas\Form\Form`, e.g. `module/Album/src/Form/AlbumForm.php`: + + +

+namespace Album\Form;
+
+use Album\InputFilter\AlbumInputFilter;
+use Laminas\Form\Element\Text;
+use Laminas\Form\Form;
+
+final class AlbumForm extends Form
+{
+    public function init(): void
+    {
+        // Set the input filter
+        $this->setInputFilterByName(AlbumInputFilter::class);
+
+        // Add form elements
+        $this->add([
+            'name'    => 'title',
+            'type'    => Text::class,
+            'options' => [
+                'label' => 'Title',
+            ],
+        ]);
+
+        // …
+    }
+}
+
+ diff --git a/mkdocs.yml b/mkdocs.yml index 5d49b8ff..caed9e7a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -12,6 +12,8 @@ nav: - "Application Integration": - "Usage in a laminas-mvc application": application-integration/usage-in-a-laminas-mvc-application.md - "Usage in a mezzio application": application-integration/usage-in-a-mezzio-application.md + - Cookbook: + - "Using Input Filters in Forms of laminas-form": cookbook/input-filter-in-forms.md site_name: laminas-inputfilter site_description: 'Normalize and validate input sets from the web, APIs, the CLI, and more, including files.' repo_url: 'https://github.com/laminas/laminas-inputfilter' From b68bf216f51614956e8cbe77672bd8baf9b7b683 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Frank=20Br=C3=BCckner?= Date: Wed, 14 Dec 2022 08:36:52 +0100 Subject: [PATCH 2/3] Updates texts in terms of wording and spelling MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Frank Brückner --- docs/book/cookbook/input-filter-in-forms.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/book/cookbook/input-filter-in-forms.md b/docs/book/cookbook/input-filter-in-forms.md index 3df880c9..26223ce3 100644 --- a/docs/book/cookbook/input-filter-in-forms.md +++ b/docs/book/cookbook/input-filter-in-forms.md @@ -1,13 +1,13 @@ # Using Input Filters in Forms of laminas-form -The following examples shows _two_ potential use cases of laminas-inputfilter within forms of [laminas-form](https://docs.laminas.dev/laminas-form/). +The following examples shows _two_ potential use cases of laminas-inputfilter within [laminas-form](https://docs.laminas.dev/laminas-form/). ## Define the Input Filter in a Form An input filter can be [defined directly in a form class](https://docs.laminas.dev/laminas-form/v3/quick-start/#hinting-to-the-input-filter) itself, using `Laminas\InputFilter\InputFilterProviderInterface`. -This interface provides one method (`getInputFilterSpecification()`) that is used by a form of laminas-form to create an input filter. +This interface provides one method (`getInputFilterSpecification()`) that is used by a form to create an input filter. -[Create a form as separate class](https://docs.laminas.dev/laminas-form/v3/quick-start/#factory-backed-form-extension) using the [`init` method](https://docs.laminas.dev/laminas-form/v3/advanced/#initialization), implement the interface `Laminas\InputFilter\InputFilterProviderInterface` and define the inputs via configuration array, e.g. `module/Album/src/Form/AlbumForm.php`: +[Create a form as a separate class](https://docs.laminas.dev/laminas-form/v3/quick-start/#factory-backed-form-extension), define the [`init` method](https://docs.laminas.dev/laminas-form/v3/advanced/#initialization), implement the interface `Laminas\InputFilter\InputFilterProviderInterface`, and define its inputs via a configuration array; as an example, consider the following definition in a file found at `module/Album/src/Form/AlbumForm.php`: 

@@ -67,7 +67,7 @@ final class AlbumForm extends Form implements InputFilterProviderInterface
 
 ### Create Input Filter
 
-[Create an input filter as separate class](../intro.md), e.g. `module/Album/src/InputFilter/AlbumInputFilter.php`:
+[Create an input filter as a separate class](../intro.md), e.g. `module/Album/src/InputFilter/AlbumInputFilter.php`:
 
 ```php
 namespace Album\InputFilter;
@@ -110,7 +110,7 @@ final class AlbumInputFilter extends InputFilter
 
 An input filter can be added directly in a form class itself, using the class name of the input filter or whatever name the input filter is registered under.
 
-Create a form as separate class using the `init` method and set the input filter via the `setInputFilterByName()` method of `Laminas\Form\Form`, e.g. `module/Album/src/Form/AlbumForm.php`:
+Create a form as a separate class, define its `init` method, and set the input filter via the `setInputFilterByName()` method of `Laminas\Form\Form`, e.g. `module/Album/src/Form/AlbumForm.php`:
 
 
 


From 9b80efd9f7ae24e5878b7b1548a4b51739b29e57 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Frank=20Br=C3=BCckner?= 
Date: Wed, 5 Apr 2023 10:38:21 +0200
Subject: [PATCH 3/3] Updates texts in terms of spelling mistakes
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Frank Brückner 
---
 docs/book/cookbook/input-filter-in-forms.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/book/cookbook/input-filter-in-forms.md b/docs/book/cookbook/input-filter-in-forms.md
index 26223ce3..8f3fbb09 100644
--- a/docs/book/cookbook/input-filter-in-forms.md
+++ b/docs/book/cookbook/input-filter-in-forms.md
@@ -1,6 +1,6 @@
 # Using Input Filters in Forms of laminas-form
 
-The following examples shows _two_ potential use cases of laminas-inputfilter within [laminas-form](https://docs.laminas.dev/laminas-form/).
+The following examples show _two_ potential use cases of laminas-inputfilter within [laminas-form](https://docs.laminas.dev/laminas-form/).
 
 ## Define the Input Filter in a Form