XoopsObjectHandler-klasse

De klasse XoopsObjectHandler en de extensie XoopsPersistableObjectHandler bieden een gestandaardiseerde interface voor het uitvoeren van CRUD-bewerkingen (maken, lezen, bijwerken, verwijderen) op XoopsObject-instanties. Hiermee wordt het Data Mapper-patroon geïmplementeerd, waarbij domeinlogica wordt gescheiden van databasetoegang.

Klassenoverzicht

namespace Xoops\Core;

abstract class XoopsObjectHandler
{
    protected XoopsDatabase $db;

    public function __construct(XoopsDatabase $db);
    abstract public function create(bool $isNew = true);
    abstract public function get(int $id);
    abstract public function insert(XoopsObject $obj, bool $force = false): bool;
    abstract public function delete(XoopsObject $obj, bool $force = false): bool;
}

Klassenhiërarchie

XoopsObjectHandler (Abstract Base)
└── XoopsPersistableObjectHandler (Extended Implementation)
    ├── XoopsUserHandler
    ├── XoopsGroupHandler
    ├── XoopsModuleHandler
    ├── XoopsBlockHandler
    ├── XoopsConfigHandler
    └── [Custom Module Handlers]

XoopsObjectHandler

Constructeur

public function __construct(XoopsDatabase $db)

Parameters:

Parameter	Typ	Beschrijving
`$db`	XoopsDatabase	Databaseverbindingsinstantie

Voorbeeld:

$db = XoopsDatabaseFactory::getDatabaseConnection();
$handler = new MyObjectHandler($db);

creëren

Creëert een nieuwe objectinstantie.

abstract public function create(bool $isNew = true): ?XoopsObject

Parameters:

Parameter	Typ	Beschrijving
`$isNew`	bool	Of object nieuw is (standaard: waar)

Retourneert: XoopsObject|null - Nieuw objectexemplaar

Voorbeeld:

$handler = xoops_getHandler('user');
$user = $handler->create();
$user->setVar('uname', 'newuser');

krijgen

Haalt een object op via zijn primaire sleutel.

abstract public function get(int $id): ?XoopsObject

Parameters:

Parameter	Typ	Beschrijving
`$id`	int	Primaire sleutelwaarde

Retourneert: XoopsObject|null - Objectinstantie of null indien niet gevonden

Voorbeeld:

$handler = xoops_getHandler('user');
$user = $handler->get(1);
if ($user) {
    echo $user->getVar('uname');
}

invoegen

Slaat een object op in de database (invoegen of bijwerken).

abstract public function insert(
    XoopsObject $obj,
    bool $force = false
): bool

Parameters:

Parameter	Typ	Beschrijving
`$obj`	XoopsObject	Object om op te slaan
`$force`	bool	Bediening forceren, ook bij ongewijzigd object

Retourzendingen: bool - Klopt bij succes

Voorbeeld:

$handler = xoops_getHandler('user');
$user = $handler->create();
$user->setVar('uname', 'testuser');
$user->setVar('email', 'test@example.com');

if ($handler->insert($user)) {
    echo "User saved with ID: " . $user->getVar('uid');
} else {
    echo "Save failed: " . implode(', ', $user->getErrors());
}

verwijderen

Verwijdert een object uit de database.

abstract public function delete(
    XoopsObject $obj,
    bool $force = false
): bool

Parameters:

Parameter	Typ	Beschrijving
`$obj`	XoopsObject	Bezwaar om te verwijderen
`$force`	bool	Verwijdering forceren

Retourzendingen: bool - Klopt bij succes

Voorbeeld:

$handler = xoops_getHandler('user');
$user = $handler->get(5);

if ($user && $handler->delete($user)) {
    echo "User deleted";
}

XoopsPersistableObjectHandler

De XoopsPersistableObjectHandler breidt de XoopsObjectHandler uit met extra methoden voor query’s en bulkbewerkingen.

Constructeur

public function __construct(
    XoopsDatabase $db,
    string $table,
    string $className,
    string $keyName,
    string $identifierName = ''
)

Parameters:

Parameter	Typ	Beschrijving
`$db`	XoopsDatabase	Databaseverbinding
`$table`	tekenreeks	Tabelnaam (zonder voorvoegsel)
`$className`	tekenreeks	Volledige klassenaam van het object
`$keyName`	tekenreeks	Veldnaam primaire sleutel
`$identifierName`	tekenreeks	Voor mensen leesbaar identificatieveld

Voorbeeld:

class ArticleHandler extends XoopsPersistableObjectHandler
{
    public function __construct(XoopsDatabase $db)
    {
        parent::__construct(
            $db,
            'mymodule_articles',    // Table name
            'Article',               // Class name
            'article_id',            // Primary key
            'title'                  // Identifier field
        );
    }
}

getObjecten

Haalt meerdere objecten op die aan de criteria voldoen.

public function getObjects(
    CriteriaElement $criteria = null,
    bool $idAsKey = false,
    bool $asObject = true
): array

Parameters:

Parameter	Typ	Beschrijving
`$criteria`	CriteriaElement	Querycriteria (optioneel)
`$idAsKey`	bool	Gebruik de primaire sleutel als arraysleutel
`$asObject`	bool	Retourneer objecten (waar) of arrays (false)

Retourneert: array - Array van objecten of associatieve arrays

Voorbeeld:

$handler = xoops_getHandler('user');

// Get all active users
$criteria = new Criteria('level', 0, '>');
$users = $handler->getObjects($criteria);

// Get users with ID as key
$users = $handler->getObjects($criteria, true);
echo $users[1]->getVar('uname'); // Access by ID

// Get as arrays instead of objects
$usersArray = $handler->getObjects($criteria, false, false);
foreach ($usersArray as $userData) {
    echo $userData['uname'];
}

getCount

Telt objecten die voldoen aan de criteria.

public function getCount(CriteriaElement $criteria = null): int

Parameters:

Parameter	Typ	Beschrijving
`$criteria`	CriteriaElement	Querycriteria (optioneel)

Retourzendingen: int - Aantal overeenkomende objecten

Voorbeeld:

$handler = xoops_getHandler('user');

// Count all users
$totalUsers = $handler->getCount();

// Count active users
$criteria = new Criteria('level', 0, '>');
$activeUsers = $handler->getCount($criteria);

echo "Total: $totalUsers, Active: $activeUsers";

haal alles

Haalt alle objecten op (alias voor getObjects zonder criteria).

public function getAll(
    CriteriaElement $criteria = null,
    array $fields = null,
    bool $asObject = true,
    bool $idAsKey = true
): array

Parameters:

Parameter	Typ	Beschrijving
`$criteria`	CriteriaElement	Zoekcriteria
`$fields`	array	Specifieke velden om op te halen
`$asObject`	bool	Retourneer als objecten
`$idAsKey`	bool	Gebruik ID als arraysleutel

Voorbeeld:

$handler = xoops_getHandler('module');

// Get all modules
$modules = $handler->getAll();

// Get only specific fields
$modules = $handler->getAll(null, ['mid', 'name', 'dirname'], false);

getIds

Haalt alleen de primaire sleutels van overeenkomende objecten op.

public function getIds(CriteriaElement $criteria = null): array

Parameters:

Parameter	Typ	Beschrijving
`$criteria`	CriteriaElement	Zoekcriteria

Retourneert: array - Array van primaire sleutelwaarden

Voorbeeld:

$handler = xoops_getHandler('user');
$criteria = new Criteria('level', 1);
$adminIds = $handler->getIds($criteria);
// [1, 5, 12, ...] - Array of admin user IDs

getLijst

Haalt een sleutel-waardelijst op voor vervolgkeuzelijsten.

public function getList(CriteriaElement $criteria = null): array

Retourneert: array - Associatieve array [id => identifier]

Voorbeeld:

$handler = xoops_getHandler('group');
$groups = $handler->getList();
// [1 => 'Administrators', 2 => 'Registered Users', ...]

// For a select dropdown
$form->addElement(new XoopsFormSelect('Group', 'group_id', $default, 1, false));
$form->getElement('group_id')->addOptionArray($groups);

verwijderAlles

Verwijdert alle objecten die aan de criteria voldoen.

public function deleteAll(
    CriteriaElement $criteria = null,
    bool $force = true,
    bool $asObject = false
): bool

Parameters:

Parameter	Typ	Beschrijving
`$criteria`	CriteriaElement	Criteria voor te verwijderen objecten
`$force`	bool	Verwijdering forceren
`$asObject`	bool	Objecten laden voordat ze worden verwijderd (triggert gebeurtenissen)

Retourzendingen: bool - Klopt bij succes

Voorbeeld:

$handler = xoops_getModuleHandler('comment', 'mymodule');

// Delete all comments for a specific article
$criteria = new Criteria('article_id', $articleId);
$handler->deleteAll($criteria);

// Delete with object loading (triggers delete events)
$handler->deleteAll($criteria, true, true);

updateAlles

Werkt een veldwaarde bij voor alle overeenkomende objecten.

public function updateAll(
    string $fieldname,
    mixed $fieldvalue,
    CriteriaElement $criteria = null,
    bool $force = false
): bool

Parameters:

Parameter	Typ	Beschrijving
`$fieldname`	tekenreeks	Te updaten veld
`$fieldvalue`	gemengd	Nieuwe waarde
`$criteria`	CriteriaElement	Criteria voor bij te werken objecten
`$force`	bool	Update forceren

Retourzendingen: bool - Klopt bij succes

Voorbeeld:

$handler = xoops_getModuleHandler('article', 'mymodule');

// Mark all articles by an author as draft
$criteria = new Criteria('author_id', $authorId);
$handler->updateAll('published', 0, $criteria);

// Update view count
$criteria = new Criteria('article_id', $id);
$handler->updateAll('views', $views + 1, $criteria);

invoegen (uitgebreid)

De uitgebreide insteekmethode met extra functionaliteit.

public function insert(
    XoopsObject $obj,
    bool $force = false
): bool

Gedrag:

Als het object nieuw is (isNew() === true): INSERT
Als object bestaat (isNew() === false): UPDATE
Roept automatisch cleanVars() op
Stelt de ID voor automatisch verhogen in voor nieuwe objecten

Voorbeeld:

$handler = xoops_getModuleHandler('article', 'mymodule');

// Create new article
$article = $handler->create();
$article->setVar('title', 'New Article');
$article->setVar('content', 'Content here');
$handler->insert($article);
echo "Created with ID: " . $article->getVar('article_id');

// Update existing article
$article = $handler->get(5);
$article->setVar('title', 'Updated Title');
$handler->insert($article);

Helperfuncties

xoops_getHandler

Globale functie voor het ophalen van een kernhandler.

function xoops_getHandler(string $name, bool $optional = false): ?XoopsObjectHandler

Parameters:

Parameter	Typ	Beschrijving
`$name`	tekenreeks	Handlernaam (gebruiker, module, groep, enz.)
`$optional`	bool	Null retourneren in plaats van fout

Voorbeeld:

$userHandler = xoops_getHandler('user');
$moduleHandler = xoops_getHandler('module');
$groupHandler = xoops_getHandler('group');
$blockHandler = xoops_getHandler('block');
$configHandler = xoops_getHandler('config');

xoops_getModuleHandler

Haalt een modulespecifieke handler op.

function xoops_getModuleHandler(
    string $name,
    string $dirname = null,
    bool $optional = false
): ?XoopsObjectHandler

Parameters:

Parameter	Typ	Beschrijving
`$name`	tekenreeks	Naam afhandelaar
`$dirname`	tekenreeks	Naam modulemap
`$optional`	bool	Null retourneren bij mislukking

Voorbeeld:

// Get handler from current module
$articleHandler = xoops_getModuleHandler('article');

// Get handler from specific module
$articleHandler = xoops_getModuleHandler('article', 'news');
$storyHandler = xoops_getModuleHandler('story', 'news');

Aangepaste handlers maken

Basishandlerimplementatie

<?php
namespace XoopsModules\MyModule;

use XoopsPersistableObjectHandler;
use XoopsDatabase;
use CriteriaElement;
use Criteria;
use CriteriaCompo;

/**
 * Handler for Article objects
 */
class ArticleHandler extends XoopsPersistableObjectHandler
{
    /**
     * Constructor
     */
    public function __construct(XoopsDatabase $db = null)
    {
        parent::__construct(
            $db,
            'mymodule_articles',
            Article::class,
            'article_id',
            'title'
        );
    }

    /**
     * Get published articles
     */
    public function getPublished(int $limit = 10, int $start = 0): array
    {
        $criteria = new CriteriaCompo();
        $criteria->add(new Criteria('published', 1));
        $criteria->add(new Criteria('publish_date', time(), '<='));
        $criteria->setSort('publish_date');
        $criteria->setOrder('DESC');
        $criteria->setLimit($limit);
        $criteria->setStart($start);

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

    /**
     * Get articles by author
     */
    public function getByAuthor(int $authorId, bool $publishedOnly = true): array
    {
        $criteria = new CriteriaCompo();
        $criteria->add(new Criteria('author_id', $authorId));

        if ($publishedOnly) {
            $criteria->add(new Criteria('published', 1));
        }

        $criteria->setSort('created');
        $criteria->setOrder('DESC');

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

    /**
     * Get articles by category
     */
    public function getByCategory(int $categoryId, int $limit = 0): array
    {
        $criteria = new CriteriaCompo();
        $criteria->add(new Criteria('category_id', $categoryId));
        $criteria->add(new Criteria('published', 1));
        $criteria->setSort('publish_date');
        $criteria->setOrder('DESC');

        if ($limit > 0) {
            $criteria->setLimit($limit);
        }

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

    /**
     * Search articles
     */
    public function search(string $query, array $fields = ['title', 'content']): array
    {
        $criteria = new CriteriaCompo();
        $searchCriteria = new CriteriaCompo();

        foreach ($fields as $field) {
            $searchCriteria->add(
                new Criteria($field, '%' . $query . '%', 'LIKE'),
                'OR'
            );
        }

        $criteria->add($searchCriteria);
        $criteria->add(new Criteria('published', 1));
        $criteria->setSort('publish_date');
        $criteria->setOrder('DESC');

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

    /**
     * Get popular articles by view count
     */
    public function getPopular(int $limit = 5): array
    {
        $criteria = new CriteriaCompo();
        $criteria->add(new Criteria('published', 1));
        $criteria->setSort('views');
        $criteria->setOrder('DESC');
        $criteria->setLimit($limit);

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

    /**
     * Increment view count
     */
    public function incrementViews(int $articleId): bool
    {
        $sql = sprintf(
            "UPDATE %s SET views = views + 1 WHERE article_id = %d",
            $this->db->prefix($this->table),
            $articleId
        );

        return $this->db->queryF($sql) !== false;
    }

    /**
     * Override insert for custom behavior
     */
    public function insert(\XoopsObject $obj, bool $force = false): bool
    {
        // Set updated timestamp
        $obj->setVar('updated', time());

        // If new, set created timestamp
        if ($obj->isNew()) {
            $obj->setVar('created', time());
        }

        return parent::insert($obj, $force);
    }

    /**
     * Override delete for cascade operations
     */
    public function delete(\XoopsObject $obj, bool $force = false): bool
    {
        // Delete associated comments
        $commentHandler = xoops_getModuleHandler('comment', 'mymodule');
        $criteria = new Criteria('article_id', $obj->getVar('article_id'));
        $commentHandler->deleteAll($criteria);

        return parent::delete($obj, $force);
    }
}

De aangepaste afhandeling gebruiken

// Get the handler
$articleHandler = xoops_getModuleHandler('article', 'mymodule');

// Create a new article
$article = $articleHandler->create();
$article->setVars([
    'title' => 'My New Article',
    'content' => 'Article content here...',
    'author_id' => $xoopsUser->getVar('uid'),
    'category_id' => 1,
    'published' => 1,
    'publish_date' => time()
]);

if ($articleHandler->insert($article)) {
    redirect_header('article.php?id=' . $article->getVar('article_id'), 2, 'Article created');
}

// Get published articles
$articles = $articleHandler->getPublished(10);

// Search articles
$results = $articleHandler->search('xoops');

// Get popular articles
$popular = $articleHandler->getPopular(5);

// Update view count
$articleHandler->incrementViews($articleId);

Beste praktijken

Gebruik criteria voor query’s: gebruik altijd Criteria-objecten voor typeveilige query’s
Uitbreiden voor aangepaste methoden: voeg domeinspecifieke querymethoden toe aan handlers
Invoegen/verwijderen overschrijven: voeg cascadebewerkingen en tijdstempels toe aan overschrijvingen
Gebruik transacties waar nodig: verpak complexe operaties in transacties
Maak gebruik van getList: gebruik getList() voor geselecteerde vervolgkeuzelijsten om het aantal zoekopdrachten te verminderen
Indexsleutels: Zorg ervoor dat databasevelden die in criteria worden gebruikt, worden geïndexeerd
Beperk resultaten: gebruik altijd setLimit() voor potentieel grote resultatensets

Gerelateerde documentatie

XoopsObject - Basisobjectklasse
../Database/Criteria - Querycriteria opstellen
../Database/XoopsDatabase - Databasebewerkingen

Zie ook: XOOPS-broncode