Table of Contents
On this page

Create InputFilter

This page assumes that you have created a Composer "make" script as described on the Setup page.

To create an InputFilter, use either of the following commands:

Run the command

composer make input-filter

OR

./vendor/bin/dot-maker input-filter

Identify the target module

dot-maker needs to know in which module you want to create the new InputFilter. To determine this, it will prompt you to enter the name of an existing module:

Existing module name:

If you input a module name which does not exist (like, "NonExistentModule"), an error will be thrown:

Module "NonExistentModule" not found

and will keep prompting for a valid module name until you provide one.

Once an existing module name (like, "ExistingModule") is provided, dot-maker will output a success message:

Found Module "ExistingModule"

Name the InputFilter

Once the target module has been identified, you will be prompted to input a name for the InputFilter:

InputFilter name:

The name must contain only letters and numbers.

You don't have to append "InputFilter" to the name. It is automatically appended when necessary. See our Naming Standards page for more information.

If you leave the name blank, the process will exit.

If you input an invalid name (like, "."), an error will be thrown:

Invalid InputFilter name: "."

If you input the name of an existing InputFilter (like, "ExistingInputFilter"), an error will be thrown:

Class "ExistingInputFilter" already exists at /path/to/project/src/ExistingModule/src/InputFilter/ExistingInputFilter.php

Once you input a valid name (like, "Book"), dot-maker will prompt you to confirm which CRUD operations will be performed on the resource:

Create resources

The prompt asks you whether you want to create resources:

Allow creating Resources? [Y(es)/n(o)]:

On confirmation, the process will create the following file:

  • src/ExistingModule/src/InputFilter/CreateBookInputFilter.php

Without confirmation, the process will skip to the next component.

Delete resources

The prompt asks you whether you want to delete resources:

Allow deleting Resources? [Y(es)/n(o)]:

On confirmation, the process will create the following file:

  • src/ExistingModule/src/InputFilter/DeleteBookInputFilter.php

Without confirmation, the process will skip to the next component.

Edit resources

The prompt asks you whether you want to edit resources:

Allow editing Resources? [Y(es)/n(o)]:

On confirmation, the process will create the following file:

  • src/ExistingModule/src/InputFilter/EditBookInputFilter.php

Without confirmation, the process will skip to the next component.

Replace resources

This file is created only when the project type is API.

The prompt asks you whether you want to replace resources:

Allow replacing Resources? [Y(es)/n(o)]:

On confirmation, the process will create the following file:

  • src/ExistingModule/src/InputFilter/ReplaceBookInputFilter.php

Without confirmation, the process will skip to the next component.

Create multiple InputFilters

To allow the creation of multiple InputFilters, the process will loop until you leave the name blank. Each iteration creates a new set of InputFilters under the same module.