mirror of
https://github.com/phpbb/phpbb.git
synced 2025-05-20 22:39:55 +02:00
108 lines
2.5 KiB
PHP
108 lines
2.5 KiB
PHP
<?php
|
|
/**
|
|
*
|
|
* This file is part of the phpBB Forum Software package.
|
|
*
|
|
* @copyright (c) phpBB Limited <https://www.phpbb.com>
|
|
* @license GNU General Public License, version 2 (GPL-2.0)
|
|
*
|
|
* For full copyright and license information, please see
|
|
* the docs/CREDITS.txt file.
|
|
*
|
|
*/
|
|
|
|
namespace phpbb\storage\adapter;
|
|
|
|
interface adapter_interface
|
|
{
|
|
/**
|
|
* Set adapter parameters
|
|
*
|
|
* @param array options Storage-specific options.
|
|
*/
|
|
public function configure($options);
|
|
|
|
/**
|
|
* Dumps content into a file
|
|
*
|
|
* @param string path The file to be written to.
|
|
* @param string content The data to write into the file.
|
|
*
|
|
* @throws \phpbb\storage\exception\exception When the file already exists
|
|
* When the file cannot be written
|
|
*/
|
|
public function put_contents($path, $content);
|
|
|
|
/**
|
|
* Read the contents of a file
|
|
*
|
|
* @param string $path The file to read
|
|
*
|
|
* @throws \phpbb\storage\exception\exception When the file doesn't exist
|
|
* When cannot read file contents
|
|
*
|
|
* @return string Returns file contents
|
|
*
|
|
*/
|
|
public function get_contents($path);
|
|
|
|
/**
|
|
* Checks the existence of files or directories
|
|
*
|
|
* @param string $path file/directory to check
|
|
*
|
|
* @return bool Returns true if the file/directory exist, false otherwise.
|
|
*/
|
|
public function exists($path);
|
|
|
|
/**
|
|
* Removes files or directories
|
|
*
|
|
* @param string $path file/directory to remove
|
|
*
|
|
* @throws \phpbb\storage\exception\exception When removal fails.
|
|
*/
|
|
public function delete($path);
|
|
|
|
/**
|
|
* Rename a file or a directory
|
|
*
|
|
* @param string $path_orig The original file/direcotry
|
|
* @param string $path_dest The target file/directory
|
|
*
|
|
* @throws \phpbb\storage\exception\exception When target exists
|
|
* When file/directory cannot be renamed
|
|
*/
|
|
public function rename($path_orig, $path_dest);
|
|
|
|
/**
|
|
* Copies a file
|
|
*
|
|
* @param string $path_orig The original filename
|
|
* @param string $path_dest The target filename
|
|
*
|
|
* @throws \phpbb\storage\exception\exception When target exists
|
|
* When the file cannot be copied
|
|
*/
|
|
public function copy($path_orig, $path_dest);
|
|
|
|
/**
|
|
* Get direct link
|
|
*
|
|
* @param string $path The file
|
|
*
|
|
* @return string Returns link.
|
|
*
|
|
*/
|
|
public function get_link($path);
|
|
|
|
/*
|
|
* Get space available in bytes
|
|
*
|
|
* @throws \phpbb\storage\exception\exception When unable to retrieve available storage space
|
|
*
|
|
* @return float Returns available space
|
|
*/
|
|
public function free_space();
|
|
}
|