Skip to content

Commit 479a843

Browse files
committed
Fix indenting.
1 parent c4fb35e commit 479a843

File tree

1 file changed

+33
-31
lines changed

1 file changed

+33
-31
lines changed

src/Scanner.php

Lines changed: 33 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -237,15 +237,15 @@ public function scan($Files, bool $Format = false, bool $Flatness = false, int $
237237
* may be necessary for the case of archives and directories. It performs the
238238
* preparations necessary for scanning files using the "data handler" and the
239239
* "meta data scan" closures. Additionally, it performs some necessary
240-
* whitelist, blacklist and greylist checks, filesize and file extension
241-
* checks, and handles the processing and extraction of files from archives,
242-
* fetching the files contained in archives being scanned in order to process
243-
* those contained files as so that they, too, may be scanned.
240+
* whitelist, blacklist and greylist checks, filesize and file extension checks,
241+
* and handles the processing and extraction of files from archives, fetching
242+
* the files contained in archives being scanned in order to process those
243+
* contained files as so that they, too, may be scanned.
244244
*
245245
* When phpMussel is instructed to scan a directory or an array of multiple
246-
* files, the recursor is the closure function responsible for iterating
247-
* through that directory and/or array queued for scanning, and if necessary,
248-
* will recurse itself (such as for when scanning a directory containing
246+
* files, the recursor is the closure function responsible for iterating through
247+
* that directory and/or array queued for scanning, and if necessary, will
248+
* recurse itself (such as for when scanning a directory containing
249249
* sub-directories or when scanning a multidimensional array of multiple files
250250
* and/or directories).
251251
*
@@ -254,41 +254,43 @@ public function scan($Files, bool $Format = false, bool $Flatness = false, int $
254254
* string) represents the "temporary filename" of the file being scanned
255255
* (the temporary filename, in this context, referring to the name
256256
* temporarily assigned to the file by the server upon the file being
257-
* uploaded to the temporary uploads location assigned to the server).
258-
* When operating in the context of CLI mode, both $Files and $OriginalFilename represent
259-
* the scan target, as per specified by the CLI operator; The only
260-
* difference between the two is when the scan target is a directory,
261-
* rather than a single file; $Files will represent the full path to the file
262-
* (so, directory plus filename), whereas $OriginalFilename will represent only the
263-
* filename. This parameter can also accept an array of filenames.
257+
* uploaded to the temporary uploads location assigned to the server). When
258+
* operating in the context of CLI mode, both $Files and $OriginalFilename
259+
* represent the scan target, as per specified by the CLI operator; The
260+
* only difference between the two is when the scan target is a directory,
261+
* rather than a single file; $Files will represent the full path to the
262+
* file (so, directory plus filename), whereas $OriginalFilename will
263+
* represent only the filename. This parameter can also accept an array of
264+
* filenames.
264265
* @param bool $n This optional parameter is a boolean (defaults to false, but
265266
* set to true during the initial scan of file uploads), indicating the
266267
* format for returning the scan results. False instructs the function to
267268
* return results as an integer; True instructs the function to return
268269
* results as human readable text (refer to Section 3A of the README
269270
* documentation, "HOW TO USE (FOR WEB SERVERS)", for more information).
270-
* @param bool $Flatness This optional parameter is a boolean (defaults to false, but
271-
* set to true during the initial scan of file uploads), indicating to the
272-
* function whether or not arrayed results should be imploded prior to
273-
* being returned to the calling function. False instructs the function to
274-
* return the arrayed results as verbatim; True instructs the function to
275-
* return the arrayed results as an imploded string.
271+
* @param bool $Flatness This optional parameter is a boolean (defaults to
272+
* false, but set to true during the initial scan of file uploads),
273+
* indicating to the function whether or not arrayed results should be
274+
* imploded prior to being returned to the calling function. False
275+
* instructs the function to return the arrayed results as verbatim; True
276+
* instructs the function to return the arrayed results as an imploded
277+
* string.
276278
* @param int $Depth Represents the current depth of recursion from which the
277279
* function has been called. This information is used for determining how
278280
* far to indent any entries generated for logging and for the display of
279281
* scan results in CLI (you should never manually set this parameter
280282
* yourself).
281-
* @param string $OriginalFilename For the file upload scanning that phpMussel normally
282-
* performs by default, this parameter represents the "original filename"
283-
* of the file being scanned (the original filename, in this context,
284-
* referring to the name supplied by the upload client, as opposed to the
285-
* temporary filename assigned by the server or anything else).
286-
* When operating in the context of CLI mode, both $Files and $OriginalFilename represent
287-
* the scan target, as per specified by the CLI operator; The only
288-
* difference between the two is when the scan target is a directory,
289-
* rather than a single file; $Files will represent the full path to the file
290-
* (so, directory plus filename), whereas $OriginalFilename will represent only the
291-
* filename.
283+
* @param string $OriginalFilename For the file upload scanning that phpMussel
284+
* normally performs by default, this parameter represents the "original
285+
* filename" of the file being scanned (the original filename, in this
286+
* context, referring to the name supplied by the upload client, as
287+
* opposed to the temporary filename assigned by the server or anything
288+
* else). When operating in the context of CLI mode, both $Files and
289+
* $OriginalFilename represent the scan target, as per specified by the CLI
290+
* operator; The only difference between the two is when the scan target is
291+
* a directory, rather than a single file; $Files will represent the full
292+
* path to the file (so, directory plus filename), whereas
293+
* $OriginalFilename will represent only the filename.
292294
* @return mixed The scan results, returned as an array when the $Files
293295
* parameter is an array and when $n and/or $Flatness is/are false, and
294296
* otherwise returned as per described by the README documentation. The

0 commit comments

Comments
 (0)