[Filesystem] Fixed some docblocks and typos
This commit is contained in:
parent
590850fe29
commit
972b971129
@ -21,7 +21,7 @@ interface IOExceptionInterface extends ExceptionInterface
|
||||
/**
|
||||
* Returns the associated path for the exception.
|
||||
*
|
||||
* @return string The path
|
||||
* @return string|null The path
|
||||
*/
|
||||
public function getPath();
|
||||
}
|
||||
|
@ -137,8 +137,8 @@ class Filesystem
|
||||
* Sets access and modification time of file.
|
||||
*
|
||||
* @param string|iterable $files A filename, an array of files, or a \Traversable instance to create
|
||||
* @param int $time The touch time as a Unix timestamp
|
||||
* @param int $atime The access time as a Unix timestamp
|
||||
* @param int|null $time The touch time as a Unix timestamp, if not supplied the current system time is used
|
||||
* @param int|null $atime The access time as a Unix timestamp, if not supplied the current system time is used
|
||||
*
|
||||
* @throws IOException When touch fails
|
||||
*/
|
||||
@ -193,7 +193,7 @@ class Filesystem
|
||||
* @param int $umask The mode mask (octal)
|
||||
* @param bool $recursive Whether change the mod recursively or not
|
||||
*
|
||||
* @throws IOException When the change fail
|
||||
* @throws IOException When the change fails
|
||||
*/
|
||||
public function chmod($files, $mode, $umask = 0000, $recursive = false)
|
||||
{
|
||||
@ -214,7 +214,7 @@ class Filesystem
|
||||
* @param string $user The new owner user name
|
||||
* @param bool $recursive Whether change the owner recursively or not
|
||||
*
|
||||
* @throws IOException When the change fail
|
||||
* @throws IOException When the change fails
|
||||
*/
|
||||
public function chown($files, $user, $recursive = false)
|
||||
{
|
||||
@ -241,7 +241,7 @@ class Filesystem
|
||||
* @param string $group The group name
|
||||
* @param bool $recursive Whether change the group recursively or not
|
||||
*
|
||||
* @throws IOException When the change fail
|
||||
* @throws IOException When the change fails
|
||||
*/
|
||||
public function chgrp($files, $group, $recursive = false)
|
||||
{
|
||||
@ -519,14 +519,14 @@ class Filesystem
|
||||
* - existing files in the target directory will be overwritten, except if they are newer (see the `override` option)
|
||||
* - files in the target directory that do not exist in the source directory will not be deleted (see the `delete` option)
|
||||
*
|
||||
* @param string $originDir The origin directory
|
||||
* @param string $targetDir The target directory
|
||||
* @param \Traversable $iterator Iterator that filters which files and directories to copy
|
||||
* @param array $options An array of boolean options
|
||||
* Valid options are:
|
||||
* - $options['override'] If true, target files newer than origin files are overwritten (see copy(), defaults to false)
|
||||
* - $options['copy_on_windows'] Whether to copy files instead of links on Windows (see symlink(), defaults to false)
|
||||
* - $options['delete'] Whether to delete files that are not in the source directory (defaults to false)
|
||||
* @param string $originDir The origin directory
|
||||
* @param string $targetDir The target directory
|
||||
* @param \Traversable|null $iterator Iterator that filters which files and directories to copy, if null a recursive iterator is created
|
||||
* @param array $options An array of boolean options
|
||||
* Valid options are:
|
||||
* - $options['override'] If true, target files newer than origin files are overwritten (see copy(), defaults to false)
|
||||
* - $options['copy_on_windows'] Whether to copy files instead of links on Windows (see symlink(), defaults to false)
|
||||
* - $options['delete'] Whether to delete files that are not in the source directory (defaults to false)
|
||||
*
|
||||
* @throws IOException When file type is unknown
|
||||
*/
|
||||
|
Reference in New Issue
Block a user