README

Welcome to the Semantic MVC Framework! This project is a custom MVC framework using FastRoute for routing and is intended for internal use. It includes features like a View class for rendering HTML views and basic authentication.

Installation

To install the Semantic MVC Framework, use Composer:

composer create-project tsirosgeorge/semantic

How to Use

Configuration

After installation, rename the file .env.example to .env and add your configuration settings.
Rendering Views

To render data in your view pages, use the View::render method. For example:
```
View::render('login', $data, 'auth');
```

The first parameter is the view page name.
The second parameter is the data to pass to the view.
The third parameter is the layout to use.

Inside your view files, you can use placeholders like {{your_value}}. These placeholders will be replaced with the corresponding values from the data array you provide. Ensure that the placeholders match the keys in your data array.

Routing

When defining routes, use the following conventions:

API Routes: Prefix API routes with api/.
Page Routes: Do not use a prefix for regular page routes.
Group Routes: Use with prefix. See exmaple below.

Example

Here is an example of how routes are defined in public/index.php:

To add protected routes, simply include 'auth' as the last parameter in the route definition.

You can also use gropu routing with prefixes

router->group([], function ($router) {
    $router->addRoute('GET', '/', 'AuthController@showLoginForm');

    $router->group(['middleware' => 'auth'], function ($router) {
        $router->addRoute('GET', '/dashboard', 'DashboardController@index');
        $router->addRoute('GET', '/dashboard/members', 'DashboardController@members');
        $router->addRoute('GET', '/dashboard/b2binterest', 'DashboardController@b2binterest');
    });
});

// Group for API Routes
$router->group(['prefix' => '/api'], function ($router) {
    // Auth Routes
    $router->addRoute('GET', '/logout', 'AuthController@logout');
    $router->addRoute('POST', '/login', 'AuthController@login');
    $router->addRoute('POST', '/register', 'AuthController@register');
    $router->addRoute('GET', '/refresh-session', 'AuthController@refreshSession');

    $router->group(['middleware' => 'auth'], function ($router) {
        $router->addRoute('GET', '/dashboard/data', 'DashboardController@loadData');
        $router->addRoute('POST', '/b2binterest', 'api\B2BInterestController@create');
        $router->addRoute('PUT', '/b2binterest/{id}', 'api\B2BInterestController@update');
    });
});

In this example:

- Routes without the `api/` prefix are used for regular page requests.
- Routes with the `api/` prefix are designated for API requests.
- To protect a route, add `'auth'` as the third parameter. This indicates that the route requires authentication or add it on a group with name middleware as the example

License

This project is licensed under a MIT license agreement. The full terms of the license can be found in the LICENSE file.

Changelog

All notable changes to this project will be documented in the CHANGELOG.md file.

tsirosgeorge / semantic

Maintainers

Details