SupportPal Documentation

Plugin Development: Routes

Previous Section: Controllers


Routes allow you to create additional pages in the system that can only be accessed when the plugin is active. All of your routes must be placed in one or several PHP files in the Routes folder. You can register a route for any HTTP verb, the most common Router methods are get(), post(), put() and delete().

Contents

Web Route Files

Predefined Route Files

The following filenames have special meaning within the Routes folder and will inherit specific attributes:

Filename Attributes
frontend.php Authenticated routes for the frontend. Routes defined in this file will also be inaccessible when maintenance mode is enabled.
operator.php Authenticated operator panel routes. Routes defined in this file will be prefixed with your Settings > Admin Folder name.
settings.php / plugin.php / widget.php Authenticated operator panel routes. Routed defined in this file will be prefixed by /admin/plugin/name (see above Settings > Admin Folder) and also be affected by the plugin permission system.

Other Route Files

Files with names other than those listed in the above table do not inherit any attributes. You're free to create whatever routes you require, for example unauthenticated routes.

Defining Routes

A very simple route looks like this.

    $router->get('settings', [
        'as' => 'plugin.helloworld.settings',
        function () {
            return 'Hello World';
        }
    ]);

The first parameter of the method is the URI, and this is relative to the plugin URL in the operator panel. For example if your help desk is hosted at http://domain.com/support/ then the above route would correspond to http://domain.com/support/admin/plugin/helloworld/settings.

The second parameter is an array of attributes for the route, the 'as' key allows you to name the route which makes it easier to use in controllers and views. The name needs to be unique to not conflict with any other routes, and we recommend to start your routes with 'plugin.pluginname' to ensure this doesn't happen.

A closure was used in the above example for simplicity, allowing to define what should be shown on the route in this file, but we recommend to instead use the 'uses' key to define a controller action that is called when the route is matched. A controller action is simply a function in a controller file and this promotes keeping the code clean by ensuring all logic is placed in the controllers. Below are the example routes for the HelloWorld plugin that display the settings page and handle updating the settings, these call the getSettingsPage and updateSettings functions in the HelloWorld controller.

Routes/plugin.php
    <?php

    $router->get('settings', [
        'as'   => 'plugin.helloworld.settings',
        'uses' => 'App\Plugins\HelloWorld\Controllers\HelloWorld@getSettingsPage'
    ]);

    $router->post('settings', [
        'as'   => 'plugin.helloworld.settings.update',
        'uses' => 'App\Plugins\HelloWorld\Controllers\HelloWorld@updateSettings'
    ]);

More options and documentation on routing is available at the Laravel website.

API Route Files

Additional API routes can also be defined in your plugin, by defining an api.php routes file.

All of your API routes will be automatically protected by API authentication. To define a group of routes, a version must be specified as shown below:

Routes/api.php
    <?php

    $api->version('v1', [ ], function ($api) {

        $api->get('user/settings', [
            'as'   => 'api.user.settings',
            'uses' => '\App\Modules\User\Controllers\Api\SettingsController@index'
        ]);

   });

The format for individual routes within the version group is largely the same as those defined earlier, the only difference being $api->get() instead of $router->get(). More options and documentation on api routing is available here: https://github.com/dingo/api/wiki/Creating-API-Endpoints

Accessing Named Routes

Routes can be accessed via their defined name under the as attribute described above. For example, to redirect to the plugin hello world settings page, defined above, in a controller you would use:

    Redirect::route('plugin.helloworld.settings')

To link to the plugin Hello World settings page in a view, you would use:

    {{ route('plugin.helloworld.settings') }}

Next Section: Languages