account-route.php

<?php
/**
* @license MIT
* boutique-en-ligne (maxaboom)
* Copyright (c) 2023 Abraham Ukachi, Axel Vair, Morgane Marechal, Catherine Tranchand. The Maxaboom Project Contributors.
* All rights reserved.
*
* 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, sublicense, 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 copyright 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 FOR 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 OR OTHER DEALINGS IN THE
* SOFTWARE.
*
* @project boutique-en-ligne
* @name Account - Route
* @file account-route.php
* @author: Abraham Ukachi <abraham.ukachi@laplateforme.io>
* @contributors: Axel Vair <axel.vair@laplateforme.io>, Morgane Marechal <morgane.marechal@laplateforme.io>, Catherine Tranchand <catherine.tranchand@laplateforme.io>
* @version: 0.0.1
* 
* Usage:
*   1+|> //  
*    -|> 
*/


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


// declare the `routes` namespace
namespace Maxaboom\Routes;

// use maxaboom's `AccountController` class
use Maxaboom\Controllers\AccountController;





/**
 * ============================
 *  Account Routes
 * ============================
 */





/**
 * Route used to display the account related pages
 * 
 * @method GET
 * @url /account
 *
 * @param string $page - the page to display
 * @param string $view - the view to display
 *
 * @echo string $accountPage - the account page
 */
$router->map('GET', '/account/[a:page]?/[a:view]?', function(?string $page = null, ?string $view = null): void {

  // create an object of `AccountController` class
  $accountController = new AccountController();

  // show the correct page with a specific view (if any)
  $accountController->showPage($page, $view);

});






/**
 * Route used to logout the user from his/her account
 *
 * @method POST
 * @url /account/[a:action] - the action to perform 
 *
 * @echo json $response - the response
 */
$router->map('POST', '/account/[a:action]', function($action): void {

  // create an object of `AccountController` class
  $accountController = new AccountController();

  // handle the action
  switch ($action) {
    // in case the action is `logout`...
    case AccountController::ACTION_LOGOUT:
      // ...logout from the current user's account
      $accountController->logout();
      break;

    // in case the action is `delete`...
    case AccountController::ACTION_DELETE:
      // ...delete the current user's account
      $accountController->delete();
      break;
    default:
      // TODO: handle the default action
  }

  // get the controller's response
  $response = $accountController->getResponse();

  // send the response back as json
  echo json_encode($response);

});




// =========================
// ====== `PATH` routes ====
// =========================


/**
 * Route used to patch or update the user's theme preference
 *
 * @method PATCH
 */
$router->map('PATCH', '/account/theme/[a:themeId]', function(string $themeId) {

  // create an object of `AccountController` class
  $accountController = new AccountController();
  
  // update the theme with the `themeId`
  $accountController->updateTheme($themeId);

  // get the controller's response
  $response = $accountController->getResponse();

  // send the response back as json
  echo json_encode($response);
});




/**
 * Route used to patch or update the user's lang preference
 *
 * @method PATCH
 */
$router->map('PATCH', '/account/language/[a:languageId]', function(string $languageId) {

  // create an object of `AccountController` class
  $accountController = new AccountController();
  
  // update the theme with the `languageId`
  $accountController->updateLanguage($languageId);

  // get the controller's response
  $response = $accountController->getResponse();

  // send the response back as json
  echo json_encode($response);
});