RatingFormOption.class.php

<?php

namespace wcf\system\form\option;

use wcf\system\database\table\column\AbstractDatabaseTableColumn;
use wcf\system\database\table\column\TinyintDatabaseTableColumn;
use wcf\system\form\builder\field\AbstractFormField;
use wcf\system\form\builder\field\RatingFormField;
use wcf\system\form\option\formatter\IFormOptionFormatter;
use wcf\system\form\option\formatter\RatingFormatter;

/**
 * Implementation of a form field for rating values.
 *
 * @author      Marcel Werk
 * @copyright   2001-2025 WoltLab GmbH
 * @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
 * @since       6.2
 */
class RatingFormOption extends AbstractFormOption
{
    #[\Override]
    public function getId(): string
    {
        return 'rating';
    }

    #[\Override]
    public function getFormField(string $id, array $configuration = []): AbstractFormField
    {
        return RatingFormField::create($id)
            ->nullable(empty($configuration['required']));
    }

    #[\Override]
    public function getFilterFormField(string $id, array $configuration = []): AbstractFormField
    {
        return RatingFormField::create($id)
            ->nullable();
    }

    #[\Override]
    public function getFormatter(): IFormOptionFormatter
    {
        return new RatingFormatter();
    }

    #[\Override]
    public function getDatabaseTableColumn(string $name): AbstractDatabaseTableColumn
    {
        return TinyintDatabaseTableColumn::create($name);
    }
}