Table of Contents
On this page

Create Service

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

dot-maker will look for a matching Repository in the module (e.g.: BookRepository — BookService). If it finds one, it will automatically inject it into the Service. Also, some common methods will be added to the Service and the ServiceInterface.

Run the command

To create a Service, use either of the following commands:

composer make service

OR

./vendor/bin/dot-maker service

Identify the target module

dot-maker needs to know in which module you want to create the new Service. 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 Service

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

Service name:

The name must contain only letters and numbers.

You don't have to append "Service" 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 Service name: "."

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

Class "ExistingService" already exists at /path/to/project/src/ExistingModule/src/Service/ExistingService.php

If you input a valid name (like, "NewService"), dot-maker will create the Service and output a success message:

Created Service: /path/to/project/src/ExistingModule/src/Service/NewService.php Created ServiceInterface: /path/to/project/src/ExistingModule/src/Service/NewServiceInterface.php

Create multiple Services

To allow the creation of multiple Services, the process will loop until you leave the name blank. Each iteration creates a new pair of Service and ServiceInterface under the same module.