php/yii2
1
0
Fork 0
mirror of https://github.com/yiisoft/yii2.git synced 2025-08-14 14:28:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix phpdoc in BaseFileHelper (#18928)

Browse Source
This commit is contained in:
Anton
2021-10-03 16:31:37 +03:00
committed by GitHub
parent ccf979196c
commit 0181a49bb4
1 changed files with 16 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
framework/helpers/BaseFileHelper.php
View File

@ -99,13 +99,12 @@ class BaseFileHelper
* "path/to/zh-CN/view.php". If the file is not found, it will try a fallback with just a language code that is
* "zh" i.e. "path/to/zh/view.php". If it is not found as well the original file will be returned.
*
* If the target and the source language codes are the same,
* the original file will be returned.
* If the target and the source language codes are the same, the original file will be returned.
*
* @param string $file the original file
* @param string $language the target language that the file should be localized to.
* @param string|null $language the target language that the file should be localized to.
* If not set, the value of [[\yii\base\Application::language]] will be used.
* @param string $sourceLanguage the language that the original file is in.
* @param string|null $sourceLanguage the language that the original file is in.
* If not set, the value of [[\yii\base\Application::sourceLanguage]] will be used.
* @return string the matching localized file, or the original file if the localized version is not found.
* If the target and the source language codes are the same, the original file will be returned.
@ -141,7 +140,7 @@ class BaseFileHelper
* [finfo_open](https://secure.php.net/manual/en/function.finfo-open.php). If the `fileinfo` extension is not installed,
* it will fall back to [[getMimeTypeByExtension()]] when `$checkExtension` is true.
* @param string $file the file name.
* @param string $magicFile name of the optional magic database file (or alias), usually something like `/path/to/magic.mime`.
* @param string|null $magicFile name of the optional magic database file (or alias), usually something like `/path/to/magic.mime`.
* This will be passed as the second parameter to [finfo_open()](https://secure.php.net/manual/en/function.finfo-open.php)
* when the `fileinfo` extension is installed. If the MIME type is being determined based via [[getMimeTypeByExtension()]]
* and this is null, it will use the file specified by [[mimeMagicFile]].
@ -180,7 +179,7 @@ class BaseFileHelper
* Determines the MIME type based on the extension name of the specified file.
* This method will use a local map between extension names and MIME types.
* @param string $file the file name.
* @param string $magicFile the path (or alias) of the file that contains all available MIME type information.
* @param string|null $magicFile the path (or alias) of the file that contains all available MIME type information.
* If this is not set, the file specified by [[mimeMagicFile]] will be used.
* @return string|null the MIME type. Null is returned if the MIME type cannot be determined.
*/
@ -202,7 +201,7 @@ class BaseFileHelper
* Determines the extensions by given MIME type.
* This method will use a local map between extension names and MIME types.
* @param string $mimeType file MIME type.
* @param string $magicFile the path (or alias) of the file that contains all available MIME type information.
* @param string|null $magicFile the path (or alias) of the file that contains all available MIME type information.
* If this is not set, the file specified by [[mimeMagicFile]] will be used.
* @return array the extensions corresponding to the specified MIME type
*/
@ -503,13 +502,14 @@ class BaseFileHelper
* @param array $options options for directory searching. Valid options are:
*
* - `filter`: callback, a PHP callback that is called for each directory or file.
* The signature of the callback should be: `function ($path)`, where `$path` refers the full path to be filtered.
* The callback can return one of the following values:
* The signature of the callback should be: `function (string $path): bool`, where `$path` refers
* the full path to be filtered. The callback can return one of the following values:
*
* * `true`: the directory will be returned
* * `false`: the directory will NOT be returned
*
* - `recursive`: boolean, whether the files under the subdirectories should also be looked for. Defaults to `true`.
* See [[findFiles()]] for more options.
* @return array directories found under the directory, in no particular order. Ordering depends on the files system used.
* @throws InvalidArgumentException if the dir is invalid.
* @since 2.0.14
@ -539,6 +539,8 @@ class BaseFileHelper
/**
* @param string $dir
* @param array $options
* @return array
*/
private static function setBasePath($dir, $options)
{
@ -553,6 +555,8 @@ class BaseFileHelper
/**
* @param string $dir
* @return resource
* @throws InvalidArgumentException if unable to open directory
*/
private static function openDir($dir)
{
@ -565,13 +569,15 @@ class BaseFileHelper
/**
* @param string $dir
* @return string
* @throws InvalidArgumentException if directory not exists
*/
private static function clearDir($dir)
{
if (!is_dir($dir)) {
throw new InvalidArgumentException("The dir argument must be a directory: $dir");
}
return rtrim($dir, DIRECTORY_SEPARATOR);
return rtrim($dir, '\/');
}
/**