How to develop a Mautic plugin: MVC – Routes

Welcome to the lesson II of the series Develop a Mautic plugin. If you have not read the previous article I highly recommended you to do it (you can find it here).

Mautic is based on Symfony which is a MVC PHP framework. So, develop a module in Mautic means that you will work follow the MVC paradigm but with Mautic rules. So in the article we will give a brief description of MVC then the first big step for module development: configuration of routes and menus.

MVC stand for Model View Controller which is a software architecture pattern. MVC define three components:

And to give access to the user you need to define routes so ca have access to resources.

And to give access to the user you need to define routes.

In the next, we will configure routes (MVC paradigm) and menus (Mautic specification) to display routes to the user. And before we continue, we need to define one of the most important things: the key name of the module, which will be used in all our configurations.

Configurations

All configurations are done Config/config.php: routes, menus, service, categories, … We will only focus on the configurations for basic MVC module and to do that, we only need to add route and menu configurations. As define the previous article, our module name is HelloWord and the key name is helloword. Let us configure the routes for different actions and the menu to give access to our module to a user.

Routes

Mautic have three types of routes:

For a route you need to define some required parameters and some other optionals, depending on your needs.

There are other parameters which can be defined in the route, you can find a full documentation here.

Each of your routes must have a unique name, name which will be used to refer to this route in the other configurations or in your source code.

In this article, we will only focus on the main route.

Menu

Mautic have 4 types of menus:

Same like routes, menu has some parameters that you can set.

There are other parameters which can be defined in the menu, you can find a full documentation here.

In this article, we will only focus on the main menu.

Config file

This is what your file will look like.

 'HelloWord',
	'description' => 'Hello Word module',
	'version' => '1.0',
	'author' => 'Hachther Co.',

	'routes' => [
		'main' => [
			'mautic_helloword_index' => [
				'path' => '/helloword/{page}',
				'controller' => 'MauticHelloWordBundle:HelloWord:index',
				'method' => 'GET'
			],
			'mautic_helloword_action' => [
				'path' => '/helloword/{objectAction}/{objectId}',
				'controller' => 'MauticHelloWordBundle:HelloWord:execute',
			],
		]
	],
	'menu' => [
		'main' => [
			'mautic.helloword' => [
				'route'    => 'mautic_helloword_index',
				'parent'   => 'mautic.core.channels',
			]
		]
	],
];

As you can see, make a configuration file is just a matter of return a php array with a specific structure. We have routes ( with main routes within) and menu (with main menu within) and for each element you define a unique name and your configuration within.

This is the end of this article. Hope this was helpful and see you in the next article.

Previous article