Module Services and Admin Controllers

<?php
// config/services.php (PrestaShop 9.2 and later)
namespace Symfony\Component\DependencyInjection\Loader\Configurator;

return static function (ContainerConfigurator $container): void {
    if (version_compare(_PS_VERSION_, '9.2.0', '>=')) {
        $container->import('services/services-ps-9.2.php');

        return;
    }

    $container->import('services/services-ps-9.php');
};

# Definitions shared by every container: the Symfony one (back office), the admin legacy one and the front one.
# No autowiring here: the legacy containers are built by hand, so arguments are explicit.
services:
  _defaults:
    public: true

  PrestaShop\Module\Pcfdadmin\Roast\RoastCalendar:
    arguments:
      - '@prestashop.adapter.legacy.configuration'

imports:
  - { resource: ./common.yml }

services:
  _defaults:
    public: false
    autowire: true
    autoconfigure: true

  # Controllers are services whose id is the fully qualified class name.
  PrestaShop\Module\Pcfdadmin\Controller\RoastController: ~

imports:
  - { resource: ../common.yml }

services:
  _defaults:
    public: true

  pcfdadmin.admin.roast_label:
    class: PrestaShop\Module\Pcfdadmin\Roast\RoastLabel
    arguments:
      - '@PrestaShop\Module\Pcfdadmin\Roast\RoastCalendar'

imports:
  - { resource: ../common.yml }

services:
  _defaults:
    public: true

  pcfdadmin.front.roast_banner:
    class: PrestaShop\Module\Pcfdadmin\Roast\RoastBanner
    arguments:
      - '@PrestaShop\Module\Pcfdadmin\Roast\RoastCalendar'

services:
  _defaults:
    public: true
    autowire: true
    autoconfigure: true

  # Register every class of src/ as a service, but never the index.php redirect stubs.
  PrestaShop\Module\Pcfdadmin\:
    resource: '../src/*'
    exclude:
      - '../src/index.php'
      - '../src/*/index.php'

<?php

declare(strict_types=1);

namespace PrestaShop\Module\Pcfdadmin\Controller;

use PrestaShop\Module\Pcfdadmin\Roast\RoastCalendar;
use PrestaShopBundle\Controller\Admin\PrestaShopAdminController;
use PrestaShopBundle\Security\Attribute\AdminSecurity;
use PrestaShopBundle\Security\Attribute\DemoRestricted;
use Symfony\Component\DependencyInjection\Attribute\Autowire;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;

class RoastController extends PrestaShopAdminController
{
    // Constructor injection: autowired from the type, RoastCalendar is declared in config/common.yml.
    public function __construct(private readonly RoastCalendar $calendar)
    {
    }

    #[AdminSecurity("is_granted('read', request.get('_legacy_controller'))", message: 'You do not have permission to view the roast calendar.')]
    public function indexAction(
        Request $request,
        // Method injection: a service picked by id, only built when this action runs.
        #[Autowire(service: 'prestashop.adapter.legacy.configuration')]
        $configuration,
    ): Response {
        return $this->render('@Modules/pcfdadmin/views/templates/admin/roasts.html.twig', [
            'layoutTitle' => $this->trans('Roast calendar', [], 'Modules.Pcfdadmin.Admin'),
            'nextRoasts' => $this->calendar->next(4),
            'lastRoast' => $configuration->get('PCFDADMIN_LAST_ROAST'),
            'logUrl' => $this->generateUrl('pcfdadmin_roast_log'),
            'csrfToken' => $this->container->get('security.csrf.token_manager')->getToken('pcfdadmin_log')->getValue(),
        ]);
    }

    #[DemoRestricted(redirectRoute: 'pcfdadmin_roasts')]
    #[AdminSecurity("is_granted('update', request.get('_legacy_controller'))", message: 'You do not have permission to log a roast.', jsonResponse: true)]
    public function logAction(Request $request): JsonResponse
    {
        if (!$this->isCsrfTokenValid('pcfdadmin_log', (string) $request->request->get('csrf'))) {
            return new JsonResponse(['error' => 'Invalid CSRF token.'], Response::HTTP_BAD_REQUEST);
        }

        $batch = trim((string) $request->request->get('batch'));
        if (!preg_match('/^PC-[A-Z]{3}-\d{3}$/', $batch)) {
            return new JsonResponse(['error' => 'Batch codes look like PC-ETH-001.'], Response::HTTP_UNPROCESSABLE_ENTITY);
        }

        $this->getConfiguration()->set('PCFDADMIN_LAST_ROAST', $batch . ' ' . date('Y-m-d'));

        return new JsonResponse(['logged' => $batch]);
    }

    #[AdminSecurity("is_granted('delete', request.get('_legacy_controller'))", message: 'You do not have permission to purge the roast log.', redirectRoute: 'pcfdadmin_roasts')]
    public function purgeAction(): RedirectResponse
    {
        $this->getConfiguration()->remove('PCFDADMIN_LAST_ROAST');
        $this->addFlash('success', $this->trans('The roast log was purged.', [], 'Modules.Pcfdadmin.Admin'));

        return $this->redirectToRoute('pcfdadmin_roasts');
    }

    #[AdminSecurity("is_granted('read', request.get('_legacy_controller'))")]
    public function showAction(string $batch): JsonResponse
    {
        return new JsonResponse(['batch' => $batch, 'weekday' => $this->calendar->weekday()]);
    }

    #[AdminSecurity("is_granted('read', request.get('_legacy_controller'))")]
    public function pingAction(): JsonResponse
    {
        return new JsonResponse(['pong' => true, 'url' => $this->generateUrl('pcfdadmin_ping')]);
    }
}

<?php

declare(strict_types=1);

namespace PrestaShop\Module\Pcfdadmin\Roast;

use PrestaShop\PrestaShop\Core\ConfigurationInterface;

/**
 * Computes the roasting days of Pocket Coffee: one fixed weekday, every week.
 */
class RoastCalendar
{
    public function __construct(private readonly ConfigurationInterface $configuration)
    {
    }

    public function weekday(): int
    {
        return max(1, min(7, (int) $this->configuration->get('PCFDADMIN_ROAST_WEEKDAY', 1)));
    }

    /**
     * @return \DateTimeImmutable[] the next $count roasting days, today included when it is one
     */
    public function next(int $count, ?\DateTimeImmutable $from = null): array
    {
        $day = ($from ?? new \DateTimeImmutable('today'))->setTime(0, 0);
        $ahead = ($this->weekday() - (int) $day->format('N') + 7) % 7;
        $day = $day->modify('+' . $ahead . ' days');

        $days = [];
        for ($i = 0; $i < $count; ++$i) {
            $days[] = $day->modify('+' . (7 * $i) . ' days');
        }

        return $days;
    }
}

<?php

declare(strict_types=1);

namespace PrestaShop\Module\Pcfdadmin\Roast;

/**
 * Human readable summary, used from the legacy back-office container (config/admin/).
 */
class RoastLabel
{
    private const NAMES = [1 => 'Monday', 2 => 'Tuesday', 3 => 'Wednesday', 4 => 'Thursday', 5 => 'Friday', 6 => 'Saturday', 7 => 'Sunday'];

    public function __construct(private readonly RoastCalendar $calendar)
    {
    }

    public function describe(): string
    {
        $next = $this->calendar->next(1)[0];

        return sprintf('Pocket Coffee roasts every %s. Next roast: %s.', self::NAMES[$this->calendar->weekday()], $next->format('Y-m-d'));
    }
}

<?php

declare(strict_types=1);

namespace PrestaShop\Module\Pcfdadmin\Roast;

/**
 * Text for the shop window, used from the light front-office container (config/front/).
 */
class RoastBanner
{
    public function __construct(private readonly RoastCalendar $calendar)
    {
    }

    public function text(): string
    {
        return 'Next roast: ' . $this->calendar->next(1)[0]->format('l j F');
    }
}

{% extends '@PrestaShop/Admin/layout.html.twig' %}
{% trans_default_domain 'Modules.Pcfdadmin.Admin' %}

{% block content %}
  <div class="card">
    <h3 class="card-header"><i class="material-icons">local_cafe</i> {{ 'Next roasting days'|trans }}</h3>
    <div class="card-body">
      <ul>
        {% for day in nextRoasts %}
          <li>{{ day|date('Y-m-d') }}</li>
        {% endfor %}
      </ul>
      <p>{{ 'Last logged roast'|trans }}: {{ lastRoast ?: '-' }}</p>
      <form id="pcfdadmin-log" data-url="{{ logUrl }}" data-csrf="{{ csrfToken }}">
        <input type="text" name="batch" placeholder="PC-ETH-001" class="form-control">
        <button type="submit" class="btn btn-primary mt-2">{{ 'Log roast'|trans }}</button>
      </form>
    </div>
  </div>
{% endblock %}

{% block javascripts %}
  {{ parent() }}
  <script>
    document.getElementById('pcfdadmin-log').addEventListener('submit', async (event) => {
      event.preventDefault();
      const form = event.currentTarget;
      const body = new URLSearchParams({ batch: form.elements.batch.value, csrf: form.dataset.csrf });
      // X-Requested-With marks the request as XHR, so a permission failure answers with JSON.
      const response = await fetch(form.dataset.url, { method: 'POST', body, headers: { 'X-Requested-With': 'XMLHttpRequest' } });
      const data = await response.json();
      window.alert(data.logged ? 'Logged ' + data.logged : (data.error || data.message));
    });
  </script>
{% endblock %}

<?php

/**
 * Pocket Coffee: roast calendar back-office page (Symfony controller, services, tab).
 */

declare(strict_types=1);

if (!defined('_PS_VERSION_')) {
    exit;
}

if (file_exists(__DIR__ . '/vendor/autoload.php')) {
    require_once __DIR__ . '/vendor/autoload.php';
}

class Pcfdadmin extends Module
{
    public const KEY_WEEKDAY = 'PCFDADMIN_ROAST_WEEKDAY';
    public const KEY_LAST_ROAST = 'PCFDADMIN_LAST_ROAST';

    public function __construct()
    {
        $this->name = 'pcfdadmin';
        $this->tab = 'administration';
        $this->version = '1.0.0';
        $this->author = 'Pocket Coffee';
        $this->need_instance = 0;
        $this->ps_versions_compliancy = ['min' => '9.0.0', 'max' => '9.99.99'];

        parent::__construct();

        $this->displayName = $this->trans('Pocket Coffee roast calendar', [], 'Modules.Pcfdadmin.Admin');
        $this->description = $this->trans('Back-office roast calendar built with a Symfony controller.', [], 'Modules.Pcfdadmin.Admin');

        // One tab per back-office page. It carries the permissions (ROLE_MOD_TAB_ADMINPCFDADMINROASTS_*)
        // and, when "visible" is true, a link in the left menu.
        $this->tabs = [
            [
                'route_name' => 'pcfdadmin_roasts',
                'class_name' => 'AdminPcfdadminRoasts',
                'visible' => true,
                'name' => 'Roasts',
                'parent_class_name' => 'AdminCatalog',
                'icon' => 'local_cafe',
                'wording' => 'Roasts',
                'wording_domain' => 'Modules.Pcfdadmin.Admin',
            ],
        ];
    }

    public function isUsingNewTranslationSystem(): bool
    {
        return true;
    }

    public function install(): bool
    {
        return parent::install()
            && $this->registerHook('displayHome')
            && Configuration::updateGlobalValue(self::KEY_WEEKDAY, 1);
    }

    public function uninstall(): bool
    {
        return Configuration::deleteByName(self::KEY_WEEKDAY)
            && Configuration::deleteByName(self::KEY_LAST_ROAST)
            && parent::uninstall();
    }

    /**
     * Back-office legacy context: services of config/admin/ and config/services.yml are reachable.
     */
    public function getContent(): string
    {
        $label = $this->get('pcfdadmin.admin.roast_label');

        return '<div class="alert alert-info">' . $label->describe() . '</div>';
    }

    /**
     * Front-office legacy context: only the services of config/front/ are reachable through $this->get().
     */
    public function hookDisplayHome(array $params): string
    {
        $banner = $this->get('pcfdadmin.front.roast_banner');

        return '<p class="pcfdadmin-banner">' . htmlspecialchars($banner->text(), ENT_QUOTES, 'UTF-8') . '</p>';
    }
}

{
  "name": "pocketcoffee/pcfdadmin",
  "description": "Pocket Coffee roast calendar",
  "type": "prestashop-module",
  "license": "AFL-3.0",
  "autoload": { "psr-4": { "PrestaShop\\Module\\Pcfdadmin\\": "src/" } },
  "config": { "prepend-autoloader": false },
  "require": { "php": ">=8.1" }
}