Analisi del modulo Publisher

Panoramica

Questo documento fornisce un’analisi tecnica dell’architettura del modulo Publisher, degli schemi e dei dettagli di implementazione. Usa questo come riferimento per comprendere come è strutturato un modulo XOOPS di qualità produttiva.

Panoramica dell’architettura

flowchart TB
    subgraph "Presentation Layer"
        FE[Frontend Pages]
        AD[Admin Panel]
        BL[Blocks]
    end

    subgraph "Application Layer"
        PH[Page Handlers]
        BH[Block Handlers]
        FO[Forms]
    end

    subgraph "Domain Layer"
        IT[Item Entity]
        CA[Category Entity]
        FI[File Entity]
    end

    subgraph "Infrastructure"
        IH[ItemHandler]
        CH[CategoryHandler]
        FH[FileHandler]
        DB[(Database)]
    end

    FE --> PH
    AD --> PH
    BL --> BH
    PH --> IT
    PH --> CA
    BH --> IT
    IT --> IH
    CA --> CH
    FI --> FH
    IH --> DB
    CH --> DB
    FH --> DB

Struttura delle directory

publisher/
├── admin/
│   ├── index.php           # Dashboard admin
│   ├── item.php            # Gestione articoli
│   ├── category.php        # Gestione categorie
│   ├── permission.php      # Autorizzazioni
│   ├── file.php            # Gestore file
│   └── menu.php            # Menu admin
├── assets/
│   ├── css/
│   ├── js/
│   └── images/
├── class/
│   ├── Category.php        # Entità categoria
│   ├── CategoryHandler.php # Accesso dati categoria
│   ├── Item.php            # Entità articolo
│   ├── ItemHandler.php     # Accesso dati articolo
│   ├── File.php            # Allegato file
│   ├── FileHandler.php     # Accesso dati file
│   ├── Form/               # Classi form
│   ├── Common/             # Utility
│   └── Helper.php          # Helper modulo
├── include/
│   ├── common.php          # Inizializzazione
│   ├── functions.php       # Funzioni utility
│   ├── oninstall.php       # Hook installazione
│   ├── onupdate.php        # Hook aggiornamento
│   └── search.php          # Integrazione ricerca
├── language/
├── templates/
├── sql/
└── xoops_version.php

Analisi entità

Entità Item (Articolo)

class Item extends \XoopsObject
{
    // Campi
    public function initVar(): void
    {
        $this->initVar('itemid', XOBJ_DTYPE_INT, null, false);
        $this->initVar('categoryid', XOBJ_DTYPE_INT, 0, false);
        $this->initVar('title', XOBJ_DTYPE_TXTBOX, '', true);
        $this->initVar('subtitle', XOBJ_DTYPE_TXTBOX, '');
        $this->initVar('summary', XOBJ_DTYPE_TXTAREA, '');
        $this->initVar('body', XOBJ_DTYPE_TXTAREA, '', true);
        $this->initVar('uid', XOBJ_DTYPE_INT, 0);
        $this->initVar('status', XOBJ_DTYPE_INT, 0);
        $this->initVar('datesub', XOBJ_DTYPE_INT, time());
        // ... altri campi
    }

    // Metodi business
    public function isPublished(): bool
    {
        return $this->getVar('status') == _PUBLISHER_STATUS_PUBLISHED;
    }

    public function canEdit(int $userId): bool
    {
        return $this->getVar('uid') == $userId
            || $this->isAdmin($userId);
    }
}

Modello Handler

class ItemHandler extends \XoopsPersistableObjectHandler
{
    public function __construct(\XoopsDatabase $db)
    {
        parent::__construct(
            $db,
            'publisher_items',
            Item::class,
            'itemid',
            'title'
        );
    }

    public function getPublishedItems(int $limit = 10): array
    {
        $criteria = new \CriteriaCompo();
        $criteria->add(new \Criteria('status', _PUBLISHER_STATUS_PUBLISHED));
        $criteria->setSort('datesub');
        $criteria->setOrder('DESC');
        $criteria->setLimit($limit);

        return $this->getObjects($criteria);
    }
}

Sistema autorizzazioni

Tipi di autorizzazione

Autorizzazione	Descrizione
publisher_view	Visualizza categoria/articoli
publisher_submit	Invia nuovi articoli
publisher_approve	Auto-approva invii
publisher_moderate	Revisione articoli in sospeso
publisher_global	Autorizzazioni modulo globali

Controllo autorizzazione

class PermissionHandler
{
    public function isGranted(string $permission, int $categoryId): bool
    {
        $userId = $GLOBALS['xoopsUser']?->uid() ?? 0;
        $groups = $this->getUserGroups($userId);

        return $this->grouppermHandler->checkRight(
            $permission,
            $categoryId,
            $groups,
            $this->helper->getModule()->mid()
        );
    }
}

Stati del flusso di lavoro

stateDiagram-v2
    [*] --> Draft: Create
    Draft --> Submitted: Submit
    Submitted --> Published: Approve
    Submitted --> Rejected: Reject
    Submitted --> Draft: Return for Edit
    Published --> Offline: Unpublish
    Offline --> Published: Republish
    Published --> [*]: Delete
    Rejected --> [*]: Delete

Struttura template

Template frontend

Template	Scopo
publisher_index.tpl	Homepage modulo
publisher_item.tpl	Articolo singolo
publisher_category.tpl	Elenco categoria
publisher_submit.tpl	Form invio
publisher_search.tpl	Risultati ricerca

Template blocchi

Template	Scopo
publisher_block_latest.tpl	Articoli recenti
publisher_block_spotlight.tpl	Articolo in primo piano
publisher_block_category.tpl	Menu categoria

Schemi chiave utilizzati

1. Modello Handler - Incapsulamento accesso dati
2. Value Object - Costanti di stato
3. Template Method - Generazione form
4. Strategy - Diverse modalità visualizzazione
5. Observer - Notifiche su eventi

Lezioni per lo sviluppo di moduli

1. Usa XoopsPersistableObjectHandler per CRUD
2. Implementa autorizzazioni granulari
3. Separa presentazione dalla logica
4. Usa Criteria per le query
5. Supporta più stati contenuto
6. Integra con il sistema di notifica XOOPS

Documentazione correlata

• Creating-Articles - Gestione articoli
• Managing-Categories - Sistema categoria
• Permissions-Setup - Configurazione autorizzazioni
• Developer-Guide/Hooks-and-Events - Punti estensione