90 lines
2 KiB
PHP
90 lines
2 KiB
PHP
|
<?php
|
||
|
|
/**
|
||
|
|
* @copyright Copyright (c) 2016 Roeland Jago Douma <roeland@famdouma.nl>
|
||
|
|
*
|
||
|
|
* @author Robin Appelman <robin@icewind.nl>
|
||
|
|
* @author Roeland Jago Douma <roeland@famdouma.nl>
|
||
|
|
*
|
||
|
|
* @license GNU AGPL version 3 or any later version
|
||
|
|
*
|
||
|
|
* This program is free software: you can redistribute it and/or modify
|
||
|
|
* it under the terms of the GNU Affero General Public License as
|
||
|
|
* published by the Free Software Foundation, either version 3 of the
|
||
|
|
* License, or (at your option) any later version.
|
||
|
|
*
|
||
|
|
* This program is distributed in the hope that it will be useful,
|
||
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
|
|
* GNU Affero General Public License for more details.
|
||
|
|
*
|
||
|
|
* You should have received a copy of the GNU Affero General Public License
|
||
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
|
||
|
|
namespace OCP\Files\SimpleFS;
|
||
|
|
|
||
|
|
use OCP\Files\NotFoundException;
|
||
|
|
use OCP\Files\NotPermittedException;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Interface ISimpleFolder
|
||
|
|
*
|
||
|
|
* @since 11.0.0
|
||
|
|
*/
|
||
|
|
interface ISimpleFolder {
|
||
|
|
/**
|
||
|
|
* Get all the files in a folder
|
||
|
|
*
|
||
|
|
* @return ISimpleFile[]
|
||
|
|
* @since 11.0.0
|
||
|
|
*/
|
||
|
|
public function getDirectoryListing();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Check if a file with $name exists
|
||
|
|
*
|
||
|
|
* @param string $name
|
||
|
|
* @return bool
|
||
|
|
* @since 11.0.0
|
||
|
|
*/
|
||
|
|
public function fileExists($name);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the file named $name from the folder
|
||
|
|
*
|
||
|
|
* @param string $name
|
||
|
|
* @return ISimpleFile
|
||
|
|
* @throws NotFoundException
|
||
|
|
* @since 11.0.0
|
||
|
|
*/
|
||
|
|
public function getFile($name);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Creates a new file with $name in the folder
|
||
|
|
*
|
||
|
|
* @param string $name
|
||
|
|
* @param string|resource|null $content @since 19.0.0
|
||
|
|
* @return ISimpleFile
|
||
|
|
* @throws NotPermittedException
|
||
|
|
* @since 11.0.0
|
||
|
|
*/
|
||
|
|
public function newFile($name, $content = null);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Remove the folder and all the files in it
|
||
|
|
*
|
||
|
|
* @throws NotPermittedException
|
||
|
|
* @since 11.0.0
|
||
|
|
*/
|
||
|
|
public function delete();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the folder name
|
||
|
|
*
|
||
|
|
* @return string
|
||
|
|
* @since 11.0.0
|
||
|
|
*/
|
||
|
|
public function getName();
|
||
|
|
}
|