UploadedFile::moveTo() - Code Metrics - Inspection of "repository update" - linna/http-message - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — b0.1.0 ( 56c359...717fd1 )

by Sebastian

created 2019-01-13 18:13 UTC

UploadedFile::moveTo() A

↳ Parent: UploadedFile

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	0

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	0
nc	1
nop	1
dl	0
loc	2
ccs	0
cts	2
cp	0
crap	2
rs	10
c	0
b	0
f	0

<?php

/**
 * Linna Psr7.
 *
 * @author Sebastian Rapetti <[email protected]>
 * @copyright (c) 2018, Sebastian Rapetti
 * @license http://opensource.org/licenses/MIT MIT License
 */
declare(strict_types=1);

namespace Linna\Http\Message;

use InvalidArgumentException;
use Psr\Http\Message\StreamInterface;
use Psr\Http\Message\UploadedFileInterface;
use RuntimeException;

class UploadedFile implements UploadedFileInterface
{
    /**
     * Retrieve a stream representing the uploaded file.
     *
     * This method MUST return a StreamInterface instance, representing the
     * uploaded file. The purpose of this method is to allow utilizing native PHP
     * stream functionality to manipulate the file upload, such as
     * stream_copy_to_stream() (though the result will need to be decorated in a
     * native PHP stream wrapper to work with such functions).
     *
     * If the moveTo() method has been called previously, this method MUST raise
     * an exception.
     *
     * @return StreamInterface Stream representation of the uploaded file.
     *
     * @throws RuntimeException in cases when no stream is available or can becreated.
     */
    public function getStream(): StreamInterface
    {
    }
interface ReturnsInt {
    public function returnsIntHinted(): int;
}

class MyClass implements ReturnsInt {
    public function returnsIntHinted(): int
    {
        if (foo()) {
            return 123;
        }
        // here: null is implicitly returned
    }
}

    /**
     * Move the uploaded file to a new location.
     *
     * Use this method as an alternative to move_uploaded_file(). This method is
     * guaranteed to work in both SAPI and non-SAPI environments.
     * Implementations must determine which environment they are in, and use the
     * appropriate method (move_uploaded_file(), rename(), or a stream
     * operation) to perform the operation.
     *
     * $targetPath may be an absolute path, or a relative path. If it is a
     * relative path, resolution should be the same as used by PHP's rename()
     * function.
     *
     * The original file or stream MUST be removed on completion.
     *
     * If this method is called more than once, any subsequent calls MUST raise
     * an exception.
     *
     * When used in an SAPI environment where $_FILES is populated, when writing
     * files via moveTo(), is_uploaded_file() and move_uploaded_file() SHOULD be
     * used to ensure permissions and upload status are verified correctly.
     *
     * If you wish to move to a stream, use getStream(), as SAPI operations
     * cannot guarantee writing to stream destinations.
     *
     * @see http://php.net/is_uploaded_file
     * @see http://php.net/move_uploaded_file
     *
     * @param string $targetPath Path to which to move the uploaded file.
     *
     * @throws InvalidArgumentException if the $targetPath specified is invalid.
     * @throws RuntimeException on any error during the move operation, or on
     *                          the second or subsequent call to the method.
     */
    public function moveTo(string $targetPath)
    {
    }

    /**
     * Retrieve the file size.
     *
     * Implementations SHOULD return the value stored in the "size" key of
     * the file in the $_FILES array if available, as PHP calculates this based
     * on the actual size transmitted.
     *
     * @return int The file size in bytes or zero if unknown.
     */
    public function getSize(): int
    {
    }
interface ReturnsInt {
    public function returnsIntHinted(): int;
}

class MyClass implements ReturnsInt {
    public function returnsIntHinted(): int
    {
        if (foo()) {
            return 123;
        }
        // here: null is implicitly returned
    }
}

    /**
     * Retrieve the error associated with the uploaded file.
     *
     * The return value MUST be one of PHP's UPLOAD_ERR_XXX constants.
     *
     * If the file was uploaded successfully, this method MUST return
     * UPLOAD_ERR_OK.
     *
     * Implementations SHOULD return the value stored in the "error" key of
     * the file in the $_FILES array.
     *
     * @see http://php.net/manual/en/features.file-upload.errors.php
     *
     * @return int One of PHP's UPLOAD_ERR_XXX constants.
     */
    public function getError(): int
    {
    }
interface ReturnsInt {
    public function returnsIntHinted(): int;
}

class MyClass implements ReturnsInt {
    public function returnsIntHinted(): int
    {
        if (foo()) {
            return 123;
        }
        // here: null is implicitly returned
    }
}

    /**
     * Retrieve the filename sent by the client.
     *
     * Do not trust the value returned by this method. A client could send
     * a malicious filename with the intention to corrupt or hack your
     * application.
     *
     * Implementations SHOULD return the value stored in the "name" key of
     * the file in the $_FILES array.
     *
     * @return string The filename sent by the client or void string if none
     *                was provided.
     */
    public function getClientFilename(): string
    {
    }
interface ReturnsInt {
    public function returnsIntHinted(): int;
}

class MyClass implements ReturnsInt {
    public function returnsIntHinted(): int
    {
        if (foo()) {
            return 123;
        }
        // here: null is implicitly returned
    }
}

    /**
     * Retrieve the media type sent by the client.
     *
     * Do not trust the value returned by this method. A client could send
     * a malicious media type with the intention to corrupt or hack your
     * application.
     *
     * Implementations SHOULD return the value stored in the "type" key of
     * the file in the $_FILES array.
     *
     * @return string The media type sent by the client or void string if none
     *                was provided.
     */
    public function getClientMediaType(): string
    {
    }
interface ReturnsInt {
    public function returnsIntHinted(): int;
}

class MyClass implements ReturnsInt {
    public function returnsIntHinted(): int
    {
        if (foo()) {
            return 123;
        }
        // here: null is implicitly returned
    }
}
}


1			<?php
2
3			/**
4			* Linna Psr7.
5			*
6			* @author Sebastian Rapetti <[email protected]>
7			* @copyright (c) 2018, Sebastian Rapetti
8			* @license http://opensource.org/licenses/MIT MIT License
9			*/
10			declare(strict_types=1);
11
12			namespace Linna\Http\Message;
13
14			use InvalidArgumentException;
15			use Psr\Http\Message\StreamInterface;
16			use Psr\Http\Message\UploadedFileInterface;
17			use RuntimeException;
18
19			class UploadedFile implements UploadedFileInterface
20			{
21			/**
22			* Retrieve a stream representing the uploaded file.
23			*
24			* This method MUST return a StreamInterface instance, representing the
25			* uploaded file. The purpose of this method is to allow utilizing native PHP
26			* stream functionality to manipulate the file upload, such as
27			* stream_copy_to_stream() (though the result will need to be decorated in a
28			* native PHP stream wrapper to work with such functions).
29			*
30			* If the moveTo() method has been called previously, this method MUST raise
31			* an exception.
32			*
33			* @return StreamInterface Stream representation of the uploaded file.
34			*
35			* @throws RuntimeException in cases when no stream is available or can becreated.
36			*/
37			public function getStream(): StreamInterface
38			{
39			}
			0 ignored issues – show Bug Best Practice introduced 2018-09-04 16:54 UTC by Report Bug Copy Issue Report In this branch, the function will implicitly return `null` which is incompatible with the type-hinted return `Psr\Http\Message\StreamInterface`. Consider adding a return statement or allowing `null` as return value. For hinted functions/methods where all return statements with the correct type are only reachable via conditions, ?null? gets implicitly returned which may be incompatible with the hinted type. Let?s take a look at an example: interface ReturnsInt { public function returnsIntHinted(): int; } class MyClass implements ReturnsInt { public function returnsIntHinted(): int { if (foo()) { return 123; } // here: null is implicitly returned } } Loading history...
40
41			/**
42			* Move the uploaded file to a new location.
43			*
44			* Use this method as an alternative to move_uploaded_file(). This method is
45			* guaranteed to work in both SAPI and non-SAPI environments.
46			* Implementations must determine which environment they are in, and use the
47			* appropriate method (move_uploaded_file(), rename(), or a stream
48			* operation) to perform the operation.
49			*
50			* $targetPath may be an absolute path, or a relative path. If it is a
51			* relative path, resolution should be the same as used by PHP's rename()
52			* function.
53			*
54			* The original file or stream MUST be removed on completion.
55			*
56			* If this method is called more than once, any subsequent calls MUST raise
57			* an exception.
58			*
59			* When used in an SAPI environment where $_FILES is populated, when writing
60			* files via moveTo(), is_uploaded_file() and move_uploaded_file() SHOULD be
61			* used to ensure permissions and upload status are verified correctly.
62			*
63			* If you wish to move to a stream, use getStream(), as SAPI operations
64			* cannot guarantee writing to stream destinations.
65			*
66			* @see http://php.net/is_uploaded_file
67			* @see http://php.net/move_uploaded_file
68			*
69			* @param string $targetPath Path to which to move the uploaded file.
70			*
71			* @throws InvalidArgumentException if the $targetPath specified is invalid.
72			* @throws RuntimeException on any error during the move operation, or on
73			* the second or subsequent call to the method.
74			*/
75			public function moveTo(string $targetPath)
76			{
77			}
78
79			/**
80			* Retrieve the file size.
81			*
82			* Implementations SHOULD return the value stored in the "size" key of
83			* the file in the $_FILES array if available, as PHP calculates this based
84			* on the actual size transmitted.
85			*
86			* @return int The file size in bytes or zero if unknown.
87			*/
88			public function getSize(): int
89			{
90			}
			0 ignored issues – show Bug Best Practice introduced 2018-09-04 16:54 UTC by Report Bug Copy Issue Report In this branch, the function will implicitly return `null` which is incompatible with the type-hinted return `integer`. Consider adding a return statement or allowing `null` as return value. For hinted functions/methods where all return statements with the correct type are only reachable via conditions, ?null? gets implicitly returned which may be incompatible with the hinted type. Let?s take a look at an example: interface ReturnsInt { public function returnsIntHinted(): int; } class MyClass implements ReturnsInt { public function returnsIntHinted(): int { if (foo()) { return 123; } // here: null is implicitly returned } } Loading history...
91
92			/**
93			* Retrieve the error associated with the uploaded file.
94			*
95			* The return value MUST be one of PHP's UPLOAD_ERR_XXX constants.
96			*
97			* If the file was uploaded successfully, this method MUST return
98			* UPLOAD_ERR_OK.
99			*
100			* Implementations SHOULD return the value stored in the "error" key of
101			* the file in the $_FILES array.
102			*
103			* @see http://php.net/manual/en/features.file-upload.errors.php
104			*
105			* @return int One of PHP's UPLOAD_ERR_XXX constants.
106			*/
107			public function getError(): int
108			{
109			}
			0 ignored issues – show Bug Best Practice introduced 2018-09-04 16:54 UTC by Report Bug Copy Issue Report In this branch, the function will implicitly return `null` which is incompatible with the type-hinted return `integer`. Consider adding a return statement or allowing `null` as return value. For hinted functions/methods where all return statements with the correct type are only reachable via conditions, ?null? gets implicitly returned which may be incompatible with the hinted type. Let?s take a look at an example: interface ReturnsInt { public function returnsIntHinted(): int; } class MyClass implements ReturnsInt { public function returnsIntHinted(): int { if (foo()) { return 123; } // here: null is implicitly returned } } Loading history...
110
111			/**
112			* Retrieve the filename sent by the client.
113			*
114			* Do not trust the value returned by this method. A client could send
115			* a malicious filename with the intention to corrupt or hack your
116			* application.
117			*
118			* Implementations SHOULD return the value stored in the "name" key of
119			* the file in the $_FILES array.
120			*
121			* @return string The filename sent by the client or void string if none
122			* was provided.
123			*/
124			public function getClientFilename(): string
125			{
126			}
			0 ignored issues – show Bug Best Practice introduced 2018-09-04 16:54 UTC by Report Bug Copy Issue Report In this branch, the function will implicitly return `null` which is incompatible with the type-hinted return `string`. Consider adding a return statement or allowing `null` as return value. For hinted functions/methods where all return statements with the correct type are only reachable via conditions, ?null? gets implicitly returned which may be incompatible with the hinted type. Let?s take a look at an example: interface ReturnsInt { public function returnsIntHinted(): int; } class MyClass implements ReturnsInt { public function returnsIntHinted(): int { if (foo()) { return 123; } // here: null is implicitly returned } } Loading history...
127
128			/**
129			* Retrieve the media type sent by the client.
130			*
131			* Do not trust the value returned by this method. A client could send
132			* a malicious media type with the intention to corrupt or hack your
133			* application.
134			*
135			* Implementations SHOULD return the value stored in the "type" key of
136			* the file in the $_FILES array.
137			*
138			* @return string The media type sent by the client or void string if none
139			* was provided.
140			*/
141			public function getClientMediaType(): string
142			{
143			}
			0 ignored issues – show Bug Best Practice introduced 2018-09-04 16:54 UTC by Report Bug Copy Issue Report In this branch, the function will implicitly return `null` which is incompatible with the type-hinted return `string`. Consider adding a return statement or allowing `null` as return value. For hinted functions/methods where all return statements with the correct type are only reachable via conditions, ?null? gets implicitly returned which may be incompatible with the hinted type. Let?s take a look at an example: interface ReturnsInt { public function returnsIntHinted(): int; } class MyClass implements ReturnsInt { public function returnsIntHinted(): int { if (foo()) { return 123; } // here: null is implicitly returned } } Loading history...
144			}
145

linna / http-message

Push — b0.1.0 ( 56c359...717fd1 )

UploadedFile::moveTo() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like