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

[ticket/15342] Update comments

Browse source 
PHPBB3-15342
This commit is contained in:
Rubén Calvo 2018-07-12 15:56:17 +02:00
parent af7e3662b8
commit e40daea4bd
7 changed files with 40 additions and 40 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -23,7 +23,7 @@ interface adapter_interface
public function configure($options); public function configure($options);
/** /**
* Dumps content into a file. * Dumps content into a file
* *
* @param string path The file to be written to. * @param string path The file to be written to.
* @param string content The data to write into the file. * @param string content The data to write into the file.
@ -47,7 +47,7 @@ interface adapter_interface
public function get_contents($path); public function get_contents($path);
/** /**
* Checks the existence of files or directories. * Checks the existence of files or directories
* *
* @param string $path file/directory to check * @param string $path file/directory to check
* *
@ -56,7 +56,7 @@ interface adapter_interface
public function exists($path); public function exists($path);
/** /**
* Removes files or directories. * Removes files or directories
* *
* @param string $path file/directory to remove * @param string $path file/directory to remove
* *
@ -65,7 +65,7 @@ interface adapter_interface
public function delete($path); public function delete($path);
/** /**
* Rename a file or a directory. * Rename a file or a directory
* *
* @param string $path_orig The original file/direcotry * @param string $path_orig The original file/direcotry
* @param string $path_dest The target file/directory * @param string $path_dest The target file/directory
@ -76,7 +76,7 @@ interface adapter_interface
public function rename($path_orig, $path_dest); public function rename($path_orig, $path_dest);
/** /**
* Copies a file. * Copies a file
* *
* @param string $path_orig The original filename * @param string $path_orig The original filename
* @param string $path_dest The target filename * @param string $path_dest The target filename
@ -87,7 +87,7 @@ interface adapter_interface
public function copy($path_orig, $path_dest); public function copy($path_orig, $path_dest);
/** /**
* Get direct link. * Get direct link
* *
* @param string $path The file * @param string $path The file
* *
@ -97,7 +97,7 @@ interface adapter_interface
public function get_link($path); public function get_link($path);
/* /*
* Get space available in bytes. * Get space available in bytes
* *
* @throws \phpbb\storage\exception\exception When unable to retrieve available storage space * @throws \phpbb\storage\exception\exception When unable to retrieve available storage space
* *

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

@ -340,7 +340,7 @@ class local implements adapter_interface, stream_interface
} }
/** /**
* Get file size. * Get file size
* *
* @param string $path The file * @param string $path The file
* *
@ -361,7 +361,7 @@ class local implements adapter_interface, stream_interface
} }
/** /**
* Get file mimetype. * Get file mimetype
* *
* @param string $path The file * @param string $path The file
* *
@ -373,7 +373,7 @@ class local implements adapter_interface, stream_interface
} }
/** /**
* Get image dimensions. * Get image dimensions
* *
* @param string $path The file * @param string $path The file
* *
@ -394,7 +394,7 @@ class local implements adapter_interface, stream_interface
} }
/** /**
* Get image width. * Get image width
* *
* @param string $path The file * @param string $path The file
* *
@ -406,7 +406,7 @@ class local implements adapter_interface, stream_interface
} }
/** /**
* Get image height. * Get image height
* *
* @param string $path The file * @param string $path The file
* *

10
phpBB/phpbb/storage/exception/exception.php
View file

@ -20,11 +20,11 @@ class exception extends runtime_exception
/** /**
* Constructor * Constructor
* *
* @param string $message The Exception message to throw (must be a language variable). * @param string $message The Exception message to throw (must be a language variable)
* @param string $filename The file that caused the error. * @param string $filename The file that caused the error
* @param array $parameters The parameters to use with the language var. * @param array $parameters The parameters to use with the language var
* @param \Exception $previous The previous runtime_exception used for the runtime_exception chaining. * @param \Exception $previous The previous runtime_exception used for the runtime_exception chaining
* @param integer $code The Exception code. * @param integer $code The Exception code
*/ */
public function __construct($message = '', $filename = '', $parameters = [], \Exception $previous = null, $code = 0) public function __construct($message = '', $filename = '', $parameters = [], \Exception $previous = null, $code = 0)
{ {

4
phpBB/phpbb/storage/file_info.php
View file

@ -34,7 +34,7 @@ class file_info
* Stores the properties of $path file, so dont have to be consulted multiple times. * Stores the properties of $path file, so dont have to be consulted multiple times.
* For example, when you need the width of an image, using getimagesize() you get * For example, when you need the width of an image, using getimagesize() you get
* both dimensions, so you store both here, and when you get the height, you dont have * both dimensions, so you store both here, and when you get the height, you dont have
* to call getimagesize() again. * to call getimagesize() again
* *
* @var array * @var array
*/ */
@ -54,7 +54,7 @@ class file_info
} }
/** /**
* Load propertys lazily. * Load propertys lazily
* *
* @param string name The property name. * @param string name The property name.
* *

8
phpBB/phpbb/storage/provider/provider_interface.php
View file

@ -16,28 +16,28 @@ namespace phpbb\storage\provider;
interface provider_interface interface provider_interface
{ {
/** /**
* Gets adapter name. * Gets adapter name
* *
* @return string * @return string
*/ */
public function get_name(); public function get_name();
/** /**
* Gets adapter class. * Gets adapter class
* *
* @return \phpbb\storage\adapter\adapter_interface * @return \phpbb\storage\adapter\adapter_interface
*/ */
public function get_adapter_class(); public function get_adapter_class();
/** /**
* Gets adapter options. * Gets adapter options
* *
* @return array Configuration keys * @return array Configuration keys
*/ */
public function get_options(); public function get_options();
/** /**
* Return true if the adapter is available. * Return true if the adapter is available
* *
* @return bool * @return bool
*/ */

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

@ -96,7 +96,7 @@ class storage
} }
/** /**
* Dumps content into a file. * Dumps content into a file
* *
* @param string path The file to be written to. * @param string path The file to be written to.
* @param string content The data to write into the file. * @param string content The data to write into the file.
@ -127,7 +127,7 @@ class storage
} }
/** /**
* Checks the existence of files or directories. * Checks the existence of files or directories
* *
* @param string $path file/directory to check * @param string $path file/directory to check
* *
@ -139,7 +139,7 @@ class storage
} }
/** /**
* Removes files or directories. * Removes files or directories
* *
* @param string $path file/directory to remove * @param string $path file/directory to remove
* *
@ -152,7 +152,7 @@ class storage
} }
/** /**
* Rename a file or a directory. * Rename a file or a directory
* *
* @param string $path_orig The original file/direcotry * @param string $path_orig The original file/direcotry
* @param string $path_dest The target file/directory * @param string $path_dest The target file/directory
@ -167,7 +167,7 @@ class storage
} }
/** /**
* Copies a file. * Copies a file
* *
* @param string $path_orig The original filename * @param string $path_orig The original filename
* @param string $path_dest The target filename * @param string $path_dest The target filename
@ -182,7 +182,7 @@ class storage
} }
/** /**
* Reads a file as a stream. * Reads a file as a stream
* *
* @param string $path File to read * @param string $path File to read
* *
@ -211,8 +211,8 @@ class storage
} }
/** /**
* Writes a new file using a stream. * Writes a new file using a stream
* You have to track file after use this method * The file needs to be tracked after using this method
* *
* @param string $path The target file * @param string $path The target file
* @param resource $resource The resource * @param resource $resource The resource
@ -235,7 +235,7 @@ class storage
} }
/** /**
* Track file into database. * Track file in database
* *
* @param string $path The target file * @param string $path The target file
* @param bool $update Update file size when already tracked * @param bool $update Update file size when already tracked
@ -276,7 +276,7 @@ class storage
} }
/** /**
* Untrack file. * Untrack file
* *
* @param string $path The target file * @param string $path The target file
*/ */
@ -296,7 +296,7 @@ class storage
} }
/** /**
* Rename tracked file. * Rename tracked file
* *
* @param string $path_orig The original file/direcotry * @param string $path_orig The original file/direcotry
* @param string $path_dest The target file/directory * @param string $path_dest The target file/directory
@ -311,7 +311,7 @@ class storage
} }
/** /**
* Get file info. * Get file info
* *
* @param string $path The file * @param string $path The file
* *
@ -338,7 +338,7 @@ class storage
} }
/** /**
* Get total storage size. * Get total storage size
* *
* @return int Size in bytes * @return int Size in bytes
*/ */
@ -363,7 +363,7 @@ class storage
} }
/** /**
* Get number of storage files. * Get number of storage files
* *
* @return int Number of files * @return int Number of files
*/ */
@ -388,7 +388,7 @@ class storage
} }
/** /**
* Get space available in bytes. * Get space available in bytes
* *
* @throws \phpbb\storage\exception\exception When unable to retrieve available storage space * @throws \phpbb\storage\exception\exception When unable to retrieve available storage space
* *

4
phpBB/phpbb/storage/stream_interface.php
View file

@ -16,7 +16,7 @@ namespace phpbb\storage;
interface stream_interface interface stream_interface
{ {
/** /**
* Reads a file as a stream. * Reads a file as a stream
* *
* @param string $path File to read * @param string $path File to read
* *
@ -27,7 +27,7 @@ interface stream_interface
public function read_stream($path); public function read_stream($path);
/** /**
* Writes a new file using a stream. * Writes a new file using a stream
* *
* @param string $path The target file * @param string $path The target file
* @param resource $resource The resource * @param resource $resource The resource