Gå til indhold
XOOPS 2.7 Docs

XoopsObject klasse

Klassen XoopsObject er den grundlæggende basisklasse for alle dataobjekter i XOOPS-systemet. Det giver en standardiseret grænseflade til styring af objektegenskaber, validering, dirty tracking og serialisering.

Klasseoversigt

Sektion kaldt “Klasseoversigt”
namespace Xoops\Core;


class XoopsObject
{
    protected array $vars = [];
    protected array $cleanVars = [];
    protected bool $isNew = true;
    protected array $errors = [];
}

Klassehierarki

Sektion kaldt “Klassehierarki”
XoopsObject
├── XoopsUser
├── XoopsGroup
├── XoopsModule
├── XoopsBlock
├── XoopsComment
├── XoopsNotification
├── XoopsConfig
└── [Custom Module Objects]

Egenskaber

Sektion kaldt “Egenskaber”
EjendomSkrivSynlighedBeskrivelse
$varsrækkebeskyttetGemmer variable definitioner og værdier
$cleanVarsrækkebeskyttetGemmer rensede værdier til databaseoperationer
$isNewboolbeskyttetAngiver om objektet er nyt (endnu ikke i databasen)
$errorsrækkebeskyttetGemmer validerings- og fejlmeddelelser

Konstruktør

Sektion kaldt “Konstruktør”
public function __construct()

Opretter en ny XoopsObject-instans. Objektet er markeret som nyt som standard.

Eksempel:

$object = new XoopsObject();
// Object is new and has no defined variables

Kernemetoder

Sektion kaldt “Kernemetoder”

initVar

Sektion kaldt “initVar”

Initialiserer en variabeldefinition for objektet.

public function initVar(
    string $key,
    int $dataType,
    mixed $value = null,
    bool $required = false,
    int $maxlength = null,
    string $options = ''
): void

Parametre:

ParameterSkrivBeskrivelse
$keystrengVariabelnavn
$dataTypeintDatatypekonstant (se Datatyper)
$valueblandetStandardværdi
$requiredboolOm felt er påkrævet
$maxlengthintMaksimal længde for strengtyper
$optionsstrengYderligere muligheder

Datatyper:

KonstantVærdiBeskrivelse
XOBJ_DTYPE_TXTBOX1Indtastning af tekstboks
XOBJ_DTYPE_TXTAREA2Tekstområdeindhold
XOBJ_DTYPE_INT3Heltalsværdi
XOBJ_DTYPE_URL4URL streng
XOBJ_DTYPE_EMAIL5E-mailadresse
XOBJ_DTYPE_ARRAY6Serialiseret array
XOBJ_DTYPE_OTHER7Brugerdefineret type
XOBJ_DTYPE_SOURCE8Kildekode
XOBJ_DTYPE_STIME9Kort tidsformat
XOBJ_DTYPE_MTIME10Mellem tidsformat
XOBJ_DTYPE_LTIME11Langtidsformat
XOBJ_DTYPE_FLOAT12Flydende komma
XOBJ_DTYPE_DECIMAL13Decimaltal
XOBJ_DTYPE_ENUM14Optælling

Eksempel:

class MyObject extends XoopsObject
{
    public function __construct()
    {
        parent::__construct();
        $this->initVar('id', XOBJ_DTYPE_INT, null, false);
        $this->initVar('title', XOBJ_DTYPE_TXTBOX, '', true, 255);
        $this->initVar('content', XOBJ_DTYPE_TXTAREA, '', false);
        $this->initVar('email', XOBJ_DTYPE_EMAIL, '', true, 100);
        $this->initVar('created', XOBJ_DTYPE_INT, time(), false);
        $this->initVar('status', XOBJ_DTYPE_INT, 1, true);
    }
}

sætVar

Sektion kaldt “sætVar”

Indstiller værdien af en variabel.

public function setVar(
    string $key,
    mixed $value,
    bool $notGpc = false
): bool

Parametre:

ParameterSkrivBeskrivelse
$keystrengVariabelnavn
$valueblandetVærdi at indstille
$notGpcboolHvis sand, er værdien ikke fra GET/POST/COOKIE

Returneringer: bool - Sandt, hvis det lykkedes, ellers falsk

Eksempel:

$object = new MyObject();
$object->setVar('title', 'Hello World');
$object->setVar('content', '<p>Content here</p>', true); // Not from user input
$object->setVar('status', 1);

getVar

Sektion kaldt “getVar”

Henter værdien af en variabel med valgfri formatering.

public function getVar(
    string $key,
    string $format = 's'
): mixed

Parametre:

ParameterSkrivBeskrivelse
$keystrengVariabelnavn
$formatstrengOutputformat

Formatindstillinger:

FormatBeskrivelse
's'Vis - HTML enheder escaped til visning
'e'Rediger - For formularindtastningsværdier
'p'Forhåndsvisning - Ligner til at vise
'f'Formulardata - Rå til formularbehandling
'n'Ingen - rå værdi, ingen formatering

Returneringer: mixed - Den formaterede værdi

Eksempel:

$object = new MyObject();
$object->setVar('title', 'Hello <World>');


echo $object->getVar('title', 's'); // "Hello &lt;World&gt;"
echo $object->getVar('title', 'e'); // "Hello &lt;World&gt;" (for input value)
echo $object->getVar('title', 'n'); // "Hello <World>" (raw)


// For array data types
$object->setVar('options', ['a', 'b', 'c']);
$options = $object->getVar('options', 'n'); // Returns array

sætVars

Sektion kaldt “sætVars”

Indstiller flere variabler på én gang fra en matrix.

public function setVars(
    array $values,
    bool $notGpc = false
): void

Parametre:

ParameterSkrivBeskrivelse
$valuesrækkeAssociativ array af nøgle => værdipar
$notGpcboolHvis sandt, er værdierne ikke fra GET/POST/COOKIE

Eksempel:

$object = new MyObject();
$object->setVars([
    'title' => 'My Title',
    'content' => 'My content',
    'status' => 1
]);


// From database (not user input)
$object->setVars($row, true);

getValues

Sektion kaldt “getValues”

Henter alle variabelværdier.

public function getValues(
    array $keys = null,
    string $format = 's',
    int $maxDepth = 1
): array

Parametre:

ParameterSkrivBeskrivelse
$keysrækkeSpecifikke nøgler til at hente (nul for alle)
$formatstrengOutputformat
$maxDepthintMaksimal dybde for indlejrede objekter

Returneringer: array - Associativ række af værdier

Eksempel:

$object = new MyObject();


// Get all values
$allValues = $object->getValues();


// Get specific values
$subset = $object->getValues(['title', 'status']);


// Get raw values for database
$rawValues = $object->getValues(null, 'n');

assignVarTildeler en værdi direkte uden validering (brug med forsigtighed).

Sektion kaldt “assignVarTildeler en værdi direkte uden validering (brug med forsigtighed).”
public function assignVar(
    string $key,
    mixed $value
): void

Parametre:

ParameterSkrivBeskrivelse
$keystrengVariabelnavn
$valueblandetVærdi at tildele

Eksempel:

// Direct assignment from trusted source (e.g., database)
$object->assignVar('id', $row['id']);
$object->assignVar('created', $row['created']);

cleanVars

Sektion kaldt “cleanVars”

Renser alle variabler til databaseoperationer.

public function cleanVars(): bool

Returnerer: bool - Sandt, hvis alle variabler er gyldige

Eksempel:

$object = new MyObject();
$object->setVar('title', 'Test');
$object->setVar('email', 'user@example.com');


if ($object->cleanVars()) {
    // Variables are sanitized and ready for database
    $cleanData = $object->cleanVars;
} else {
    // Validation errors occurred
    $errors = $object->getErrors();
}

er nyt

Sektion kaldt “er nyt”

Kontrollerer eller indstiller, om objektet er nyt.

public function isNew(): bool
public function setNew(): void
public function unsetNew(): void

Eksempel:

$object = new MyObject();
echo $object->isNew(); // true


$object->unsetNew();
echo $object->isNew(); // false


$object->setNew();
echo $object->isNew(); // true

Fejlhåndteringsmetoder

Sektion kaldt “Fejlhåndteringsmetoder”

sætFejl

Sektion kaldt “sætFejl”

Tilføjer en fejlmeddelelse.

public function setErrors(string|array $error): void

Eksempel:

$object->setErrors('Title is required');
$object->setErrors(['Field 1 error', 'Field 2 error']);

getErrors

Sektion kaldt “getErrors”

Henter alle fejlmeddelelser.

public function getErrors(): array

Eksempel:

$errors = $object->getErrors();
foreach ($errors as $error) {
    echo $error . "\n";
}

getHtmlErrors

Sektion kaldt “getHtmlErrors”

Returnerer fejl formateret som HTML.

public function getHtmlErrors(): string

Eksempel:

if (!$object->cleanVars()) {
    echo '<div class="error">' . $object->getHtmlErrors() . '</div>';
}

Hjælpemetoder

Sektion kaldt “Hjælpemetoder”

tilArray

Sektion kaldt “tilArray”

Konverterer objektet til et array.

public function toArray(): array

Eksempel:

$object = new MyObject();
$object->setVar('title', 'Test');
$data = $object->toArray();
// ['title' => 'Test', ...]

getVars

Sektion kaldt “getVars”

Returnerer variabeldefinitionerne.

public function getVars(): array

Eksempel:

$vars = $object->getVars();
foreach ($vars as $key => $definition) {
    echo "Field: $key, Type: {$definition['data_type']}\n";
}

Komplet brugseksempel

Sektion kaldt “Komplet brugseksempel”
<?php
/**
 * Custom Article Object
 */
class Article extends XoopsObject
{
    /**
     * Constructor - Initialize all variables
     */
    public function __construct()
    {
        parent::__construct();


        // Primary key
        $this->initVar('article_id', XOBJ_DTYPE_INT, null, false);


        // Required fields
        $this->initVar('title', XOBJ_DTYPE_TXTBOX, '', true, 255);
        $this->initVar('author_id', XOBJ_DTYPE_INT, 0, true);


        // Optional fields
        $this->initVar('summary', XOBJ_DTYPE_TXTAREA, '', false);
        $this->initVar('content', XOBJ_DTYPE_TXTAREA, '', false);
        $this->initVar('category_id', XOBJ_DTYPE_INT, 0, false);


        // Timestamps
        $this->initVar('created', XOBJ_DTYPE_INT, time(), false);
        $this->initVar('updated', XOBJ_DTYPE_INT, time(), false);


        // Status flags
        $this->initVar('published', XOBJ_DTYPE_INT, 0, false);
        $this->initVar('views', XOBJ_DTYPE_INT, 0, false);


        // Metadata as array
        $this->initVar('meta', XOBJ_DTYPE_ARRAY, [], false);
    }


    /**
     * Get formatted creation date
     */
    public function getCreatedDate(string $format = 'Y-m-d H:i:s'): string
    {
        return date($format, $this->getVar('created', 'n'));
    }


    /**
     * Check if article is published
     */
    public function isPublished(): bool
    {
        return $this->getVar('published', 'n') == 1;
    }


    /**
     * Increment view counter
     */
    public function incrementViews(): void
    {
        $views = $this->getVar('views', 'n');
        $this->setVar('views', $views + 1);
    }


    /**
     * Custom validation
     */
    public function validate(): bool
    {
        $this->errors = [];


        // Title validation
        $title = trim($this->getVar('title', 'n'));
        if (empty($title)) {
            $this->setErrors('Title is required');
        } elseif (strlen($title) < 5) {
            $this->setErrors('Title must be at least 5 characters');
        }


        // Author validation
        if ($this->getVar('author_id', 'n') <= 0) {
            $this->setErrors('Author is required');
        }


        return empty($this->errors);
    }
}


// Usage
$article = new Article();
$article->setVar('title', 'My First Article');
$article->setVar('author_id', 1);
$article->setVar('content', '<p>Article content here...</p>', true);
$article->setVar('meta', [
    'keywords' => ['xoops', 'cms', 'php'],
    'description' => 'An example article'
]);


if ($article->validate() && $article->cleanVars()) {
    // Save to database via handler
    $handler = xoops_getModuleHandler('article', 'mymodule');
    $handler->insert($article);


    echo "Article saved with ID: " . $article->getVar('article_id');
} else {
    echo "Errors: " . $article->getHtmlErrors();
}

Bedste praksis

Sektion kaldt “Bedste praksis”

  1. Initialiser altid variabler: Definer alle variabler i konstruktøren ved hjælp af initVar()

  2. Brug passende datatyper: Vælg den korrekte XOBJ_DTYPE_* konstant til validering

  3. Håndter brugerinput forsigtigt: Brug setVar() med $notGpc = false til brugerinput

  4. Valider før lagring: Kald altid cleanVars() før databasehandlinger

  5. Brug formatparametre: Brug det passende format i getVar() til konteksten

  6. Udvid til brugerdefineret logik: Tilføj domænespecifikke metoder i underklasser

Relateret dokumentation

Sektion kaldt “Relateret dokumentation”
  • XoopsObjectHandler - Håndtermønster for objektpersistens
  • ../Database/Criteria - Forespørgselsbygning med kriterier
  • ../Database/XoopsDatabase - Databaseoperationer

Se også: XOOPS kildekode