osu-web / app / Traits / Validatable.php

<?php

// Copyright (c) ppy Pty Ltd <[e-mail]>. Licensed under the GNU Affero General Public License v3.0.
// See the LICENCE file in the repository root for full licence text.

namespace App\Traits;

use App\Libraries\ValidationErrors;

trait Validatable
{
    protected $_validationErrors = null;

    abstract public function validationErrorsTranslationPrefix(): string;

    public function validationErrorsKeyBase(): string
    {
        return 'model_validation.';
    }

    public function validationErrors(): ValidationErrors
    {
        if ($this->_validationErrors === null) {
            $this->_validationErrors = new ValidationErrors(
                $this->validationErrorsTranslationPrefix(),
                $this->validationErrorsKeyBase()
            );
        }

        return $this->_validationErrors;
    }

    protected function validateFieldLength(int $limit, string $field, ?string $checkField = null): void
    {
        $checkField ??= $field;
        $val = $this->$checkField;
        if ($val !== null && mb_strlen($val) > $limit) {
            $this->validationErrors()->add($field, 'too_long', ['limit' => $limit]);
        }
    }
}