Skip to content

Commit 240556e

Browse files
authored
Merge pull request #720 from flightphp/improve-@copyright-and-@license
Normalize and simplify @copyright and @license PHPDoc tags
2 parents 7fc6fc1 + 32ff664 commit 240556e

10 files changed

Lines changed: 20 additions & 27 deletions

File tree

flight/Engine.php

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,7 @@
2424
* It is responsible for loading an HTTP request, running the assigned services,
2525
* and generating an HTTP response.
2626
*
27-
* @license MIT, https://docs.flightphp.com/license
28-
* @copyright Copyright (c) 2011-2025, Mike Cao <mike@mikecao.com>, n0nag0n <n0nag0n@sky-9.com>
27+
* @copyright 2011-2026, Mike Cao https://mikecao.com, n0nag0n <n0nag0n@sky-9.com>
2928
*
3029
* @method void start()
3130
* @method void stop()
@@ -75,10 +74,7 @@
7574
* @phpstan-method void json(mixed $data, int $code = 200, bool $encode = true, string $charset = "utf8", int $encodeOption = 0, int $encodeDepth = 512)
7675
* @phpstan-method void jsonHalt(mixed $data, int $code = 200, bool $encode = true, string $charset = 'utf-8', int $option = 0)
7776
* @phpstan-method void jsonp(mixed $data, string $param = 'jsonp', int $code = 200, bool $encode = true, string $charset = "utf8", int $encodeOption = 0, int $encodeDepth = 512)
78-
*
79-
* Note: IDEs will use standard @method tags for autocompletion, while PHPStan will use @phpstan-* tags for advanced type checking.
80-
*
81-
* phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
77+
* @license https://docs.flightphp.com/license MIT
8278
*/
8379
class Engine
8480
{

flight/Flight.php

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
* The Flight class is a static representation of the framework.
1616
*
1717
* @license MIT, https://docs.flightphp.com/license
18-
* @copyright Copyright (c) 2011-2025, Mike Cao <mike@mikecao.com>, n0nag0n <n0nag0n@sky-9.com>
18+
* @copyright 2011-2026, Mike Cao https://mikecao.com, n0nag0n <n0nag0n@sky-9.com>
1919
*
2020
* @method static void start()
2121
* @method static void path(string $dir)
@@ -77,11 +77,8 @@
7777
* @phpstan-method static void json(mixed $data, int $code = 200, bool $encode = true, string $charset = "utf8", int $encodeOption = 0, int $encodeDepth = 512)
7878
* @phpstan-method static void jsonHalt(mixed $data, int $code = 200, bool $encode = true, string $charset = 'utf-8', int $option = 0)
7979
* @phpstan-method static void jsonp(mixed $data, string $param = 'jsonp', int $code = 200, bool $encode = true, string $charset = "utf8", int $encodeOption = 0, int $encodeDepth = 512)
80-
*
81-
* Note: IDEs will use standard @method tags for autocompletion,
82-
* while PHPStan will use @phpstan-* tags for advanced type checking.
80+
* @license https://docs.flightphp.com/license MIT
8381
*/
84-
// phpcs:ignore PSR1.Classes.ClassDeclaration.MissingNamespace
8582
class Flight
8683
{
8784
/**

flight/core/Dispatcher.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@
1818
* allows you to hook other functions to an event that can modify the
1919
* input parameters and/or the output.
2020
*
21-
* @license MIT, http://flightphp.com/license
22-
* @copyright Copyright (c) 2011, Mike Cao <mike@mikecao.com>
21+
* @copyright 2011 Mike Cao https://mikecao.com
22+
* @license https://docs.flightphp.com/license MIT
2323
* @phpstan-template EngineTemplate of object
2424
*/
2525
class Dispatcher

flight/core/Loader.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@
1313
* instances with custom initialization parameters. It also performs
1414
* class autoloading.
1515
*
16-
* @license MIT, http://flightphp.com/license
17-
* @copyright Copyright (c) 2011, Mike Cao <mike@mikecao.com>
16+
* @copyright 2011 Mike Cao https://mikecao.com
17+
* @license https://docs.flightphp.com/license MIT
1818
*/
1919
class Loader
2020
{

flight/net/Request.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@
1111
* all the super globals $_GET, $_POST, $_COOKIE, and $_FILES
1212
* are stored and accessible via the Request object.
1313
*
14-
* @license MIT, http://flightphp.com/license
15-
* @copyright Copyright (c) 2011, Mike Cao <mike@mikecao.com>
14+
* @copyright 2011 Mike Cao https://mikecao.com
15+
* @license https://docs.flightphp.com/license MIT
1616
*
1717
* The default request properties are:
1818
*

flight/net/Response.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
* contains the response headers, HTTP status code, and response
1313
* body.
1414
*
15-
* @license MIT, http://flightphp.com/license
16-
* @copyright Copyright (c) 2011, Mike Cao <mike@mikecao.com>
15+
* @copyright 2011 Mike Cao https://mikecao.com
16+
* @license https://docs.flightphp.com/license MIT
1717
*/
1818
class Response
1919
{

flight/net/Route.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99
* an assigned callback function. The Router tries to match the
1010
* requested URL against a series of URL patterns.
1111
*
12-
* @license MIT, http://flightphp.com/license
13-
* @copyright Copyright (c) 2011, Mike Cao <mike@mikecao.com>
12+
* @copyright 2011 Mike Cao https://mikecao.com
13+
* @license https://docs.flightphp.com/license MIT
1414
*/
1515
class Route
1616
{

flight/net/Router.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
* an assigned callback function. The Router tries to match the
1313
* requested URL against a series of URL patterns.
1414
*
15-
* @license MIT, http://flightphp.com/license
16-
* @copyright Copyright (c) 2011, Mike Cao <mike@mikecao.com>
15+
* @copyright 2011 Mike Cao https://mikecao.com
16+
* @license https://docs.flightphp.com/license MIT
1717
*/
1818
class Router
1919
{

flight/template/View.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99
* methods for managing view data and inserts the data into
1010
* view templates upon rendering.
1111
*
12-
* @license MIT, http://flightphp.com/license
13-
* @copyright Copyright (c) 2011, Mike Cao <mike@mikecao.com>
12+
* @copyright 2011 Mike Cao https://mikecao.com
13+
* @license https://docs.flightphp.com/license MIT
1414
*/
1515
class View
1616
{

flight/util/Collection.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@
1313
* The Collection class allows you to access a set of data
1414
* using both array and object notation.
1515
*
16-
* @license MIT, http://flightphp.com/license
17-
* @copyright Copyright (c) 2011, Mike Cao <mike@mikecao.com>
16+
* @copyright 2011 Mike Cao https://mikecao.com
1817
* @implements ArrayAccess<string, mixed>
1918
* @implements Iterator<string, mixed>
19+
* @license https://docs.flightphp.com/license MIT
2020
*/
2121
class Collection implements ArrayAccess, Iterator, Countable, JsonSerializable
2222
{

0 commit comments

Comments
 (0)