Browse Source

Enable `phpdoc_summary` rule in php-cs-fixer config (#14675)

* Enable `phpdoc_summary` rule in php-cs-fixer config.

* Fix case in "PHPDoc".
tags/2.0.13
Robert Korulczyk 7 years ago committed by Carsten Brandt
parent
commit
5a8c3d537b
  1. 20
      build/controllers/DevController.php
  2. 2
      build/controllers/MimeTypeController.php
  3. 16
      build/controllers/PhpDocController.php
  4. 16
      build/controllers/ReleaseController.php
  5. 6
      build/controllers/TranslationController.php
  6. 2
      build/controllers/Utf8Controller.php
  7. 2
      cs/src/YiiConfig.php
  8. 8
      framework/BaseYii.php
  9. 2
      framework/CHANGELOG.md
  10. 2
      framework/base/ActionFilter.php
  11. 4
      framework/base/Application.php
  12. 4
      framework/base/BaseObject.php
  13. 8
      framework/base/Component.php
  14. 1
      framework/base/Controller.php
  15. 6
      framework/base/ErrorHandler.php
  16. 1
      framework/base/Model.php
  17. 4
      framework/base/Request.php
  18. 5
      framework/base/View.php
  19. 1
      framework/base/Widget.php
  20. 2
      framework/caching/Cache.php
  21. 2
      framework/caching/CacheInterface.php
  22. 3
      framework/caching/DbQueryDependency.php
  23. 2
      framework/caching/Dependency.php
  24. 2
      framework/caching/MemCache.php
  25. 2
      framework/caching/migrations/m150909_153426_cache_init.php
  26. 12
      framework/console/Controller.php
  27. 4
      framework/console/Markdown.php
  28. 2
      framework/console/controllers/BaseMigrateController.php
  29. 3
      framework/console/controllers/CacheController.php
  30. 9
      framework/console/controllers/FixtureController.php
  31. 2
      framework/console/controllers/HelpController.php
  32. 19
      framework/console/controllers/MessageController.php
  33. 4
      framework/console/controllers/MigrateController.php
  34. 4
      framework/console/controllers/ServeController.php
  35. 20
      framework/console/widgets/Table.php
  36. 2
      framework/data/ArrayDataProvider.php
  37. 2
      framework/db/ActiveQueryTrait.php
  38. 2
      framework/db/ActiveRecord.php
  39. 5
      framework/db/ActiveRecordInterface.php
  40. 2
      framework/db/ActiveRelationTrait.php
  41. 6
      framework/db/BaseActiveRecord.php
  42. 6
      framework/db/ColumnSchemaBuilder.php
  43. 14
      framework/db/Command.php
  44. 2
      framework/db/Connection.php
  45. 3
      framework/db/DataReader.php
  46. 2
      framework/db/Expression.php
  47. 8
      framework/db/Migration.php
  48. 1
      framework/db/Query.php
  49. 19
      framework/db/QueryBuilder.php
  50. 2
      framework/db/QueryTrait.php
  51. 1
      framework/db/Schema.php
  52. 3
      framework/db/mssql/PDO.php
  53. 4
      framework/db/mssql/QueryBuilder.php
  54. 1
      framework/db/mssql/Schema.php
  55. 1
      framework/db/mysql/Schema.php
  56. 1
      framework/db/oci/QueryBuilder.php
  57. 12
      framework/db/oci/Schema.php
  58. 1
      framework/db/pgsql/Schema.php
  59. 3
      framework/db/sqlite/QueryBuilder.php
  60. 1
      framework/db/sqlite/Schema.php
  61. 2
      framework/di/Container.php
  62. 2
      framework/di/Instance.php
  63. 2
      framework/filters/AccessRule.php
  64. 26
      framework/filters/Cors.php
  65. 2
      framework/filters/HttpCache.php
  66. 2
      framework/filters/RateLimiter.php
  67. 2
      framework/grid/ActionColumn.php
  68. 4
      framework/grid/CheckboxColumn.php
  69. 34
      framework/helpers/BaseConsole.php
  70. 1
      framework/helpers/BaseFileHelper.php
  71. 3
      framework/helpers/BaseHtml.php
  72. 2
      framework/helpers/BaseHtmlPurifier.php
  73. 39
      framework/helpers/BaseInflector.php
  74. 2
      framework/helpers/BaseJson.php
  75. 12
      framework/helpers/BaseStringHelper.php
  76. 1
      framework/helpers/BaseUrl.php
  77. 2
      framework/helpers/FileHelper.php
  78. 2
      framework/helpers/StringHelper.php
  79. 2
      framework/i18n/Formatter.php
  80. 14
      framework/i18n/MessageFormatter.php
  81. 2
      framework/log/SyslogTarget.php
  82. 4
      framework/rbac/BaseManager.php
  83. 2
      framework/rbac/DbManager.php
  84. 2
      framework/rbac/ManagerInterface.php
  85. 2
      framework/rbac/migrations/m140506_102106_rbac_init.php
  86. 3
      framework/test/FixtureTrait.php
  87. 10
      framework/validators/DateValidator.php
  88. 2
      framework/validators/ExistValidator.php
  89. 7
      framework/validators/FileValidator.php
  90. 34
      framework/validators/IpValidator.php
  91. 2
      framework/validators/UniqueValidator.php
  92. 2
      framework/validators/Validator.php
  93. 2
      framework/views/_createTable.php
  94. 2
      framework/views/_dropTable.php
  95. 2
      framework/views/_foreignTables.php
  96. 3
      framework/views/addColumnMigration.php
  97. 3
      framework/views/createJunctionMigration.php
  98. 3
      framework/views/createTableMigration.php
  99. 3
      framework/views/dropColumnMigration.php
  100. 3
      framework/views/dropTableMigration.php
  101. Some files were not shown because too many files have changed in this diff Show More

20
build/controllers/DevController.php

@ -14,7 +14,7 @@ use yii\helpers\Console;
use yii\helpers\FileHelper;
/**
* This command helps to set up a dev environment with all extensions and applications
* This command helps to set up a dev environment with all extensions and applications.
*
* It will clone an extension or app repo and link the yii2 dev installation to the containted applications/extensions vendor dirs
* to help working on yii using the application to test it.
@ -62,7 +62,7 @@ class DevController extends Controller
/**
* Install all extensions and advanced + basic app
* Install all extensions and advanced + basic app.
*/
public function actionAll()
{
@ -88,7 +88,7 @@ class DevController extends Controller
}
/**
* Runs a command in all extension and application directories
* Runs a command in all extension and application directories.
*
* Can be used to run e.g. `git pull`.
*
@ -118,7 +118,7 @@ class DevController extends Controller
}
/**
* This command installs a project template in the `apps` directory and links the framework and extensions
* This command installs a project template in the `apps` directory and links the framework and extensions.
*
* It basically runs the following commands in the dev repo root:
*
@ -178,7 +178,7 @@ class DevController extends Controller
}
/**
* This command installs an extension in the `extensions` directory and links the framework and other extensions
* This command installs an extension in the `extensions` directory and links the framework and other extensions.
*
* @param string $extension the application name e.g. `basic` or `advanced`.
* @param string $repo url of the git repo to clone if it does not already exist.
@ -243,7 +243,7 @@ class DevController extends Controller
/**
* Remove all symlinks in the vendor subdirectory of the directory specified
* Remove all symlinks in the vendor subdirectory of the directory specified.
* @param string $dir base directory
*/
protected function cleanupVendorDir($dir)
@ -262,7 +262,7 @@ class DevController extends Controller
}
/**
* Creates symlinks to framework and extension sources for the application
* Creates symlinks to framework and extension sources for the application.
* @param string $dir application directory
* @param string $base Yii sources base directory
*
@ -294,7 +294,7 @@ class DevController extends Controller
}
/**
* Properly removes symlinked directory under Windows, MacOS and Linux
* Properly removes symlinked directory under Windows, MacOS and Linux.
*
* @param string $file path to symlink
*/
@ -308,7 +308,7 @@ class DevController extends Controller
}
/**
* Get a list of subdirectories for directory specified
* Get a list of subdirectories for directory specified.
* @param string $dir directory to read
*
* @return array list of subdirectories
@ -337,7 +337,7 @@ class DevController extends Controller
}
/**
* Finds linkable applications
* Finds linkable applications.
*
* @param string $dir directory to search in
* @return array list of applications command can link

2
build/controllers/MimeTypeController.php

@ -13,7 +13,7 @@ use yii\helpers\Console;
use yii\helpers\VarDumper;
/**
* MimeTypeController generates a map of file extensions to MIME types
* MimeTypeController generates a map of file extensions to MIME types.
*
* It uses `mime.types` file from apache http located under
* http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/conf/mime.types?view=markup

16
build/controllers/PhpDocController.php

@ -13,7 +13,7 @@ use yii\helpers\Console;
use yii\helpers\FileHelper;
/**
* PhpDocController is there to help maintaining PHPDoc annotation in class files
* PhpDocController is there to help maintaining PHPDoc annotation in class files.
*
* @author Carsten Brandt <mail@cebe.cc>
* @author Alexander Makarov <sam@rmcreative.ru>
@ -34,7 +34,7 @@ class PhpDocController extends Controller
/**
* Generates `@property` annotations in class files from getters and setters
* Generates `@property` annotations in class files from getters and setters.
*
* Property description will be taken from getter or setter or from an `@property` annotation
* in the getters docblock if there is one defined.
@ -70,7 +70,7 @@ class PhpDocController extends Controller
}
/**
* Fix some issues with PHPdoc in files
* Fix some issues with PHPDoc in files.
*
* @param string $root the directory to parse files from. Defaults to YII2_PATH.
*/
@ -243,7 +243,7 @@ class PhpDocController extends Controller
}
/**
* Fix file PHPdoc
* Fix file PHPDoc.
*/
protected function fixFileDoc(&$lines)
{
@ -284,7 +284,7 @@ class PhpDocController extends Controller
}
/**
* Markdown aware fix of whitespace issues in doc comments
* Markdown aware fix of whitespace issues in doc comments.
*/
protected function fixDocBlockIndentation(&$lines)
{
@ -356,7 +356,7 @@ class PhpDocController extends Controller
}
/**
* Fixes line spacing code style for properties and constants
* Fixes line spacing code style for properties and constants.
* @param string[] $lines
* @return string[]
*/
@ -554,7 +554,7 @@ class PhpDocController extends Controller
}
/**
* remove multi empty lines and trim trailing whitespace
* remove multi empty lines and trim trailing whitespace.
*
* @param $doc
* @return string
@ -574,7 +574,7 @@ class PhpDocController extends Controller
}
/**
* Replace property annotations in doc comment
* Replace property annotations in doc comment.
* @param $doc
* @param $properties
* @return string

16
build/controllers/ReleaseController.php

@ -437,11 +437,11 @@ class ReleaseController extends Controller
$this->dryRun || Yii::$app->runAction('mime-type', ["$frameworkPath/helpers/mimeTypes.php"]);
$this->stdout("done.\n", Console::FG_GREEN, Console::BOLD);
$this->stdout("fixing various PHPdoc style issues...\n", Console::BOLD);
$this->stdout("fixing various PHPDoc style issues...\n", Console::BOLD);
$this->dryRun || Yii::$app->runAction('php-doc/fix', [$frameworkPath]);
$this->stdout("done.\n", Console::FG_GREEN, Console::BOLD);
$this->stdout("updating PHPdoc @property annotations...\n", Console::BOLD);
$this->stdout("updating PHPDoc @property annotations...\n", Console::BOLD);
$this->dryRun || Yii::$app->runAction('php-doc/property', [$frameworkPath]);
$this->stdout("done.\n", Console::FG_GREEN, Console::BOLD);
@ -561,13 +561,13 @@ class ReleaseController extends Controller
// adjustments
$this->stdout("fixing various PHPdoc style issues...\n", Console::BOLD);
$this->stdout("fixing various PHPDoc style issues...\n", Console::BOLD);
$this->setAppAliases($name, $path);
$this->dryRun || Yii::$app->runAction('php-doc/fix', [$path, 'skipFrameworkRequirements' => true]);
$this->resetAppAliases();
$this->stdout("done.\n", Console::FG_GREEN, Console::BOLD);
$this->stdout("updating PHPdoc @property annotations...\n", Console::BOLD);
$this->stdout("updating PHPDoc @property annotations...\n", Console::BOLD);
$this->setAppAliases($name, $path);
$this->dryRun || Yii::$app->runAction('php-doc/property', [$path, 'skipFrameworkRequirements' => true]);
$this->resetAppAliases();
@ -679,11 +679,11 @@ class ReleaseController extends Controller
// adjustments
$this->stdout("fixing various PHPdoc style issues...\n", Console::BOLD);
$this->stdout("fixing various PHPDoc style issues...\n", Console::BOLD);
$this->dryRun || Yii::$app->runAction('php-doc/fix', [$path]);
$this->stdout("done.\n", Console::FG_GREEN, Console::BOLD);
$this->stdout("updating PHPdoc @property annotations...\n", Console::BOLD);
$this->stdout("updating PHPDoc @property annotations...\n", Console::BOLD);
$this->dryRun || Yii::$app->runAction('php-doc/property', [$path]);
$this->stdout("done.\n", Console::FG_GREEN, Console::BOLD);
@ -849,7 +849,7 @@ class ReleaseController extends Controller
}
/**
* Extract changelog content for a specific version
* Extract changelog content for a specific version.
* @param string $file
* @param string $version
* @return array
@ -886,7 +886,7 @@ class ReleaseController extends Controller
}
/**
* Ensure sorting of the changelog lines
* Ensure sorting of the changelog lines.
* @param string[] $changelog
* @return string[]
*/

6
build/controllers/TranslationController.php

@ -83,7 +83,7 @@ class TranslationController extends Controller
}
/**
* Checks for files existence
* Checks for files existence.
*
* @param string $translatedFilePath
* @param string $sourceFilePath
@ -104,7 +104,7 @@ class TranslationController extends Controller
}
/**
* Getting DIFF from git
* Getting DIFF from git.
*
* @param string $translatedFilePath path pointing to translated file
* @param string $sourceFilePath path pointing to original file
@ -117,7 +117,7 @@ class TranslationController extends Controller
}
/**
* Adds all necessary HTML tags and classes to diff output
* Adds all necessary HTML tags and classes to diff output.
*
* @param string $diff DIFF
* @return string highlighted DIFF

2
build/controllers/Utf8Controller.php

@ -96,7 +96,7 @@ class Utf8Controller extends Controller
}
/**
* Equvalent for ord() just for unicode
* Equivalent for ord() just for unicode.
*
* http://stackoverflow.com/a/10333324/1106908
*

2
cs/src/YiiConfig.php

@ -135,7 +135,7 @@ class YiiConfig extends Config
'phpdoc_return_self_reference' => true,
'phpdoc_scalar' => true,
'phpdoc_single_line_var_spacing' => true,
// 'phpdoc_summary' => true, // needs more attention (summary should be separated by blank line from description)
'phpdoc_summary' => true,
// 'phpdoc_to_comment' => true, // breaks phpdoc for define('CONSTANT', $value);
'phpdoc_trim' => true,
'phpdoc_types' => true,

8
framework/BaseYii.php

@ -31,15 +31,15 @@ defined('YII_DEBUG') or define('YII_DEBUG', false);
*/
defined('YII_ENV') or define('YII_ENV', 'prod');
/**
* Whether the the application is running in production environment
* Whether the the application is running in production environment.
*/
defined('YII_ENV_PROD') or define('YII_ENV_PROD', YII_ENV === 'prod');
/**
* Whether the the application is running in development environment
* Whether the the application is running in development environment.
*/
defined('YII_ENV_DEV') or define('YII_ENV_DEV', YII_ENV === 'dev');
/**
* Whether the the application is running in testing environment
* Whether the the application is running in testing environment.
*/
defined('YII_ENV_TEST') or define('YII_ENV_TEST', YII_ENV === 'test');
@ -253,6 +253,7 @@ class BaseYii
/**
* Class autoload loader.
*
* This method is invoked automatically when PHP sees an unknown class.
* The method will attempt to include the class file according to the following procedure:
*
@ -435,6 +436,7 @@ class BaseYii
/**
* Marks the beginning of a code block for profiling.
*
* This has to be matched with a call to [[endProfile]] with the same category name.
* The begin- and end- calls must also be properly nested. For example,
*

2
framework/CHANGELOG.md

@ -552,7 +552,7 @@ Yii Framework 2 Change Log
- Enh #11137: Added weak ETag support to `yii\filters\HttpCache`. It could be turned on via setting `$weakEtag` to `true` (particleflux)
- Enh #11139: `yii\validators\EachValidator` injects specific attribute value in error message parameters (silverfire)
- Enh #11166: migrate command new option `useTablePrefix` (Faryshta)
- Enh #11187: migrate command now generates phpdoc for table migrations (Faryshta)
- Enh #11187: migrate command now generates PHPDoc for table migrations (Faryshta)
- Enh #11207: migrate command can create foreign keys. (Faryshta)
- Enh #11254: Added ability to attach RBAC rule using class name (mdmunir)
- Enh #11285: `yii\base\Security` enhancements (tom--, samdark)

2
framework/base/ActionFilter.php

@ -115,7 +115,7 @@ class ActionFilter extends Behavior
}
/**
* Returns an action ID by converting [[Action::$uniqueId]] into an ID relative to the module
* Returns an action ID by converting [[Action::$uniqueId]] into an ID relative to the module.
* @param Action $action
* @return string
* @since 2.0.7

4
framework/base/Application.php

@ -572,7 +572,7 @@ abstract class Application extends Module
}
/**
* Returns the internationalization (i18n) component
* Returns the internationalization (i18n) component.
* @return \yii\i18n\I18N the internationalization application component.
*/
public function getI18n()
@ -664,7 +664,7 @@ abstract class Application extends Module
}
/**
* Configures [[Yii::$container]] with the $config
* Configures [[Yii::$container]] with the $config.
*
* @param array $config values given in terms of name-value pairs
* @since 2.0.11

4
framework/base/BaseObject.php

@ -87,6 +87,7 @@ class BaseObject implements Configurable
/**
* Constructor.
*
* The default implementation does two things:
*
* - Initializes the object with the given configuration `$config`.
@ -222,6 +223,7 @@ class BaseObject implements Configurable
/**
* Returns a value indicating whether a property is defined.
*
* A property is defined if:
*
* - the class has a getter or setter method associated with the specified name
@ -241,6 +243,7 @@ class BaseObject implements Configurable
/**
* Returns a value indicating whether a property can be read.
*
* A property is readable if:
*
* - the class has a getter method associated with the specified name
@ -259,6 +262,7 @@ class BaseObject implements Configurable
/**
* Returns a value indicating whether a property can be set.
*
* A property is writable if:
*
* - the class has a setter method associated with the specified name

8
framework/base/Component.php

@ -111,6 +111,7 @@ class Component extends BaseObject
/**
* Returns the value of a component property.
*
* This method will check in the following order and act accordingly:
*
* - a property defined by a getter: return the getter result
@ -149,6 +150,7 @@ class Component extends BaseObject
/**
* Sets the value of a component property.
*
* This method will check in the following order and act accordingly:
*
* - a property defined by a setter: set the property value
@ -203,6 +205,7 @@ class Component extends BaseObject
/**
* Checks if a property is set, i.e. defined and not null.
*
* This method will check in the following order and act accordingly:
*
* - a property defined by a setter: return whether the property is set
@ -235,6 +238,7 @@ class Component extends BaseObject
/**
* Sets a component property to be null.
*
* This method will check in the following order and act accordingly:
*
* - a property defined by a setter: set the property value to be null
@ -302,6 +306,7 @@ class Component extends BaseObject
/**
* Returns a value indicating whether a property is defined for this component.
*
* A property is defined if:
*
* - the class has a getter or setter method associated with the specified name
@ -323,6 +328,7 @@ class Component extends BaseObject
/**
* Returns a value indicating whether a property can be read.
*
* A property can be read if:
*
* - the class has a getter method associated with the specified name
@ -354,6 +360,7 @@ class Component extends BaseObject
/**
* Returns a value indicating whether a property can be set.
*
* A property can be written if:
*
* - the class has a setter method associated with the specified name
@ -385,6 +392,7 @@ class Component extends BaseObject
/**
* Returns a value indicating whether a method is defined.
*
* A method is defined if:
*
* - the class has a method with the specified name

1
framework/base/Controller.php

@ -88,6 +88,7 @@ class Controller extends Component implements ViewContextInterface
/**
* Declares external actions for the controller.
*
* This method is meant to be overwritten to declare external actions for the controller.
* It should return an array, with array keys being action IDs, and array values the corresponding
* action class names or action configuration arrays. For example,

6
framework/base/ErrorHandler.php

@ -53,7 +53,7 @@ abstract class ErrorHandler extends Component
/**
* Register this error handler
* Register this error handler.
*/
public function register()
{
@ -232,7 +232,7 @@ abstract class ErrorHandler extends Component
}
/**
* Handles fatal PHP errors
* Handles fatal PHP errors.
*/
public function handleFatalError()
{
@ -277,7 +277,7 @@ abstract class ErrorHandler extends Component
abstract protected function renderException($exception);
/**
* Logs the given exception
* Logs the given exception.
* @param \Exception $exception the exception to be logged
* @since 2.0.3 this method is now public.
*/

1
framework/base/Model.php

@ -159,6 +159,7 @@ class Model extends Component implements IteratorAggregate, ArrayAccess, Arrayab
/**
* Returns a list of scenarios and the corresponding active attributes.
*
* An active attribute is one that is subject to validation in the current scenario.
* The returned array should be in the following format:
*

4
framework/base/Request.php

@ -33,7 +33,7 @@ abstract class Request extends Component
abstract public function resolve();
/**
* Returns a value indicating whether the current request is made via command line
* Returns a value indicating whether the current request is made via command line.
* @return bool the value indicating whether the current request is made via console
*/
public function getIsConsoleRequest()
@ -42,7 +42,7 @@ abstract class Request extends Component
}
/**
* Sets the value indicating whether the current request is made via command line
* Sets the value indicating whether the current request is made via command line.
* @param bool $value the value indicating whether the current request is made via command line
*/
public function setIsConsoleRequest($value)

5
framework/base/View.php

@ -395,7 +395,8 @@ class View extends Component
/**
* Begins recording a block.
* This method is a shortcut to beginning [[Block]]
*
* This method is a shortcut to beginning [[Block]].
* @param string $id the block ID.
* @param bool $renderInPlace whether to render the block content in place.
* Defaults to false, meaning the captured block will not be displayed.
@ -420,6 +421,7 @@ class View extends Component
/**
* Begins the rendering of content that is to be decorated by the specified view.
*
* This method can be used to implement nested layout. For example, a layout can be embedded
* in another layout file specified as '@app/views/layouts/base.php' like the following:
*
@ -454,6 +456,7 @@ class View extends Component
/**
* Begins fragment caching.
*
* This method will display cached content if it is available.
* If not, it will start caching and would expect an [[endCache()]]
* call to end the cache and save the content into cache.

1
framework/base/Widget.php

@ -213,6 +213,7 @@ class Widget extends Component implements ViewContextInterface
/**
* Renders a view.
*
* The view to be rendered can be specified in one of the following formats:
*
* - [path alias](guide:concept-aliases) (e.g. "@app/views/site/index");

2
framework/caching/Cache.php

@ -365,7 +365,7 @@ abstract class Cache extends Component implements CacheInterface
}
/**
* Deletes a value with the specified key from cache
* Deletes a value with the specified key from cache.
* @param mixed $key a key identifying the value to be deleted from cache. This can be a simple string or
* a complex data structure consisting of factors representing the key.
* @return bool if no error happens during deletion

2
framework/caching/CacheInterface.php

@ -148,7 +148,7 @@ interface CacheInterface extends \ArrayAccess
public function multiAdd($items, $duration = 0, $dependency = null);
/**
* Deletes a value with the specified key from cache
* Deletes a value with the specified key from cache.
* @param mixed $key a key identifying the value to be deleted from cache. This can be a simple string or
* a complex data structure consisting of factors representing the key.
* @return bool if no error happens during deletion

3
framework/caching/DbQueryDependency.php

@ -61,7 +61,8 @@ class DbQueryDependency extends Dependency
/**
* Generates the data needed to determine if dependency is changed.
* This method returns the query result
*
* This method returns the query result.
* @param CacheInterface $cache the cache component that is currently evaluating this dependency
* @return mixed the data needed to determine if dependency has been changed.
* @throws InvalidConfigException on invalid configuration.

2
framework/caching/Dependency.php

@ -69,7 +69,7 @@ abstract class Dependency extends \yii\base\BaseObject
}
/**
* Checks whether the dependency is changed
* Checks whether the dependency is changed.
* @param CacheInterface $cache the cache component that is currently evaluating this dependency
* @return bool whether the dependency has changed.
* @since 2.0.11

2
framework/caching/MemCache.php

@ -117,7 +117,7 @@ class MemCache extends Cache
}
/**
* Add servers to the server pool of the cache specified
* Add servers to the server pool of the cache specified.
*
* @param \Memcache|\Memcached $cache
* @param MemCacheServer[] $servers

2
framework/caching/migrations/m150909_153426_cache_init.php

@ -10,7 +10,7 @@ use yii\caching\DbCache;
use yii\db\Migration;
/**
* Initializes Cache tables
* Initializes Cache tables.
*
* @author Misbahul D Munir <misbahuldmunir@gmail.com>
* @since 2.0.7

12
framework/console/Controller.php

@ -177,7 +177,7 @@ class Controller extends \yii\base\Controller
}
/**
* Formats a string with ANSI codes
* Formats a string with ANSI codes.
*
* You may pass additional parameters using the constants defined in [[\yii\helpers\Console]].
*
@ -202,7 +202,7 @@ class Controller extends \yii\base\Controller
}
/**
* Prints a string to STDOUT
* Prints a string to STDOUT.
*
* You may optionally format the string with ANSI codes by
* passing additional parameters using the constants defined in [[\yii\helpers\Console]].
@ -228,7 +228,7 @@ class Controller extends \yii\base\Controller
}
/**
* Prints a string to STDERR
* Prints a string to STDERR.
*
* You may optionally format the string with ANSI codes by
* passing additional parameters using the constants defined in [[\yii\helpers\Console]].
@ -254,7 +254,7 @@ class Controller extends \yii\base\Controller
}
/**
* Prompts the user for input and validates it
* Prompts the user for input and validates it.
*
* @param string $text prompt string
* @param array $options the options to validate the input:
@ -394,7 +394,7 @@ class Controller extends \yii\base\Controller
}
/**
* Returns the properties corresponding to the passed options
* Returns the properties corresponding to the passed options.
*
* @return array the properties corresponding to the passed options
*/
@ -455,6 +455,7 @@ class Controller extends \yii\base\Controller
/**
* Returns the help information for the anonymous arguments for the action.
*
* The returned value should be an array. The keys are the argument names, and the values are
* the corresponding help information. Each value must be an array of the following structure:
*
@ -513,6 +514,7 @@ class Controller extends \yii\base\Controller
/**
* Returns the help information for the options for the action.
*
* The returned value should be an array. The keys are the option names, and the values are
* the corresponding help information. Each value must be an array of the following structure:
*

4
framework/console/Markdown.php

@ -43,7 +43,7 @@ class Markdown extends \cebe\markdown\Parser
/**
* Renders a code block
* Renders a code block.
*
* @param array $block
* @return string
@ -54,7 +54,7 @@ class Markdown extends \cebe\markdown\Parser
}
/**
* Render a paragraph block
* Render a paragraph block.
*
* @param string $block
* @return string

2
framework/console/controllers/BaseMigrateController.php

@ -138,6 +138,7 @@ abstract class BaseMigrateController extends Controller
/**
* Upgrades the application by applying new migrations.
*
* For example,
*
* ```
@ -196,6 +197,7 @@ abstract class BaseMigrateController extends Controller
/**
* Downgrades the application by reverting old migrations.
*
* For example,
*
* ```

3
framework/console/controllers/CacheController.php

@ -62,6 +62,7 @@ class CacheController extends Controller
/**
* Flushes given cache components.
*
* For example,
*
* ```
@ -287,7 +288,7 @@ class CacheController extends Controller
}
/**
* Checks if cache of a certain class can be flushed
* Checks if cache of a certain class can be flushed.
* @param string $className class name.
* @return bool
*/

9
framework/console/controllers/FixtureController.php

@ -87,6 +87,7 @@ class FixtureController extends Controller
/**
* Loads the specified fixture data.
*
* For example,
*
* ```
@ -167,6 +168,7 @@ class FixtureController extends Controller
/**
* Unloads the specified fixtures.
*
* For example,
*
* ```
@ -242,7 +244,7 @@ class FixtureController extends Controller
}
/**
* Notifies user that there are no fixtures to load according input conditions
* Notifies user that there are no fixtures to load according input conditions.
* @param array $foundFixtures array of found fixtures
* @param array $except array of names of fixtures that should not be loaded
*/
@ -264,7 +266,7 @@ class FixtureController extends Controller
}
/**
* Notifies user that there are no fixtures to unload according input conditions
* Notifies user that there are no fixtures to unload according input conditions.
* @param array $foundFixtures array of found fixtures
* @param array $except array of names of fixtures that should not be loaded
*/
@ -424,7 +426,7 @@ class FixtureController extends Controller
/**
* Calculates fixture's name
* Basically, strips [[getFixturePath()]] and `Fixture.php' suffix from fixture's full path
* Basically, strips [[getFixturePath()]] and `Fixture.php' suffix from fixture's full path.
* @see getFixturePath()
* @param string $fullFixturePath Full fixture path
* @return string Relative fixture name
@ -467,6 +469,7 @@ class FixtureController extends Controller
/**
* Filters fixtures by splitting them in two categories: one that should be applied and not.
*
* If fixture is prefixed with "-", for example "-User", that means that fixture should not be loaded,
* if it is not prefixed it is considered as one to be loaded. Returns array:
*

2
framework/console/controllers/HelpController.php

@ -131,7 +131,7 @@ class HelpController extends Controller
}
/**
* Displays usage information for $action
* Displays usage information for $action.
*
* @param string $action route to action
* @since 2.0.11

19
framework/console/controllers/MessageController.php

@ -205,7 +205,7 @@ class MessageController extends \yii\console\Controller
}
/**
* Creates a configuration file for the "extract" command using command line options specified
* Creates a configuration file for the "extract" command using command line options specified.
*
* The generated configuration file contains parameters required
* for source code messages extraction.
@ -336,7 +336,7 @@ EOD;
}
/**
* Saves messages to database
* Saves messages to database.
*
* @param array $messages
* @param Connection $db
@ -458,7 +458,7 @@ EOD;
}
/**
* Extracts messages from a file
* Extracts messages from a file.
*
* @param string $fileName name of the file to extract messages from
* @param string $translator name of the function used to translate messages
@ -572,6 +572,7 @@ EOD;
/**
* The method checks, whether the $category is ignored according to $ignoreCategories array.
*
* Examples:
*
* - `myapp` - will be ignored only `myapp` category;
@ -599,7 +600,7 @@ EOD;
}
/**
* Finds out if two PHP tokens are equal
* Finds out if two PHP tokens are equal.
*
* @param array|string $a
* @param array|string $b
@ -619,7 +620,7 @@ EOD;
}
/**
* Finds out a line of the first non-char PHP token found
* Finds out a line of the first non-char PHP token found.
*
* @param array $tokens
* @return int|string
@ -637,7 +638,7 @@ EOD;
}
/**
* Writes messages into PHP files
* Writes messages into PHP files.
*
* @param array $messages
* @param string $dirName name of the directory to write to
@ -660,7 +661,7 @@ EOD;
}
/**
* Writes category messages into PHP file
* Writes category messages into PHP file.
*
* @param array $messages
* @param string $fileName name of the file to write to
@ -742,7 +743,7 @@ EOD;
}
/**
* Writes messages into PO file
* Writes messages into PO file.
*
* @param array $messages
* @param string $dirName name of the directory to write to
@ -838,7 +839,7 @@ EOD;
}
/**
* Writes messages into POT file
* Writes messages into POT file.
*
* @param array $messages
* @param string $dirName name of the directory to write to

4
framework/console/controllers/MigrateController.php

@ -433,7 +433,7 @@ class MigrateController extends BaseMigrateController
}
/**
* Parse the command line migration fields
* Parse the command line migration fields.
* @return array parse result with following fields:
*
* - fields: array, parsed fields
@ -483,7 +483,7 @@ class MigrateController extends BaseMigrateController
}
/**
* Adds default primary key to fields list if there's no primary key specified
* Adds default primary key to fields list if there's no primary key specified.
* @param array $fields parsed fields
* @since 2.0.7
*/

4
framework/console/controllers/ServeController.php

@ -12,7 +12,7 @@ use yii\console\Controller;
use yii\helpers\Console;
/**
* Runs PHP built-in web server
* Runs PHP built-in web server.
*
* In order to access server from remote machines use 0.0.0.0:8000. That is especially useful when running server in
* a virtual machine.
@ -43,7 +43,7 @@ class ServeController extends Controller
/**
* Runs PHP built-in web server
* Runs PHP built-in web server.
*
* @param string $address address to serve on. Either "host" or "host:port".
*

20
framework/console/widgets/Table.php

@ -103,7 +103,7 @@ class Table extends Widget
private $_listPrefix = '• ';
/**
* Set table headers
* Set table headers.
*
* @param array $headers table headers
* @return $this
@ -115,7 +115,7 @@ class Table extends Widget
}
/**
* Set table rows
* Set table rows.
*
* @param array $rows table rows
* @return $this
@ -127,7 +127,7 @@ class Table extends Widget
}
/**
* Set table chars
* Set table chars.
*
* @param array $chars table chars
* @return $this
@ -139,7 +139,7 @@ class Table extends Widget
}
/**
* Set screen width
* Set screen width.
*
* @param int $width screen width
* @return $this
@ -151,7 +151,7 @@ class Table extends Widget
}
/**
* Set list prefix
* Set list prefix.
*
* @param string $listPrefix list prefix
* @return $this
@ -206,7 +206,7 @@ class Table extends Widget
}
/**
* Renders a row of data into a string
* Renders a row of data into a string.
*
* @param array $row row of data
* @param string $spanLeft character for left border
@ -262,7 +262,7 @@ class Table extends Widget
}
/**
* Renders separator
* Renders separator.
*
* @param string $spanLeft character for left border
* @param string $spanMid character for middle border
@ -285,7 +285,7 @@ class Table extends Widget
}
/**
* Calculate the size of rows to draw anchor of columns in console
* Calculate the size of rows to draw anchor of columns in console.
*
* @see \yii\console\widgets\Table::render()
*/
@ -327,7 +327,7 @@ class Table extends Widget
}
/**
* Calculate the height of a row
* Calculate the height of a row.
*
* @param array $row
* @return int maximum row per cell
@ -360,7 +360,7 @@ class Table extends Widget
}
/**
* Getting screen width
* Getting screen width.
*
* @return int screen width
*/

2
framework/data/ArrayDataProvider.php

@ -127,7 +127,7 @@ class ArrayDataProvider extends BaseDataProvider
}
/**
* Sorts the data models according to the given sort definition
* Sorts the data models according to the given sort definition.
* @param array $models the models to be sorted
* @param Sort $sort the sort definition
* @return array the sorted data models

2
framework/db/ActiveQueryTrait.php

@ -104,7 +104,7 @@ trait ActiveQueryTrait
}
/**
* Converts found rows into model instances
* Converts found rows into model instances.
* @param array $rows
* @return array|ActiveRecord[]
* @since 2.0.11

2
framework/db/ActiveRecord.php

@ -98,7 +98,7 @@ class ActiveRecord extends BaseActiveRecord
/**
* Loads default values from database table schema
* Loads default values from database table schema.
*
* You may call this method to load default values after creating a new instance:
*

5
framework/db/ActiveRecordInterface.php

@ -8,7 +8,7 @@
namespace yii\db;
/**
* ActiveRecordInterface
* ActiveRecordInterface.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @author Carsten Brandt <mail@cebe.cc>
@ -87,7 +87,7 @@ interface ActiveRecordInterface
public function getOldPrimaryKey($asArray = false);
/**
* Returns a value indicating whether the given set of attributes represents the primary key for this model
* Returns a value indicating whether the given set of attributes represents the primary key for this model.
* @param array $keys the set of attributes to check
* @return bool whether the given set of attributes represents the primary key for this model
*/
@ -245,6 +245,7 @@ interface ActiveRecordInterface
/**
* Updates records using the provided attribute values and conditions.
*
* For example, to change the status to be 1 for all customers whose status is 2:
*
* ```php

2
framework/db/ActiveRelationTrait.php

@ -160,7 +160,7 @@ trait ActiveRelationTrait
}
/**
* If applicable, populate the query's primary model into the related records' inverse relationship
* If applicable, populate the query's primary model into the related records' inverse relationship.
* @param array $result the array of related records as generated by [[populate()]]
* @since 2.0.9
*/

6
framework/db/BaseActiveRecord.php

@ -143,6 +143,7 @@ abstract class BaseActiveRecord extends Model implements ActiveRecordInterface
/**
* Updates the whole table using the provided attribute values and conditions.
*
* For example, to change the status to be 1 for all customers whose status is 2:
*
* ```php
@ -162,6 +163,7 @@ abstract class BaseActiveRecord extends Model implements ActiveRecordInterface
/**
* Updates the whole table using the provided counter changes and conditions.
*
* For example, to increment all customers' age by 1,
*
* ```php
@ -914,6 +916,7 @@ abstract class BaseActiveRecord extends Model implements ActiveRecordInterface
/**
* This method is called at the beginning of inserting or updating a record.
*
* The default implementation will trigger an [[EVENT_BEFORE_INSERT]] event when `$insert` is `true`,
* or an [[EVENT_BEFORE_UPDATE]] event if `$insert` is `false`.
* When overriding this method, make sure you call the parent implementation like the following:
@ -970,6 +973,7 @@ abstract class BaseActiveRecord extends Model implements ActiveRecordInterface
/**
* This method is invoked before deleting a record.
*
* The default implementation raises the [[EVENT_BEFORE_DELETE]] event.
* When overriding this method, make sure you call the parent implementation like the following:
*
@ -1544,7 +1548,7 @@ abstract class BaseActiveRecord extends Model implements ActiveRecordInterface
}
/**
* Returns a value indicating whether the given set of attributes represents the primary key for this model
* Returns a value indicating whether the given set of attributes represents the primary key for this model.
* @param array $keys the set of attributes to check
* @return bool whether the given set of attributes represents the primary key for this model
*/

6
framework/db/ColumnSchemaBuilder.php

@ -143,7 +143,7 @@ class ColumnSchemaBuilder extends BaseObject
}
/**
* Adds a `NULL` constraint to the column
* Adds a `NULL` constraint to the column.
* @return $this
* @since 2.0.9
*/
@ -271,7 +271,7 @@ class ColumnSchemaBuilder extends BaseObject
}
/**
* Builds the full string for the column's schema
* Builds the full string for the column's schema.
* @return string
*/
public function __toString()
@ -430,7 +430,7 @@ class ColumnSchemaBuilder extends BaseObject
}
/**
* Returns the complete column definition from input format
* Returns the complete column definition from input format.
* @param string $format the format of the definition.
* @return string a string containing the complete column definition.
* @since 2.0.8

14
framework/db/Command.php

@ -407,6 +407,7 @@ class Command extends Component
/**
* Creates an INSERT command.
*
* For example,
*
* ```php
@ -436,6 +437,7 @@ class Command extends Component
/**
* Creates a batch INSERT command.
*
* For example,
*
* ```php
@ -466,6 +468,7 @@ class Command extends Component
/**
* Creates an UPDATE command.
*
* For example,
*
* ```php
@ -499,6 +502,7 @@ class Command extends Component
/**
* Creates a DELETE command.
*
* For example,
*
* ```php
@ -876,7 +880,7 @@ class Command extends Component
}
/**
* Builds a SQL command for adding comment to column
* Builds a SQL command for adding comment to column.
*
* @param string $table the table whose column is to be commented. The table name will be properly quoted by the method.
* @param string $column the name of the column to be commented. The column name will be properly quoted by the method.
@ -892,7 +896,7 @@ class Command extends Component
}
/**
* Builds a SQL command for adding comment to table
* Builds a SQL command for adding comment to table.
*
* @param string $table the table whose column is to be commented. The table name will be properly quoted by the method.
* @param string $comment the text of the comment to be added. The comment will be properly quoted by the method.
@ -907,7 +911,7 @@ class Command extends Component
}
/**
* Builds a SQL command for dropping comment from column
* Builds a SQL command for dropping comment from column.
*
* @param string $table the table whose column is to be commented. The table name will be properly quoted by the method.
* @param string $column the name of the column to be commented. The column name will be properly quoted by the method.
@ -922,7 +926,7 @@ class Command extends Component
}
/**
* Builds a SQL command for dropping comment from table
* Builds a SQL command for dropping comment from table.
*
* @param string $table the table whose column is to be commented. The table name will be properly quoted by the method.
* @return $this the command object itself
@ -1068,7 +1072,7 @@ class Command extends Component
}
/**
* Refreshes table schema, which was marked by [[requireTableSchemaRefresh()]]
* Refreshes table schema, which was marked by [[requireTableSchemaRefresh()]].
* @since 2.0.6
*/
protected function refreshTableSchema()

2
framework/db/Connection.php

@ -427,6 +427,7 @@ class Connection extends Component
/**
* Uses query cache for the queries performed with the callable.
*
* When query caching is enabled ([[enableQueryCache]] is true and [[queryCache]] refers to a valid cache),
* queries performed within the callable will be cached and their results will be fetched from cache if available.
* For example,
@ -472,6 +473,7 @@ class Connection extends Component
/**
* Disables query cache temporarily.
*
* Queries performed within the callable will not use query cache at all. For example,
*
* ```php

3
framework/db/DataReader.php

@ -92,7 +92,8 @@ class DataReader extends \yii\base\BaseObject implements \Iterator, \Countable
}
/**
* Set the default fetch mode for this statement
* Set the default fetch mode for this statement.
*
* @param int $mode fetch mode
* @see http://www.php.net/manual/en/function.PDOStatement-setFetchMode.php
*/

2
framework/db/Expression.php

@ -56,7 +56,7 @@ class Expression extends \yii\base\BaseObject
}
/**
* String magic method
* String magic method.
* @return string the DB expression
*/
public function __toString()

8
framework/db/Migration.php

@ -499,7 +499,7 @@ class Migration extends Component implements MigrationInterface
}
/**
* Builds and execute a SQL statement for adding comment to column
* Builds and execute a SQL statement for adding comment to column.
*
* @param string $table the table whose column is to be commented. The table name will be properly quoted by the method.
* @param string $column the name of the column to be commented. The column name will be properly quoted by the method.
@ -515,7 +515,7 @@ class Migration extends Component implements MigrationInterface
}
/**
* Builds a SQL statement for adding comment to table
* Builds a SQL statement for adding comment to table.
*
* @param string $table the table whose column is to be commented. The table name will be properly quoted by the method.
* @param string $comment the text of the comment to be added. The comment will be properly quoted by the method.
@ -530,7 +530,7 @@ class Migration extends Component implements MigrationInterface
}
/**
* Builds and execute a SQL statement for dropping comment from column
* Builds and execute a SQL statement for dropping comment from column.
*
* @param string $table the table whose column is to be commented. The table name will be properly quoted by the method.
* @param string $column the name of the column to be commented. The column name will be properly quoted by the method.
@ -545,7 +545,7 @@ class Migration extends Component implements MigrationInterface
}
/**
* Builds a SQL statement for dropping comment from table
* Builds a SQL statement for dropping comment from table.
*
* @param string $table the table whose column is to be commented. The table name will be properly quoted by the method.
* @since 2.0.8

1
framework/db/Query.php

@ -175,6 +175,7 @@ class Query extends Component implements QueryInterface
/**
* Starts a batch query and retrieves data row by row.
*
* This method is similar to [[batch()]] except that in each iteration of the result,
* only one row of data is returned. For example,
*

19
framework/db/QueryBuilder.php

@ -146,6 +146,7 @@ class QueryBuilder extends \yii\base\BaseObject
/**
* Creates an INSERT SQL statement.
*
* For example,
*
* ```php
@ -237,6 +238,7 @@ class QueryBuilder extends \yii\base\BaseObject
/**
* Generates a batch INSERT SQL statement.
*
* For example,
*
* ```php
@ -304,6 +306,7 @@ class QueryBuilder extends \yii\base\BaseObject
/**
* Creates an UPDATE SQL statement.
*
* For example,
*
* ```php
@ -351,6 +354,7 @@ class QueryBuilder extends \yii\base\BaseObject
/**
* Creates a DELETE SQL statement.
*
* For example,
*
* ```php
@ -746,7 +750,7 @@ class QueryBuilder extends \yii\base\BaseObject
}
/**
* Builds a SQL command for adding comment to column
* Builds a SQL command for adding comment to column.
*
* @param string $table the table whose column is to be commented. The table name will be properly quoted by the method.
* @param string $column the name of the column to be commented. The column name will be properly quoted by the method.
@ -760,7 +764,7 @@ class QueryBuilder extends \yii\base\BaseObject
}
/**
* Builds a SQL command for adding comment to table
* Builds a SQL command for adding comment to table.
*
* @param string $table the table whose column is to be commented. The table name will be properly quoted by the method.
* @param string $comment the text of the comment to be added. The comment will be properly quoted by the method.
@ -773,7 +777,7 @@ class QueryBuilder extends \yii\base\BaseObject
}
/**
* Builds a SQL command for adding comment to column
* Builds a SQL command for adding comment to column.
*
* @param string $table the table whose column is to be commented. The table name will be properly quoted by the method.
* @param string $column the name of the column to be commented. The column name will be properly quoted by the method.
@ -786,7 +790,7 @@ class QueryBuilder extends \yii\base\BaseObject
}
/**
* Builds a SQL command for adding comment to table
* Builds a SQL command for adding comment to table.
*
* @param string $table the table whose column is to be commented. The table name will be properly quoted by the method.
* @return string the SQL statement for adding comment on column
@ -799,6 +803,7 @@ class QueryBuilder extends \yii\base\BaseObject
/**
* Converts an abstract column type into a physical column type.
*
* The conversion is done using the type map specified in [[typeMap]].
* The following abstract column types are supported (using MySQL as an example to explain the corresponding
* physical types):
@ -952,7 +957,7 @@ class QueryBuilder extends \yii\base\BaseObject
}
/**
* Quotes table names passed
* Quotes table names passed.
*
* @param array $tables
* @param array $params
@ -1401,7 +1406,7 @@ class QueryBuilder extends \yii\base\BaseObject
}
/**
* Builds SQL for IN condition
* Builds SQL for IN condition.
*
* @param string $operator
* @param array $columns
@ -1430,7 +1435,7 @@ class QueryBuilder extends \yii\base\BaseObject
}
/**
* Builds SQL for IN condition
* Builds SQL for IN condition.
*
* @param string $operator
* @param array|\Traversable $columns

2
framework/db/QueryTrait.php

@ -356,7 +356,7 @@ trait QueryTrait
}
/**
* Normalizes format of ORDER BY data
* Normalizes format of ORDER BY data.
*
* @param array|string|Expression $columns the columns value to normalize. See [[orderBy]] and [[addOrderBy]].
* @return array

1
framework/db/Schema.php

@ -314,6 +314,7 @@ abstract class Schema extends BaseObject
/**
* Returns all unique indexes for the given table.
*
* Each array element is of the following structure:
*
* ```php

3
framework/db/mssql/PDO.php

@ -64,8 +64,9 @@ class PDO extends \PDO
/**
* Retrieve a database connection attribute.
*
* It is necessary to override PDO's method as some MSSQL PDO driver (e.g. dblib) does not
* support getting attributes
* support getting attributes.
* @param int $attribute One of the PDO::ATTR_* constants.
* @return mixed A successful call returns the value of the requested PDO attribute.
* An unsuccessful call returns null.

4
framework/db/mssql/QueryBuilder.php

@ -286,7 +286,7 @@ class QueryBuilder extends \yii\db\QueryBuilder
}
/**
* Returns an array of column names given model name
* Returns an array of column names given model name.
*
* @param string $modelClass name of the model class
* @return array|null array of column names
@ -336,7 +336,7 @@ class QueryBuilder extends \yii\db\QueryBuilder
}
/**
* Builds SQL for IN condition
* Builds SQL for IN condition.
*
* @param string $operator
* @param array $columns

1
framework/db/mssql/Schema.php

@ -572,6 +572,7 @@ SQL;
/**
* Returns all unique indexes for the given table.
*
* Each array element is of the following structure:
*
* ```php

1
framework/db/mysql/Schema.php

@ -429,6 +429,7 @@ SQL;
/**
* Returns all unique indexes for the given table.
*
* Each array element is of the following structure:
*
* ```php

1
framework/db/oci/QueryBuilder.php

@ -229,6 +229,7 @@ EOD;
/**
* Generates a batch INSERT SQL statement.
*
* For example,
*
* ```php

12
framework/db/oci/Schema.php

@ -21,7 +21,7 @@ use yii\db\TableSchema;
use yii\helpers\ArrayHelper;
/**
* Schema is the class for retrieving metadata from an Oracle database
* Schema is the class for retrieving metadata from an Oracle database.
*
* @property string $lastInsertID The row ID of the last row inserted, or the last value retrieved from the
* sequence object. This property is read-only.
@ -334,7 +334,7 @@ SQL;
}
/**
* Sequence name of table
* Sequence name of table.
*
* @param string $tableName
* @internal param \yii\db\TableSchema $table->name the table schema
@ -379,7 +379,7 @@ SQL;
}
/**
* Creates ColumnSchema instance
* Creates ColumnSchema instance.
*
* @param array $column
* @return ColumnSchema
@ -422,7 +422,7 @@ SQL;
}
/**
* Finds constraints and fills them into TableSchema object passed
* Finds constraints and fills them into TableSchema object passed.
* @param TableSchema $table
*/
protected function findConstraints($table)
@ -491,7 +491,7 @@ SQL;
/**
* Returns all unique indexes for the given table.
* Each array element is of the following structure:
* Each array element is of the following structure:.
*
* ```php
* [
@ -531,7 +531,7 @@ SQL;
}
/**
* Extracts the data types for the given column
* Extracts the data types for the given column.
* @param ColumnSchema $column
* @param string $dbType DB type
* @param string $precision total number of digits.

1
framework/db/pgsql/Schema.php

@ -419,6 +419,7 @@ SQL;
/**
* Returns all unique indexes for the given table.
*
* Each array element is of the following structure:
*
* ```php

3
framework/db/sqlite/QueryBuilder.php

@ -55,6 +55,7 @@ class QueryBuilder extends \yii\db\QueryBuilder
/**
* Generates a batch INSERT SQL statement.
*
* For example,
*
* ```php
@ -430,7 +431,7 @@ class QueryBuilder extends \yii\db\QueryBuilder
}
/**
* Builds SQL for IN condition
* Builds SQL for IN condition.
*
* @param string $operator
* @param array $columns

1
framework/db/sqlite/Schema.php

@ -278,6 +278,7 @@ class Schema extends \yii\db\Schema
/**
* Returns all unique indexes for the given table.
*
* Each array element is of the following structure:
*
* ```php

2
framework/di/Container.php

@ -630,7 +630,7 @@ class Container extends Component
}
/**
* Registers class definitions as singletons within this container by calling [[setSingleton()]]
* Registers class definitions as singletons within this container by calling [[setSingleton()]].
*
* @param array $singletons array of singleton definitions. See [[setDefinitions()]]
* for allowed formats of array.

2
framework/di/Instance.php

@ -168,7 +168,7 @@ class Instance
}
/**
* Restores class state after using `var_export()`
* Restores class state after using `var_export()`.
*
* @param array $state
* @return Instance

2
framework/filters/AccessRule.php

@ -16,7 +16,7 @@ use yii\web\Request;
use yii\web\User;
/**
* This class represents an access rule defined by the [[AccessControl]] action filter
* This class represents an access rule defined by the [[AccessControl]] action filter.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0

26
framework/filters/Cors.php

@ -110,7 +110,7 @@ class Cors extends ActionFilter
}
/**
* Override settings for specific action
* Override settings for specific action.
* @param \yii\base\Action $action the action settings to override
*/
public function overrideDefaultSettings($action)
@ -127,7 +127,7 @@ class Cors extends ActionFilter
}
/**
* Extract CORS headers from the request
* Extract CORS headers from the request.
* @return array CORS headers to handle
*/
public function extractHeaders()
@ -146,7 +146,7 @@ class Cors extends ActionFilter
}
/**
* For each CORS headers create the specific response
* For each CORS headers create the specific response.
* @param array $requestHeaders CORS headers we have detected
* @return array CORS headers ready to be sent
*/
@ -182,7 +182,7 @@ class Cors extends ActionFilter
}
/**
* Handle classic CORS request to avoid duplicate code
* Handle classic CORS request to avoid duplicate code.
* @param string $type the kind of headers we would handle
* @param array $requestHeaders CORS headers request by client
* @param array $responseHeaders CORS response headers sent to the client
@ -206,7 +206,7 @@ class Cors extends ActionFilter
}
/**
* Adds the CORS headers to the response
* Adds the CORS headers to the response.
* @param Response $response
* @param array $headers CORS headers which have been computed
*/
@ -221,9 +221,11 @@ class Cors extends ActionFilter
}
/**
* Convert any string (including php headers with HTTP prefix) to header format like :
* * X-PINGOTHER -> X-Pingother
* * X_PINGOTHER -> X-Pingother
* Convert any string (including php headers with HTTP prefix) to header format.
*
* Example:
* - X-PINGOTHER -> X-Pingother
* - X_PINGOTHER -> X-Pingother
* @param string $string string to convert
* @return string the result in "header" format
*/
@ -237,9 +239,11 @@ class Cors extends ActionFilter
}
/**
* Convert any string (including php headers with HTTP prefix) to header format like :
* * X-Pingother -> HTTP_X_PINGOTHER
* * X PINGOTHER -> HTTP_X_PINGOTHER
* Convert any string (including php headers with HTTP prefix) to header format.
*
* Example:
* - X-Pingother -> HTTP_X_PINGOTHER
* - X PINGOTHER -> HTTP_X_PINGOTHER
* @param string $string string to convert
* @return string the result in "php $_SERVER header" format
*/

2
framework/filters/HttpCache.php

@ -177,7 +177,7 @@ class HttpCache extends ActionFilter
}
/**
* Sends the cache control header to the client
* Sends the cache control header to the client.
* @see cacheControlHeader
*/
protected function sendCacheControlHeader()

2
framework/filters/RateLimiter.php

@ -127,7 +127,7 @@ class RateLimiter extends ActionFilter
}
/**
* Adds the rate limit headers to the response
* Adds the rate limit headers to the response.
* @param Response $response
* @param int $limit the maximum number of allowed requests during a period
* @param int $remaining the remaining number of allowed requests within the current period

2
framework/grid/ActionColumn.php

@ -151,7 +151,7 @@ class ActionColumn extends Column
}
/**
* Initializes the default button rendering callback for single button
* Initializes the default button rendering callback for single button.
* @param string $name Button name as it's written in template
* @param string $iconName The part of Bootstrap glyphicon class that makes it unique
* @param array $additionalOptions Array of additional options

4
framework/grid/CheckboxColumn.php

@ -131,7 +131,7 @@ class CheckboxColumn extends Column
}
/**
* Returns header checkbox name
* Returns header checkbox name.
* @return string header checkbox name
* @since 2.0.8
*/
@ -151,7 +151,7 @@ class CheckboxColumn extends Column
}
/**
* Registers the needed JavaScript
* Registers the needed JavaScript.
* @since 2.0.8
*/
public function registerClientScript()

34
framework/helpers/BaseConsole.php

@ -264,7 +264,7 @@ class BaseConsole
/**
* Resets any ANSI format set by previous method [[beginAnsiFormat()]]
* Any output after this will have default text format.
* This is equal to calling
* This is equal to calling.
*
* ```php
* echo Console::ansiFormatCode([Console::RESET])
@ -276,7 +276,7 @@ class BaseConsole
}
/**
* Will return a string formatted with the given ANSI style
* Will return a string formatted with the given ANSI style.
*
* @param string $string the string to be formatted
* @param array $format An array containing formatting values.
@ -293,8 +293,9 @@ class BaseConsole
/**
* Returns the ansi format code for xterm foreground color.
*
* You can pass the return value of this to one of the formatting methods:
* [[ansiFormat]], [[ansiFormatCode]], [[beginAnsiFormat]]
* [[ansiFormat]], [[ansiFormatCode]], [[beginAnsiFormat]].
*
* @param int $colorCode xterm color code
* @return string
@ -307,8 +308,9 @@ class BaseConsole
/**
* Returns the ansi format code for xterm background color.
*
* You can pass the return value of this to one of the formatting methods:
* [[ansiFormat]], [[ansiFormatCode]], [[beginAnsiFormat]]
* [[ansiFormat]], [[ansiFormatCode]], [[beginAnsiFormat]].
*
* @param int $colorCode xterm color code
* @return string
@ -320,7 +322,7 @@ class BaseConsole
}
/**
* Strips ANSI control codes from a string
* Strips ANSI control codes from a string.
*
* @param string $string String to strip
* @return string
@ -341,7 +343,7 @@ class BaseConsole
}
/**
* Converts an ANSI formatted string to HTML
* Converts an ANSI formatted string to HTML.
*
* Note: xTerm 256 bit colors are currently not supported.
*
@ -455,7 +457,7 @@ class BaseConsole
}
/**
* Converts Markdown to be better readable in console environments by applying some ANSI format
* Converts Markdown to be better readable in console environments by applying some ANSI format.
* @param string $markdown the markdown string.
* @return string the parsed result as ANSI formatted string.
*/
@ -466,7 +468,7 @@ class BaseConsole
}
/**
* Converts a string to ansi formatted by replacing patterns like %y (for yellow) with ansi control codes
* Converts a string to ansi formatted by replacing patterns like %y (for yellow) with ansi control codes.
*
* Uses almost the same syntax as https://github.com/pear/Console_Color2/blob/master/Console/Color2.php
* The conversion table is: ('bold' meaning 'light' on some
@ -558,7 +560,7 @@ class BaseConsole
/**
* Escapes % so they don't get interpreted as color codes when
* the string is parsed by [[renderColoredString]]
* the string is parsed by [[renderColoredString]].
*
* @param string $string String to escape
*
@ -587,7 +589,7 @@ class BaseConsole
}
/**
* Returns true if the console is running on windows
* Returns true if the console is running on windows.
* @return bool
*/
public static function isRunningOnWindows()
@ -596,7 +598,13 @@ class BaseConsole
}
/**
* Usage: list($width, $height) = ConsoleHelper::getScreenSize();
* Returns terminal screen size.
*
* Usage:
*
* ```php
* list($width, $height) = ConsoleHelper::getScreenSize();
* ```
*
* @param bool $refresh whether to force checking and not re-use cached size value.
* This is useful to detect changing window size while the application is running but may
@ -648,7 +656,7 @@ class BaseConsole
}
/**
* Word wrap text with indentation to fit the screen size
* Word wrap text with indentation to fit the screen size.
*
* If screen size could not be detected, or the indentation is greater than the screen size, the text will not be wrapped.
*
@ -760,7 +768,7 @@ class BaseConsole
}
/**
* Prompts the user for input and validates it
* Prompts the user for input and validates it.
*
* @param string $text prompt string
* @param array $options the options to validate the input:

1
framework/helpers/BaseFileHelper.php

@ -37,6 +37,7 @@ class BaseFileHelper
/**
* Normalizes a file/directory path.
*
* The normalization does the following work:
*
* - Convert all directory separators into `DIRECTORY_SEPARATOR` (e.g. "\a/b\c" becomes "/a/b/c")

3
framework/helpers/BaseHtml.php

@ -1880,6 +1880,7 @@ class BaseHtml
/**
* Adds a CSS class (or several classes) to the specified options.
*
* If the CSS class is already in the options, it will not be added again.
* If class specification at given options is an array, and some class placed there with the named (string) key,
* overriding of such key will have no effect. For example:
@ -2195,7 +2196,7 @@ class BaseHtml
}
/**
* Escapes regular expression to use in JavaScript
* Escapes regular expression to use in JavaScript.
* @param string $regexp the regular expression to be escaped.
* @return string the escaped result.
* @since 2.0.6

2
framework/helpers/BaseHtmlPurifier.php

@ -18,7 +18,7 @@ namespace yii\helpers;
class BaseHtmlPurifier
{
/**
* Passes markup through HTMLPurifier making it safe to output to end user
* Passes markup through HTMLPurifier making it safe to output to end user.
*
* @param string $content The HTML content to purify
* @param array|\Closure|null $config The config to use for HtmlPurifier.

39
framework/helpers/BaseInflector.php

@ -236,10 +236,12 @@ class BaseInflector
'ÿ' => 'y',
];
/**
* Shortcut for `Any-Latin; NFKD` transliteration rule. The rule is strict, letters will be transliterated with
* Shortcut for `Any-Latin; NFKD` transliteration rule.
*
* The rule is strict, letters will be transliterated with
* the closest sound-representation chars. The result may contain any UTF-8 chars. For example:
* `获取到 どちら Українська: ґ,є, Српска: ђ, њ, џ! ¿Español?` will be transliterated to
* `huò qǔ dào dochira Ukraí̈nsʹka: g̀,ê, Srpska: đ, n̂, d̂! ¿Español?`
* `huò qǔ dào dochira Ukraí̈nsʹka: g̀,ê, Srpska: đ, n̂, d̂! ¿Español?`.
*
* Used in [[transliterate()]].
* For detailed information see [unicode normalization forms](http://unicode.org/reports/tr15/#Normalization_Forms_Table)
@ -249,10 +251,12 @@ class BaseInflector
*/
const TRANSLITERATE_STRICT = 'Any-Latin; NFKD';
/**
* Shortcut for `Any-Latin; Latin-ASCII` transliteration rule. The rule is medium, letters will be
* Shortcut for `Any-Latin; Latin-ASCII` transliteration rule.
*
* The rule is medium, letters will be
* transliterated to characters of Latin-1 (ISO 8859-1) ASCII table. For example:
* `获取到 どちら Українська: ґ,є, Српска: ђ, њ, џ! ¿Español?` will be transliterated to
* `huo qu dao dochira Ukrainsʹka: g,e, Srpska: d, n, d! ¿Espanol?`
* `huo qu dao dochira Ukrainsʹka: g,e, Srpska: d, n, d! ¿Espanol?`.
*
* Used in [[transliterate()]].
* For detailed information see [unicode normalization forms](http://unicode.org/reports/tr15/#Normalization_Forms_Table)
@ -262,11 +266,13 @@ class BaseInflector
*/
const TRANSLITERATE_MEDIUM = 'Any-Latin; Latin-ASCII';
/**
* Shortcut for `Any-Latin; Latin-ASCII; [\u0080-\uffff] remove` transliteration rule. The rule is loose,
* Shortcut for `Any-Latin; Latin-ASCII; [\u0080-\uffff] remove` transliteration rule.
*
* The rule is loose,
* letters will be transliterated with the characters of Basic Latin Unicode Block.
* For example:
* `获取到 どちら Українська: ґ,є, Српска: ђ, њ, џ! ¿Español?` will be transliterated to
* `huo qu dao dochira Ukrainska: g,e, Srpska: d, n, d! Espanol?`
* `huo qu dao dochira Ukrainska: g,e, Srpska: d, n, d! Espanol?`.
*
* Used in [[transliterate()]].
* For detailed information see [unicode normalization forms](http://unicode.org/reports/tr15/#Normalization_Forms_Table)
@ -306,7 +312,7 @@ class BaseInflector
}
/**
* Returns the singular of the $word
* Returns the singular of the $word.
* @param string $word the english word to singularize
* @return string Singular noun.
*/
@ -340,10 +346,11 @@ class BaseInflector
}
/**
* Returns given word as CamelCased
* Returns given word as CamelCased.
*
* Converts a word like "send_email" to "SendEmail". It
* will remove non alphanumeric character from the word, so
* "who's online" will be converted to "WhoSOnline"
* "who's online" will be converted to "WhoSOnline".
* @see variablize()
* @param string $word the word to CamelCase
* @return string
@ -414,7 +421,7 @@ class BaseInflector
}
/**
* Returns a human-readable string from $word
* Returns a human-readable string from $word.
* @param string $word the string to humanize
* @param bool $ucAll whether to set all words to uppercase or not
* @return string
@ -428,9 +435,10 @@ class BaseInflector
/**
* Same as camelize but first char is in lowercase.
*
* Converts a word like "send_email" to "sendEmail". It
* will remove non alphanumeric character from the word, so
* "who's online" will be converted to "whoSOnline"
* "who's online" will be converted to "whoSOnline".
* @param string $word to lowerCamelCase
* @return string
*/
@ -442,8 +450,9 @@ class BaseInflector
}
/**
* Converts a class name to its table name (pluralized)
* naming conventions. For example, converts "Person" to "people"
* Converts a class name to its table name (pluralized) naming conventions.
*
* For example, converts "Person" to "people".
* @param string $className the class name for getting related table_name
* @return string
*/
@ -510,7 +519,9 @@ class BaseInflector
}
/**
* Converts a table name to its class name. For example, converts "people" to "Person"
* Converts a table name to its class name.
*
* For example, converts "people" to "Person".
* @param string $tableName
* @return string
*/

2
framework/helpers/BaseJson.php

@ -22,7 +22,7 @@ use yii\web\JsExpression;
class BaseJson
{
/**
* List of JSON Error messages assigned to constant names for better handling of version differences
* List of JSON Error messages assigned to constant names for better handling of version differences.
* @var array
* @since 2.0.7
*/

12
framework/helpers/BaseStringHelper.php

@ -247,7 +247,7 @@ class BaseStringHelper
}
/**
* Explodes string into array, optionally trims values and skips empty ones
* Explodes string into array, optionally trims values and skips empty ones.
*
* @param string $string String to be exploded.
* @param string $delimiter Delimiter. Default is ','.
@ -283,7 +283,7 @@ class BaseStringHelper
}
/**
* Counts words in a string
* Counts words in a string.
* @since 2.0.8
*
* @param string $string
@ -295,8 +295,8 @@ class BaseStringHelper
}
/**
* Returns string represenation of number value with replaced commas to dots, if decimal point
* of current locale is comma
* Returns string representation of number value with replaced commas to dots, if decimal point
* of current locale is comma.
* @param int|float|string $value
* @return string
* @since 2.0.11
@ -316,7 +316,7 @@ class BaseStringHelper
}
/**
* Encodes string into "Base 64 Encoding with URL and Filename Safe Alphabet" (RFC 4648)
* Encodes string into "Base 64 Encoding with URL and Filename Safe Alphabet" (RFC 4648).
*
* > Note: Base 64 padding `=` may be at the end of the returned string.
* > `=` is not transparent to URL encoding.
@ -332,7 +332,7 @@ class BaseStringHelper
}
/**
* Decodes "Base 64 Encoding with URL and Filename Safe Alphabet" (RFC 4648)
* Decodes "Base 64 Encoding with URL and Filename Safe Alphabet" (RFC 4648).
*
* @see https://tools.ietf.org/html/rfc4648#page-7
* @param string $input encoded string.

1
framework/helpers/BaseUrl.php

@ -327,6 +327,7 @@ class BaseUrl
/**
* Returns the canonical URL of the currently requested page.
*
* The canonical URL is constructed using the current controller's [[\yii\web\Controller::route]] and
* [[\yii\web\Controller::actionParams]]. You may use the following code in the layout view to add a link tag
* about canonical URL:

2
framework/helpers/FileHelper.php

@ -8,7 +8,7 @@
namespace yii\helpers;
/**
* File system helper
* File system helper.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @author Alex Makarov <sam@rmcreative.ru>

2
framework/helpers/StringHelper.php

@ -8,7 +8,7 @@
namespace yii\helpers;
/**
* StringHelper
* StringHelper.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @author Alex Makarov <sam@rmcreative.ru>

2
framework/i18n/Formatter.php

@ -1645,7 +1645,7 @@ class Formatter extends Component
}
/**
* Normalizes a numeric input value
* Normalizes a numeric input value.
*
* - everything [empty](http://php.net/manual/en/function.empty.php) will result in `0`
* - a [numeric](http://php.net/manual/en/function.is-numeric.php) string will be casted to float

14
framework/i18n/MessageFormatter.php

@ -12,7 +12,7 @@ use yii\base\Component;
use yii\base\NotSupportedException;
/**
* MessageFormatter allows formatting messages via [ICU message format](http://userguide.icu-project.org/formatparse/messages)
* MessageFormatter allows formatting messages via [ICU message format](http://userguide.icu-project.org/formatparse/messages).
*
* This class enhances the message formatter class provided by the PHP intl extension.
*
@ -50,7 +50,7 @@ class MessageFormatter extends Component
/**
* Get the error code from the last operation
* Get the error code from the last operation.
* @link http://php.net/manual/en/messageformatter.geterrorcode.php
* @return string Code of the last error.
*/
@ -60,7 +60,7 @@ class MessageFormatter extends Component
}
/**
* Get the error text from the last operation
* Get the error text from the last operation.
* @link http://php.net/manual/en/messageformatter.geterrormessage.php
* @return string Description of the last error.
*/
@ -70,7 +70,7 @@ class MessageFormatter extends Component
}
/**
* Formats a message via [ICU message format](http://userguide.icu-project.org/formatparse/messages)
* Formats a message via [ICU message format](http://userguide.icu-project.org/formatparse/messages).
*
* It uses the PHP intl extension's [MessageFormatter](http://www.php.net/manual/en/class.messageformatter.php)
* and works around some issues.
@ -255,7 +255,7 @@ class MessageFormatter extends Component
}
/**
* Fallback implementation for MessageFormatter::formatMessage
* Fallback implementation for MessageFormatter::formatMessage.
* @param string $pattern The pattern string to insert things into.
* @param array $args The array of values to insert into the format string
* @param string $locale The locale to use for formatting locale-dependent parts
@ -284,7 +284,7 @@ class MessageFormatter extends Component
}
/**
* Tokenizes a pattern by separating normal text from replaceable patterns
* Tokenizes a pattern by separating normal text from replaceable patterns.
* @param string $pattern patter to tokenize
* @return array|bool array of tokens or false on failure
*/
@ -327,7 +327,7 @@ class MessageFormatter extends Component
}
/**
* Parses a token
* Parses a token.
* @param array $token the token to parse
* @param array $args arguments to replace
* @param string $locale the locale

2
framework/log/SyslogTarget.php

@ -60,7 +60,7 @@ class SyslogTarget extends Target
}
/**
* Writes log messages to syslog
* Writes log messages to syslog.
*/
public function export()
{

4
framework/rbac/BaseManager.php

@ -195,7 +195,7 @@ abstract class BaseManager extends Component implements ManagerInterface
}
/**
* Returns defaultRoles as array of Role objects
* Returns defaultRoles as array of Role objects.
* @since 2.0.12
* @return Role[] default roles. The array is indexed by the role names
*/
@ -244,7 +244,7 @@ abstract class BaseManager extends Component implements ManagerInterface
}
/**
* Checks whether array of $assignments is empty and [[defaultRoles]] property is empty as well
* Checks whether array of $assignments is empty and [[defaultRoles]] property is empty as well.
*
* @param Assignment[] $assignments array of user's assignments
* @return bool whether array of $assignments is empty and [[defaultRoles]] property is empty as well

2
framework/rbac/DbManager.php

@ -428,7 +428,7 @@ class DbManager extends BaseManager
}
/**
* Populates an auth item with the data fetched from database
* Populates an auth item with the data fetched from database.
* @param array $row the data from the auth item table
* @return Item the populated auth item instance (either Role or Permission)
*/

2
framework/rbac/ManagerInterface.php

@ -129,7 +129,7 @@ interface ManagerInterface extends CheckAccessInterface
public function getRules();
/**
* Checks the possibility of adding a child to parent
* Checks the possibility of adding a child to parent.
* @param Item $parent the parent item
* @param Item $child the child item to be added to the hierarchy
* @return bool possibility of adding

2
framework/rbac/migrations/m140506_102106_rbac_init.php

@ -9,7 +9,7 @@ use yii\base\InvalidConfigException;
use yii\rbac\DbManager;
/**
* Initializes RBAC tables
* Initializes RBAC tables.
*
* @author Alexander Kochetov <creocoder@gmail.com>
* @since 2.0

3
framework/test/FixtureTrait.php

@ -37,6 +37,7 @@ trait FixtureTrait
/**
* Declares the fixtures that are needed by the current test case.
*
* The return value of this method must be an array of fixture configurations. For example,
*
* ```php
@ -125,7 +126,7 @@ trait FixtureTrait
}
/**
* Initialize the fixtures
* Initialize the fixtures.
* @since 2.0.12
*/
public function initFixtures()

10
framework/validators/DateValidator.php

@ -318,7 +318,7 @@ class DateValidator extends Validator
}
/**
* Parses date string into UNIX timestamp
* Parses date string into UNIX timestamp.
*
* @param string $value string representing date
* @return int|false a UNIX timestamp or `false` on failure.
@ -330,7 +330,7 @@ class DateValidator extends Validator
}
/**
* Parses date string into UNIX timestamp
* Parses date string into UNIX timestamp.
*
* @param string $value string representing date
* @param string $format expected date format
@ -356,7 +356,7 @@ class DateValidator extends Validator
}
/**
* Parses a date value using the IntlDateFormatter::parse()
* Parses a date value using the IntlDateFormatter::parse().
* @param string $value string representing date
* @param string $format the expected date format
* @return int|bool a UNIX timestamp or `false` on failure.
@ -394,7 +394,7 @@ class DateValidator extends Validator
}
/**
* Parses a date value using the DateTime::createFromFormat()
* Parses a date value using the DateTime::createFromFormat().
* @param string $value string representing date
* @param string $format the expected date format
* @return int|bool a UNIX timestamp or `false` on failure.
@ -418,7 +418,7 @@ class DateValidator extends Validator
}
/**
* Formats a timestamp using the specified format
* Formats a timestamp using the specified format.
* @param int $timestamp
* @param string $format
* @return string

2
framework/validators/ExistValidator.php

@ -211,7 +211,7 @@ class ExistValidator extends Validator
}
/**
* Returns conditions with alias
* Returns conditions with alias.
* @param ActiveQuery $query
* @param array $conditions array of condition, keys to be modified
* @param null|string $alias set empty string for no apply alias. Set null for apply primary table alias

7
framework/validators/FileValidator.php

@ -283,6 +283,7 @@ class FileValidator extends Validator
/**
* Returns the maximum size allowed for uploaded files.
*
* This is determined based on four factors:
*
* - 'upload_max_filesize' in php.ini
@ -322,7 +323,7 @@ class FileValidator extends Validator
}
/**
* Converts php.ini style size to bytes
* Converts php.ini style size to bytes.
*
* @param string $sizeStr $sizeStr
* @return int
@ -455,7 +456,7 @@ class FileValidator extends Validator
}
/**
* Builds the RegExp from the $mask
* Builds the RegExp from the $mask.
*
* @param string $mask
* @return string the regular expression
@ -467,7 +468,7 @@ class FileValidator extends Validator
}
/**
* Checks the mimeType of the $file against the list in the [[mimeTypes]] property
* Checks the mimeType of the $file against the list in the [[mimeTypes]] property.
*
* @param UploadedFile $file
* @return bool whether the $file mimeType is allowed

34
framework/validators/IpValidator.php

@ -40,16 +40,17 @@ use yii\web\JsExpression;
class IpValidator extends Validator
{
/**
* The length of IPv6 address in bits
* The length of IPv6 address in bits.
*/
const IPV6_ADDRESS_LENGTH = 128;
/**
* The length of IPv4 address in bits
* The length of IPv4 address in bits.
*/
const IPV4_ADDRESS_LENGTH = 32;
/**
* Negation char. Used to negate [[ranges]] or [[networks]]
* or to negate validating value when [[negation]] is set to `true`
* Negation char.
*
* Used to negate [[ranges]] or [[networks]] or to negate validating value when [[negation]] is set to `true`.
* @see negation
* @see networks
* @see ranges
@ -319,7 +320,7 @@ class IpValidator extends Validator
}
/**
* Validates an IPv4/IPv6 address or subnet
* Validates an IPv4/IPv6 address or subnet.
*
* @param $ip string
* @return string|array
@ -404,8 +405,9 @@ class IpValidator extends Validator
}
/**
* Expands an IPv6 address to it's full notation. For example `2001:db8::1` will be
* expanded to `2001:0db8:0000:0000:0000:0000:0000:0001`
* Expands an IPv6 address to it's full notation.
*
* For example `2001:db8::1` will be expanded to `2001:0db8:0000:0000:0000:0000:0000:0001`.
*
* @param string $ip the original IPv6
* @return string the expanded IPv6
@ -455,10 +457,10 @@ class IpValidator extends Validator
}
/**
* Prepares array to fill in [[ranges]]:
* - Recursively substitutes aliases, described in [[networks]] with their values
* - Removes duplicates
* Prepares array to fill in [[ranges]].
*
* - Recursively substitutes aliases, described in [[networks]] with their values,
* - Removes duplicates.
*
* @param $ranges
* @return array
@ -484,7 +486,7 @@ class IpValidator extends Validator
}
/**
* Validates IPv4 address
* Validates IPv4 address.
*
* @param string $value
* @return bool
@ -495,7 +497,7 @@ class IpValidator extends Validator
}
/**
* Validates IPv6 address
* Validates IPv6 address.
*
* @param string $value
* @return bool
@ -506,7 +508,7 @@ class IpValidator extends Validator
}
/**
* Gets the IP version
* Gets the IP version.
*
* @param string $ip
* @return int
@ -517,7 +519,7 @@ class IpValidator extends Validator
}
/**
* Used to get the Regexp pattern for initial IP address parsing
* Used to get the Regexp pattern for initial IP address parsing.
* @return string
*/
private function getIpParsePattern()
@ -526,7 +528,7 @@ class IpValidator extends Validator
}
/**
* Checks whether the IP is in subnet range
* Checks whether the IP is in subnet range.
*
* @param string $ip an IPv4 or IPv6 address
* @param int $cidr
@ -556,7 +558,7 @@ class IpValidator extends Validator
}
/**
* Converts IP address to bits representation
* Converts IP address to bits representation.
*
* @param string $ip
* @return string bits as a string

2
framework/validators/UniqueValidator.php

@ -277,7 +277,7 @@ class UniqueValidator extends Validator
}
/**
* Returns conditions with alias
* Returns conditions with alias.
* @param ActiveQuery $query
* @param array $conditions array of condition, keys to be modified
* @param null|string $alias set empty string for no apply alias. Set null for apply primary table alias

2
framework/validators/Validator.php

@ -455,7 +455,7 @@ class Validator extends Component
}
/**
* Returns cleaned attribute names without the `!` character at the beginning
* Returns cleaned attribute names without the `!` character at the beginning.
* @return array attribute names.
* @since 2.0.12
*/

2
framework/views/_createTable.php

@ -1,7 +1,7 @@
<?php
/**
* Creates a call for the method `yii\db\Migration::createTable()`
* Creates a call for the method `yii\db\Migration::createTable()`.
*/
/* @var $table string the name table */
/* @var $fields array the fields */

2
framework/views/_dropTable.php

@ -1,7 +1,7 @@
<?php
/**
* Creates a call for the method `yii\db\Migration::dropTable()`
* Creates a call for the method `yii\db\Migration::dropTable()`.
*/
/* @var $table string the name table */
/* @var $foreignKeys array the foreign keys */

2
framework/views/_foreignTables.php

@ -1,7 +1,7 @@
<?php
/**
* Creates a call for the method `yii\db\Migration::createTable()`
* Creates a call for the method `yii\db\Migration::createTable()`.
*/
/* @var $foreignKeys array the foreign keys */

3
framework/views/addColumnMigration.php

@ -1,6 +1,7 @@
<?php
/**
* This view is used by console/controllers/MigrateController.php
* This view is used by console/controllers/MigrateController.php.
*
* The following variables are available in this view:
*/
/* @var $className string the new migration class name without namespace */

3
framework/views/createJunctionMigration.php

@ -1,6 +1,7 @@
<?php
/**
* This view is used by console/controllers/MigrateController.php
* This view is used by console/controllers/MigrateController.php.
*
* The following variables are available in this view:
* @since 2.0.7
* @deprecated since 2.0.8

3
framework/views/createTableMigration.php

@ -1,6 +1,7 @@
<?php
/**
* This view is used by console/controllers/MigrateController.php
* This view is used by console/controllers/MigrateController.php.
*
* The following variables are available in this view:
*/
/* @var $className string the new migration class name without namespace */

3
framework/views/dropColumnMigration.php

@ -1,6 +1,7 @@
<?php
/**
* This view is used by console/controllers/MigrateController.php
* This view is used by console/controllers/MigrateController.php.
*
* The following variables are available in this view:
*/
/* @var $className string the new migration class name without namespace */

3
framework/views/dropTableMigration.php

@ -1,6 +1,7 @@
<?php
/**
* This view is used by console/controllers/MigrateController.php
* This view is used by console/controllers/MigrateController.php.
*
* The following variables are available in this view:
*/
/* @var $className string the new migration class name without namespace */

Some files were not shown because too many files have changed in this diff Show More

Loading…
Cancel
Save