mirror of
https://github.com/nextcloud/server.git
synced 2024-12-29 00:18:42 +00:00
46f1efac41
Co-authored-by: Ferdinand Thiessen <opensource@fthiessen.de> Co-authored-by: Côme Chilliet <91878298+come-nc@users.noreply.github.com> Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
40 lines
1.1 KiB
PHP
40 lines
1.1 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
/**
|
|
* SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
|
|
* SPDX-License-Identifier: AGPL-3.0-or-later
|
|
*/
|
|
namespace OCP\Files;
|
|
|
|
/**
|
|
* @since 30.0.0
|
|
*/
|
|
interface IFilenameValidator {
|
|
|
|
/**
|
|
* It is recommended to use `\OCP\Files\Storage\IStorage::isFileValid` instead as this
|
|
* only checks if the filename is valid in general but not for a specific storage
|
|
* which might have additional naming rules.
|
|
*
|
|
* @param string $filename The filename to check for validity
|
|
* @return bool
|
|
* @since 30.0.0
|
|
*/
|
|
public function isFilenameValid(string $filename): bool;
|
|
|
|
/**
|
|
* It is recommended to use `\OCP\Files\Storage\IStorage::isFileValid` instead as this
|
|
* only checks if the filename is valid in general but not for a specific storage
|
|
* which might have additional naming rules.
|
|
*
|
|
* This will validate a filename and throw an exception with details on error.
|
|
*
|
|
* @param string $filename The filename to check for validity
|
|
* @throws \OCP\Files\InvalidPathException or one of its child classes in case of an error
|
|
* @since 30.0.0
|
|
*/
|
|
public function validateFilename(string $filename): void;
|
|
}
|