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.

Sign up for GitHub

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

Update docblock version to 4.0.0 #1986

Merged
merged 1 commit into from
May 6, 2019
Merged

Update docblock version to 4.0.0 #1986

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion contributing/styleguide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ An example::
* @copyright 2014-2019 British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 3.0.0
* @since Version 4.0.0
* @filesource
*/
namespace CodeIgniter\Fruit;
Expand Down
2 changes: 1 addition & 1 deletion system/API/ResponseTrait.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
* @copyright 2014-2019 British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 3.0.0
* @since Version 4.0.0
* @filesource
*/

Expand Down
2 changes: 1 addition & 1 deletion system/Autoloader/Autoloader.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
* @copyright 2014-2019 British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 3.0.0
* @since Version 4.0.0
* @filesource
*/

Expand Down
2 changes: 1 addition & 1 deletion system/Autoloader/FileLocator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
* @copyright 2014-2019 British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 3.0.0
* @since Version 4.0.0
* @filesource
*/

Expand Down
2 changes: 1 addition & 1 deletion system/CLI/BaseCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
* @copyright 2014-2019 British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 3.0.0
* @since Version 4.0.0
* @filesource
*/

Expand Down
8 changes: 4 additions & 4 deletions system/CLI/CLI.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
* @copyright 2014-2019 British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 3.0.0
* @since Version 4.0.0
* @filesource
*/

Expand Down Expand Up @@ -517,7 +517,7 @@ public static function color(string $text, string $foreground, string $backgroun
* Get the number of characters in string having encoded characters
* and ignores styles set by the color() function
*
* @param ?string $string
* @param string $string
*
* @return integer
*/
Expand Down Expand Up @@ -594,8 +594,8 @@ public static function getHeight(int $default = 32): int
* Displays a progress bar on the CLI. You must call it repeatedly
* to update it. Set $thisStep = false to erase the progress bar.
*
* @param integer|boolean $thisStep
* @param integer $totalSteps
* @param integer|boolean $thisStep
* @param integer $totalSteps
*/
public static function showProgress($thisStep = 1, int $totalSteps = 10)
{
Expand Down
2 changes: 1 addition & 1 deletion system/CLI/CommandRunner.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
* @copyright 2014-2019 British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 3.0.0
* @since Version 4.0.0
* @filesource
*/

Expand Down
2 changes: 1 addition & 1 deletion system/CLI/Console.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
* @copyright 2014-2019 British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 3.0.0
* @since Version 4.0.0
* @filesource
*/

Expand Down
2 changes: 1 addition & 1 deletion system/Cache/CacheFactory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
* @copyright 2014-2019 British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 3.0.0
* @since Version 4.0.0
* @filesource
*/

Expand Down
2 changes: 1 addition & 1 deletion system/Cache/CacheInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
* @copyright 2014-2019 British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 3.0.0
* @since Version 4.0.0
* @filesource
*/

Expand Down
2 changes: 1 addition & 1 deletion system/Cache/Handlers/DummyHandler.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
* @copyright 2014-2019 British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 3.0.0
* @since Version 4.0.0
* @filesource
*/

Expand Down
2 changes: 1 addition & 1 deletion system/Cache/Handlers/FileHandler.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
* @copyright 2014-2019 British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 3.0.0
* @since Version 4.0.0
* @filesource
*/

Expand Down
8 changes: 4 additions & 4 deletions system/Cache/Handlers/MemcachedHandler.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
* @copyright 2014-2019 British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 3.0.0
* @since Version 4.0.0
* @filesource
*/

Expand Down Expand Up @@ -159,18 +159,18 @@ public function get(string $key)
$data = $this->memcached->get($key);

// check for unmatched key
if ($this->memcached->getResultCode()==\Memcached::RES_NOTFOUND)
if ($this->memcached->getResultCode() === \Memcached::RES_NOTFOUND)
{
return null;
}
}
elseif ($this->memcached instanceof \Memcache)
{
$flags = false;
$data = $this->memcached->get($key, $flags);
$data = $this->memcached->get($key, $flags);

// check for unmatched key (i.e. $flags is untouched)
if ($flags===false)
if ($flags === false)
{
return null;
}
Expand Down
2 changes: 1 addition & 1 deletion system/Cache/Handlers/PredisHandler.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
* @copyright 2014-2019 British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 3.0.0
* @since Version 4.0.0
* @filesource
*/

Expand Down
2 changes: 1 addition & 1 deletion system/Cache/Handlers/RedisHandler.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
* @copyright 2014-2019 British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 3.0.0
* @since Version 4.0.0
* @filesource
*/

Expand Down
4 changes: 2 additions & 2 deletions system/Cache/Handlers/WincacheHandler.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
* @copyright 2014-2019 British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 3.0.0
* @since Version 4.0.0
* @filesource
*/

Expand Down Expand Up @@ -215,7 +215,7 @@ public function getCacheInfo()
* Returns detailed information about the specific item in the cache.
*
* @codeCoverageIgnore
* @param string $key Cache item name.
* @param string $key Cache item name.
*
* @return mixed
*/
Expand Down
2 changes: 1 addition & 1 deletion system/CodeIgniter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
* @copyright 2014-2019 British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 3.0.0
* @since Version 4.0.0
* @filesource
*/

Expand Down
2 changes: 1 addition & 1 deletion system/Commands/Database/CreateMigration.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
* @copyright 2014-2019 British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 3.0.0
* @since Version 4.0.0
* @filesource
*/

Expand Down
2 changes: 1 addition & 1 deletion system/Commands/Database/MigrateCurrent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
* @copyright 2014-2019 British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 3.0.0
* @since Version 4.0.0
* @filesource
*/

Expand Down
2 changes: 1 addition & 1 deletion system/Commands/Database/MigrateLatest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
* @copyright 2014-2019 British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 3.0.0
* @since Version 4.0.0
* @filesource
*/

Expand Down
2 changes: 1 addition & 1 deletion system/Commands/Database/MigrateRefresh.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
* @copyright 2014-2019 British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 3.0.0
* @since Version 4.0.0
* @filesource
*/

Expand Down
2 changes: 1 addition & 1 deletion system/Commands/Database/MigrateRollback.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
* @copyright 2014-2019 British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 3.0.0
* @since Version 4.0.0
* @filesource
*/

Expand Down
2 changes: 1 addition & 1 deletion system/Commands/Database/MigrateStatus.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
* @copyright 2014-2019 British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 3.0.0
* @since Version 4.0.0
* @filesource
*/

Expand Down
2 changes: 1 addition & 1 deletion system/Commands/Database/MigrateVersion.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
* @copyright 2014-2019 British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 3.0.0
* @since Version 4.0.0
* @filesource
*/

Expand Down
2 changes: 1 addition & 1 deletion system/Commands/Database/Seed.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
* @copyright 2014-2019 British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 3.0.0
* @since Version 4.0.0
* @filesource
*/

Expand Down
2 changes: 1 addition & 1 deletion system/Commands/Help.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
* @copyright 2014-2019 British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 3.0.0
* @since Version 4.0.0
* @filesource
*/

Expand Down
2 changes: 1 addition & 1 deletion system/Commands/ListCommands.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
* @copyright 2014-2019 British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 3.0.0
* @since Version 4.0.0
* @filesource
*/

Expand Down
2 changes: 1 addition & 1 deletion system/Commands/Server/Serve.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
* @copyright 2014-2019 British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 3.0.0
* @since Version 4.0.0
* @filesource
*/

Expand Down
2 changes: 1 addition & 1 deletion system/Commands/Sessions/CreateMigration.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
* @copyright 2014-2019 British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 3.0.0
* @since Version 4.0.0
* @filesource
*/

Expand Down
2 changes: 1 addition & 1 deletion system/Commands/Utilities/Namespaces.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
* @copyright 2014-2019 British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 3.0.0
* @since Version 4.0.0
* @filesource
*/

Expand Down
2 changes: 1 addition & 1 deletion system/Commands/Utilities/Routes.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
* @copyright 2014-2019 British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 3.0.0
* @since Version 4.0.0
* @filesource
*/

Expand Down
6 changes: 3 additions & 3 deletions system/Common.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
* @copyright 2014-2019 British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 3.0.0
* @since Version 4.0.0
* @filesource
*/

Expand Down Expand Up @@ -945,13 +945,13 @@ function stringify_attributes($attributes, bool $js = false): string
* the file, based on the read-only attribute. is_writable() is also unreliable
* on Unix servers if safe_mode is on.
*
* @link https://bugs.php.net/bug.php?id=54709
* @link https://bugs.php.net/bug.php?id=54709
*
* @param string $file
*
* @return boolean
*
* @throws \Exception
* @throws \Exception
* @codeCoverageIgnore Not practical to test, as travis runs on linux
*/
function is_really_writable(string $file): bool
Expand Down
2 changes: 1 addition & 1 deletion system/ComposerScripts.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
* @copyright 2014-2019 British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 3.0.0
* @since Version 4.0.0
* @filesource
*/

Expand Down
2 changes: 1 addition & 1 deletion system/Config/AutoloadConfig.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
* @copyright 2014-2019 British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 3.0.0
* @since Version 4.0.0
* @filesource
*/

Expand Down
4 changes: 2 additions & 2 deletions system/Config/BaseConfig.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
* @copyright 2014-2019 British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 3.0.0
* @since Version 4.0.0
* @filesource
*/

Expand Down Expand Up @@ -186,7 +186,7 @@ protected function registerProperties()

foreach ($registrarsFiles as $file)
{
$className = $locator->getClassname($file);
$className = $locator->getClassname($file);
static::$registrars[] = new $className();
}

Expand Down
2 changes: 1 addition & 1 deletion system/Config/BaseService.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
* @copyright 2014-2019 British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 3.0.0
* @since Version 4.0.0
* @filesource
*/

Expand Down
Loading