CakePHP 4未上传文件时如何避免触发mimeType等文件校验规则

解决方案 #

方案1：使用when()条件校验（最优） #

CakePHP Validator 原生提供when()方法用于控制规则是否触发，你可以统一为所有文件上传相关的校验绑定「仅当存在上传文件时执行」的条件，无需在每个规则内部重复写判断逻辑：

public function validationDefault(Validator $validator): Validator
{
    $validator = parent::validationDefault($validator);

    $validator
        ->allowEmptyFile('image')
        ->add('image', 'uploadError', [
            'rule' => function ($value, $context) {
                foreach ($value as $v) {
                    return Validation::uploadError($v, true);
                }
            },
            'last' => true,
            'message' => 'Upload error'
        ])
        // 仅当有文件上传时，才触发后续所有文件校验规则
        ->when(
            function ($context) {
                // 判断是否存在有效上传文件
                return isset($context['data']['image'][0]) 
                    && $context['data']['image'][0]->getError() !== UPLOAD_ERR_NO_FILE;
            },
            function (Validator $validator) {
                // 所有需要在有文件时才执行的规则都放在这个回调里
                return $validator
                    ->add('image', 'mimeType', [
                        'rule' => function ($value, $context) {
                            foreach ($value as $v) {
                                return Validation::mimeType($v, [
                                    'image/png',
                                    'image/gif',
                                    'image/pjpeg',
                                    'image/jpeg'
                                ]);
                            }
                        },
                        'message' => 'Bad mime type.',
                    ])
                    // 后续新增的文件大小、尺寸校验直接在这里加即可，无需重复写空判断
                    ->add('image', 'fileSize', [
                        'rule' => function ($value, $context) {
                            // 你的文件大小校验逻辑
                        },
                        'message' => 'File is too large.'
                    ]);
            }
        );

    return $validator;
}

该方案所有和文件内容相关的校验都收拢在when的回调内，条件统一控制，没有冗余代码，后续扩展规则成本极低。

方案2：封装公共判断方法 #

如果你不想用条件校验的写法，也可以把空文件判断抽成公共方法，所有自定义规则直接调用即可：

// 公共辅助方法可放在Trait或者通用校验类里复用
private function hasUploadedFile($value): bool
{
    return isset($value[0]) && $value[0]->getError() !== UPLOAD_ERR_NO_FILE;
}

// 校验规则中直接调用公共方法
->add('image', 'mimeType', [
    'rule' => function ($value, $context) {
        if (!$this->hasUploadedFile($value)) {
            return true;
        }
        foreach ($value as $v) {
            return Validation::mimeType($v, [
                'image/png',
                'image/gif',
                'image/pjpeg',
                'image/jpeg'
            ]);
        }
    },
    'message' => 'Bad mime type.',
])

内容的提问来源于stack exchange，提问作者Oliv