index.php

<?php
/**
 * @license MIT 
 * super-week
 *
 * Copyright (c) 2023 Abraham Ukachi
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy 
 * of this software and associated documentation files (the "Software"), to deal 
 * in the Software without restriction, including without limitation the rights 
 * to use, copy, modify, merge, publish, distribute, sub-license, and/or sell 
 * copies of the Software, and to permit persons to whom the Software is 
 * furnished to do so, subject to the following conditions:
 *
 * The above copy-right notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS, OR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OF OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 * @project super-week 
 * @name Router - Super Week
 * @file index.php
 * @author: Abraham Ukachi <abraham.ukachi@laplateforme.io>
 * @version: 0.0.1
 * 
 * Usage:
 *  1+|> // how-to route  
 *   -|>
 *
 */



/*
* !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
* MOTTO: We'll always do more 😜!!!
* !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
*/


// ---===--- enabling error reporting ---====---
error_reporting(E_ALL);
ini_set("display_errors", 1);
// ---===---===---===---===---===---===---===---

// start the session
session_start();


// require the autoloader
require __DIR__ . '/vendor/autoload.php';


// instantiate the `AltoRouter` class with an object named `router`
$router = new AltoRouter();



// using controllers
use App\Controller\HomeController; // <- use the `HomeController`
use App\Controller\UserController; // <- use the `UserController`
use App\Controller\AuthController; // <- use the `AuthController`
use App\Controller\RegisterController; // <- use the `RegisterController`
use App\Controller\LoginController; // <- use the `LoginController`
use App\Controller\LogoutController; // <- use the `LogoutController`
use App\Controller\BookController; // <- use the `BookController`





// Define some constant variables
const APP_NAME = 'super-week';
const BASE_DIR = '/' . APP_NAME;

// set the base path of our `router` using `BASE_DIR`
$router->setBasePath(BASE_DIR);











// #########################
// ####   GET - Routes  ####
// #########################


/**
 * Route that displays the home page
 *
 * @example http://localhost/super-week/
 *
 * @method GET
 * @route '/'
 *
 */
$router->map('GET', '/[home:page]?', function(?string $page = null) {
  if ($page === 'home') {
    // redirect to the home page
      header('Location: ' . BASE_DIR);
      exit();
  }

  // Instantiate the `HomeController`
  $homeController = new HomeController();

  // Call the `showPage()` method
  $homeController->showPage();

});




/**
 * Route that displays a the users page
 *
 * @example http://localhost/super-week/users
 *
 * @method GET
 * @route '/users'
 *
 */
$router->map('GET', '/users', function() {
  // Instantiate the `UserController`
  $userController = new UserController();
  // get all users as `users`
  $users = $userController->getAll();
  
  // Check if there's a header with the name 'Response-Type',
  // and assign its value to a variable named `responseType`
  $responseType = $_SERVER['HTTP_RESPONSE_TYPE'] ?? null;

  // If the `responseType` is `raw/json`...
  if ($responseType === 'raw/json') {
    // ...get the `response` from `userController`
    $response = $userController->getResponse();

    // echo the `response` in a `json` format
    echo json_encode($response, JSON_PRETTY_PRINT);

    return; // <- stop the code execution here ;)
  }

  // At this point, the `responseType` is not `raw/json`,
  // so we'll just show the list page, as per project requirement
  $userController->showListPage($users);

});




/**
 * Route that displays a register form,
 * and allows a user to get registered
 *
 * @example http://localhost/super-week/register
 *
 * @method GET
 * @route '/register'
 */
$router->map('GET', '/register', function() {
  
  // Instantiate the `RegisterController`
  $registerController = new RegisterController();

  // show the register page
  $registerController->showPage();

});



/**
 * Route that displays a login form,
 * and allows a user to get logged in
 *
 * @example http://localhost/super-week/login
 *
 * @method GET
 * @route '/login'
 */
$router->map('GET', '/login', function() {

  // Instantiate the `LoginController`
  $loginController = new LoginController();

  // show the login page
  $loginController->showPage();

});



/**
 * Route that displays the logout page,
 * and logs a user out
 *
 * @example http://localhost/super-week/logout
 *
 * @method GET
 * @route '/logout'
 */
$router->map('GET', '/logout', function() {

  // Instantiate the `LogoutController`
  $logoutController = new LogoutController();

  // show the logout page
  $logoutController->showPage();

  // log the user out
  $logoutController->logoutUser();

});






/**
 * Route that displays a specific user's page
 *
 * @example http://localhost/super-week/users/3
 *
 * @method GET
 * @route '/users/[i:userId]'
 *
 */
$router->map('GET', '/users/[i:userId]', function($userId) {
  // Instantiate the `UserController`
  $userController = new UserController();
  // get the user's info
  $userInfo = $userController->get($userId);


  // Check if there's a header with the name 'Response-Type',
  // and assign its value to a variable named `responseType`
  $responseType = $_SERVER['HTTP_RESPONSE_TYPE'] ?? null;

  // If the `responseType` is `raw/json`...
  if ($responseType === 'raw/json') {
    // ...get the `response` from `userController`
    $response = $userController->getResponse();

    // echo the `response` in a `json` format
    echo json_encode($response, JSON_PRETTY_PRINT);

    return; // <- stop the code execution here ;)
  }

  // At this point, the `responseType` is not `raw/json`,
  // so we'll just show the specific user's page, as per project requirement
  // TODO: Use the `userInfo` instead of the `userId`
  $userController->showPage($userId);

});



$router->map('GET', '/books', function() {
  // Instantiate the `BookController`
  $bookController = new BookController();
  // get all books as `books`
  $books = $bookController->getAll();
  
  // Check if there's a header with the name 'Response-Type',
  // and assign its value to a variable named `responseType`
  $responseType = $_SERVER['HTTP_RESPONSE_TYPE'] ?? null;

  // If the `responseType` is `raw/json`...
  if ($responseType === 'raw/json') {
    // ...get the `response` from `bookController`
    $response = $bookController->getResponse();

    // echo the `response` in a `json` format
    echo json_encode($response, JSON_PRETTY_PRINT);

    return; // <- stop the code execution here ;)
  }

  // At this point, the `responseType` is not `raw/json`,
  // so we'll just show the list page, as per project requirement
  $bookController->showListPage($books);

});



/**
 * Route that displays the create or write page for a book.
 *
 * @example http://localhost/super-week/books/write
 *
 * @method GET
 * @route '/books/write'
 */
$router->map('GET', '/books/write', function() {
  // Instantiate the `BookController`
  $bookController = new BookController();

  // show the create page
  $bookController->showCreatePage();

});



/**
 * Route that displays a specific book's page
 *
 * @example http://localhost/super-week/books/3
 *
 * @method GET
 * @route '/books/[i:bookId]'
 *
 */
$router->map('GET', '/books/[i:bookId]', function($bookId) {
  // Instantiate the `BookController`
  $bookController = new BookController();

  // get the book's info
  $bookInfo = $bookController->get($bookId);


  // Check if there's a header with the name 'Response-Type',
  // and assign its value to a variable named `responseType`
  $responseType = $_SERVER['HTTP_RESPONSE_TYPE'] ?? null;

  // If the `responseType` is `raw/json`...
  if ($responseType === 'raw/json') {
    // ...get the `response` from `bookController`
    $response = $bookController->getResponse();

    // echo the `response` in a `json` format
    echo json_encode($response, JSON_PRETTY_PRINT);

    return; // <- stop the code execution here ;)
  }

  // At this point, the `responseType` is not `raw/json`,
  // so we'll just show the list page, as per project requirement

  
  // show the specific book's page 
  // TODO: Use the `bookInfo` instead of the `$bookId`
  $bookController->showPage($bookId);
});















// ##########################
// ####   POST - Routes  ####
// ##########################




/**
 * Route that allows a user to get registered
 *
 * @example fetch('register', {method: 'POST', body: form})
 *
 * @method POST
 * @route '/register'
 *
 */
$router->map('POST', '/register', function() {
  // Instantiate the `AuthController`
  $authController = new AuthController();
  
  // Call the `register()` method
  $authController->register();

  // Get the response after the `register()` method is called
  $response = $authController->getResponse();

  // echo the `response` in a JSON format
  echo json_encode($response);

});


/**
 * Route that allows a user to login 
 *
 * @example fetch('login', {method: 'POST', body: form})
 *
 * @method POST
 * @route '/login'
 *
 */
$router->map('POST', '/login', function() {
  // Instantiate the `AuthController`
  $authController = new AuthController();
  
  // Call the `login()` method
  $authController->login();

  // Get the response after the `login()` method is called
  $response = $authController->getResponse();

  // echo the `response` in a JSON format
  echo json_encode($response);

});



/**
 * Route that allows a user to write or create a book
 *
 * @example fetch('books/write', {method: 'POST', body: form})
 *
 * @method POST
 * @route '/books/write'
 */
$router->map('POST', '/books/write', function() {
  // Instantiate the `BookController`
  $bookController = new BookController();

  // Call the `write()` method
  $bookController->write();

  // Get the response after the `write()` method is called
  $response = $bookController->getResponse();

  // echo the `response` in a JSON format
  echo json_encode($response);

});






// ###########################
// ####   PATCH - Routes  ####
// ###########################







// #########################
// ####   PUT - Routes  ####
// #########################







// ############################
// ####   DELETE - Routes  ####
// ############################



// Match the router
$match = $router->match();


// Check if there's a match
if (is_array($match) && is_callable($match['target'])) {
  call_user_func_array($match['target'], $match['params']);

} else { // <- no route matched

  // show a 404 Error Page
  header($_SERVER["SERVER_PROTOCOL"] . ' 404 Not Found');
}