diff --git a/build/controllers/DevController.php b/build/controllers/DevController.php index 4020f9c..bc26295 100644 --- a/build/controllers/DevController.php +++ b/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 diff --git a/build/controllers/MimeTypeController.php b/build/controllers/MimeTypeController.php index 768aac5..8faf653 100644 --- a/build/controllers/MimeTypeController.php +++ b/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 diff --git a/build/controllers/PhpDocController.php b/build/controllers/PhpDocController.php index c2c876f..2757c79 100644 --- a/build/controllers/PhpDocController.php +++ b/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 * @author Alexander Makarov @@ -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 diff --git a/build/controllers/ReleaseController.php b/build/controllers/ReleaseController.php index 83db01f..985f1e7 100644 --- a/build/controllers/ReleaseController.php +++ b/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[] */ diff --git a/build/controllers/TranslationController.php b/build/controllers/TranslationController.php index 9adc9c9..0200ad9 100644 --- a/build/controllers/TranslationController.php +++ b/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 diff --git a/build/controllers/Utf8Controller.php b/build/controllers/Utf8Controller.php index 133928a..64e8c0a 100644 --- a/build/controllers/Utf8Controller.php +++ b/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 * diff --git a/cs/src/YiiConfig.php b/cs/src/YiiConfig.php index c393270..4e2e28f 100644 --- a/cs/src/YiiConfig.php +++ b/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, diff --git a/framework/BaseYii.php b/framework/BaseYii.php index 7c67f32..3053f93 100644 --- a/framework/BaseYii.php +++ b/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, * diff --git a/framework/CHANGELOG.md b/framework/CHANGELOG.md index 077804a..9a56ead 100644 --- a/framework/CHANGELOG.md +++ b/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) diff --git a/framework/base/ActionFilter.php b/framework/base/ActionFilter.php index f66dd9f..0b9b974 100644 --- a/framework/base/ActionFilter.php +++ b/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 diff --git a/framework/base/Application.php b/framework/base/Application.php index 441f00c..d7b91c3 100644 --- a/framework/base/Application.php +++ b/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 diff --git a/framework/base/BaseObject.php b/framework/base/BaseObject.php index 714dd63..c579bbd 100644 --- a/framework/base/BaseObject.php +++ b/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 diff --git a/framework/base/Component.php b/framework/base/Component.php index 537bd4f..6db285c 100644 --- a/framework/base/Component.php +++ b/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 diff --git a/framework/base/Controller.php b/framework/base/Controller.php index 25fd570..68954d0 100644 --- a/framework/base/Controller.php +++ b/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, diff --git a/framework/base/ErrorHandler.php b/framework/base/ErrorHandler.php index cdd9355..1ec9608 100644 --- a/framework/base/ErrorHandler.php +++ b/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. */ diff --git a/framework/base/Model.php b/framework/base/Model.php index b1baa09..5c62dce 100644 --- a/framework/base/Model.php +++ b/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: * diff --git a/framework/base/Request.php b/framework/base/Request.php index 53af930..1271ae6 100644 --- a/framework/base/Request.php +++ b/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) diff --git a/framework/base/View.php b/framework/base/View.php index 4461752..3957cab 100644 --- a/framework/base/View.php +++ b/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. diff --git a/framework/base/Widget.php b/framework/base/Widget.php index fcf1511..0f32b79 100644 --- a/framework/base/Widget.php +++ b/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"); diff --git a/framework/caching/Cache.php b/framework/caching/Cache.php index d11b4bf..64106e6 100644 --- a/framework/caching/Cache.php +++ b/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 diff --git a/framework/caching/CacheInterface.php b/framework/caching/CacheInterface.php index 387d913..cc34415 100644 --- a/framework/caching/CacheInterface.php +++ b/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 diff --git a/framework/caching/DbQueryDependency.php b/framework/caching/DbQueryDependency.php index 95193fb..3aafd0f 100644 --- a/framework/caching/DbQueryDependency.php +++ b/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. diff --git a/framework/caching/Dependency.php b/framework/caching/Dependency.php index 5cfb5a9..9093e8e 100644 --- a/framework/caching/Dependency.php +++ b/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 diff --git a/framework/caching/MemCache.php b/framework/caching/MemCache.php index 92fa947..3c7e592 100644 --- a/framework/caching/MemCache.php +++ b/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 diff --git a/framework/caching/migrations/m150909_153426_cache_init.php b/framework/caching/migrations/m150909_153426_cache_init.php index 50a5488..4b55cd9 100644 --- a/framework/caching/migrations/m150909_153426_cache_init.php +++ b/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 * @since 2.0.7 diff --git a/framework/console/Controller.php b/framework/console/Controller.php index 5430bb0..ad0d7db 100644 --- a/framework/console/Controller.php +++ b/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: * diff --git a/framework/console/Markdown.php b/framework/console/Markdown.php index 0cdc067..0e62a81 100644 --- a/framework/console/Markdown.php +++ b/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 diff --git a/framework/console/controllers/BaseMigrateController.php b/framework/console/controllers/BaseMigrateController.php index dd694ed..f01a538 100644 --- a/framework/console/controllers/BaseMigrateController.php +++ b/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, * * ``` diff --git a/framework/console/controllers/CacheController.php b/framework/console/controllers/CacheController.php index 7e17f9c..ef53cd4 100644 --- a/framework/console/controllers/CacheController.php +++ b/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 */ diff --git a/framework/console/controllers/FixtureController.php b/framework/console/controllers/FixtureController.php index d74034b..8b159f1 100644 --- a/framework/console/controllers/FixtureController.php +++ b/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: * diff --git a/framework/console/controllers/HelpController.php b/framework/console/controllers/HelpController.php index f79b6d1..8c7f0ae 100644 --- a/framework/console/controllers/HelpController.php +++ b/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 diff --git a/framework/console/controllers/MessageController.php b/framework/console/controllers/MessageController.php index 0af3fea..da578da 100644 --- a/framework/console/controllers/MessageController.php +++ b/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 diff --git a/framework/console/controllers/MigrateController.php b/framework/console/controllers/MigrateController.php index 8c116de..e7ccc1d 100644 --- a/framework/console/controllers/MigrateController.php +++ b/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 */ diff --git a/framework/console/controllers/ServeController.php b/framework/console/controllers/ServeController.php index 65f1513..65e69bd 100644 --- a/framework/console/controllers/ServeController.php +++ b/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". * diff --git a/framework/console/widgets/Table.php b/framework/console/widgets/Table.php index 0c79b4d..e2066f1 100644 --- a/framework/console/widgets/Table.php +++ b/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 */ diff --git a/framework/data/ArrayDataProvider.php b/framework/data/ArrayDataProvider.php index c6f621a..516fb2d 100644 --- a/framework/data/ArrayDataProvider.php +++ b/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 diff --git a/framework/db/ActiveQueryTrait.php b/framework/db/ActiveQueryTrait.php index 7880dea..365606e 100644 --- a/framework/db/ActiveQueryTrait.php +++ b/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 diff --git a/framework/db/ActiveRecord.php b/framework/db/ActiveRecord.php index 081ada1..819eacd 100644 --- a/framework/db/ActiveRecord.php +++ b/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: * diff --git a/framework/db/ActiveRecordInterface.php b/framework/db/ActiveRecordInterface.php index 0400f6e..b5a7539 100644 --- a/framework/db/ActiveRecordInterface.php +++ b/framework/db/ActiveRecordInterface.php @@ -8,7 +8,7 @@ namespace yii\db; /** - * ActiveRecordInterface + * ActiveRecordInterface. * * @author Qiang Xue * @author Carsten Brandt @@ -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 diff --git a/framework/db/ActiveRelationTrait.php b/framework/db/ActiveRelationTrait.php index 1e141b5..4c9946a 100644 --- a/framework/db/ActiveRelationTrait.php +++ b/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 */ diff --git a/framework/db/BaseActiveRecord.php b/framework/db/BaseActiveRecord.php index e039247..7f17213 100644 --- a/framework/db/BaseActiveRecord.php +++ b/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 */ diff --git a/framework/db/ColumnSchemaBuilder.php b/framework/db/ColumnSchemaBuilder.php index 0f918ee..ba9ea59 100644 --- a/framework/db/ColumnSchemaBuilder.php +++ b/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 diff --git a/framework/db/Command.php b/framework/db/Command.php index d1058ac..0c713a9 100644 --- a/framework/db/Command.php +++ b/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() diff --git a/framework/db/Connection.php b/framework/db/Connection.php index df35e3e..d0fd06d 100644 --- a/framework/db/Connection.php +++ b/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 diff --git a/framework/db/DataReader.php b/framework/db/DataReader.php index b12bef9..ea84336 100644 --- a/framework/db/DataReader.php +++ b/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 */ diff --git a/framework/db/Expression.php b/framework/db/Expression.php index 6515b52..28e79b2 100644 --- a/framework/db/Expression.php +++ b/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() diff --git a/framework/db/Migration.php b/framework/db/Migration.php index aa31e7e..83a1ab5 100644 --- a/framework/db/Migration.php +++ b/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 diff --git a/framework/db/Query.php b/framework/db/Query.php index b86be81..0d5fea8 100644 --- a/framework/db/Query.php +++ b/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, * diff --git a/framework/db/QueryBuilder.php b/framework/db/QueryBuilder.php index f5f9196..a1fea92 100644 --- a/framework/db/QueryBuilder.php +++ b/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 diff --git a/framework/db/QueryTrait.php b/framework/db/QueryTrait.php index fc795c8..54870fd 100644 --- a/framework/db/QueryTrait.php +++ b/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 diff --git a/framework/db/Schema.php b/framework/db/Schema.php index d5708e9..2cfc200 100644 --- a/framework/db/Schema.php +++ b/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 diff --git a/framework/db/mssql/PDO.php b/framework/db/mssql/PDO.php index 196eaf5..005774c 100644 --- a/framework/db/mssql/PDO.php +++ b/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. diff --git a/framework/db/mssql/QueryBuilder.php b/framework/db/mssql/QueryBuilder.php index 07493a5..04afdd3 100644 --- a/framework/db/mssql/QueryBuilder.php +++ b/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 diff --git a/framework/db/mssql/Schema.php b/framework/db/mssql/Schema.php index 72e432a..d89292e 100644 --- a/framework/db/mssql/Schema.php +++ b/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 diff --git a/framework/db/mysql/Schema.php b/framework/db/mysql/Schema.php index 4cb62e0..c532fac 100644 --- a/framework/db/mysql/Schema.php +++ b/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 diff --git a/framework/db/oci/QueryBuilder.php b/framework/db/oci/QueryBuilder.php index 0d6b215..8e14ef3 100644 --- a/framework/db/oci/QueryBuilder.php +++ b/framework/db/oci/QueryBuilder.php @@ -229,6 +229,7 @@ EOD; /** * Generates a batch INSERT SQL statement. + * * For example, * * ```php diff --git a/framework/db/oci/Schema.php b/framework/db/oci/Schema.php index 1285441..f338769 100644 --- a/framework/db/oci/Schema.php +++ b/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. diff --git a/framework/db/pgsql/Schema.php b/framework/db/pgsql/Schema.php index 70fa8cc..0670ae5 100644 --- a/framework/db/pgsql/Schema.php +++ b/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 diff --git a/framework/db/sqlite/QueryBuilder.php b/framework/db/sqlite/QueryBuilder.php index 575be90..5b15aa0 100644 --- a/framework/db/sqlite/QueryBuilder.php +++ b/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 diff --git a/framework/db/sqlite/Schema.php b/framework/db/sqlite/Schema.php index 9887e11..21aa309 100644 --- a/framework/db/sqlite/Schema.php +++ b/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 diff --git a/framework/di/Container.php b/framework/di/Container.php index 5bb2976..b481ffe 100644 --- a/framework/di/Container.php +++ b/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. diff --git a/framework/di/Instance.php b/framework/di/Instance.php index dfc0ee9..af0044c 100644 --- a/framework/di/Instance.php +++ b/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 diff --git a/framework/filters/AccessRule.php b/framework/filters/AccessRule.php index 78b585e..ba88135 100644 --- a/framework/filters/AccessRule.php +++ b/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 * @since 2.0 diff --git a/framework/filters/Cors.php b/framework/filters/Cors.php index 3dd16db..8aba3a3 100644 --- a/framework/filters/Cors.php +++ b/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 */ diff --git a/framework/filters/HttpCache.php b/framework/filters/HttpCache.php index 022cb7d..5daf232 100644 --- a/framework/filters/HttpCache.php +++ b/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() diff --git a/framework/filters/RateLimiter.php b/framework/filters/RateLimiter.php index cb2f1c4..17e4392 100644 --- a/framework/filters/RateLimiter.php +++ b/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 diff --git a/framework/grid/ActionColumn.php b/framework/grid/ActionColumn.php index b2d1286..9ef1ed2 100644 --- a/framework/grid/ActionColumn.php +++ b/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 diff --git a/framework/grid/CheckboxColumn.php b/framework/grid/CheckboxColumn.php index b30e51e..632033f 100644 --- a/framework/grid/CheckboxColumn.php +++ b/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() diff --git a/framework/helpers/BaseConsole.php b/framework/helpers/BaseConsole.php index d23c74c..28a63ba 100644 --- a/framework/helpers/BaseConsole.php +++ b/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: diff --git a/framework/helpers/BaseFileHelper.php b/framework/helpers/BaseFileHelper.php index e097031..a92d4c9 100644 --- a/framework/helpers/BaseFileHelper.php +++ b/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") diff --git a/framework/helpers/BaseHtml.php b/framework/helpers/BaseHtml.php index 1ca4453..4cea3d8 100644 --- a/framework/helpers/BaseHtml.php +++ b/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 diff --git a/framework/helpers/BaseHtmlPurifier.php b/framework/helpers/BaseHtmlPurifier.php index bc6d5af..3c748a0 100644 --- a/framework/helpers/BaseHtmlPurifier.php +++ b/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. diff --git a/framework/helpers/BaseInflector.php b/framework/helpers/BaseInflector.php index ae6e06b..d3ddfaa 100644 --- a/framework/helpers/BaseInflector.php +++ b/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 */ diff --git a/framework/helpers/BaseJson.php b/framework/helpers/BaseJson.php index eef9d0b..5ac9394 100644 --- a/framework/helpers/BaseJson.php +++ b/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 */ diff --git a/framework/helpers/BaseStringHelper.php b/framework/helpers/BaseStringHelper.php index 4e1f190..bf98d9f 100644 --- a/framework/helpers/BaseStringHelper.php +++ b/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. diff --git a/framework/helpers/BaseUrl.php b/framework/helpers/BaseUrl.php index c2c14c0..ca85b64 100644 --- a/framework/helpers/BaseUrl.php +++ b/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: diff --git a/framework/helpers/FileHelper.php b/framework/helpers/FileHelper.php index f1f14d9..9322661 100644 --- a/framework/helpers/FileHelper.php +++ b/framework/helpers/FileHelper.php @@ -8,7 +8,7 @@ namespace yii\helpers; /** - * File system helper + * File system helper. * * @author Qiang Xue * @author Alex Makarov diff --git a/framework/helpers/StringHelper.php b/framework/helpers/StringHelper.php index 5ecd390..73960a3 100644 --- a/framework/helpers/StringHelper.php +++ b/framework/helpers/StringHelper.php @@ -8,7 +8,7 @@ namespace yii\helpers; /** - * StringHelper + * StringHelper. * * @author Qiang Xue * @author Alex Makarov diff --git a/framework/i18n/Formatter.php b/framework/i18n/Formatter.php index ce885ea..d5a7a60 100644 --- a/framework/i18n/Formatter.php +++ b/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 diff --git a/framework/i18n/MessageFormatter.php b/framework/i18n/MessageFormatter.php index f8d75d1..25de640 100644 --- a/framework/i18n/MessageFormatter.php +++ b/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 diff --git a/framework/log/SyslogTarget.php b/framework/log/SyslogTarget.php index 2c817b7..76007e4 100644 --- a/framework/log/SyslogTarget.php +++ b/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() { diff --git a/framework/rbac/BaseManager.php b/framework/rbac/BaseManager.php index 7b902b2..88672cf 100644 --- a/framework/rbac/BaseManager.php +++ b/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 diff --git a/framework/rbac/DbManager.php b/framework/rbac/DbManager.php index 862acbc..1a95d71 100644 --- a/framework/rbac/DbManager.php +++ b/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) */ diff --git a/framework/rbac/ManagerInterface.php b/framework/rbac/ManagerInterface.php index 0dd45e7..4d53d30 100644 --- a/framework/rbac/ManagerInterface.php +++ b/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 diff --git a/framework/rbac/migrations/m140506_102106_rbac_init.php b/framework/rbac/migrations/m140506_102106_rbac_init.php index 2c34a39..d5c01a7 100644 --- a/framework/rbac/migrations/m140506_102106_rbac_init.php +++ b/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 * @since 2.0 diff --git a/framework/test/FixtureTrait.php b/framework/test/FixtureTrait.php index c1abef2..49ca57f 100644 --- a/framework/test/FixtureTrait.php +++ b/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() diff --git a/framework/validators/DateValidator.php b/framework/validators/DateValidator.php index 4075a03..33e466b 100644 --- a/framework/validators/DateValidator.php +++ b/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 diff --git a/framework/validators/ExistValidator.php b/framework/validators/ExistValidator.php index 0cdd5a6..0ba8022 100644 --- a/framework/validators/ExistValidator.php +++ b/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 diff --git a/framework/validators/FileValidator.php b/framework/validators/FileValidator.php index 343d884..17393c4 100644 --- a/framework/validators/FileValidator.php +++ b/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 diff --git a/framework/validators/IpValidator.php b/framework/validators/IpValidator.php index 4abd9db..12a272e 100644 --- a/framework/validators/IpValidator.php +++ b/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 diff --git a/framework/validators/UniqueValidator.php b/framework/validators/UniqueValidator.php index e276ccb..c4e3b83 100644 --- a/framework/validators/UniqueValidator.php +++ b/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 diff --git a/framework/validators/Validator.php b/framework/validators/Validator.php index df2d902..0a9e14c 100644 --- a/framework/validators/Validator.php +++ b/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 */ diff --git a/framework/views/_createTable.php b/framework/views/_createTable.php index 0944c5f..0768299 100644 --- a/framework/views/_createTable.php +++ b/framework/views/_createTable.php @@ -1,7 +1,7 @@ diff --git a/framework/web/ErrorHandler.php b/framework/web/ErrorHandler.php index 51158c7..dad929d 100644 --- a/framework/web/ErrorHandler.php +++ b/framework/web/ErrorHandler.php @@ -412,7 +412,7 @@ class ErrorHandler extends \yii\base\ErrorHandler } /** - * Converts arguments array to its string representation + * Converts arguments array to its string representation. * * @param array $args arguments array to be converted * @return string string representation of the arguments array @@ -466,7 +466,7 @@ class ErrorHandler extends \yii\base\ErrorHandler } /** - * Returns human-readable exception name + * Returns human-readable exception name. * @param \Exception $exception * @return string human-readable exception name or null if it cannot be determined */ diff --git a/framework/web/GoneHttpException.php b/framework/web/GoneHttpException.php index 87faf74..ad736ac 100644 --- a/framework/web/GoneHttpException.php +++ b/framework/web/GoneHttpException.php @@ -8,7 +8,7 @@ namespace yii\web; /** - * GoneHttpException represents a "Gone" HTTP exception with status code 410 + * GoneHttpException represents a "Gone" HTTP exception with status code 410. * * Throw a GoneHttpException when a user requests a resource that no longer exists * at the requested url. For example, after a record is deleted, future requests diff --git a/framework/web/JsonParser.php b/framework/web/JsonParser.php index 061ea50..5225649 100644 --- a/framework/web/JsonParser.php +++ b/framework/web/JsonParser.php @@ -11,7 +11,7 @@ use yii\base\InvalidParamException; use yii\helpers\Json; /** - * Parses a raw HTTP request using [[\yii\helpers\Json::decode()]] + * Parses a raw HTTP request using [[\yii\helpers\Json::decode()]]. * * To enable parsing for JSON requests you can configure [[Request::parsers]] using this class: * diff --git a/framework/web/MultipartFormDataParser.php b/framework/web/MultipartFormDataParser.php index 633b327..67a2eb7 100644 --- a/framework/web/MultipartFormDataParser.php +++ b/framework/web/MultipartFormDataParser.php @@ -334,7 +334,8 @@ class MultipartFormDataParser extends BaseObject implements RequestParserInterfa /** * Gets the size in bytes from verbose size representation. - * For example: '5K' => 5*1024 + * + * For example: '5K' => 5*1024. * @param string $verboseSize verbose size representation. * @return int actual size in bytes. */ diff --git a/framework/web/NotAcceptableHttpException.php b/framework/web/NotAcceptableHttpException.php index 7bd39cb..65abdc4 100644 --- a/framework/web/NotAcceptableHttpException.php +++ b/framework/web/NotAcceptableHttpException.php @@ -8,7 +8,7 @@ namespace yii\web; /** - * NotAcceptableHttpException represents a "Not Acceptable" HTTP exception with status code 406 + * NotAcceptableHttpException represents a "Not Acceptable" HTTP exception with status code 406. * * Use this exception when the client requests a Content-Type that your * application cannot return. Note that, according to the HTTP 1.1 specification, diff --git a/framework/web/Request.php b/framework/web/Request.php index 37d2ceb..b8fa303 100644 --- a/framework/web/Request.php +++ b/framework/web/Request.php @@ -11,7 +11,7 @@ use Yii; use yii\base\InvalidConfigException; /** - * The web Request class represents an HTTP request + * The web Request class represents an HTTP request. * * It encapsulates the $_SERVER variable and resolves its inconsistency among different Web servers. * Also it provides an interface to retrieve request parameters from $_POST, $_GET, $_COOKIES and REST @@ -437,7 +437,7 @@ class Request extends \yii\base\Request } /** - * Returns whether this is a PJAX request + * Returns whether this is a PJAX request. * @return bool whether this is a PJAX request */ public function getIsPjax() @@ -1201,6 +1201,7 @@ class Request extends \yii\base\Request /** * Returns the content types acceptable by the end user. + * * This is determined by the `Accept` HTTP header. For example, * * ```php @@ -1434,6 +1435,7 @@ class Request extends \yii\base\Request /** * Returns the cookie collection. + * * Through the returned cookie collection, you may access a cookie using the following syntax: * * ```php @@ -1611,7 +1613,7 @@ class Request extends \yii\base\Request } /** - * Validates CSRF token + * Validates CSRF token. * * @param string $clientSuppliedToken The masked client-supplied token. * @param string $trueToken The masked true token. diff --git a/framework/web/Response.php b/framework/web/Response.php index 1d7af47..36bb41d 100644 --- a/framework/web/Response.php +++ b/framework/web/Response.php @@ -16,7 +16,7 @@ use yii\helpers\StringHelper; use yii\helpers\Url; /** - * The web Response class represents an HTTP response + * The web Response class represents an HTTP response. * * It holds the [[headers]], [[cookies]] and [[content]] that is to be sent to the client. * It also controls the HTTP [[statusCode|status code]]. @@ -358,7 +358,7 @@ class Response extends \yii\base\Response } /** - * Sends the response headers to the client + * Sends the response headers to the client. */ protected function sendHeaders() { @@ -407,7 +407,7 @@ class Response extends \yii\base\Response } /** - * Sends the response content to the client + * Sends the response content to the client. */ protected function sendContent() { @@ -742,7 +742,7 @@ class Response extends \yii\base\Response } /** - * Returns Content-Disposition header value that is safe to use with both old and new browsers + * Returns Content-Disposition header value that is safe to use with both old and new browsers. * * Fallback name: * @@ -892,6 +892,7 @@ class Response extends \yii\base\Response /** * Returns the cookie collection. + * * Through the returned cookie collection, you add or remove cookies as follows, * * ```php diff --git a/framework/web/Session.php b/framework/web/Session.php index 3e4e2c2..ac2c8be 100644 --- a/framework/web/Session.php +++ b/framework/web/Session.php @@ -402,6 +402,7 @@ class Session extends Component implements \IteratorAggregate, \ArrayAccess, \Co /** * Sets the value indicating whether cookies should be used to store session IDs. + * * Three states are possible: * * - true: cookies and only cookies will be used to store session IDs. @@ -628,7 +629,7 @@ class Session extends Component implements \IteratorAggregate, \ArrayAccess, \Co } /** - * Removes all session variables + * Removes all session variables. */ public function removeAll() { diff --git a/framework/web/TooManyRequestsHttpException.php b/framework/web/TooManyRequestsHttpException.php index 0646434..eb60211 100644 --- a/framework/web/TooManyRequestsHttpException.php +++ b/framework/web/TooManyRequestsHttpException.php @@ -8,7 +8,7 @@ namespace yii\web; /** - * TooManyRequestsHttpException represents a "Too Many Requests" HTTP exception with status code 429 + * TooManyRequestsHttpException represents a "Too Many Requests" HTTP exception with status code 429. * * Use this exception to indicate that a client has made too many requests in a * given period of time. For example, you would throw this exception when diff --git a/framework/web/UnauthorizedHttpException.php b/framework/web/UnauthorizedHttpException.php index db26548..2f8350e 100644 --- a/framework/web/UnauthorizedHttpException.php +++ b/framework/web/UnauthorizedHttpException.php @@ -8,7 +8,7 @@ namespace yii\web; /** - * UnauthorizedHttpException represents an "Unauthorized" HTTP exception with status code 401 + * UnauthorizedHttpException represents an "Unauthorized" HTTP exception with status code 401. * * Use this exception to indicate that a client needs to authenticate via WWW-Authenticate header * to perform the requested action. diff --git a/framework/web/UnsupportedMediaTypeHttpException.php b/framework/web/UnsupportedMediaTypeHttpException.php index 903dd17..5942ea2 100644 --- a/framework/web/UnsupportedMediaTypeHttpException.php +++ b/framework/web/UnsupportedMediaTypeHttpException.php @@ -8,7 +8,7 @@ namespace yii\web; /** - * UnsupportedMediaTypeHttpException represents an "Unsupported Media Type" HTTP exception with status code 415 + * UnsupportedMediaTypeHttpException represents an "Unsupported Media Type" HTTP exception with status code 415. * * Use this exception when the client sends data in a format that your * application does not understand. For example, you would throw this exception diff --git a/framework/web/UrlManager.php b/framework/web/UrlManager.php index 171b1a3..ab31cec 100644 --- a/framework/web/UrlManager.php +++ b/framework/web/UrlManager.php @@ -449,7 +449,7 @@ class UrlManager extends Component } /** - * Get URL from internal cache if exists + * Get URL from internal cache if exists. * @param string $cacheKey generated cache key to store data. * @param string $route the route (e.g. `site/index`). * @param array $params rule params. @@ -474,7 +474,7 @@ class UrlManager extends Component } /** - * Store rule (e.g. [[UrlRule]]) to internal cache + * Store rule (e.g. [[UrlRule]]) to internal cache. * @param $cacheKey * @param UrlRuleInterface $rule * @since 2.0.8 diff --git a/framework/web/UrlRule.php b/framework/web/UrlRule.php index 7319919..2c7d71e 100644 --- a/framework/web/UrlRule.php +++ b/framework/web/UrlRule.php @@ -33,11 +33,11 @@ use yii\base\InvalidConfigException; class UrlRule extends BaseObject implements UrlRuleInterface { /** - * Set [[mode]] with this value to mark that this rule is for URL parsing only + * Set [[mode]] with this value to mark that this rule is for URL parsing only. */ const PARSING_ONLY = 1; /** - * Set [[mode]] with this value to mark that this rule is for URL creation only + * Set [[mode]] with this value to mark that this rule is for URL creation only. */ const CREATION_ONLY = 2; /** diff --git a/framework/web/ViewAction.php b/framework/web/ViewAction.php index 17c2d45..84ca319 100644 --- a/framework/web/ViewAction.php +++ b/framework/web/ViewAction.php @@ -98,7 +98,7 @@ class ViewAction extends Action } /** - * Renders a view + * Renders a view. * * @param string $viewName view name * @return string result of the rendering diff --git a/framework/web/XmlResponseFormatter.php b/framework/web/XmlResponseFormatter.php index f990067..11723e7 100644 --- a/framework/web/XmlResponseFormatter.php +++ b/framework/web/XmlResponseFormatter.php @@ -126,7 +126,7 @@ class XmlResponseFormatter extends Component implements ResponseFormatterInterfa } /** - * Formats scalar value to use in XML text node + * Formats scalar value to use in XML text node. * * @param int|string|bool $value * @return string @@ -165,7 +165,7 @@ class XmlResponseFormatter extends Component implements ResponseFormatterInterfa } /** - * Checks if name is valid to be used in XML + * Checks if name is valid to be used in XML. * * @param mixed $name * @return bool diff --git a/framework/web/migrations/m160313_153426_session_init.php b/framework/web/migrations/m160313_153426_session_init.php index 279ebf9..9ebc951 100644 --- a/framework/web/migrations/m160313_153426_session_init.php +++ b/framework/web/migrations/m160313_153426_session_init.php @@ -8,7 +8,7 @@ use yii\db\Migration; /** - * Initializes Session tables + * Initializes Session tables. * * @author Misbahul D Munir * @since 2.0.8 diff --git a/framework/widgets/ActiveField.php b/framework/widgets/ActiveField.php index 68d634c..dc6c6d7 100644 --- a/framework/widgets/ActiveField.php +++ b/framework/widgets/ActiveField.php @@ -819,7 +819,7 @@ class ActiveField extends Component } /** - * Checks if client validation enabled for the field + * Checks if client validation enabled for the field. * @return bool * @since 2.0.11 */ @@ -829,7 +829,7 @@ class ActiveField extends Component } /** - * Checks if ajax validation enabled for the field + * Checks if ajax validation enabled for the field. * @return bool * @since 2.0.11 */ @@ -849,7 +849,7 @@ class ActiveField extends Component } /** - * Adds aria attributes to the input options + * Adds aria attributes to the input options. * @param $options array input options * @since 2.0.11 */ diff --git a/framework/widgets/MaskedInput.php b/framework/widgets/MaskedInput.php index 20630ed..db44cb4 100644 --- a/framework/widgets/MaskedInput.php +++ b/framework/widgets/MaskedInput.php @@ -132,7 +132,9 @@ class MaskedInput extends InputWidget } /** - * Generates a hashed variable to store the plugin `clientOptions`. Helps in reusing the variable for similar + * Generates a hashed variable to store the plugin `clientOptions`. + * + * Helps in reusing the variable for similar * options passed for other widgets on the same page. The following special data attribute will also be * added to the input field to allow accessing the client options via javascript: * @@ -150,7 +152,7 @@ class MaskedInput extends InputWidget } /** - * Initializes client options + * Initializes client options. */ protected function initClientOptions() { diff --git a/tests/TestCase.php b/tests/TestCase.php index fb00046..41d5ee4 100644 --- a/tests/TestCase.php +++ b/tests/TestCase.php @@ -28,7 +28,7 @@ abstract class TestCase extends \PHPUnit\Framework\TestCase } /** - * Returns a test configuration param from /data/config.php + * Returns a test configuration param from /data/config.php. * @param string $name params name * @param mixed $default default value to use when param is not set. * @return mixed the value of the configuration param @@ -109,7 +109,7 @@ abstract class TestCase extends \PHPUnit\Framework\TestCase } /** - * Asserting two strings equality ignoring line endings + * Asserting two strings equality ignoring line endings. * @param string $expected * @param string $actual */ @@ -122,7 +122,7 @@ abstract class TestCase extends \PHPUnit\Framework\TestCase } /** - * Invokes a inaccessible method + * Invokes a inaccessible method. * @param $object * @param $method * @param array $args @@ -144,7 +144,7 @@ abstract class TestCase extends \PHPUnit\Framework\TestCase } /** - * Sets an inaccessible object property to a designated value + * Sets an inaccessible object property to a designated value. * @param $object * @param $propertyName * @param $value @@ -166,7 +166,7 @@ abstract class TestCase extends \PHPUnit\Framework\TestCase } /** - * Gets an inaccessible object property + * Gets an inaccessible object property. * @param $object * @param $propertyName * @param bool $revoke whether to make property inaccessible after getting @@ -190,7 +190,7 @@ abstract class TestCase extends \PHPUnit\Framework\TestCase /** - * Asserts that value is one of expected values + * Asserts that value is one of expected values. * * @param mixed $actual * @param array $expected diff --git a/tests/data/ar/Animal.php b/tests/data/ar/Animal.php index 98900f5..7f7d866 100644 --- a/tests/data/ar/Animal.php +++ b/tests/data/ar/Animal.php @@ -9,7 +9,7 @@ namespace yiiunit\data\ar; /** - * Class Animal + * Class Animal. * * @author Jose Lorente * @property int $id diff --git a/tests/data/ar/BitValues.php b/tests/data/ar/BitValues.php index e63256e..fbd5346 100644 --- a/tests/data/ar/BitValues.php +++ b/tests/data/ar/BitValues.php @@ -9,7 +9,7 @@ namespace yiiunit\data\ar; /** - * https://github.com/yiisoft/yii2/issues/9006 + * @see https://github.com/yiisoft/yii2/issues/9006 * * @property int $id * @property int $val diff --git a/tests/data/ar/Cat.php b/tests/data/ar/Cat.php index 7ad69ba..bfef4d0 100644 --- a/tests/data/ar/Cat.php +++ b/tests/data/ar/Cat.php @@ -9,7 +9,7 @@ namespace yiiunit\data\ar; /** - * Class Cat + * Class Cat. * * @author Jose Lorente * @since 2.0 diff --git a/tests/data/ar/Customer.php b/tests/data/ar/Customer.php index 216d6e1..89cdedf 100644 --- a/tests/data/ar/Customer.php +++ b/tests/data/ar/Customer.php @@ -11,7 +11,7 @@ use yii\db\ActiveQuery; use yiiunit\framework\db\ActiveRecordTest; /** - * Class Customer + * Class Customer. * * @property int $id * @property string $name diff --git a/tests/data/ar/CustomerQuery.php b/tests/data/ar/CustomerQuery.php index 567991c..a53ec90 100644 --- a/tests/data/ar/CustomerQuery.php +++ b/tests/data/ar/CustomerQuery.php @@ -10,7 +10,7 @@ namespace yiiunit\data\ar; use yii\db\ActiveQuery; /** - * CustomerQuery + * CustomerQuery. */ class CustomerQuery extends ActiveQuery { diff --git a/tests/data/ar/DefaultPk.php b/tests/data/ar/DefaultPk.php index 5fbb7eb..1a0d9ad 100644 --- a/tests/data/ar/DefaultPk.php +++ b/tests/data/ar/DefaultPk.php @@ -8,7 +8,7 @@ namespace yiiunit\data\ar; /** - * DefaultPk + * DefaultPk. * * @author Jan Waś * @property int $id diff --git a/tests/data/ar/Dog.php b/tests/data/ar/Dog.php index 1f0f2d7..17cac2e 100644 --- a/tests/data/ar/Dog.php +++ b/tests/data/ar/Dog.php @@ -9,7 +9,7 @@ namespace yiiunit\data\ar; /** - * Class Dog + * Class Dog. * * @author Jose Lorente * @since 2.0 diff --git a/tests/data/ar/Item.php b/tests/data/ar/Item.php index f2447c3..8a9f2da 100644 --- a/tests/data/ar/Item.php +++ b/tests/data/ar/Item.php @@ -8,7 +8,7 @@ namespace yiiunit\data\ar; /** - * Class Item + * Class Item. * * @property int $id * @property string $name diff --git a/tests/data/ar/NullValues.php b/tests/data/ar/NullValues.php index c2766a0..afa4548 100644 --- a/tests/data/ar/NullValues.php +++ b/tests/data/ar/NullValues.php @@ -8,7 +8,7 @@ namespace yiiunit\data\ar; /** - * Class NullValues + * Class NullValues. * * @property int $id * @property int $var1 diff --git a/tests/data/ar/Order.php b/tests/data/ar/Order.php index 9e65b48..ae6e82c 100644 --- a/tests/data/ar/Order.php +++ b/tests/data/ar/Order.php @@ -8,7 +8,7 @@ namespace yiiunit\data\ar; /** - * Class Order + * Class Order. * * @property int $id * @property int $customer_id diff --git a/tests/data/ar/OrderItem.php b/tests/data/ar/OrderItem.php index 117abbe..d0df290 100644 --- a/tests/data/ar/OrderItem.php +++ b/tests/data/ar/OrderItem.php @@ -8,7 +8,7 @@ namespace yiiunit\data\ar; /** - * Class OrderItem + * Class OrderItem. * * @property int $order_id * @property int $item_id diff --git a/tests/data/ar/OrderItemWithNullFK.php b/tests/data/ar/OrderItemWithNullFK.php index 09c3494..cc50b62 100644 --- a/tests/data/ar/OrderItemWithNullFK.php +++ b/tests/data/ar/OrderItemWithNullFK.php @@ -8,7 +8,7 @@ namespace yiiunit\data\ar; /** - * Class OrderItem + * Class OrderItem. * * @property int $order_id * @property int $item_id diff --git a/tests/data/ar/OrderWithNullFK.php b/tests/data/ar/OrderWithNullFK.php index ef09bab..c4c539e 100644 --- a/tests/data/ar/OrderWithNullFK.php +++ b/tests/data/ar/OrderWithNullFK.php @@ -8,7 +8,7 @@ namespace yiiunit\data\ar; /** - * Class Order + * Class Order. * * @property int $id * @property int $customer_id diff --git a/tests/data/ar/Profile.php b/tests/data/ar/Profile.php index 9bd1285..5b02be3 100644 --- a/tests/data/ar/Profile.php +++ b/tests/data/ar/Profile.php @@ -8,7 +8,7 @@ namespace yiiunit\data\ar; /** - * Class Profile + * Class Profile. * * @property int $id * @property string $description diff --git a/tests/data/ar/Type.php b/tests/data/ar/Type.php index 0b86110..bd02d4e 100644 --- a/tests/data/ar/Type.php +++ b/tests/data/ar/Type.php @@ -8,7 +8,7 @@ namespace yiiunit\data\ar; /** - * Model representing type table + * Model representing type table. * * @property int $int_col * @property int $int_col2 DEFAULT 1 diff --git a/tests/data/base/InvalidRulesModel.php b/tests/data/base/InvalidRulesModel.php index 4b76f85..fd80c42 100644 --- a/tests/data/base/InvalidRulesModel.php +++ b/tests/data/base/InvalidRulesModel.php @@ -10,7 +10,7 @@ namespace yiiunit\data\base; use yii\base\Model; /** - * InvalidRulesModel + * InvalidRulesModel. */ class InvalidRulesModel extends Model { diff --git a/tests/data/base/RulesModel.php b/tests/data/base/RulesModel.php index f605b43..e8458ac 100644 --- a/tests/data/base/RulesModel.php +++ b/tests/data/base/RulesModel.php @@ -10,7 +10,7 @@ namespace yiiunit\data\base; use yii\base\Model; /** - * model to test different rules combinations in ModelTest + * Model to test different rules combinations in ModelTest. */ class RulesModel extends Model { diff --git a/tests/data/base/Singer.php b/tests/data/base/Singer.php index 9ae6295..444eb54 100644 --- a/tests/data/base/Singer.php +++ b/tests/data/base/Singer.php @@ -10,7 +10,7 @@ namespace yiiunit\data\base; use yii\base\Model; /** - * Singer + * Singer. */ class Singer extends Model { diff --git a/tests/data/base/Speaker.php b/tests/data/base/Speaker.php index 2bd3a65..64c3720 100644 --- a/tests/data/base/Speaker.php +++ b/tests/data/base/Speaker.php @@ -10,7 +10,7 @@ namespace yiiunit\data\base; use yii\base\Model; /** - * Speaker + * Speaker. */ class Speaker extends Model { diff --git a/tests/data/cache/MockDependency.php b/tests/data/cache/MockDependency.php index 7ee846a..794dad8 100644 --- a/tests/data/cache/MockDependency.php +++ b/tests/data/cache/MockDependency.php @@ -10,7 +10,7 @@ namespace yiiunit\data\cache; use yii\caching\Dependency; /** - * Class MockDependency + * Class MockDependency. * * @author Boudewijn Vahrmeijer * @since 2.0.11 diff --git a/tests/data/config-docker.php b/tests/data/config-docker.php index ba1ca64..86c3f83 100644 --- a/tests/data/config-docker.php +++ b/tests/data/config-docker.php @@ -7,13 +7,17 @@ /** * This is the configuration file for the Yii 2 unit tests. + * * You can override configuration values by creating a `config.local.php` file * and manipulate the `$config` variable. * For example to change MySQL username and password your `config.local.php` should * contain the following: + * + * ```php * [ diff --git a/tests/data/config.php b/tests/data/config.php index 22694f4..1ccae2d 100644 --- a/tests/data/config.php +++ b/tests/data/config.php @@ -7,13 +7,16 @@ /** * This is the configuration file for the Yii 2 unit tests. + * * You can override configuration values by creating a `config.local.php` file * and manipulate the `$config` variable. * For example to change MySQL username and password your `config.local.php` should * contain the following: + * ```php * [ diff --git a/tests/framework/BaseYiiTest.php b/tests/framework/BaseYiiTest.php index 8216ed5..2bf3e9e 100644 --- a/tests/framework/BaseYiiTest.php +++ b/tests/framework/BaseYiiTest.php @@ -15,7 +15,7 @@ use yiiunit\data\base\Singer; use yiiunit\TestCase; /** - * BaseYiiTest + * BaseYiiTest. * @group base */ class BaseYiiTest extends TestCase diff --git a/tests/framework/ar/ActiveRecordTestTrait.php b/tests/framework/ar/ActiveRecordTestTrait.php index 2e76ba5..5ffd10f 100644 --- a/tests/framework/ar/ActiveRecordTestTrait.php +++ b/tests/framework/ar/ActiveRecordTestTrait.php @@ -25,25 +25,25 @@ trait ActiveRecordTestTrait { /* @var $this TestCase */ /** - * This method should return the classname of Customer class + * This method should return the classname of Customer class. * @return string */ abstract public function getCustomerClass(); /** - * This method should return the classname of Order class + * This method should return the classname of Order class. * @return string */ abstract public function getOrderClass(); /** - * This method should return the classname of OrderItem class + * This method should return the classname of OrderItem class. * @return string */ abstract public function getOrderItemClass(); /** - * This method should return the classname of Item class + * This method should return the classname of Item class. * @return string */ abstract public function getItemClass(); @@ -53,7 +53,7 @@ trait ActiveRecordTestTrait abstract public function getOrderItemWithNullFKmClass(); /** - * can be overridden to do things after save() + * Can be overridden to do things after save(). */ public function afterSave() { @@ -559,8 +559,9 @@ trait ActiveRecordTestTrait } /** - * Ensure ActiveRelationTrait does preserve order of items on find via() - * https://github.com/yiisoft/yii2/issues/1310 + * Ensure ActiveRelationTrait does preserve order of items on find via(). + * + * @see https://github.com/yiisoft/yii2/issues/1310. */ public function testFindEagerViaRelationPreserveOrder() { diff --git a/tests/framework/base/ExposedSecurity.php b/tests/framework/base/ExposedSecurity.php index db4408f..2e7e45a 100644 --- a/tests/framework/base/ExposedSecurity.php +++ b/tests/framework/base/ExposedSecurity.php @@ -10,7 +10,7 @@ namespace yiiunit\framework\base; use yii\base\Security; /** - * ExposedSecurity exposes protected methods for direct testing + * ExposedSecurity exposes protected methods for direct testing. */ class ExposedSecurity extends Security { diff --git a/tests/framework/base/SecurityTest.php b/tests/framework/base/SecurityTest.php index 87abab2..e0d9d4b 100644 --- a/tests/framework/base/SecurityTest.php +++ b/tests/framework/base/SecurityTest.php @@ -23,8 +23,8 @@ namespace yii\base { return \function_exists($name); } /** - * emulate chunked reading of fread(), to test different branches of Security class - * where different execution paths are chosen based on the return value of fopen/fread + * Emulate chunked reading of fread(), to test different branches of Security class + * where different execution paths are chosen based on the return value of fopen/fread. * * This function overrides fopen and fread from the root namespace in yii\base. * @param string $filename @@ -159,10 +159,10 @@ class SecurityTest extends TestCase } /** - * Generates test vectors like this: - * [key/password, plaintext, ciphertext] + * Generates test vectors like this: `[key/password, plaintext, ciphertext]`. + * * The output can then be used for testing compatibility of data encrypted in one - * version of Yii and decrypted in another + * version of Yii and decrypted in another. */ public function notestGenerateVectors() { @@ -889,7 +889,7 @@ TEXT; } /** - * Test the case where opening /dev/urandom fails + * Test the case where opening /dev/urandom fails. */ public function testRandomKeyNoOptions() { @@ -902,7 +902,7 @@ TEXT; } /** - * Test the case where reading from /dev/urandom fails + * Test the case where reading from /dev/urandom fails. */ public function testRandomKeyFreadFailure() { diff --git a/tests/framework/caching/ApcCacheTest.php b/tests/framework/caching/ApcCacheTest.php index 80b5dfb..2ff6669 100644 --- a/tests/framework/caching/ApcCacheTest.php +++ b/tests/framework/caching/ApcCacheTest.php @@ -10,7 +10,7 @@ namespace yiiunit\framework\caching; use yii\caching\ApcCache; /** - * Class for testing APC cache backend + * Class for testing APC cache backend. * @group apc * @group caching */ diff --git a/tests/framework/caching/ArrayCacheTest.php b/tests/framework/caching/ArrayCacheTest.php index add894f..9aa7a1d 100644 --- a/tests/framework/caching/ArrayCacheTest.php +++ b/tests/framework/caching/ArrayCacheTest.php @@ -10,7 +10,7 @@ namespace yiiunit\framework\caching; use yii\caching\ArrayCache; /** - * Class for testing file cache backend + * Class for testing file cache backend. * @group caching */ class ArrayCacheTest extends CacheTestCase diff --git a/tests/framework/caching/CacheTestCase.php b/tests/framework/caching/CacheTestCase.php index b3211c4..7e32cbd 100644 --- a/tests/framework/caching/CacheTestCase.php +++ b/tests/framework/caching/CacheTestCase.php @@ -8,7 +8,7 @@ namespace yii\caching; /** - * Mock for the time() function for caching classes + * Mock for the time() function for caching classes. * @return int */ function time() @@ -17,7 +17,7 @@ function time() } /** - * Mock for the microtime() function for caching classes + * Mock for the microtime() function for caching classes. * @param bool $float * @return float */ @@ -33,7 +33,7 @@ use yii\caching\TagDependency; use yiiunit\TestCase; /** - * Base class for testing cache backends + * Base class for testing cache backends. */ abstract class CacheTestCase extends TestCase { diff --git a/tests/framework/caching/DbCacheTest.php b/tests/framework/caching/DbCacheTest.php index 557701c..7e9e17b 100644 --- a/tests/framework/caching/DbCacheTest.php +++ b/tests/framework/caching/DbCacheTest.php @@ -10,7 +10,7 @@ namespace yiiunit\framework\caching; use yii\caching\DbCache; /** - * Class for testing file cache backend + * Class for testing file cache backend. * @group db * @group caching */ diff --git a/tests/framework/caching/DependencyTest.php b/tests/framework/caching/DependencyTest.php index 255c804..a97ca9f 100644 --- a/tests/framework/caching/DependencyTest.php +++ b/tests/framework/caching/DependencyTest.php @@ -13,7 +13,7 @@ use yiiunit\data\cache\MockDependency; use yiiunit\TestCase; /** - * Dependency (abstract) tests + * Dependency (abstract) tests. * @group caching * @author Boudewijn Vahrmeijer * @since 2.0.11 diff --git a/tests/framework/caching/FileCacheTest.php b/tests/framework/caching/FileCacheTest.php index 7129c88..5c6dbd1 100644 --- a/tests/framework/caching/FileCacheTest.php +++ b/tests/framework/caching/FileCacheTest.php @@ -10,7 +10,7 @@ namespace yiiunit\framework\caching; use yii\caching\FileCache; /** - * Class for testing file cache backend + * Class for testing file cache backend. * @group caching */ class FileCacheTest extends CacheTestCase diff --git a/tests/framework/caching/MemCacheTest.php b/tests/framework/caching/MemCacheTest.php index 410560b..dc99311 100644 --- a/tests/framework/caching/MemCacheTest.php +++ b/tests/framework/caching/MemCacheTest.php @@ -10,7 +10,7 @@ namespace yiiunit\framework\caching; use yii\caching\MemCache; /** - * Class for testing memcache cache backend + * Class for testing memcache cache backend. * @group memcache * @group caching */ diff --git a/tests/framework/caching/MemCachedTest.php b/tests/framework/caching/MemCachedTest.php index 05682f3..6521a00 100644 --- a/tests/framework/caching/MemCachedTest.php +++ b/tests/framework/caching/MemCachedTest.php @@ -10,7 +10,7 @@ namespace yiiunit\framework\caching; use yii\caching\MemCache; /** - * Class for testing memcached cache backend + * Class for testing memcached cache backend. * @group memcached * @group caching */ diff --git a/tests/framework/caching/WinCacheTest.php b/tests/framework/caching/WinCacheTest.php index e290692..5ebdf7d 100644 --- a/tests/framework/caching/WinCacheTest.php +++ b/tests/framework/caching/WinCacheTest.php @@ -10,7 +10,7 @@ namespace yiiunit\framework\caching; use yii\caching\WinCache; /** - * Class for testing wincache backend + * Class for testing wincache backend. * @group wincache * @group caching */ diff --git a/tests/framework/caching/XCacheTest.php b/tests/framework/caching/XCacheTest.php index 6702829..e8fe20b 100644 --- a/tests/framework/caching/XCacheTest.php +++ b/tests/framework/caching/XCacheTest.php @@ -10,7 +10,7 @@ namespace yiiunit\framework\caching; use yii\caching\XCache; /** - * Class for testing xcache backend + * Class for testing xcache backend. * @group xcache * @group caching */ diff --git a/tests/framework/caching/ZendDataCacheTest.php b/tests/framework/caching/ZendDataCacheTest.php index 86b5bf1..9531738 100644 --- a/tests/framework/caching/ZendDataCacheTest.php +++ b/tests/framework/caching/ZendDataCacheTest.php @@ -10,7 +10,7 @@ namespace yiiunit\framework\caching; use yii\caching\ZendDataCache; /** - * Class for testing Zend cache backend + * Class for testing Zend cache backend. * @group zenddata * @group caching */ diff --git a/tests/framework/console/controllers/AssetControllerTest.php b/tests/framework/console/controllers/AssetControllerTest.php index 881ac98..ad1f853 100644 --- a/tests/framework/console/controllers/AssetControllerTest.php +++ b/tests/framework/console/controllers/AssetControllerTest.php @@ -571,7 +571,7 @@ EOL; } /** - * Data provider for [[testFindRealPath()]] + * Data provider for [[testFindRealPath()]]. * @return array test data */ public function findRealPathDataProvider() @@ -752,7 +752,7 @@ EOL; } /** - * Mock class for [[\yii\console\controllers\AssetController]] + * Mock class for [[\yii\console\controllers\AssetController]]. */ class AssetControllerMock extends AssetController { diff --git a/tests/framework/console/controllers/BaseMessageControllerTest.php b/tests/framework/console/controllers/BaseMessageControllerTest.php index 352b4e0..c67110b 100644 --- a/tests/framework/console/controllers/BaseMessageControllerTest.php +++ b/tests/framework/console/controllers/BaseMessageControllerTest.php @@ -100,7 +100,7 @@ abstract class BaseMessageControllerTest extends TestCase } /** - * Creates source file with given content + * Creates source file with given content. * @param string $content file content * @return string path to source file */ @@ -112,7 +112,7 @@ abstract class BaseMessageControllerTest extends TestCase } /** - * Saves messages + * Saves messages. * * @param array $messages * @param string $category @@ -120,7 +120,7 @@ abstract class BaseMessageControllerTest extends TestCase abstract protected function saveMessages($messages, $category); /** - * Loads messages + * Loads messages. * * @param string $category * @return array @@ -133,7 +133,7 @@ abstract class BaseMessageControllerTest extends TestCase abstract protected function getDefaultConfig(); /** - * Returns config + * Returns config. * * @param array $additionalConfig * @return array diff --git a/tests/framework/console/controllers/MigrateControllerTestTrait.php b/tests/framework/console/controllers/MigrateControllerTestTrait.php index 3fb3b91..663c5f5 100644 --- a/tests/framework/console/controllers/MigrateControllerTestTrait.php +++ b/tests/framework/console/controllers/MigrateControllerTestTrait.php @@ -13,7 +13,7 @@ use yii\helpers\FileHelper; use yiiunit\TestCase; /** - * This trait provides unit tests shared by the different migration controllers implementations + * This trait provides unit tests shared by the different migration controllers implementations. * @see BaseMigrateController */ trait MigrateControllerTestTrait @@ -162,7 +162,7 @@ CODE; } /** - * Change class name migration to $class + * Change class name migration to $class. * @param string $class name class * @return string content generated class migration * @see https://github.com/yiisoft/yii2/pull/10213 @@ -491,7 +491,7 @@ CODE; } /** - * Test migration with using multiple migration paths and namespaces + * Test migration with using multiple migration paths and namespaces. */ public function testCombinedMigrationProcess() { diff --git a/tests/framework/console/controllers/StdOutBufferControllerTrait.php b/tests/framework/console/controllers/StdOutBufferControllerTrait.php index bfae262..7449436 100644 --- a/tests/framework/console/controllers/StdOutBufferControllerTrait.php +++ b/tests/framework/console/controllers/StdOutBufferControllerTrait.php @@ -9,7 +9,7 @@ namespace yiiunit\framework\console\controllers; /** * StdOutBufferControllerTrait is a trait, which can be applied to [[yii\console\Controller]], - * allowing to store all output into internal buffer instead of direct sending it to 'stdout' + * allowing to store all output into internal buffer instead of direct sending it to 'stdout'. */ trait StdOutBufferControllerTrait { diff --git a/tests/framework/data/BaseDataProviderTest.php b/tests/framework/data/BaseDataProviderTest.php index d59b5e0..0fc1003 100644 --- a/tests/framework/data/BaseDataProviderTest.php +++ b/tests/framework/data/BaseDataProviderTest.php @@ -28,7 +28,7 @@ class BaseDataProviderTest extends TestCase } /** - * ConcreteDataProvider + * ConcreteDataProvider. */ class ConcreteDataProvider extends BaseDataProvider { diff --git a/tests/framework/data/PaginationTest.php b/tests/framework/data/PaginationTest.php index c83dd33..98bc9ec 100644 --- a/tests/framework/data/PaginationTest.php +++ b/tests/framework/data/PaginationTest.php @@ -28,7 +28,7 @@ class PaginationTest extends TestCase } /** - * Data provider for [[testCreateUrl()]] + * Data provider for [[testCreateUrl()]]. * @return array test data */ public function dataProviderCreateUrl() diff --git a/tests/framework/db/ActiveQueryTest.php b/tests/framework/db/ActiveQueryTest.php index 5fe6d5b..9de1d62 100644 --- a/tests/framework/db/ActiveQueryTest.php +++ b/tests/framework/db/ActiveQueryTest.php @@ -16,7 +16,7 @@ use yiiunit\data\ar\Customer; use yiiunit\data\ar\Profile; /** - * Class ActiveQueryTest the base class for testing ActiveQuery + * Class ActiveQueryTest the base class for testing ActiveQuery. */ abstract class ActiveQueryTest extends DatabaseTestCase { diff --git a/tests/framework/db/ActiveRecordTest.php b/tests/framework/db/ActiveRecordTest.php index 8e37388..6f8e95d 100644 --- a/tests/framework/db/ActiveRecordTest.php +++ b/tests/framework/db/ActiveRecordTest.php @@ -241,7 +241,7 @@ abstract class ActiveRecordTest extends DatabaseTestCase } /** - * https://github.com/yiisoft/yii2/issues/5341 + * @see https://github.com/yiisoft/yii2/issues/5341 * * Issue: Plan 1 -- * Account * -- * User * Our Tests: Category 1 -- * Item * -- * Order @@ -584,8 +584,9 @@ abstract class ActiveRecordTest extends DatabaseTestCase } /** - * This query will do the same join twice, ensure duplicated JOIN gets removed - * https://github.com/yiisoft/yii2/pull/2650 + * This query will do the same join twice, ensure duplicated JOIN gets removed. + * + * @see https://github.com/yiisoft/yii2/pull/2650 */ public function testJoinWithVia() { @@ -609,7 +610,7 @@ abstract class ActiveRecordTest extends DatabaseTestCase } /** - * Tests the alias syntax for joinWith: 'alias' => 'relation' + * Tests the alias syntax for joinWith: 'alias' => 'relation'. * @dataProvider aliasMethodProvider * @param string $aliasMethod whether alias is specified explicitly or using the query syntax {{@tablename}} */ @@ -885,8 +886,8 @@ abstract class ActiveRecordTest extends DatabaseTestCase } /** - * https://github.com/yiisoft/yii2/issues/10201 - * https://github.com/yiisoft/yii2/issues/9047 + * @see https://github.com/yiisoft/yii2/issues/10201 + * @see https://github.com/yiisoft/yii2/issues/9047 */ public function testFindCompositeRelationWithJoin() { @@ -1306,7 +1307,7 @@ abstract class ActiveRecordTest extends DatabaseTestCase } /** - * https://github.com/yiisoft/yii2/issues/9006 + * @see https://github.com/yiisoft/yii2/issues/9006 */ public function testBit() { @@ -1425,7 +1426,7 @@ abstract class ActiveRecordTest extends DatabaseTestCase } /** - * https://github.com/yiisoft/yii2/issues/12213 + * @see https://github.com/yiisoft/yii2/issues/12213 */ public function testUnlinkAllOnCondition() { @@ -1456,7 +1457,7 @@ abstract class ActiveRecordTest extends DatabaseTestCase } /** - * https://github.com/yiisoft/yii2/issues/12213 + * @see https://github.com/yiisoft/yii2/issues/12213 */ public function testUnlinkAllOnConditionViaTable() { @@ -1486,7 +1487,7 @@ abstract class ActiveRecordTest extends DatabaseTestCase } /** - * verify that {{}} are not going to be replaced in parameters + * Verify that {{}} are not going to be replaced in parameters. */ public function testNoTablenameReplacement() { @@ -1511,8 +1512,9 @@ abstract class ActiveRecordTest extends DatabaseTestCase } /** - * Ensure no ambiguous column error occurs if ActiveQuery adds a JOIN - * https://github.com/yiisoft/yii2/issues/13757 + * Ensure no ambiguous column error occurs if ActiveQuery adds a JOIN. + * + * @see https://github.com/yiisoft/yii2/issues/13757 */ public function testAmbiguousColumnFindOne() { @@ -1523,8 +1525,9 @@ abstract class ActiveRecordTest extends DatabaseTestCase } /** - * Ensure no ambiguous column error occurs on indexBy with JOIN - * https://github.com/yiisoft/yii2/issues/13859 + * Ensure no ambiguous column error occurs on indexBy with JOIN. + * + * @see https://github.com/yiisoft/yii2/issues/13859 */ public function testAmbiguousColumnIndexBy() { diff --git a/tests/framework/db/CommandTest.php b/tests/framework/db/CommandTest.php index e204176..965572b 100644 --- a/tests/framework/db/CommandTest.php +++ b/tests/framework/db/CommandTest.php @@ -239,7 +239,7 @@ SQL; } /** - * Test whether param binding works in other places than WHERE + * Test whether param binding works in other places than WHERE. * @dataProvider paramsNonWhereProvider * @param string $sql */ @@ -392,7 +392,7 @@ SQL; } /** - * verify that {{}} are not going to be replaced in parameters + * verify that {{}} are not going to be replaced in parameters. */ public function testNoTablenameReplacement() { @@ -425,7 +425,7 @@ SQL; } /** - * Test INSERT INTO ... SELECT SQL statement + * Test INSERT INTO ... SELECT SQL statement. */ public function testInsertSelect() { @@ -479,7 +479,7 @@ SQL; } /** - * Test INSERT INTO ... SELECT SQL statement with alias syntax + * Test INSERT INTO ... SELECT SQL statement with alias syntax. */ public function testInsertSelectAlias() { @@ -533,7 +533,7 @@ SQL; } /** - * Data provider for testInsertSelectFailed + * Data provider for testInsertSelectFailed. * @return array */ public function invalidSelectColumns() @@ -546,7 +546,7 @@ SQL; } /** - * Test INSERT INTO ... SELECT SQL statement with wrong query object + * Test INSERT INTO ... SELECT SQL statement with wrong query object. * * @dataProvider invalidSelectColumns * @expectedException \yii\base\InvalidParamException @@ -990,7 +990,7 @@ SQL; } /** - * Data provider for [[testGetRawSql()]] + * Data provider for [[testGetRawSql()]]. * @return array test data */ public function dataProviderGetRawSql() diff --git a/tests/framework/db/ConnectionTest.php b/tests/framework/db/ConnectionTest.php index 8376d8c..51fc2ed 100644 --- a/tests/framework/db/ConnectionTest.php +++ b/tests/framework/db/ConnectionTest.php @@ -390,7 +390,7 @@ abstract class ConnectionTest extends DatabaseTestCase /** - * Test whether slave connection is recovered when call getSlavePdo() after close() + * Test whether slave connection is recovered when call getSlavePdo() after close(). * * @see https://github.com/yiisoft/yii2/issues/14165 */ diff --git a/tests/framework/db/DatabaseTestCase.php b/tests/framework/db/DatabaseTestCase.php index 5fd70f4..27ce691 100644 --- a/tests/framework/db/DatabaseTestCase.php +++ b/tests/framework/db/DatabaseTestCase.php @@ -107,7 +107,7 @@ abstract class DatabaseTestCase extends TestCase } /** - * adjust dbms specific escaping + * Adjust dbms specific escaping. * @param $sql * @return mixed */ diff --git a/tests/framework/db/QueryBuilderTest.php b/tests/framework/db/QueryBuilderTest.php index 3ec10d5..ca327b9 100644 --- a/tests/framework/db/QueryBuilderTest.php +++ b/tests/framework/db/QueryBuilderTest.php @@ -68,8 +68,8 @@ abstract class QueryBuilderTest extends DatabaseTestCase } /** - * this is not used as a dataprovider for testGetColumnType to speed up the test - * when used as dataprovider every single line will cause a reconnect with the database which is not needed here + * This is not used as a dataprovider for testGetColumnType to speed up the test + * when used as dataprovider every single line will cause a reconnect with the database which is not needed here. */ public function columnTypes() { @@ -1625,7 +1625,7 @@ abstract class QueryBuilderTest extends DatabaseTestCase } /** - * https://github.com/yiisoft/yii2/issues/10869 + * @see https://github.com/yiisoft/yii2/issues/10869 */ public function testFromIndexHint() { diff --git a/tests/framework/db/QueryTest.php b/tests/framework/db/QueryTest.php index 2485f04..34c6c4c 100644 --- a/tests/framework/db/QueryTest.php +++ b/tests/framework/db/QueryTest.php @@ -337,8 +337,9 @@ abstract class QueryTest extends DatabaseTestCase /** - * Ensure no ambiguous column error occurs on indexBy with JOIN - * https://github.com/yiisoft/yii2/issues/13859 + * Ensure no ambiguous column error occurs on indexBy with JOIN. + * + * @see https://github.com/yiisoft/yii2/issues/13859 */ public function testAmbiguousColumnIndexBy() { diff --git a/tests/framework/db/cubrid/ColumnSchemaBuilderTest.php b/tests/framework/db/cubrid/ColumnSchemaBuilderTest.php index 75164fd..b6cdc92 100644 --- a/tests/framework/db/cubrid/ColumnSchemaBuilderTest.php +++ b/tests/framework/db/cubrid/ColumnSchemaBuilderTest.php @@ -11,7 +11,7 @@ use yii\db\cubrid\ColumnSchemaBuilder; use yii\db\Schema; /** - * ColumnSchemaBuilderTest tests ColumnSchemaBuilder for Cubrid + * ColumnSchemaBuilderTest tests ColumnSchemaBuilder for Cubrid. * @group db * @group cubrid */ diff --git a/tests/framework/db/cubrid/QueryBuilderTest.php b/tests/framework/db/cubrid/QueryBuilderTest.php index c2d3c69..79c8e92 100644 --- a/tests/framework/db/cubrid/QueryBuilderTest.php +++ b/tests/framework/db/cubrid/QueryBuilderTest.php @@ -24,8 +24,8 @@ class QueryBuilderTest extends \yiiunit\framework\db\QueryBuilderTest ]; /** - * this is not used as a dataprovider for testGetColumnType to speed up the test - * when used as dataprovider every single line will cause a reconnect with the database which is not needed here + * This is not used as a dataprovider for testGetColumnType to speed up the test + * when used as dataprovider every single line will cause a reconnect with the database which is not needed here. */ public function columnTypes() { diff --git a/tests/framework/db/mssql/ColumnSchemaBuilderTest.php b/tests/framework/db/mssql/ColumnSchemaBuilderTest.php index 59fe034..020d598 100644 --- a/tests/framework/db/mssql/ColumnSchemaBuilderTest.php +++ b/tests/framework/db/mssql/ColumnSchemaBuilderTest.php @@ -10,7 +10,7 @@ namespace yiiunit\framework\db\mssql; use yii\db\ColumnSchemaBuilder; /** - * ColumnSchemaBuilderTest tests ColumnSchemaBuilder for MSSQL + * ColumnSchemaBuilderTest tests ColumnSchemaBuilder for MSSQL. * @group db * @group mssql */ diff --git a/tests/framework/db/mssql/QueryBuilderTest.php b/tests/framework/db/mssql/QueryBuilderTest.php index 72f653e..703ed04 100644 --- a/tests/framework/db/mssql/QueryBuilderTest.php +++ b/tests/framework/db/mssql/QueryBuilderTest.php @@ -94,8 +94,8 @@ class QueryBuilderTest extends \yiiunit\framework\db\QueryBuilderTest } /** - * this is not used as a dataprovider for testGetColumnType to speed up the test - * when used as dataprovider every single line will cause a reconnect with the database which is not needed here + * This is not used as a dataprovider for testGetColumnType to speed up the test + * when used as dataprovider every single line will cause a reconnect with the database which is not needed here. */ public function columnTypes() { diff --git a/tests/framework/db/mysql/ColumnSchemaBuilderTest.php b/tests/framework/db/mysql/ColumnSchemaBuilderTest.php index f25d28a..7f1b0ff 100644 --- a/tests/framework/db/mysql/ColumnSchemaBuilderTest.php +++ b/tests/framework/db/mysql/ColumnSchemaBuilderTest.php @@ -11,7 +11,7 @@ use yii\db\mysql\ColumnSchemaBuilder; use yii\db\Schema; /** - * ColumnSchemaBuilderTest tests ColumnSchemaBuilder for MySQL + * ColumnSchemaBuilderTest tests ColumnSchemaBuilder for MySQL. * @group db * @group mysql */ diff --git a/tests/framework/db/mysql/QueryBuilderTest.php b/tests/framework/db/mysql/QueryBuilderTest.php index 848e121..6601be7 100644 --- a/tests/framework/db/mysql/QueryBuilderTest.php +++ b/tests/framework/db/mysql/QueryBuilderTest.php @@ -18,8 +18,8 @@ class QueryBuilderTest extends \yiiunit\framework\db\QueryBuilderTest protected $driverName = 'mysql'; /** - * this is not used as a dataprovider for testGetColumnType to speed up the test - * when used as dataprovider every single line will cause a reconnect with the database which is not needed here + * This is not used as a dataprovider for testGetColumnType to speed up the test + * when used as dataprovider every single line will cause a reconnect with the database which is not needed here. */ public function columnTypes() { diff --git a/tests/framework/db/mysql/QueryTest.php b/tests/framework/db/mysql/QueryTest.php index f225398..b33d64a 100644 --- a/tests/framework/db/mysql/QueryTest.php +++ b/tests/framework/db/mysql/QueryTest.php @@ -19,7 +19,7 @@ class QueryTest extends \yiiunit\framework\db\QueryTest protected $driverName = 'mysql'; /** - * Tests MySQL specific syntax for index hints + * Tests MySQL specific syntax for index hints. */ public function testQueryIndexHint() { diff --git a/tests/framework/db/mysql/connection/DeadLockTest.php b/tests/framework/db/mysql/connection/DeadLockTest.php index f518513..9f54a06 100644 --- a/tests/framework/db/mysql/connection/DeadLockTest.php +++ b/tests/framework/db/mysql/connection/DeadLockTest.php @@ -23,7 +23,7 @@ class DeadLockTest extends \yiiunit\framework\db\mysql\ConnectionTest const CHILD_EXIT_CODE_DEADLOCK = 15; /** - * Test deadlock exception + * Test deadlock exception. * * Accident deadlock exception lost while rolling back a transaction or savepoint * @link https://github.com/yiisoft/yii2/issues/12715 @@ -280,7 +280,7 @@ class DeadLockTest extends \yiiunit\framework\db\mysql\ConnectionTest } /** - * Sets filename for log file shared between children processes + * Sets filename for log file shared between children processes. * @param string $filename */ private function setLogFile($filename) diff --git a/tests/framework/db/oci/ColumnSchemaBuilderTest.php b/tests/framework/db/oci/ColumnSchemaBuilderTest.php index dda7b73..9535ac8 100644 --- a/tests/framework/db/oci/ColumnSchemaBuilderTest.php +++ b/tests/framework/db/oci/ColumnSchemaBuilderTest.php @@ -11,7 +11,7 @@ use yii\db\oci\ColumnSchemaBuilder; use yii\db\Schema; /** - * ColumnSchemaBuilderTest tests ColumnSchemaBuilder for Oracle + * ColumnSchemaBuilderTest tests ColumnSchemaBuilder for Oracle. * @group db * @group oci */ diff --git a/tests/framework/db/oci/QueryBuilderTest.php b/tests/framework/db/oci/QueryBuilderTest.php index 40b4070..0e1dbbf 100644 --- a/tests/framework/db/oci/QueryBuilderTest.php +++ b/tests/framework/db/oci/QueryBuilderTest.php @@ -27,8 +27,8 @@ class QueryBuilderTest extends \yiiunit\framework\db\QueryBuilderTest ]; /** - * this is not used as a dataprovider for testGetColumnType to speed up the test - * when used as dataprovider every single line will cause a reconnect with the database which is not needed here + * This is not used as a dataprovider for testGetColumnType to speed up the test + * when used as dataprovider every single line will cause a reconnect with the database which is not needed here. */ public function columnTypes() { diff --git a/tests/framework/db/pgsql/ActiveRecordTest.php b/tests/framework/db/pgsql/ActiveRecordTest.php index b21417a..ed25cfc 100644 --- a/tests/framework/db/pgsql/ActiveRecordTest.php +++ b/tests/framework/db/pgsql/ActiveRecordTest.php @@ -116,7 +116,7 @@ class ActiveRecordTest extends \yiiunit\framework\db\ActiveRecordTest } /** - * https://github.com/yiisoft/yii2/issues/4672 + * @see https://github.com/yiisoft/yii2/issues/4672 */ public function testBooleanValues2() { diff --git a/tests/framework/db/pgsql/ColumnSchemaBuilderTest.php b/tests/framework/db/pgsql/ColumnSchemaBuilderTest.php index dd61271..641d780 100644 --- a/tests/framework/db/pgsql/ColumnSchemaBuilderTest.php +++ b/tests/framework/db/pgsql/ColumnSchemaBuilderTest.php @@ -10,7 +10,7 @@ namespace yiiunit\framework\db\pgsql; use yii\db\ColumnSchemaBuilder; /** - * ColumnSchemaBuilderTest tests ColumnSchemaBuilder for Oracle + * ColumnSchemaBuilderTest tests ColumnSchemaBuilder for Oracle. * @group db * @group pgsql */ diff --git a/tests/framework/db/pgsql/SchemaTest.php b/tests/framework/db/pgsql/SchemaTest.php index 944910b..7208024 100644 --- a/tests/framework/db/pgsql/SchemaTest.php +++ b/tests/framework/db/pgsql/SchemaTest.php @@ -173,7 +173,7 @@ class SchemaTest extends \yiiunit\framework\db\SchemaTest } /** - * https://github.com/yiisoft/yii2/issues/12483 + * @see https://github.com/yiisoft/yii2/issues/12483 */ public function testParenthesisDefaultValue() { @@ -198,7 +198,7 @@ class SchemaTest extends \yiiunit\framework\db\SchemaTest } /** - * https://github.com/yiisoft/yii2/issues/14192 + * @see https://github.com/yiisoft/yii2/issues/14192 */ public function testTimestampNullDefaultValue() { diff --git a/tests/framework/db/sqlite/ColumnSchemaBuilderTest.php b/tests/framework/db/sqlite/ColumnSchemaBuilderTest.php index 9660329..7831c80 100644 --- a/tests/framework/db/sqlite/ColumnSchemaBuilderTest.php +++ b/tests/framework/db/sqlite/ColumnSchemaBuilderTest.php @@ -11,7 +11,7 @@ use yii\db\Schema; use yii\db\sqlite\ColumnSchemaBuilder; /** - * ColumnSchemaBuilderTest tests ColumnSchemaBuilder for SQLite + * ColumnSchemaBuilderTest tests ColumnSchemaBuilder for SQLite. * @group db * @group sqlite */ diff --git a/tests/framework/di/InstanceTest.php b/tests/framework/di/InstanceTest.php index cbda936..5e93733 100644 --- a/tests/framework/di/InstanceTest.php +++ b/tests/framework/di/InstanceTest.php @@ -147,7 +147,7 @@ class InstanceTest extends TestCase } /** - * This tests the usage example given in yii\di\Instance class PHPdoc + * This tests the usage example given in yii\di\Instance class PHPDoc. */ public function testLazyInitializationExample() { diff --git a/tests/framework/di/ServiceLocatorTest.php b/tests/framework/di/ServiceLocatorTest.php index 1c5560e..abf7f1a 100644 --- a/tests/framework/di/ServiceLocatorTest.php +++ b/tests/framework/di/ServiceLocatorTest.php @@ -88,7 +88,7 @@ class ServiceLocatorTest extends TestCase } /** - * https://github.com/yiisoft/yii2/issues/11771 + * @see https://github.com/yiisoft/yii2/issues/11771 */ public function testModulePropertyIsset() { diff --git a/tests/framework/filters/AccessRuleTest.php b/tests/framework/filters/AccessRuleTest.php index ddaf844..7e4197a 100644 --- a/tests/framework/filters/AccessRuleTest.php +++ b/tests/framework/filters/AccessRuleTest.php @@ -209,7 +209,7 @@ class AccessRuleTest extends \yiiunit\TestCase } /** - * Data provider for testMatchRole + * Data provider for testMatchRole. * * @return array or arrays * the id of the action @@ -252,7 +252,7 @@ class AccessRuleTest extends \yiiunit\TestCase } /** - * Test that a user matches certain roles + * Test that a user matches certain roles. * * @dataProvider matchRoleProvider * @param string $actionid the action id @@ -282,7 +282,7 @@ class AccessRuleTest extends \yiiunit\TestCase } /** - * Test that matching role is not possible without User component + * Test that matching role is not possible without User component. * * @see https://github.com/yiisoft/yii2/issues/4793 */ diff --git a/tests/framework/filters/auth/AuthTest.php b/tests/framework/filters/auth/AuthTest.php index 6727c9d..6f01910 100644 --- a/tests/framework/filters/auth/AuthTest.php +++ b/tests/framework/filters/auth/AuthTest.php @@ -218,7 +218,7 @@ class AuthTest extends \yiiunit\TestCase } /** - * Class TestAuthController + * Class TestAuthController. * * @author Dmitry Naumenko * @since 2.0.7 diff --git a/tests/framework/filters/auth/CompositeAuthTest.php b/tests/framework/filters/auth/CompositeAuthTest.php index 99faf3d..12bbffe 100644 --- a/tests/framework/filters/auth/CompositeAuthTest.php +++ b/tests/framework/filters/auth/CompositeAuthTest.php @@ -108,7 +108,7 @@ class CompositeAuthTest extends \yiiunit\TestCase } /** - * reproducing the issue specified in https://github.com/yiisoft/yii2/issues/7409 + * @see https://github.com/yiisoft/yii2/issues/7409 */ public function testRunAction() { diff --git a/tests/framework/filters/stubs/MockAuthManager.php b/tests/framework/filters/stubs/MockAuthManager.php index 1ed140e..8b0bb26 100644 --- a/tests/framework/filters/stubs/MockAuthManager.php +++ b/tests/framework/filters/stubs/MockAuthManager.php @@ -12,7 +12,7 @@ use yii\rbac\PhpManager; class MockAuthManager extends PhpManager { /** - * This mock does not persist + * This mock does not persist. * @inheritdoc */ protected function saveToFile($data, $file) diff --git a/tests/framework/filters/stubs/UserIdentity.php b/tests/framework/filters/stubs/UserIdentity.php index 086ab8b..c97eb21 100644 --- a/tests/framework/filters/stubs/UserIdentity.php +++ b/tests/framework/filters/stubs/UserIdentity.php @@ -12,7 +12,7 @@ use yii\base\NotSupportedException; use yii\web\IdentityInterface; /** - * Class UserIdentity + * Class UserIdentity. * @author Dmitry Naumenko * @since 2.0.7 */ diff --git a/tests/framework/grid/RadiobuttonColumnTest.php b/tests/framework/grid/RadiobuttonColumnTest.php index d08c263..2e65a9a 100644 --- a/tests/framework/grid/RadiobuttonColumnTest.php +++ b/tests/framework/grid/RadiobuttonColumnTest.php @@ -15,7 +15,7 @@ use yii\web\Request; use yiiunit\TestCase; /** - * Class RadiobuttonColumnTest + * Class RadiobuttonColumnTest. * @group grid * @since 2.0.11 */ diff --git a/tests/framework/helpers/ArrayHelperTest.php b/tests/framework/helpers/ArrayHelperTest.php index 69cbc4b..0d1867b 100644 --- a/tests/framework/helpers/ArrayHelperTest.php +++ b/tests/framework/helpers/ArrayHelperTest.php @@ -803,7 +803,7 @@ class ArrayHelperTest extends TestCase } /** - * This is expected to result in a PHP error + * This is expected to result in a PHP error. * @expectedException \PHPUnit_Framework_Error */ public function testGetValueNonexistingProperties1() @@ -813,7 +813,7 @@ class ArrayHelperTest extends TestCase } /** - * This is expected to result in a PHP error + * This is expected to result in a PHP error. * @expectedException \PHPUnit_Framework_Error */ public function testGetValueNonexistingProperties2() @@ -823,7 +823,7 @@ class ArrayHelperTest extends TestCase } /** - * Data provider for [[testSetValue()]] + * Data provider for [[testSetValue()]]. * @return array test data */ public function dataProviderSetValue() diff --git a/tests/framework/helpers/FallbackInflector.php b/tests/framework/helpers/FallbackInflector.php index f9ab341..868c51d 100644 --- a/tests/framework/helpers/FallbackInflector.php +++ b/tests/framework/helpers/FallbackInflector.php @@ -10,7 +10,7 @@ namespace yiiunit\framework\helpers; use yii\helpers\BaseInflector; /** - * Forces Inflector::slug to use PHP even if intl is available + * Forces Inflector::slug to use PHP even if intl is available. */ class FallbackInflector extends BaseInflector { diff --git a/tests/framework/helpers/FileHelperTest.php b/tests/framework/helpers/FileHelperTest.php index 80dc8a9..2613aaf 100644 --- a/tests/framework/helpers/FileHelperTest.php +++ b/tests/framework/helpers/FileHelperTest.php @@ -9,7 +9,7 @@ use yii\helpers\FileHelper; use yiiunit\TestCase; /** - * Unit test for [[yii\helpers\FileHelper]] + * Unit test for [[yii\helpers\FileHelper]]. * @see FileHelper * @group helpers */ @@ -98,7 +98,7 @@ class FileHelperTest extends TestCase } /** - * Creates test files structure, + * Creates test files structure. * @param array $items file system objects to be created in format: objectName => objectContent * Arrays specifies directories, other values - files. * @param string $basePath structure base file path. diff --git a/tests/framework/helpers/HtmlTest.php b/tests/framework/helpers/HtmlTest.php index e898cba..5b69c32 100644 --- a/tests/framework/helpers/HtmlTest.php +++ b/tests/framework/helpers/HtmlTest.php @@ -161,7 +161,7 @@ class HtmlTest extends TestCase } /** - * Data provider for [[testBeginFormSimulateViaPost()]] + * Data provider for [[testBeginFormSimulateViaPost()]]. * @return array test data */ public function dataProviderBeginFormSimulateViaPost() @@ -1045,7 +1045,7 @@ EOD; } /** - * Data provider for [[testActiveTextInput()]] + * Data provider for [[testActiveTextInput()]]. * @return array test data */ public function dataProviderActiveTextInput() @@ -1088,7 +1088,7 @@ EOD; } /** - * Data provider for [[testActivePasswordInput()]] + * Data provider for [[testActivePasswordInput()]]. * @return array test data */ public function dataProviderActivePasswordInput() @@ -1210,7 +1210,7 @@ EOD; } /** - * Data provider for [[testActiveTextArea()]] + * Data provider for [[testActiveTextArea()]]. * @return array test data */ public function dataProviderActiveTextArea() @@ -1260,7 +1260,7 @@ EOD; } /** - * Fixes #10078 + * @see https://github.com/yiisoft/yii2/issues/10078 */ public function testCsrfDisable() { @@ -1279,7 +1279,7 @@ EOD; } /** - * Data provider for [[testActiveRadio()]] + * Data provider for [[testActiveRadio()]]. * @return array test data */ public function dataProviderActiveRadio() @@ -1323,7 +1323,7 @@ EOD; } /** - * Data provider for [[testActiveCheckbox()]] + * Data provider for [[testActiveCheckbox()]]. * @return array test data */ public function dataProviderActiveCheckbox() @@ -1367,7 +1367,7 @@ EOD; } /** - * Data provider for [[testAttributeNameValidation()]] + * Data provider for [[testAttributeNameValidation()]]. * @return array test data */ public function validAttributeNamesProvider() @@ -1393,7 +1393,7 @@ EOD; } /** - * Data provider for [[testAttributeNameValidation()]] + * Data provider for [[testAttributeNameValidation()]]. * @return array test data */ public function invalidAttributeNamesProvider() diff --git a/tests/framework/helpers/MarkdownTest.php b/tests/framework/helpers/MarkdownTest.php index 8826784..627f984 100644 --- a/tests/framework/helpers/MarkdownTest.php +++ b/tests/framework/helpers/MarkdownTest.php @@ -11,7 +11,7 @@ use yii\helpers\Markdown; use yiiunit\TestCase; /** - * Description of MarkdownTest + * Description of MarkdownTest. * * @author Misbahul D Munir * @group helpers diff --git a/tests/framework/helpers/StringHelperTest.php b/tests/framework/helpers/StringHelperTest.php index 9ebac10..a58c5b2 100644 --- a/tests/framework/helpers/StringHelperTest.php +++ b/tests/framework/helpers/StringHelperTest.php @@ -11,7 +11,7 @@ use yii\helpers\StringHelper; use yiiunit\TestCase; /** - * StringHelperTest + * StringHelperTest. * @group helpers */ class StringHelperTest extends TestCase @@ -162,7 +162,7 @@ class StringHelperTest extends TestCase } /** - * Rules that should work the same for case-sensitive and case-insensitive `startsWith()` + * Rules that should work the same for case-sensitive and case-insensitive `startsWith()`. */ public function providerStartsWith() { @@ -218,7 +218,7 @@ class StringHelperTest extends TestCase } /** - * Rules that should work the same for case-sensitive and case-insensitive `endsWith()` + * Rules that should work the same for case-sensitive and case-insensitive `endsWith()`. */ public function providerEndsWith() { diff --git a/tests/framework/helpers/UrlTest.php b/tests/framework/helpers/UrlTest.php index 9db7c3c..a236f4c 100644 --- a/tests/framework/helpers/UrlTest.php +++ b/tests/framework/helpers/UrlTest.php @@ -18,7 +18,7 @@ use yiiunit\framework\filters\stubs\UserIdentity; use yiiunit\TestCase; /** - * UrlTest + * UrlTest. * @group helpers */ class UrlTest extends TestCase @@ -54,7 +54,7 @@ class UrlTest extends TestCase } /** - * Mocks controller action with parameters + * Mocks controller action with parameters. * * @param string $controllerId * @param string $actionID @@ -228,7 +228,7 @@ class UrlTest extends TestCase } /** - * https://github.com/yiisoft/yii2/issues/11925 + * @see https://github.com/yiisoft/yii2/issues/11925 */ public function testToWithSuffix() { diff --git a/tests/framework/helpers/VarDumperTest.php b/tests/framework/helpers/VarDumperTest.php index b8eac90..6bc818e 100644 --- a/tests/framework/helpers/VarDumperTest.php +++ b/tests/framework/helpers/VarDumperTest.php @@ -56,7 +56,7 @@ class VarDumperTest extends TestCase } /** - * Data provider for [[testExport()]] + * Data provider for [[testExport()]]. * @return array test data */ public function dataProviderExport() diff --git a/tests/framework/i18n/FormatterDateTest.php b/tests/framework/i18n/FormatterDateTest.php index 3ae0525..bb6f53c 100644 --- a/tests/framework/i18n/FormatterDateTest.php +++ b/tests/framework/i18n/FormatterDateTest.php @@ -239,8 +239,8 @@ class FormatterDateTest extends TestCase } /** - * Test for dates before 1970 - * https://github.com/yiisoft/yii2/issues/3126 + * Test for dates before 1970. + * @see https://github.com/yiisoft/yii2/issues/3126 */ public function testDateRangeLow() { @@ -259,8 +259,8 @@ class FormatterDateTest extends TestCase } /** - * Test for dates after 2038 - * https://github.com/yiisoft/yii2/issues/3126 + * Test for dates after 2038. + * @see https://github.com/yiisoft/yii2/issues/3126 */ public function testDateRangeHigh() { @@ -560,7 +560,7 @@ class FormatterDateTest extends TestCase } /** - * provide default timezones times input date value + * Provide default timezones times input date value. */ public function provideTimesAndTz() { @@ -590,7 +590,7 @@ class FormatterDateTest extends TestCase } /** - * Test timezones with input date and time in other timezones + * Test timezones with input date and time in other timezones. * @dataProvider provideTimesAndTz * @param string $defaultTz * @param mixed $inputTimeDst @@ -602,7 +602,7 @@ class FormatterDateTest extends TestCase } /** - * Test timezones with input date and time in other timezones + * Test timezones with input date and time in other timezones. * @dataProvider provideTimesAndTz * @param string $defaultTz * @param mixed $inputTimeDst @@ -654,7 +654,7 @@ class FormatterDateTest extends TestCase } /** - * Test timezones with input date and time in other timezones + * Test timezones with input date and time in other timezones. */ public function testTimezoneInputNonDefault() { @@ -728,9 +728,9 @@ class FormatterDateTest extends TestCase } /** - * https://github.com/yiisoft/yii2/issues/13343 - * * Prevent timezone conversion for time-only values. + * + * @see https://github.com/yiisoft/yii2/issues/13343 */ public function testTimeOnlyValues() { @@ -750,7 +750,7 @@ class FormatterDateTest extends TestCase } /** - * https://github.com/yiisoft/yii2/issues/6263 + * @see https://github.com/yiisoft/yii2/issues/6263. * * it is a PHP bug: https://bugs.php.net/bug.php?id=45543 * Fixed in this commit: https://github.com/php/php-src/commit/22dba2f5f3211efe6c3b9bb24734c811ca64c68c#diff-7b738accc3d60f74c259da18588ddc5dL2996 diff --git a/tests/framework/i18n/FormatterNumberTest.php b/tests/framework/i18n/FormatterNumberTest.php index abd78c8..5b24f62 100644 --- a/tests/framework/i18n/FormatterNumberTest.php +++ b/tests/framework/i18n/FormatterNumberTest.php @@ -43,7 +43,7 @@ class FormatterNumberTest extends TestCase } /** - * Provides some configuration that should not affect Integer formatter + * Provides some configuration that should not affect Integer formatter. */ public function differentConfigProvider() { @@ -325,7 +325,7 @@ class FormatterNumberTest extends TestCase } /** - * https://github.com/yiisoft/yii2/issues/12345 + * @see https://github.com/yiisoft/yii2/issues/12345 */ public function testIntlCurrencyFraction() { @@ -361,7 +361,7 @@ class FormatterNumberTest extends TestCase } /** - * https://github.com/yiisoft/yii2/pull/5261 + * @see https://github.com/yiisoft/yii2/pull/5261 */ public function testIntlIssue5261() { @@ -464,7 +464,7 @@ class FormatterNumberTest extends TestCase } /** - * https://github.com/yiisoft/yii2/issues/14278 + * @see https://github.com/yiisoft/yii2/issues/14278 */ public function testIntlAsOrdinalDate() { @@ -680,7 +680,7 @@ class FormatterNumberTest extends TestCase } /** - * https://github.com/yiisoft/yii2/issues/4960 + * @see https://github.com/yiisoft/yii2/issues/4960 */ public function testAsSizeConfiguration() { diff --git a/tests/framework/i18n/FormatterTest.php b/tests/framework/i18n/FormatterTest.php index 8990c13..8498a71 100644 --- a/tests/framework/i18n/FormatterTest.php +++ b/tests/framework/i18n/FormatterTest.php @@ -12,7 +12,7 @@ use yii\i18n\Formatter; use yiiunit\TestCase; /** - * Test for basic formatter functions + * Test for basic formatter functions. * * See FormatterDateTest and FormatterNumberTest for date/number formatting. * diff --git a/tests/framework/i18n/I18NTest.php b/tests/framework/i18n/I18NTest.php index 6c893f3..a57c21a 100644 --- a/tests/framework/i18n/I18NTest.php +++ b/tests/framework/i18n/I18NTest.php @@ -99,7 +99,7 @@ class I18NTest extends TestCase } /** - * https://github.com/yiisoft/yii2/issues/7964 + * @see https://github.com/yiisoft/yii2/issues/7964 */ public function testSourceLanguageFallback() { @@ -165,7 +165,8 @@ class I18NTest extends TestCase /** * When translation is missing source language should be used for formatting. - * https://github.com/yiisoft/yii2/issues/2209 + * + * @see https://github.com/yiisoft/yii2/issues/2209 */ public function testMissingTranslationFormatting() { @@ -173,7 +174,7 @@ class I18NTest extends TestCase } /** - * https://github.com/yiisoft/yii2/issues/7093 + * @see https://github.com/yiisoft/yii2/issues/7093 */ public function testRussianPlurals() { @@ -194,7 +195,7 @@ class I18NTest extends TestCase } /** - * https://github.com/yiisoft/yii2/issues/2519 + * @see https://github.com/yiisoft/yii2/issues/2519 */ public function testMissingTranslationEvent() { @@ -267,7 +268,7 @@ class I18NTest extends TestCase /** * Formatting a message that contains params but they are not provided. - * https://github.com/yiisoft/yii2/issues/10884 + * @see https://github.com/yiisoft/yii2/issues/10884 */ public function testFormatMessageWithNoParam() { diff --git a/tests/framework/i18n/IntlTestHelper.php b/tests/framework/i18n/IntlTestHelper.php index 797b255..b6a23df 100644 --- a/tests/framework/i18n/IntlTestHelper.php +++ b/tests/framework/i18n/IntlTestHelper.php @@ -15,9 +15,9 @@ namespace yiiunit\framework\i18n { public static $enableIntl; /** - * emulate disabled intl extension + * Emulate disabled intl extension. * - * enable it only for tests prefixed with testIntl + * Enable it only for tests prefixed with testIntl. * @param Testcase $test */ public static function setIntlStatus($test) diff --git a/tests/framework/log/DbTargetTest.php b/tests/framework/log/DbTargetTest.php index 79f197c..1a4f68d 100644 --- a/tests/framework/log/DbTargetTest.php +++ b/tests/framework/log/DbTargetTest.php @@ -116,7 +116,7 @@ abstract class DbTargetTest extends TestCase } /** - * Tests that precision isn't lost for log timestamps + * Tests that precision isn't lost for log timestamps. * @see https://github.com/yiisoft/yii2/issues/7384 */ public function testTimestamp() diff --git a/tests/framework/log/DispatcherTest.php b/tests/framework/log/DispatcherTest.php index cf3a7c9..b2944b6 100644 --- a/tests/framework/log/DispatcherTest.php +++ b/tests/framework/log/DispatcherTest.php @@ -45,7 +45,7 @@ namespace yiiunit\framework\log { public static $microtimeIsMocked = false; /** - * Array of static functions + * Array of static functions. * * @var array */ diff --git a/tests/framework/log/EmailTargetTest.php b/tests/framework/log/EmailTargetTest.php index acb73f3..f3133cc 100644 --- a/tests/framework/log/EmailTargetTest.php +++ b/tests/framework/log/EmailTargetTest.php @@ -11,7 +11,7 @@ use yii\log\EmailTarget; use yiiunit\TestCase; /** - * Class EmailTargetTest + * Class EmailTargetTest. * @group log */ class EmailTargetTest extends TestCase @@ -22,7 +22,7 @@ class EmailTargetTest extends TestCase protected $mailer; /** - * Set up mailer + * Set up mailer. */ protected function setUp() { diff --git a/tests/framework/log/LoggerTest.php b/tests/framework/log/LoggerTest.php index ce4932b..c23da90 100644 --- a/tests/framework/log/LoggerTest.php +++ b/tests/framework/log/LoggerTest.php @@ -268,7 +268,7 @@ class LoggerTest extends TestCase } /** - * See https://github.com/yiisoft/yii2/issues/14133 + * @see https://github.com/yiisoft/yii2/issues/14133 * * @covers \yii\log\Logger::calculateTimings() */ diff --git a/tests/framework/log/SyslogTargetTest.php b/tests/framework/log/SyslogTargetTest.php index 84a9535..a77028e 100644 --- a/tests/framework/log/SyslogTargetTest.php +++ b/tests/framework/log/SyslogTargetTest.php @@ -31,14 +31,14 @@ namespace yiiunit\framework\log { use yiiunit\TestCase; /** - * Class SyslogTargetTest + * Class SyslogTargetTest. * * @group log */ class SyslogTargetTest extends TestCase { /** - * Array of static functions + * Array of static functions. * * @var array */ @@ -50,7 +50,7 @@ namespace yiiunit\framework\log { protected $syslogTarget; /** - * Set up syslogTarget as the mock object + * Set up syslogTarget as the mock object. */ protected function setUp() { diff --git a/tests/framework/mail/BaseMailerTest.php b/tests/framework/mail/BaseMailerTest.php index c81596a..993e86e 100644 --- a/tests/framework/mail/BaseMailerTest.php +++ b/tests/framework/mail/BaseMailerTest.php @@ -310,7 +310,7 @@ TEXT } /** - * Test Mailer class + * Test Mailer class. */ class Mailer extends BaseMailer { @@ -326,7 +326,7 @@ class Mailer extends BaseMailer } /** - * Test Message class + * Test Message class. */ class Message extends BaseMessage { diff --git a/tests/framework/mail/BaseMessageTest.php b/tests/framework/mail/BaseMessageTest.php index 92819e4..fbe9b57 100644 --- a/tests/framework/mail/BaseMessageTest.php +++ b/tests/framework/mail/BaseMessageTest.php @@ -63,7 +63,7 @@ class BaseMessageTest extends TestCase } /** - * Test Mailer class + * Test Mailer class. */ class TestMailer extends BaseMailer { @@ -77,7 +77,7 @@ class TestMailer extends BaseMailer } /** - * Test Message class + * Test Message class. */ class TestMessage extends BaseMessage { diff --git a/tests/framework/mutex/FileMutexTest.php b/tests/framework/mutex/FileMutexTest.php index 778f0f8..bd90ec3 100644 --- a/tests/framework/mutex/FileMutexTest.php +++ b/tests/framework/mutex/FileMutexTest.php @@ -11,7 +11,7 @@ use yii\mutex\FileMutex; use yiiunit\TestCase; /** - * Class FileMutexTest + * Class FileMutexTest. * * @group mutex */ diff --git a/tests/framework/mutex/MutexTestTrait.php b/tests/framework/mutex/MutexTestTrait.php index 934b99d..3a401b2 100644 --- a/tests/framework/mutex/MutexTestTrait.php +++ b/tests/framework/mutex/MutexTestTrait.php @@ -10,7 +10,7 @@ namespace yiiunit\framework\mutex; use yii\mutex\Mutex; /** - * Class MutexTestTrait + * Class MutexTestTrait. */ trait MutexTestTrait { diff --git a/tests/framework/mutex/MysqlMutexTest.php b/tests/framework/mutex/MysqlMutexTest.php index 94edafc..ae34d37 100644 --- a/tests/framework/mutex/MysqlMutexTest.php +++ b/tests/framework/mutex/MysqlMutexTest.php @@ -11,7 +11,7 @@ use yii\mutex\MysqlMutex; use yiiunit\framework\db\DatabaseTestCase; /** - * Class MysqlMutexTest + * Class MysqlMutexTest. * * @group mutex * @group db diff --git a/tests/framework/mutex/PgsqlMutexTest.php b/tests/framework/mutex/PgsqlMutexTest.php index fd26360..4bdecb1 100644 --- a/tests/framework/mutex/PgsqlMutexTest.php +++ b/tests/framework/mutex/PgsqlMutexTest.php @@ -11,7 +11,7 @@ use yii\mutex\PgsqlMutex; use yiiunit\framework\db\DatabaseTestCase; /** - * Class PgsqlMutexTest + * Class PgsqlMutexTest. * * @group mutex * @group db diff --git a/tests/framework/rbac/ActionRule.php b/tests/framework/rbac/ActionRule.php index a5fa76b..336052f 100644 --- a/tests/framework/rbac/ActionRule.php +++ b/tests/framework/rbac/ActionRule.php @@ -10,7 +10,7 @@ namespace yiiunit\framework\rbac; use yii\rbac\Rule; /** - * Description of ActionRule + * Description of ActionRule. */ class ActionRule extends Rule { diff --git a/tests/framework/rbac/AuthorRule.php b/tests/framework/rbac/AuthorRule.php index 0a7fe9a..4a0dd4d 100644 --- a/tests/framework/rbac/AuthorRule.php +++ b/tests/framework/rbac/AuthorRule.php @@ -10,7 +10,7 @@ namespace yiiunit\framework\rbac; use yii\rbac\Rule; /** - * Checks if authorID matches userID passed via params + * Checks if authorID matches userID passed via params. */ class AuthorRule extends Rule { diff --git a/tests/framework/rbac/DbManagerTestCase.php b/tests/framework/rbac/DbManagerTestCase.php index 7fb1a7e..9a15877 100644 --- a/tests/framework/rbac/DbManagerTestCase.php +++ b/tests/framework/rbac/DbManagerTestCase.php @@ -19,7 +19,7 @@ use yiiunit\data\rbac\UserID; use yiiunit\framework\console\controllers\EchoMigrateController; /** - * DbManagerTestCase + * DbManagerTestCase. * @group db * @group rbac * @group mysql diff --git a/tests/framework/rbac/ExposedPhpManager.php b/tests/framework/rbac/ExposedPhpManager.php index a3a97dd..ec92b10 100644 --- a/tests/framework/rbac/ExposedPhpManager.php +++ b/tests/framework/rbac/ExposedPhpManager.php @@ -10,7 +10,7 @@ namespace yiiunit\framework\rbac; use yii\rbac\PhpManager; /** - * Exposes protected properties and methods to inspect from outside + * Exposes protected properties and methods to inspect from outside. */ class ExposedPhpManager extends PhpManager { diff --git a/tests/framework/rbac/ManagerTestCase.php b/tests/framework/rbac/ManagerTestCase.php index f406101..341e2dd 100644 --- a/tests/framework/rbac/ManagerTestCase.php +++ b/tests/framework/rbac/ManagerTestCase.php @@ -13,7 +13,7 @@ use yii\rbac\Role; use yiiunit\TestCase; /** - * ManagerTestCase + * ManagerTestCase. */ abstract class ManagerTestCase extends TestCase { @@ -561,7 +561,7 @@ abstract class ManagerTestCase extends TestCase } /** - * Create Role or Permission RBAC item + * Create Role or Permission RBAC item. * @param int $RBACItemType * @param string $name * @return Permission|Role @@ -579,7 +579,7 @@ abstract class ManagerTestCase extends TestCase } /** - * Get Role or Permission RBAC item + * Get Role or Permission RBAC item. * @param int $RBACItemType * @param string $name * @return Permission|Role @@ -597,8 +597,8 @@ abstract class ManagerTestCase extends TestCase } /** - * https://github.com/yiisoft/yii2/issues/10176 - * https://github.com/yiisoft/yii2/issues/12681 + * @see https://github.com/yiisoft/yii2/issues/10176 + * @see https://github.com/yiisoft/yii2/issues/12681 */ public function testRuleWithPrivateFields() { diff --git a/tests/framework/rbac/MySQLManagerCacheTest.php b/tests/framework/rbac/MySQLManagerCacheTest.php index bb3ce87..ec7d1c6 100644 --- a/tests/framework/rbac/MySQLManagerCacheTest.php +++ b/tests/framework/rbac/MySQLManagerCacheTest.php @@ -11,7 +11,7 @@ use yii\caching\FileCache; use yii\rbac\DbManager; /** - * MySQLManagerCacheTest + * MySQLManagerCacheTest. * @group rbac * @group db * @group mysql diff --git a/tests/framework/rbac/MySQLManagerTest.php b/tests/framework/rbac/MySQLManagerTest.php index b37c167..99f2ef3 100644 --- a/tests/framework/rbac/MySQLManagerTest.php +++ b/tests/framework/rbac/MySQLManagerTest.php @@ -8,7 +8,7 @@ namespace yiiunit\framework\rbac; /** - * MySQLManagerTest + * MySQLManagerTest. * @group db * @group rbac * @group mysql diff --git a/tests/framework/rbac/PgSQLManagerCacheTest.php b/tests/framework/rbac/PgSQLManagerCacheTest.php index 7451ba4..b833a1a 100644 --- a/tests/framework/rbac/PgSQLManagerCacheTest.php +++ b/tests/framework/rbac/PgSQLManagerCacheTest.php @@ -11,7 +11,7 @@ use yii\caching\FileCache; use yii\rbac\DbManager; /** - * PgSQLManagerTest + * PgSQLManagerTest. * @group db * @group rbac * @group pgsql diff --git a/tests/framework/rbac/PgSQLManagerTest.php b/tests/framework/rbac/PgSQLManagerTest.php index bf211ad..01e805d 100644 --- a/tests/framework/rbac/PgSQLManagerTest.php +++ b/tests/framework/rbac/PgSQLManagerTest.php @@ -8,7 +8,7 @@ namespace yiiunit\framework\rbac; /** - * PgSQLManagerTest + * PgSQLManagerTest. * @group db * @group rbac * @group pgsql diff --git a/tests/framework/rbac/SqliteManagerTest.php b/tests/framework/rbac/SqliteManagerTest.php index 4767cef..df3addf 100644 --- a/tests/framework/rbac/SqliteManagerTest.php +++ b/tests/framework/rbac/SqliteManagerTest.php @@ -8,7 +8,7 @@ namespace yiiunit\framework\rbac; /** - * SqliteManagerTest + * SqliteManagerTest. * @group db * @group rbac */ diff --git a/tests/framework/rest/SerializerTest.php b/tests/framework/rest/SerializerTest.php index d456a97..698a27f 100644 --- a/tests/framework/rest/SerializerTest.php +++ b/tests/framework/rest/SerializerTest.php @@ -113,7 +113,7 @@ class SerializerTest extends TestCase } /** - * https://github.com/yiisoft/yii2/issues/12107 + * @see https://github.com/yiisoft/yii2/issues/12107 */ public function testExpandInvalidInput() { diff --git a/tests/framework/validators/DateValidatorTest.php b/tests/framework/validators/DateValidatorTest.php index c29a819..96ce6fb 100644 --- a/tests/framework/validators/DateValidatorTest.php +++ b/tests/framework/validators/DateValidatorTest.php @@ -580,9 +580,9 @@ class DateValidatorTest extends TestCase } /** - * returns true if the version of ICU is old and has a bug that makes it + * Returns true if the version of ICU is old and has a bug that makes it * impossible to parse two digit years properly. - * see http://bugs.icu-project.org/trac/ticket/9836 + * @see http://bugs.icu-project.org/trac/ticket/9836 * @return bool */ private function checkOldIcuBug() diff --git a/tests/framework/validators/EmailValidatorTest.php b/tests/framework/validators/EmailValidatorTest.php index d5facaa..8a6d188 100644 --- a/tests/framework/validators/EmailValidatorTest.php +++ b/tests/framework/validators/EmailValidatorTest.php @@ -164,8 +164,8 @@ class EmailValidatorTest extends TestCase } /** - * Test malicious email addresses that can be used to exploit SwiftMailer vulnerability CVE-2016-10074 - * https://legalhackers.com/advisories/SwiftMailer-Exploit-Remote-Code-Exec-CVE-2016-10074-Vuln.html + * Test malicious email addresses that can be used to exploit SwiftMailer vulnerability CVE-2016-10074. + * @see https://legalhackers.com/advisories/SwiftMailer-Exploit-Remote-Code-Exec-CVE-2016-10074-Vuln.html * * @dataProvider malformedAddressesProvider * @param string $value diff --git a/tests/framework/validators/ExistValidatorTest.php b/tests/framework/validators/ExistValidatorTest.php index e114f16..612410d 100644 --- a/tests/framework/validators/ExistValidatorTest.php +++ b/tests/framework/validators/ExistValidatorTest.php @@ -191,7 +191,7 @@ abstract class ExistValidatorTest extends DatabaseTestCase } /** - * Test expresssion in targetAttribute + * Test expresssion in targetAttribute. * @see https://github.com/yiisoft/yii2/issues/14304 */ public function testExpresionInAttributeColumnName() diff --git a/tests/framework/validators/NumberValidatorTest.php b/tests/framework/validators/NumberValidatorTest.php index af20efa..b26c8c8 100644 --- a/tests/framework/validators/NumberValidatorTest.php +++ b/tests/framework/validators/NumberValidatorTest.php @@ -250,7 +250,7 @@ class NumberValidatorTest extends TestCase } /** - * https://github.com/yiisoft/yii2/issues/3118 + * @see https://github.com/yiisoft/yii2/issues/3118 */ public function testClientValidateComparison() { diff --git a/tests/framework/validators/UniqueValidatorTest.php b/tests/framework/validators/UniqueValidatorTest.php index 84e2af5..4bae83a 100644 --- a/tests/framework/validators/UniqueValidatorTest.php +++ b/tests/framework/validators/UniqueValidatorTest.php @@ -395,7 +395,7 @@ abstract class UniqueValidatorTest extends DatabaseTestCase } /** - * Test ambiguous column name in select clause + * Test ambiguous column name in select clause. * @see https://github.com/yiisoft/yii2/issues/14042 */ public function testAmbiguousColumnName() @@ -415,7 +415,7 @@ abstract class UniqueValidatorTest extends DatabaseTestCase } /** - * Test expresssion in targetAttribute + * Test expresssion in targetAttribute. * @see https://github.com/yiisoft/yii2/issues/14304 */ public function testExpresionInAttributeColumnName() diff --git a/tests/framework/validators/ValidatorTest.php b/tests/framework/validators/ValidatorTest.php index 6c28ad4..e050673 100644 --- a/tests/framework/validators/ValidatorTest.php +++ b/tests/framework/validators/ValidatorTest.php @@ -287,9 +287,9 @@ class ValidatorTest extends TestCase } /** - * Make sure attribute names are calculated dynamically - * https://github.com/yiisoft/yii2/issues/13979 - * https://github.com/yiisoft/yii2/pull/14413 + * Make sure attribute names are calculated dynamically. + * @see https://github.com/yiisoft/yii2/issues/13979 + * @see https://github.com/yiisoft/yii2/pull/14413 */ public function testAttributeNamesDynamic() { diff --git a/tests/framework/web/AssetBundleTest.php b/tests/framework/web/AssetBundleTest.php index 0fe902d..ba98852 100644 --- a/tests/framework/web/AssetBundleTest.php +++ b/tests/framework/web/AssetBundleTest.php @@ -49,7 +49,7 @@ class AssetBundleTest extends \yiiunit\TestCase } /** - * Returns View with configured AssetManager + * Returns View with configured AssetManager. * * @param array $config may be used to override default AssetManager config * @return View diff --git a/tests/framework/web/ErrorActionTest.php b/tests/framework/web/ErrorActionTest.php index 9cd82ce..64cea6a 100644 --- a/tests/framework/web/ErrorActionTest.php +++ b/tests/framework/web/ErrorActionTest.php @@ -26,7 +26,7 @@ class ErrorActionTest extends TestCase } /** - * Creates a controller instance + * Creates a controller instance. * * @param array $actionConfig * @return TestController diff --git a/tests/framework/web/FormatterTest.php b/tests/framework/web/FormatterTest.php index abaa04b..05cec3a 100644 --- a/tests/framework/web/FormatterTest.php +++ b/tests/framework/web/FormatterTest.php @@ -34,7 +34,7 @@ abstract class FormatterTest extends \yiiunit\TestCase abstract protected function getFormatterInstance(); /** - * Formatter should not format null + * Formatter should not format null. */ public function testFormatNull() { diff --git a/tests/framework/web/RequestTest.php b/tests/framework/web/RequestTest.php index 9f8c270..3e9e293 100644 --- a/tests/framework/web/RequestTest.php +++ b/tests/framework/web/RequestTest.php @@ -138,7 +138,7 @@ class RequestTest extends TestCase } /** - * test CSRF token validation by POST param + * Test CSRF token validation by POST param. */ public function testCsrfTokenPost() { @@ -166,7 +166,7 @@ class RequestTest extends TestCase } /** - * test CSRF token validation by POST param + * Test CSRF token validation by POST param. */ public function testCsrfTokenHeader() { diff --git a/tests/framework/web/ResponseTest.php b/tests/framework/web/ResponseTest.php index 5113c63..4a6aeff 100644 --- a/tests/framework/web/ResponseTest.php +++ b/tests/framework/web/ResponseTest.php @@ -97,7 +97,7 @@ class ResponseTest extends \yiiunit\TestCase } /** - * https://github.com/yiisoft/yii2/issues/7529 + * @see https://github.com/yiisoft/yii2/issues/7529 */ public function testSendContentAsFile() { diff --git a/tests/framework/web/SessionTest.php b/tests/framework/web/SessionTest.php index c5d353d..b11900a 100644 --- a/tests/framework/web/SessionTest.php +++ b/tests/framework/web/SessionTest.php @@ -16,7 +16,7 @@ use yiiunit\TestCase; class SessionTest extends TestCase { /** - * Test to prove that after Session::destroy session id set to old value + * Test to prove that after Session::destroy session id set to old value. */ public function testDestroySessionId() { diff --git a/tests/framework/web/UrlManagerCreateUrlTest.php b/tests/framework/web/UrlManagerCreateUrlTest.php index 877e018..e1ca2b2 100644 --- a/tests/framework/web/UrlManagerCreateUrlTest.php +++ b/tests/framework/web/UrlManagerCreateUrlTest.php @@ -126,10 +126,11 @@ class UrlManagerCreateUrlTest extends TestCase } /** - * Test createUrl() and createAbsoluteUrl() - * with varying $showScriptName - * without rules. - * With UrlManager::$suffix + * Test createUrl() and createAbsoluteUrl(). + * + * - with varying $showScriptName, + * - without rules, + * - with UrlManager::$suffix. * * @dataProvider variationsProvider * @param string $method @@ -237,10 +238,11 @@ class UrlManagerCreateUrlTest extends TestCase } /** - * Test createUrl() and createAbsoluteUrl() - * with varying $showScriptName - * with simple rules. - * With UrlManager::$suffix + * Test createUrl() and createAbsoluteUrl(). + * + * - with varying $showScriptName, + * - with simple rules, + * - with UrlManager::$suffix. * * @dataProvider variationsProvider * @param string $method @@ -688,7 +690,7 @@ class UrlManagerCreateUrlTest extends TestCase } /** - * Test matching of Url rules dependent on the current host info + * Test matching of Url rules dependent on the current host info. * * @dataProvider multipleHostsRulesDataProvider * @see https://github.com/yiisoft/yii2/issues/7948 diff --git a/tests/framework/web/UrlNormalizerTest.php b/tests/framework/web/UrlNormalizerTest.php index 7a172b5..e0a6a83 100644 --- a/tests/framework/web/UrlNormalizerTest.php +++ b/tests/framework/web/UrlNormalizerTest.php @@ -118,9 +118,9 @@ class UrlNormalizerTest extends TestCase } /** - * Test usage of UrlNormalizer in UrlManager + * Test usage of UrlNormalizer in UrlManager. * - * trailing slash is insignificant if normalizer is enabled + * Trailing slash is insignificant if normalizer is enabled. */ public function testUrlManager() { diff --git a/tests/framework/web/UserTest.php b/tests/framework/web/UserTest.php index 5b27da6..4eadd65 100644 --- a/tests/framework/web/UserTest.php +++ b/tests/framework/web/UserTest.php @@ -8,7 +8,7 @@ namespace yii\web; /** - * Mock for the time() function for web classes + * Mock for the time() function for web classes. * @return int */ function time() @@ -98,7 +98,7 @@ class UserTest extends TestCase } /** - * Make sure autologin works more than once + * Make sure autologin works more than once. * @see https://github.com/yiisoft/yii2/issues/11825 */ public function testIssue11825() diff --git a/tests/framework/widgets/ActiveFieldTest.php b/tests/framework/widgets/ActiveFieldTest.php index 4e7cf4e..627aa1e 100644 --- a/tests/framework/widgets/ActiveFieldTest.php +++ b/tests/framework/widgets/ActiveFieldTest.php @@ -528,7 +528,7 @@ EOD; } /** - * Helper methods + * Helper methods. */ protected function getView() { @@ -553,7 +553,7 @@ class ActiveFieldTestModel extends DynamicModel } /** - * Helper Classes + * Helper Classes. */ class ActiveFieldExtend extends ActiveField { diff --git a/tests/framework/widgets/BreadcrumbsTest.php b/tests/framework/widgets/BreadcrumbsTest.php index a677029..a5a76e8 100644 --- a/tests/framework/widgets/BreadcrumbsTest.php +++ b/tests/framework/widgets/BreadcrumbsTest.php @@ -188,7 +188,7 @@ class BreadcrumbsTest extends \yiiunit\TestCase } /** - * Helper methods + * Helper methods. * @param string $class * @param string $method */ diff --git a/tests/framework/widgets/DetailViewTest.php b/tests/framework/widgets/DetailViewTest.php index ea0b505..019c6cd 100644 --- a/tests/framework/widgets/DetailViewTest.php +++ b/tests/framework/widgets/DetailViewTest.php @@ -317,7 +317,7 @@ class DetailViewTest extends \yiiunit\TestCase } /** - * Helper Class + * Helper Class. */ class ArrayableMock implements Arrayable { @@ -329,7 +329,7 @@ class ArrayableMock implements Arrayable } /** - * Helper Class + * Helper Class. */ class ModelMock extends Model { @@ -363,17 +363,17 @@ class ModelMock extends Model } /** - * Used for testing attributes containing non-English characters + * Used for testing attributes containing non-English characters. */ class UnicodeAttributesModelMock extends Model { /** - * Product's ID (Russian) + * Product's ID (Russian). * @var mixed */ public $ИдентификаторТовара; /** - * ID (Greek) + * ID (Greek). * @var mixed */ public $το_αναγνωριστικό_του; diff --git a/tests/framework/widgets/LinkPagerTest.php b/tests/framework/widgets/LinkPagerTest.php index 9e25530..db14465 100644 --- a/tests/framework/widgets/LinkPagerTest.php +++ b/tests/framework/widgets/LinkPagerTest.php @@ -29,7 +29,7 @@ class LinkPagerTest extends \yiiunit\TestCase } /** - * Get pagination + * Get pagination. * @param int $page * @return Pagination */