Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating the file header comments so phpdoc stops complaining. #88

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions src/MessageInterface.php
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
<?php
/**
* PHP Framework Interop Group
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE file.
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) PHP Framework Interop Group (https://www.php-fig.org)
* @link https://www.php-fig.org/psr/psr-7/
* @license https://opensource.org/licenses/mit-license.php MIT License
*/

namespace Psr\Http\Message;

Expand Down
13 changes: 12 additions & 1 deletion src/RequestInterface.php
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
<?php
/**
* PHP Framework Interop Group
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE file.
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) PHP Framework Interop Group (https://www.php-fig.org)
* @link https://www.php-fig.org/psr/psr-7/
* @license https://opensource.org/licenses/mit-license.php MIT License
*/

namespace Psr\Http\Message;

Expand Down Expand Up @@ -55,7 +66,7 @@ public function getRequestTarget();
*
* @link http://tools.ietf.org/html/rfc7230#section-5.3 (for the various
* request-target forms allowed in request messages)
* @param mixed $requestTarget
* @param mixed $requestTarget The request target.
* @return static
*/
public function withRequestTarget($requestTarget);
Expand Down
11 changes: 11 additions & 0 deletions src/ResponseInterface.php
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
<?php
/**
* PHP Framework Interop Group
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE file.
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) PHP Framework Interop Group (https://www.php-fig.org)
* @link https://www.php-fig.org/psr/psr-7/
* @license https://opensource.org/licenses/mit-license.php MIT License
*/

namespace Psr\Http\Message;

Expand Down
11 changes: 11 additions & 0 deletions src/ServerRequestInterface.php
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
<?php
/**
* PHP Framework Interop Group
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE file.
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) PHP Framework Interop Group (https://www.php-fig.org)
* @link https://www.php-fig.org/psr/psr-7/
* @license https://opensource.org/licenses/mit-license.php MIT License
*/

namespace Psr\Http\Message;

Expand Down
13 changes: 13 additions & 0 deletions src/StreamInterface.php
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
<?php
/**
* PHP Framework Interop Group
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE file.
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) PHP Framework Interop Group (https://www.php-fig.org)
* @link https://www.php-fig.org/psr/psr-7/
* @license https://opensource.org/licenses/mit-license.php MIT License
*/

namespace Psr\Http\Message;

Expand Down Expand Up @@ -82,6 +93,7 @@ public function isSeekable();
* PHP $whence values for `fseek()`. SEEK_SET: Set position equal to
* offset bytes SEEK_CUR: Set position to current location plus offset
* SEEK_END: Set position to end-of-stream plus offset.
* @return int
* @throws \RuntimeException on failure.
*/
public function seek($offset, $whence = SEEK_SET);
Expand All @@ -94,6 +106,7 @@ public function seek($offset, $whence = SEEK_SET);
*
* @see seek()
* @link http://www.php.net/manual/en/function.fseek.php
* @return int
* @throws \RuntimeException on failure.
*/
public function rewind();
Expand Down
20 changes: 16 additions & 4 deletions src/UploadedFileInterface.php
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
<?php
/**
* PHP Framework Interop Group
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE file.
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) PHP Framework Interop Group (https://www.php-fig.org)
* @link https://www.php-fig.org/psr/psr-7/
* @license https://opensource.org/licenses/mit-license.php MIT License
*/

namespace Psr\Http\Message;

Expand Down Expand Up @@ -58,12 +69,13 @@ public function getStream();
* @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.
* @return bool
* @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($targetPath);

/**
* Retrieve the file size.
*
Expand All @@ -74,7 +86,7 @@ public function moveTo($targetPath);
* @return int|null The file size in bytes or null if unknown.
*/
public function getSize();

/**
* Retrieve the error associated with the uploaded file.
*
Expand All @@ -90,7 +102,7 @@ public function getSize();
* @return int One of PHP's UPLOAD_ERR_XXX constants.
*/
public function getError();

/**
* Retrieve the filename sent by the client.
*
Expand All @@ -105,7 +117,7 @@ public function getError();
* was provided.
*/
public function getClientFilename();

/**
* Retrieve the media type sent by the client.
*
Expand Down
12 changes: 12 additions & 0 deletions src/UriInterface.php
Original file line number Diff line number Diff line change
@@ -1,4 +1,16 @@
<?php
/**
* PHP Framework Interop Group
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE file.
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) PHP Framework Interop Group (https://www.php-fig.org)
* @link https://www.php-fig.org/psr/psr-7/
* @license https://opensource.org/licenses/mit-license.php MIT License
*/

namespace Psr\Http\Message;

/**
Expand Down