makary/phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-06-08 04:18:52 +00:00
Code Issues Projects Releases Packages Wiki Activity

[ticket/15305] Use an aditional interface for streams

Browse source 
PHPBB3-15305
This commit is contained in:
Rubén Calvo 2017-08-07 17:15:49 +02:00
parent cd2bae63cb
commit c93c2d4007
4 changed files with 45 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
phpBB/phpbb/storage/adapter/adapter_interface.php
View file

@ -92,28 +92,4 @@ interface adapter_interface
* @throws \phpbb\storage\exception\not_implemented When the adapter doesnt implement the method * @throws \phpbb\storage\exception\not_implemented When the adapter doesnt implement the method
*/ */
public function copy($path_orig, $path_dest); public function copy($path_orig, $path_dest);
/**
* Reads a file as a stream.
*
* @param string $path File to read
*
* @throws \phpbb\storage\exception\exception When cannot open file
* @throws \phpbb\storage\exception\not_implemented When the adapter doesnt implement the method
*
* @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
* @throws \phpbb\storage\exception\not_implemented When the adapter doesnt implement the method
*/
public function write_stream($path, $resource);
} }

3
phpBB/phpbb/storage/adapter/local.php
View file

@ -13,6 +13,7 @@
namespace phpbb\storage\adapter; namespace phpbb\storage\adapter;
use phpbb\storage\stream_interface;
use phpbb\storage\exception\exception; use phpbb\storage\exception\exception;
use phpbb\filesystem\exception\filesystem_exception; use phpbb\filesystem\exception\filesystem_exception;
use phpbb\filesystem\filesystem; use phpbb\filesystem\filesystem;
@ -21,7 +22,7 @@ use phpbb\filesystem\helper as filesystem_helper;
/** /**
* @internal Experimental * @internal Experimental
*/ */
class local implements adapter_interface class local implements adapter_interface, stream_interface
{ {
/** /**
* Filesystem component * Filesystem component

7
phpBB/phpbb/storage/storage.php
View file

@ -155,8 +155,7 @@ class storage
* @param string $path File to read * @param string $path File to read
* *
* @throws \phpbb\storage\exception\exception When cannot open file * @throws \phpbb\storage\exception\exception When cannot open file
* @throws \phpbb\storage\exception\not_implemented When the adapter doesnt implement the method
*
* @return resource Returns a file pointer * @return resource Returns a file pointer
*/ */
public function read_stream($path) public function read_stream($path)
@ -169,9 +168,7 @@ class storage
* *
* @param string $path The target file * @param string $path The target file
* @param resource $resource The resource * @param resource $resource The resource
* * When target file cannot be created
* @throws \phpbb\storage\exception\exception When target file exists
* When target file cannot be created
* @throws \phpbb\storage\exception\not_implemented When the adapter doesnt implement the method * @throws \phpbb\storage\exception\not_implemented When the adapter doesnt implement the method
*/ */
public function write_stream($path, $resource) public function write_stream($path, $resource)

41
phpBB/phpbb/storage/stream_interface.php Normal file
View file

@ -0,0 +1,41 @@
<?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 cannot open file
* @throws \phpbb\storage\exception\not_implemented When the adapter doesnt implement the method
*
* @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
* @throws \phpbb\storage\exception\not_implemented When the adapter doesnt implement the method
*/
public function write_stream($path, $resource);
}