diff --git a/core/modules/file/file.api.php b/core/modules/file/file.api.php index 23a02915fe70..c7994ff72314 100644 --- a/core/modules/file/file.api.php +++ b/core/modules/file/file.api.php @@ -18,7 +18,7 @@ * * @param \Drupal\file\FileInterface $file * The file entity being validated. - * @return + * @return array * An array of error messages. If there are no problems with the file return * an empty array. * diff --git a/core/modules/file/file.module b/core/modules/file/file.module index 7d36c58d5ee5..9d1592de3e8a 100644 --- a/core/modules/file/file.module +++ b/core/modules/file/file.module @@ -53,7 +53,7 @@ function file_help($route_name, RouteMatchInterface $route_match) { * * @param array $fids * (optional) An array of entity IDs. If omitted, all entities are loaded. - * @param $reset + * @param bool $reset * Whether to reset the internal file_load_multiple() cache. * * @return array @@ -77,9 +77,9 @@ function file_load_multiple(array $fids = NULL, $reset = FALSE) { /** * Loads a single file entity from the database. * - * @param $fid + * @param int $fid * A file ID. - * @param $reset + * @param bool $reset * Whether to reset the internal file_load_multiple() cache. * * @return \Drupal\file\FileInterface @@ -116,10 +116,10 @@ function file_load($fid, $reset = FALSE) { * * @param \Drupal\file\FileInterface $source * A file entity. - * @param $destination + * @param string $destination * A string containing the destination that $source should be copied to. * This must be a stream wrapper URI. - * @param $replace + * @param int $replace * Replace behavior when the destination file already exists: * - FILE_EXISTS_REPLACE - Replace the existing file. If a managed file with * the destination name exists then its database entry will be updated. If @@ -128,7 +128,7 @@ function file_load($fid, $reset = FALSE) { * unique. * - FILE_EXISTS_ERROR - Do nothing and return FALSE. * - * @return + * @return \Drupal\file\FileInterface|FALSE * File object if the copy is successful, or FALSE in the event of an error. * * @see file_unmanaged_copy() @@ -191,10 +191,10 @@ function file_copy(FileInterface $source, $destination = NULL, $replace = FILE_E * * @param \Drupal\file\FileInterface $source * A file entity. - * @param $destination + * @param string $destination * A string containing the destination that $source should be moved to. * This must be a stream wrapper URI. - * @param $replace + * @param int $replace * Replace behavior when the destination file already exists: * - FILE_EXISTS_REPLACE - Replace the existing file. If a managed file with * the destination name exists then its database entry will be updated and @@ -267,7 +267,7 @@ function file_move(FileInterface $source, $destination = NULL, $replace = FILE_E * * @param \Drupal\file\FileInterface $file * A file entity. - * @param $validators + * @param array $validators * An optional, associative array of callback functions used to validate the * file. The keys are function names and the values arrays of callback * parameters which will be passed in after the file entity. The @@ -275,7 +275,7 @@ function file_move(FileInterface $source, $destination = NULL, $replace = FILE_E * indicates that the file passed validation. The functions will be called in * the order specified. * - * @return + * @return array * An array containing validation error messages. * * @see hook_file_validate() @@ -300,7 +300,7 @@ function file_validate(FileInterface $file, $validators = array()) { * @param \Drupal\file\FileInterface $file * A file entity. * - * @return + * @return array * An array. If the file name is too long, it will contain an error message. */ function file_validate_name_length(FileInterface $file) { @@ -320,10 +320,10 @@ function file_validate_name_length(FileInterface $file) { * * @param \Drupal\file\FileInterface $file * A file entity. - * @param $extensions + * @param string $extensions * A string with a space separated list of allowed extensions. * - * @return + * @return array * An array. If the file extension is not allowed, it will contain an error * message. * @@ -344,14 +344,14 @@ function file_validate_extensions(FileInterface $file, $extensions) { * * @param \Drupal\file\FileInterface $file * A file entity. - * @param $file_limit + * @param int $file_limit * An integer specifying the maximum file size in bytes. Zero indicates that * no limit should be enforced. - * @param $user_limit + * @param int $user_limit * An integer specifying the maximum number of bytes the user is allowed. * Zero indicates that no limit should be enforced. * - * @return + * @return array * An array. If the file size exceeds limits, it will contain an error * message. * @@ -379,7 +379,7 @@ function file_validate_size(FileInterface $file, $file_limit = 0, $user_limit = * @param \Drupal\file\FileInterface $file * A file entity. * - * @return + * @return array * An array. If the file is not an image, it will contain an error message. * * @see hook_file_validate() @@ -405,12 +405,12 @@ function file_validate_is_image(FileInterface $file) { * * @param \Drupal\file\FileInterface $file * A file entity. This function may resize the file affecting its size. - * @param $maximum_dimensions + * @param string $maximum_dimensions * An optional string in the form WIDTHxHEIGHT e.g. '640x480' or '85x85'. If * an image toolkit is installed the image will be resized down to these * dimensions. A value of 0 indicates no restriction on size, so resizing * will be attempted. - * @param $minimum_dimensions + * @param string $minimum_dimensions * An optional string in the form WIDTHxHEIGHT. This will check that the * image meets a minimum size. A value of 0 indicates no restriction. * @@ -458,13 +458,13 @@ function file_validate_image_resolution(FileInterface $file, $maximum_dimensions /** * Saves a file to the specified destination and creates a database entry. * - * @param $data + * @param string $data * A string containing the contents of the file. - * @param $destination + * @param string $destination * A string containing the destination URI. This must be a stream wrapper URI. * If no value is provided, a randomized name will be generated and the file * will be saved using Drupal's default files scheme, usually "public://". - * @param $replace + * @param int $replace * Replace behavior when the destination file already exists: * - FILE_EXISTS_REPLACE - Replace the existing file. If a managed file with * the destination name exists then its database entry will be updated. If @@ -527,7 +527,7 @@ function file_save_data($data, $destination = NULL, $replace = FILE_EXISTS_RENAM * @param \Drupal\file\FileInterface $file * A file entity. * - * @return + * @return array * An associative array of headers, as expected by * \Symfony\Component\HttpFoundation\StreamedResponse. */ @@ -665,10 +665,10 @@ function file_cron() { * Temporary files are periodically cleaned. Use the 'file.usage' service to * register the usage of the file which will automatically mark it as permanent. * - * @param $form_field_name + * @param string $form_field_name * A string that is the associative array key of the upload form element in * the form array. - * @param $validators + * @param array $validators * An optional, associative array of callback functions used to validate the * file. See file_validate() for a full discussion of the array format. * If no extension validator is provided it will default to a limited safe @@ -677,20 +677,20 @@ function file_cron() { * explicitly set the 'file_validate_extensions' validator to an empty array * (Beware: this is not safe and should only be allowed for trusted users, if * at all). - * @param $destination + * @param string $destination * A string containing the URI that the file should be copied to. This must * be a stream wrapper URI. If this value is omitted, Drupal's temporary * files scheme will be used ("temporary://"). - * @param $delta + * @param int $delta * Delta of the file to save or NULL to save all files. Defaults to NULL. - * @param $replace + * @param int $replace * Replace behavior when the destination file already exists: * - FILE_EXISTS_REPLACE: Replace the existing file. * - FILE_EXISTS_RENAME: Append _{incrementing number} until the filename is * unique. * - FILE_EXISTS_ERROR: Do nothing and return FALSE. * - * @return + * @return array * Function returns array of files or a single file object if $delta * != NULL. Each file object contains the file information if the * upload succeeded or FALSE in the event of an error. Function @@ -906,7 +906,7 @@ function file_save_upload($form_field_name, $validators = array(), $destination /** * Determines the preferred upload progress implementation. * - * @return + * @return string|FALSE * A string indicating which upload progress system is available. Either "apc" * or "uploadprogress". If neither are available, returns FALSE. */ @@ -1144,12 +1144,12 @@ function file_managed_file_submit($form, FormStateInterface $form_state) { /** * Saves any files that have been uploaded into a managed_file element. * - * @param $element + * @param array $element * The FAPI element whose values are being saved. * @param \Drupal\Core\Form\FormStateInterface $form_state * The current state of the form. * - * @return + * @return array * An array of file entities for each file that was saved, keyed by its file * ID, or FALSE if no files were saved. */ @@ -1291,7 +1291,7 @@ function file_icon_class($mime_type) { * @param string $mime_type * A MIME type. * - * @return + * @return string|FALSE * The generic icon MIME package expected for this file. */ function file_icon_map($mime_type) { @@ -1427,19 +1427,19 @@ function file_icon_map($mime_type) { * @param \Drupal\Core\Field\FieldDefinitionInterface $field * (optional) A field definition to be used for this check. If given, limits the * reference check to the given field. - * @param $age + * @param int $age * (optional) A constant that specifies which references to count. Use * EntityStorageInterface::FIELD_LOAD_REVISION to retrieve all * references within all revisions or * EntityStorageInterface::FIELD_LOAD_CURRENT to retrieve references * only in the current revisions. - * @param $field_type + * @param string $field_type * (optional) The name of a field type. If given, limits the reference check * to fields of the given type. If both $field and $field_type is given but * $field is not the same type as $field_type, an empty array will be * returned. * - * @return + * @return array * A multidimensional array. The keys are field_name, entity_type, * entity_id and the value is an entity referencing this file. * diff --git a/core/modules/file/src/Plugin/Field/FieldType/FileItem.php b/core/modules/file/src/Plugin/Field/FieldType/FileItem.php index 0631289fced8..f609b70ad72a 100644 --- a/core/modules/file/src/Plugin/Field/FieldType/FileItem.php +++ b/core/modules/file/src/Plugin/Field/FieldType/FileItem.php @@ -256,10 +256,10 @@ class FileItem extends EntityReferenceItem { /** * Determines the URI for a file field. * - * @param $data + * @param array $data * An array of token objects to pass to token_replace(). * - * @return + * @return string * A file directory URI with tokens replaced. * * @see token_replace() @@ -277,7 +277,7 @@ class FileItem extends EntityReferenceItem { /** * Retrieves the upload validators for a file field. * - * @return + * @return array * An array suitable for passing to file_save_upload() or the file field * element's '#upload_validators' property. */ diff --git a/core/modules/file/src/Plugin/views/argument/Fid.php b/core/modules/file/src/Plugin/views/argument/Fid.php index 0015823ee88b..b21e96eff921 100644 --- a/core/modules/file/src/Plugin/views/argument/Fid.php +++ b/core/modules/file/src/Plugin/views/argument/Fid.php @@ -48,7 +48,7 @@ class Fid extends NumericArgument implements ContainerFactoryPluginInterface { * The plugin implementation definition. * @param \Drupal\Core\Entity\EntityManagerInterface $entity_manager * The entity manager. - * @param \Drupal\Core\Entity\Query\QueryFactory + * @param \Drupal\Core\Entity\Query\QueryFactory $entity_query * The entity query factory. */ public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityManagerInterface $entity_manager, QueryFactory $entity_query) { diff --git a/core/modules/file/src/Tests/DownloadTest.php b/core/modules/file/src/Tests/DownloadTest.php index 811ea3334e3f..3dc83421aa9e 100644 --- a/core/modules/file/src/Tests/DownloadTest.php +++ b/core/modules/file/src/Tests/DownloadTest.php @@ -130,14 +130,14 @@ class DownloadTest extends FileManagedTestBase { * the URL generated by file_create_url() for the specified file equals the * specified URL; fetch the URL and then compare the contents to the file. * - * @param $scheme - * A scheme, e.g. "public" - * @param $directory - * A directory, possibly "" - * @param $filename - * A filename - * @param $expected_url - * The expected URL + * @param string $scheme + * A scheme, e.g. "public". + * @param string $directory + * A directory, possibly "". + * @param string $filename + * A filename. + * @param string $expected_url + * The expected URL. */ private function checkUrl($scheme, $directory, $filename, $expected_url) { // Convert $filename to a valid filename, i.e. strip characters not diff --git a/core/modules/file/src/Tests/FileFieldPathTest.php b/core/modules/file/src/Tests/FileFieldPathTest.php index 6de342a7cd87..4b3c3de88c8a 100644 --- a/core/modules/file/src/Tests/FileFieldPathTest.php +++ b/core/modules/file/src/Tests/FileFieldPathTest.php @@ -65,12 +65,12 @@ class FileFieldPathTest extends FileFieldTestBase { /** * Asserts that a file is uploaded to the right location. * - * @param $expected_path + * @param string $expected_path * The location where the file is expected to be uploaded. Duplicate file * names to not need to be taken into account. - * @param $actual_path + * @param string $actual_path * Where the file was actually uploaded. - * @param $message + * @param string $message * The message to display with this assertion. */ function assertPathMatch($expected_path, $actual_path, $message) { diff --git a/core/modules/file/src/Tests/FileFieldTestBase.php b/core/modules/file/src/Tests/FileFieldTestBase.php index e0da957d1339..d0d4cfa404a1 100644 --- a/core/modules/file/src/Tests/FileFieldTestBase.php +++ b/core/modules/file/src/Tests/FileFieldTestBase.php @@ -61,17 +61,17 @@ abstract class FileFieldTestBase extends WebTestBase { /** * Creates a new file field. * - * @param $name + * @param string $name * The name of the new field (all lowercase), exclude the "field_" prefix. - * @param $entity_type + * @param string $entity_type * The entity type. - * @param $bundle + * @param string $bundle * The bundle that this field will be added to. - * @param $storage_settings + * @param array $storage_settings * A list of field storage settings that will be added to the defaults. - * @param $field_settings + * @param array $field_settings * A list of instance settings that will be added to the instance defaults. - * @param $widget_settings + * @param array $widget_settings * A list of widget settings that will be added to the widget defaults. */ function createFileField($name, $entity_type, $bundle, $storage_settings = array(), $field_settings = array(), $widget_settings = array()) { @@ -91,15 +91,15 @@ abstract class FileFieldTestBase extends WebTestBase { /** * Attaches a file field to an entity. * - * @param $name + * @param string $name * The name of the new field (all lowercase), exclude the "field_" prefix. - * @param $entity_type + * @param string $entity_type * The entity type this field will be added to. - * @param $bundle + * @param string $bundle * The bundle this field will be added to. - * @param $field_settings + * @param array $field_settings * A list of field settings that will be added to the defaults. - * @param $widget_settings + * @param array $widget_settings * A list of widget settings that will be added to the widget defaults. */ function attachFileField($name, $entity_type, $bundle, $field_settings = array(), $widget_settings = array()) { diff --git a/core/modules/file/src/Tests/FileManagedTestBase.php b/core/modules/file/src/Tests/FileManagedTestBase.php index 031a1a766078..e26ccd32a9d0 100644 --- a/core/modules/file/src/Tests/FileManagedTestBase.php +++ b/core/modules/file/src/Tests/FileManagedTestBase.php @@ -33,7 +33,7 @@ abstract class FileManagedTestBase extends WebTestBase { * Assert that all of the specified hook_file_* hooks were called once, other * values result in failure. * - * @param $expected + * @param array $expected * Array with string containing with the hook name, e.g. 'load', 'save', * 'insert', etc. */ @@ -65,11 +65,11 @@ abstract class FileManagedTestBase extends WebTestBase { /** * Assert that a hook_file_* hook was called a certain number of times. * - * @param $hook + * @param string $hook * String with the hook name, e.g. 'load', 'save', 'insert', etc. - * @param $expected_count + * @param int $expected_count * Optional integer count. - * @param $message + * @param string|NULL $message * Optional translated string message. */ function assertFileHookCalled($hook, $expected_count = 1, $message = NULL) { @@ -137,13 +137,13 @@ abstract class FileManagedTestBase extends WebTestBase { * Create a file and save it to the files table and assert that it occurs * correctly. * - * @param $filepath + * @param string $filepath * Optional string specifying the file path. If none is provided then a * randomly named file will be created in the site's files directory. - * @param $contents + * @param string $contents * Optional contents to save into the file. If a NULL value is provided an * arbitrary string will be used. - * @param $scheme + * @param string $scheme * Optional string indicating the stream scheme to use. Drupal core includes * public, private, and temporary. The public wrapper is the default. * @return \Drupal\file\FileInterface diff --git a/core/modules/file/src/Tests/FileManagedUnitTestBase.php b/core/modules/file/src/Tests/FileManagedUnitTestBase.php index 00448c515f6d..b02e3160a9f9 100644 --- a/core/modules/file/src/Tests/FileManagedUnitTestBase.php +++ b/core/modules/file/src/Tests/FileManagedUnitTestBase.php @@ -45,7 +45,7 @@ abstract class FileManagedUnitTestBase extends KernelTestBase { * Assert that all of the specified hook_file_* hooks were called once, other * values result in failure. * - * @param $expected + * @param array $expected * Array with string containing with the hook name, e.g. 'load', 'save', * 'insert', etc. */ @@ -77,11 +77,11 @@ abstract class FileManagedUnitTestBase extends KernelTestBase { /** * Assert that a hook_file_* hook was called a certain number of times. * - * @param $hook + * @param string $hook * String with the hook name, e.g. 'load', 'save', 'insert', etc. - * @param $expected_count + * @param int $expected_count * Optional integer count. - * @param $message + * @param string $message * Optional translated string message. */ function assertFileHookCalled($hook, $expected_count = 1, $message = NULL) { @@ -149,13 +149,13 @@ abstract class FileManagedUnitTestBase extends KernelTestBase { * Create a file and save it to the files table and assert that it occurs * correctly. * - * @param $filepath + * @param string $filepath * Optional string specifying the file path. If none is provided then a * randomly named file will be created in the site's files directory. - * @param $contents + * @param string $contents * Optional contents to save into the file. If a NULL value is provided an * arbitrary string will be used. - * @param $scheme + * @param string $scheme * Optional string indicating the stream scheme to use. Drupal core includes * public, private, and temporary. The public wrapper is the default. * @return \Drupal\file\FileInterface diff --git a/core/modules/file/tests/file_test/file_test.module b/core/modules/file/tests/file_test/file_test.module index e014246a6f9e..e7ec56cb39db 100644 --- a/core/modules/file/tests/file_test/file_test.module +++ b/core/modules/file/tests/file_test/file_test.module @@ -45,11 +45,11 @@ function file_test_reset() { * Get the arguments passed to invocation of a given hook since * file_test_reset() was last called. * - * @param $op + * @param string $op * One of the hook_file_* operations: 'load', 'validate', 'download', * 'insert', 'update', 'copy', 'move', 'delete'. * - * @return + * @return array * Array of the parameters passed to each call. * * @see _file_test_log_call() @@ -75,10 +75,10 @@ function file_test_get_all_calls() { /** * Store the values passed to a hook invocation. * - * @param $op + * @param string $op * One of the hook_file_* operations: 'load', 'validate', 'download', * 'insert', 'update', 'copy', 'move', 'delete'. - * @param $args + * @param array $args * Values passed to hook. * * @see file_test_get_calls() @@ -95,10 +95,10 @@ function _file_test_log_call($op, $args) { /** * Load the appropriate return value. * - * @param $op + * @param string $op * One of the hook_file_[validate,download] operations. * - * @return + * @return mixed * Value set by file_test_set_return(). * * @see file_test_set_return() @@ -112,9 +112,9 @@ function _file_test_get_return($op) { /** * Assign a return value for a given operation. * - * @param $op + * @param string $op * One of the hook_file_[validate,download] operations. - * @param $value + * @param mixed $value * Value for the hook to return. * * @see _file_test_get_return() @@ -317,9 +317,9 @@ function file_test_validator(File $file, $errors) { * When the function is called with no $filepath parameter, the results are * returned. * - * @param $filepath + * @param string|NULL $filepath * File path - * @return + * @return array * If $filepath is NULL, an array of all previous $filepath parameters */ function file_test_file_scan_callback($filepath = NULL) {