1
0
mirror of https://github.com/phpbb/phpbb.git synced 2025-05-04 14:47:52 +02:00
php-phpbb/phpBB/phpbb/storage/stream_interface.php
Rubén Calvo e40daea4bd [ticket/15342] Update comments
PHPBB3-15342
2018-07-12 15:56:17 +02:00

40 lines
901 B
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;
interface stream_interface
{
/**
* Reads a file as a stream
*
* @param string $path File to read
*
* @throws \phpbb\storage\exception\exception When unable to open file
*
* @return resource Returns a file pointer
*/
public function read_stream($path);
/**
* Writes a new file using a stream
*
* @param string $path The target file
* @param resource $resource The resource
*
* @throws \phpbb\storage\exception\exception When target file exists
* When target file cannot be created
*/
public function write_stream($path, $resource);
}