XOOPS Form Elements

Overview

XOOPS provides a comprehensive set of form elements through its XoopsFormElement class hierarchy. These elements handle rendering, validation, and data processing for web forms.

Form Element Hierarchy

classDiagram
    class XoopsFormElement {
        +getName()
        +getCaption()
        +render()
        +setValue()
        +getValue()
    }

    XoopsFormElement <|-- XoopsFormText
    XoopsFormElement <|-- XoopsFormTextArea
    XoopsFormElement <|-- XoopsFormSelect
    XoopsFormElement <|-- XoopsFormCheckBox
    XoopsFormElement <|-- XoopsFormRadio
    XoopsFormElement <|-- XoopsFormButton
    XoopsFormElement <|-- XoopsFormHidden
    XoopsFormElement <|-- XoopsFormFile
    XoopsFormElement <|-- XoopsFormLabel
    XoopsFormElement <|-- XoopsFormPassword
    XoopsFormElement <|-- XoopsFormDateTime

Text Input Elements

XoopsFormText

Single-line text input:

use XoopsFormText;

$element = new XoopsFormText(
    caption: 'Username',
    name: 'username',
    size: 30,
    maxlength: 50,
    value: $currentValue
);

XoopsFormPassword

Password input with masking:

use XoopsFormPassword;

$element = new XoopsFormPassword(
    caption: 'Password',
    name: 'password',
    size: 30,
    maxlength: 100
);

XoopsFormTextArea

Multi-line text input:

use XoopsFormTextArea;

$element = new XoopsFormTextArea(
    caption: 'Description',
    name: 'description',
    value: $currentValue,
    rows: 5,
    cols: 50
);

Selection Elements

XoopsFormSelect

Dropdown select:

use XoopsFormSelect;

$element = new XoopsFormSelect(
    caption: 'Category',
    name: 'category_id',
    value: $selected,
    size: 1,
    multiple: false
);

$element->addOption(1, 'Category 1');
$element->addOption(2, 'Category 2');
$element->addOptionArray([
    3 => 'Category 3',
    4 => 'Category 4'
]);

XoopsFormCheckBox

Checkbox input:

use XoopsFormCheckBox;

$element = new XoopsFormCheckBox(
    caption: 'Features',
    name: 'features',
    value: $selected
);

$element->addOption('comments', 'Enable Comments');
$element->addOption('ratings', 'Enable Ratings');

XoopsFormRadio

Radio button group:

use XoopsFormRadio;

$element = new XoopsFormRadio(
    caption: 'Status',
    name: 'status',
    value: $currentValue
);

$element->addOption('draft', 'Draft');
$element->addOption('published', 'Published');
$element->addOption('archived', 'Archived');

File Upload

XoopsFormFile

File upload input:

use XoopsFormFile;

$element = new XoopsFormFile(
    caption: 'Upload Image',
    name: 'image'
);

$element->setMaxFileSize(2 * 1024 * 1024); // 2MB

Date and Time

XoopsFormDateTime

Date/time picker:

use XoopsFormDateTime;

$element = new XoopsFormDateTime(
    caption: 'Publish Date',
    name: 'publish_date',
    size: 15,
    value: time()
);

Special Elements

XoopsFormHidden

Hidden field:

use XoopsFormHidden;

$element = new XoopsFormHidden('article_id', $articleId);

XoopsFormLabel

Display-only label:

use XoopsFormLabel;

$element = new XoopsFormLabel(
    caption: 'Created By',
    value: $authorName
);

XoopsFormButton

Form buttons:

use XoopsFormButton;

// Submit button
$submit = new XoopsFormButton('', 'submit', 'Save', 'submit');

// Reset button
$reset = new XoopsFormButton('', 'reset', 'Reset', 'reset');

Element Customization

Adding CSS Classes

$element->setExtra('class="form-control custom-class"');

Adding Custom Attributes

$element->setExtra('data-validate="required" placeholder="Enter text..."');

Setting Description

$element->setDescription('Enter a unique username (3-20 characters)');

Related Documentation

• Forms Overview
• Form Validation
• Custom Renderers