Merge pull request #5987 from WoltLab/acp-dahsboard-box-hight

[GitHub/WoltLab/WCF.git] / wcfsetup / install / files / lib / system / option / TextOptionType.class.php

<?php

namespace wcf\system\option;

use wcf\data\option\Option;
use wcf\data\user\User;
use wcf\data\user\UserList;
use wcf\system\database\util\PreparedStatementConditionBuilder;
use wcf\system\exception\UserInputException;
use wcf\system\WCF;
use wcf\util\StringUtil;

/**
 * Option type implementation for textual input fields.
 *
 * @author  Marcel Werk
 * @copyright   2001-2019 WoltLab GmbH
 * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
 */
class TextOptionType extends AbstractOptionType implements ISearchableConditionUserOption
{
    /**
     * input type
     * @var string
     */
    protected $inputType = 'text';

    /**
     * input css class
     * @var string
     */
    protected $inputClass = 'long';

    /**
     * if `true`, the option is considered as being searched when generating the form element
     * @var bool
     */
    public $forceSearchOption = false;

    /**
     * @inheritDoc
     */
    public function getFormElement(Option $option, $value)
    {
        WCF::getTPL()->assign([
            'option' => $option,
            'inputType' => $this->inputType,
            'inputClass' => $this->inputClass,
            'value' => $value,
        ]);

        return WCF::getTPL()->fetch('textOptionType');
    }

    /**
     * @inheritDoc
     */
    public function getSearchFormElement(Option $option, $value)
    {
        WCF::getTPL()->assign([
            'option' => $option,
            'inputType' => $this->inputType,
            'inputClass' => $this->inputClass,
            'searchOption' => $this->forceSearchOption || ($value !== null && $value !== $option->defaultValue) || isset($_POST['searchOptions'][$option->optionName]),
            'value' => $value,
        ]);

        return WCF::getTPL()->fetch('textSearchableOptionType');
    }

    /**
     * @inheritDoc
     */
    public function getCondition(PreparedStatementConditionBuilder &$conditions, Option $option, $value)
    {
        if (!isset($_POST['searchOptions'][$option->optionName])) {
            return false;
        }

        $value = StringUtil::trim($value ?: '');
        if ($value == '') {
            $conditions->add("option_value.userOption" . $option->optionID . " = ?", ['']);
        } else {
            $conditions->add(
                "option_value.userOption" . $option->optionID . " LIKE ?",
                ['%' . \addcslashes($value, '_%') . '%']
            );
        }

        return true;
    }

    /**
     * @inheritDoc
     */
    public function validate(Option $option, $newValue)
    {
        $newValue = $this->getContent($option, $newValue);

        if ($option->minlength !== null && $option->minlength > \mb_strlen($newValue)) {
            throw new UserInputException($option->optionName, 'tooShort');
        }
        if ($option->maxlength !== null && $option->maxlength < \mb_strlen($newValue)) {
            throw new UserInputException($option->optionName, 'tooLong');
        }
    }

    /**
     * @inheritDoc
     */
    public function getData(Option $option, $newValue)
    {
        return $this->getContent($option, $newValue);
    }

    /**
     * Tries to extract content from value.
     *
     * @param Option $option
     * @param string $newValue
     * @return  string
     */
    protected function getContent(Option $option, $newValue)
    {
        if ($option->contentpattern) {
            if (\preg_match('~' . $option->contentpattern . '~', $newValue, $matches)) {
                unset($matches[0]);
                $newValue = \implode('', $matches);
            }
        }

        return $newValue;
    }

    /**
     * @inheritDoc
     */
    public function addCondition(UserList $userList, Option $option, $value)
    {
        $value = StringUtil::trim($value);
        if ($value == '') {
            $userList->getConditionBuilder()->add('user_option_value.userOption' . $option->optionID . ' = ?', ['']);
        } else {
            $userList->getConditionBuilder()->add(
                'user_option_value.userOption' . $option->optionID . ' LIKE ?',
                ['%' . \addcslashes($value, '_%') . '%']
            );
        }
    }

    /**
     * @inheritDoc
     */
    public function checkUser(User $user, Option $option, $value)
    {
        $value = StringUtil::trim($value);
        if ($value == '') {
            return $user->getUserOption($option->optionName) == '';
        } else {
            return \mb_stripos($user->getUserOption($option->optionName), $value) !== false;
        }
    }

    /**
     * @inheritDoc
     */
    public function getConditionData(Option $option, $newValue)
    {
        return $newValue;
    }

    /**
     * @inheritDoc
     */
    public function hideLabelInSearch()
    {
        return true;
    }
}