From c1445871f45ab41f5d0f6bd477fe1971675c4659 Mon Sep 17 00:00:00 2001 From: Thiago Talma Date: Wed, 16 Apr 2014 19:29:07 -0300 Subject: [PATCH 1/3] Correction of many errors code inspection. Adjustments code according to the standards. Adding missing PHPDoc comment. --- framework/base/ArrayAccessTrait.php | 2 ++ framework/base/ErrorHandler.php | 2 +- framework/base/Formatter.php | 4 +-- framework/base/Theme.php | 1 + framework/caching/MemCache.php | 23 +++++++++++----- framework/captcha/CaptchaAction.php | 12 ++++++--- .../console/controllers/FixtureController.php | 10 ++++--- .../console/controllers/MessageController.php | 7 +++-- .../console/controllers/MigrateController.php | 3 ++- framework/db/ActiveQueryTrait.php | 1 + framework/db/ActiveRelationTrait.php | 12 +++++++++ framework/db/BaseActiveRecord.php | 4 +++ framework/db/Connection.php | 7 +++-- framework/di/Container.php | 2 +- framework/grid/DataColumn.php | 3 +-- framework/helpers/BaseConsole.php | 1 + framework/helpers/BaseInflector.php | 12 ++++++--- framework/i18n/MessageFormatter.php | 3 ++- framework/log/SyslogTarget.php | 4 +-- framework/validators/CompareValidator.php | 27 ++++++++++++------- framework/views/errorHandler/error.php | 18 ++++++++++--- framework/web/JsonResponseFormatter.php | 24 ++++++++--------- framework/web/ViewAction.php | 2 +- framework/yii | 4 +-- 24 files changed, 127 insertions(+), 61 deletions(-) diff --git a/framework/base/ArrayAccessTrait.php b/framework/base/ArrayAccessTrait.php index 14016e8c94..3d279daf9f 100644 --- a/framework/base/ArrayAccessTrait.php +++ b/framework/base/ArrayAccessTrait.php @@ -15,6 +15,8 @@ namespace yii\base; * * @author Qiang Xue * @since 2.0 + * + * @property array $data */ trait ArrayAccessTrait { diff --git a/framework/base/ErrorHandler.php b/framework/base/ErrorHandler.php index 14459637da..5abb8d0d0b 100644 --- a/framework/base/ErrorHandler.php +++ b/framework/base/ErrorHandler.php @@ -176,7 +176,7 @@ abstract class ErrorHandler extends Component * Renders the exception. * @param \Exception $exception the exception to be rendered. */ - protected abstract function renderException($exception); + abstract protected function renderException($exception); /** * Logs the given exception diff --git a/framework/base/Formatter.php b/framework/base/Formatter.php index 9e0fbbffd6..113ba205fe 100644 --- a/framework/base/Formatter.php +++ b/framework/base/Formatter.php @@ -184,9 +184,7 @@ class Formatter extends Component return $this->nullDisplay; } - return str_replace('

', '', - '

' . preg_replace('/[\r\n]{2,}/', "

\n

", Html::encode($value)) . '

' - ); + return str_replace('

', '', '

' . preg_replace('/[\r\n]{2,}/', "

\n

", Html::encode($value)) . '

'); } /** diff --git a/framework/base/Theme.php b/framework/base/Theme.php index d123e66bf0..5337dd491d 100644 --- a/framework/base/Theme.php +++ b/framework/base/Theme.php @@ -181,6 +181,7 @@ class Theme extends Component * Converts a relative file path into an absolute one using [[basePath]]. * @param string $path the relative file path to be converted. * @return string the absolute file path + * @throws InvalidConfigException if [[baseUrl]] is not set */ public function getPath($path) { diff --git a/framework/caching/MemCache.php b/framework/caching/MemCache.php index bf8c8d8952..45256be7be 100644 --- a/framework/caching/MemCache.php +++ b/framework/caching/MemCache.php @@ -107,15 +107,26 @@ class MemCache extends Cache $timeout = (int) ($server->timeout / 1000) + (($server->timeout % 1000 > 0) ? 1 : 0); if ($paramCount === 9) { $cache->addServer( - $server->host, $server->port, $server->persistent, - $server->weight, $timeout, $server->retryInterval, - $server->status, $server->failureCallback, $server->timeout + $server->host, + $server->port, + $server->persistent, + $server->weight, + $timeout, + $server->retryInterval, + $server->status, + $server->failureCallback, + $server->timeout ); } else { $cache->addServer( - $server->host, $server->port, $server->persistent, - $server->weight, $timeout, $server->retryInterval, - $server->status, $server->failureCallback + $server->host, + $server->port, + $server->persistent, + $server->weight, + $timeout, + $server->retryInterval, + $server->status, + $server->failureCallback ); } } diff --git a/framework/captcha/CaptchaAction.php b/framework/captcha/CaptchaAction.php index 588c290a04..11562d3227 100644 --- a/framework/captcha/CaptchaAction.php +++ b/framework/captcha/CaptchaAction.php @@ -252,10 +252,12 @@ class CaptchaAction extends Action { $image = imagecreatetruecolor($this->width, $this->height); - $backColor = imagecolorallocate($image, + $backColor = imagecolorallocate( + $image, (int) ($this->backColor % 0x1000000 / 0x10000), (int) ($this->backColor % 0x10000 / 0x100), - $this->backColor % 0x100); + $this->backColor % 0x100 + ); imagefilledrectangle($image, 0, 0, $this->width, $this->height, $backColor); imagecolordeallocate($image, $backColor); @@ -263,10 +265,12 @@ class CaptchaAction extends Action imagecolortransparent($image, $backColor); } - $foreColor = imagecolorallocate($image, + $foreColor = imagecolorallocate( + $image, (int) ($this->foreColor % 0x1000000 / 0x10000), (int) ($this->foreColor % 0x10000 / 0x100), - $this->foreColor % 0x100); + $this->foreColor % 0x100 + ); $length = strlen($code); $box = imagettfbbox(30, 0, $this->fontFile, $code); diff --git a/framework/console/controllers/FixtureController.php b/framework/console/controllers/FixtureController.php index f1c72b6abd..5b298abdb9 100644 --- a/framework/console/controllers/FixtureController.php +++ b/framework/console/controllers/FixtureController.php @@ -89,8 +89,9 @@ class FixtureController extends Controller } if (!$foundFixtures) { - throw new Exception("No files were found by name: \"" . implode(', ', $fixtures) . "\".\n" - . "Check that files with these name exists, under fixtures path: \n\"" . $this->getFixturePath() . "\"." + throw new Exception( + "No files were found by name: \"" . implode(', ', $fixtures) . "\".\n" . + "Check that files with these name exists, under fixtures path: \n\"" . $this->getFixturePath() . "\"." ); } @@ -131,8 +132,9 @@ class FixtureController extends Controller } if (!$foundFixtures) { - throw new Exception("No files were found by name: \"" . implode(', ', $fixtures) . "\".\n" - . "Check that fixtures with these name exists, under fixtures path: \n\"" . $this->getFixturePath() . "\"." + throw new Exception( + "No files were found by name: \"" . implode(', ', $fixtures) . "\".\n" . + "Check that fixtures with these name exists, under fixtures path: \n\"" . $this->getFixturePath() . "\"." ); } diff --git a/framework/console/controllers/MessageController.php b/framework/console/controllers/MessageController.php index 59235617a4..ec32561c09 100644 --- a/framework/console/controllers/MessageController.php +++ b/framework/console/controllers/MessageController.php @@ -221,7 +221,7 @@ class MessageController extends Controller } else { $last_id = $db->getLastInsertID(); $db->createCommand() - ->update( + ->update( $sourceMessageTable, ['message' => new \yii\db\Expression("CONCAT('@@',message,'@@')")], ['in', 'id', $obsolete] @@ -253,7 +253,10 @@ class MessageController extends Controller foreach ($translator as $currentTranslator) { $n = preg_match_all( '/\b' . $currentTranslator . '\s*\(\s*(\'.*?(?modelClass; $relations = $this->normalizeRelations($primaryModel, $with); + /** @var ActiveQuery $relation */ foreach ($relations as $name => $relation) { if ($relation->asArray === null) { // inherit asArray from primary query diff --git a/framework/db/ActiveRelationTrait.php b/framework/db/ActiveRelationTrait.php index d65e5a8f1f..863f6a3e60 100644 --- a/framework/db/ActiveRelationTrait.php +++ b/framework/db/ActiveRelationTrait.php @@ -16,6 +16,10 @@ use yii\base\InvalidParamException; * @author Qiang Xue * @author Carsten Brandt * @since 2.0 + * + * @method ActiveRelationTrait one() + * @method ActiveRelationTrait[] all() + * @property ActiveRecord $modelClass */ trait ActiveRelationTrait { @@ -248,12 +252,20 @@ trait ActiveRelationTrait } } + /** + * @param ActiveRecordInterface[] $primaryModels primary models + * @param ActiveRecordInterface[] $models models + * @param string $primaryName the primary relation name + * @param string $name the relation name + * @return null + */ private function populateInverseRelation(&$primaryModels, $models, $primaryName, $name) { if (empty($models) || empty($primaryModels)) { return; } $model = reset($models); + /** @var ActiveQueryInterface|ActiveQuery $relation */ $relation = $model instanceof ActiveRecordInterface ? $model->getRelation($name) : (new $this->modelClass)->getRelation($name); if ($relation->multiple) { diff --git a/framework/db/BaseActiveRecord.php b/framework/db/BaseActiveRecord.php index 6e65fa8d5e..d821e7dbc9 100644 --- a/framework/db/BaseActiveRecord.php +++ b/framework/db/BaseActiveRecord.php @@ -145,6 +145,7 @@ abstract class BaseActiveRecord extends Model implements ActiveRecordInterface * @param string|array $condition the conditions that will be put in the WHERE part of the UPDATE SQL. * Please refer to [[Query::where()]] on how to specify this parameter. * @return integer the number of rows updated + * @throws NotSupportedException if not overrided */ public static function updateAll($attributes, $condition = '') { @@ -164,6 +165,7 @@ abstract class BaseActiveRecord extends Model implements ActiveRecordInterface * @param string|array $condition the conditions that will be put in the WHERE part of the UPDATE SQL. * Please refer to [[Query::where()]] on how to specify this parameter. * @return integer the number of rows updated + * @throws NotSupportedException if not overrided */ public static function updateAllCounters($counters, $condition = '') { @@ -184,6 +186,7 @@ abstract class BaseActiveRecord extends Model implements ActiveRecordInterface * Please refer to [[Query::where()]] on how to specify this parameter. * @param array $params the parameters (name => value) to be bound to the query. * @return integer the number of rows deleted + * @throws NotSupportedException if not overrided */ public static function deleteAll($condition = '', $params = []) { @@ -908,6 +911,7 @@ abstract class BaseActiveRecord extends Model implements ActiveRecordInterface */ public function refresh() { + /** @var ActiveQuery $record */ $record = $this->findOne($this->getPrimaryKey(true)); if ($record === null) { return false; diff --git a/framework/db/Connection.php b/framework/db/Connection.php index 7e999cd0fc..1d073f271b 100644 --- a/framework/db/Connection.php +++ b/framework/db/Connection.php @@ -528,14 +528,17 @@ class Connection extends Component */ public function quoteSql($sql) { - return preg_replace_callback('/(\\{\\{(%?[\w\-\. ]+%?)\\}\\}|\\[\\[([\w\-\. ]+)\\]\\])/', + return preg_replace_callback( + '/(\\{\\{(%?[\w\-\. ]+%?)\\}\\}|\\[\\[([\w\-\. ]+)\\]\\])/', function ($matches) { if (isset($matches[3])) { return $this->quoteColumnName($matches[3]); } else { return str_replace('%', $this->tablePrefix, $this->quoteTableName($matches[2])); } - }, $sql); + }, + $sql + ); } /** diff --git a/framework/di/Container.php b/framework/di/Container.php index 0c4f5a5f77..9c245bf026 100644 --- a/framework/di/Container.php +++ b/framework/di/Container.php @@ -263,7 +263,7 @@ class Container extends Component */ public function setSingleton($class, $definition = [], array $params = []) { - $this->_definitions[$class] = $this->normalizeDefinition($class, $definition);; + $this->_definitions[$class] = $this->normalizeDefinition($class, $definition); $this->_params[$class] = $params; $this->_singletons[$class] = null; return $this; diff --git a/framework/grid/DataColumn.php b/framework/grid/DataColumn.php index 30005ddfc0..14ed3a202d 100644 --- a/framework/grid/DataColumn.php +++ b/framework/grid/DataColumn.php @@ -142,8 +142,7 @@ class DataColumn extends Column if (is_string($this->filter)) { return $this->filter; } elseif ($this->filter !== false && $this->grid->filterModel instanceof Model && - $this->attribute !== null && $this->grid->filterModel->isAttributeActive($this->attribute)) - { + $this->attribute !== null && $this->grid->filterModel->isAttributeActive($this->attribute)) { if (is_array($this->filter)) { $options = array_merge(['prompt' => ''], $this->filterInputOptions); return Html::activeDropDownList($this->grid->filterModel, $this->attribute, $this->filter, $options); diff --git a/framework/helpers/BaseConsole.php b/framework/helpers/BaseConsole.php index ae006864c8..178bbcd2be 100644 --- a/framework/helpers/BaseConsole.php +++ b/framework/helpers/BaseConsole.php @@ -341,6 +341,7 @@ class BaseConsole function ($ansi) use (&$tags) { $styleA = []; foreach (explode(';', $ansi) as $controlCode) { + $style = []; switch ($controlCode) { case self::FG_BLACK: $style = ['color' => '#000000']; diff --git a/framework/helpers/BaseInflector.php b/framework/helpers/BaseInflector.php index e9555189b4..2f73db8bdf 100644 --- a/framework/helpers/BaseInflector.php +++ b/framework/helpers/BaseInflector.php @@ -500,10 +500,14 @@ class BaseInflector return $number . 'th'; } switch ($number % 10) { - case 1: return $number . 'st'; - case 2: return $number . 'nd'; - case 3: return $number . 'rd'; - default: return $number . 'th'; + case 1: + return $number . 'st'; + case 2: + return $number . 'nd'; + case 3: + return $number . 'rd'; + default: + return $number . 'th'; } } } diff --git a/framework/i18n/MessageFormatter.php b/framework/i18n/MessageFormatter.php index 893322f789..baea084ce6 100644 --- a/framework/i18n/MessageFormatter.php +++ b/framework/i18n/MessageFormatter.php @@ -344,7 +344,8 @@ class MessageFormatter extends Component return $arg; } throw new NotSupportedException("Message format 'number' is only supported for integer values. You have to install PHP intl extension to use this feature."); - case 'none': return $arg; + case 'none': + return $arg; case 'select': /* http://icu-project.org/apiref/icu4c/classicu_1_1SelectFormat.html selectStyle = (selector '{' message '}')+ diff --git a/framework/log/SyslogTarget.php b/framework/log/SyslogTarget.php index b8d12d4def..f6ac0ec270 100644 --- a/framework/log/SyslogTarget.php +++ b/framework/log/SyslogTarget.php @@ -29,7 +29,7 @@ class SyslogTarget extends Target /** * @var array syslog levels */ - private $syslogLevels = [ + private $_syslogLevels = [ Logger::LEVEL_TRACE => LOG_DEBUG, Logger::LEVEL_PROFILE_BEGIN => LOG_DEBUG, Logger::LEVEL_PROFILE_END => LOG_DEBUG, @@ -45,7 +45,7 @@ class SyslogTarget extends Target { openlog($this->identity, LOG_ODELAY | LOG_PID, $this->facility); foreach ($this->messages as $message) { - syslog($this->syslogLevels[$message[1]], $this->formatMessage($message)); + syslog($this->_syslogLevels[$message[1]], $this->formatMessage($message)); } closelog(); } diff --git a/framework/validators/CompareValidator.php b/framework/validators/CompareValidator.php index 2a9965842b..d697f7bac8 100644 --- a/framework/validators/CompareValidator.php +++ b/framework/validators/CompareValidator.php @@ -161,15 +161,24 @@ class CompareValidator extends Validator protected function compareValues($operator, $value, $compareValue) { switch ($operator) { - case '==': return $value == $compareValue; - case '===': return $value === $compareValue; - case '!=': return $value != $compareValue; - case '!==': return $value !== $compareValue; - case '>': return $value > $compareValue; - case '>=': return $value >= $compareValue; - case '<': return $value < $compareValue; - case '<=': return $value <= $compareValue; - default: return false; + case '==': + return $value == $compareValue; + case '===': + return $value === $compareValue; + case '!=': + return $value != $compareValue; + case '!==': + return $value !== $compareValue; + case '>': + return $value > $compareValue; + case '>=': + return $value >= $compareValue; + case '<': + return $value < $compareValue; + case '<=': + return $value <= $compareValue; + default: + return false; } } diff --git a/framework/views/errorHandler/error.php b/framework/views/errorHandler/error.php index 93f49255dc..47fc166f11 100644 --- a/framework/views/errorHandler/error.php +++ b/framework/views/errorHandler/error.php @@ -1,6 +1,6 @@ beginPage(); +} ?> -beginPage(); ?> @@ -80,7 +83,14 @@ if ($exception instanceof \yii\base\UserException) {
- endBody(); // to allow injecting code into body (mostly by Yii Debug Toolbar) ?> + endBody(); // to allow injecting code into body (mostly by Yii Debug Toolbar) + } + ?> -endPage(); ?> +endPage(); +} \ No newline at end of file diff --git a/framework/web/JsonResponseFormatter.php b/framework/web/JsonResponseFormatter.php index bd47704c90..7953517c3e 100644 --- a/framework/web/JsonResponseFormatter.php +++ b/framework/web/JsonResponseFormatter.php @@ -28,18 +28,18 @@ class JsonResponseFormatter extends Component implements ResponseFormatterInterf */ public $useJsonp = false; - /** - * Formats the specified response. - * @param Response $response the response to be formatted. - */ - public function format($response) - { - if ($this->useJsonp) { - $this->formatJsonp($response); - } else { - $this->formatJson($response); - } - } + /** + * Formats the specified response. + * @param Response $response the response to be formatted. + */ + public function format($response) + { + if ($this->useJsonp) { + $this->formatJsonp($response); + } else { + $this->formatJson($response); + } + } /** * Formats response data in JSON format. diff --git a/framework/web/ViewAction.php b/framework/web/ViewAction.php index 256aa564d5..401da0cd76 100644 --- a/framework/web/ViewAction.php +++ b/framework/web/ViewAction.php @@ -70,7 +70,7 @@ class ViewAction extends Action $viewName = $this->resolveViewName(); $controllerLayout = null; - if($this->layout !== null) { + if ($this->layout !== null) { $controllerLayout = $this->controller->layout; $this->controller->layout = $this->layout; } diff --git a/framework/yii b/framework/yii index 2fbd6d3f0b..4024f4a20b 100755 --- a/framework/yii +++ b/framework/yii @@ -17,8 +17,8 @@ defined('STDOUT') or define('STDOUT', fopen('php://stdout', 'w')); require(__DIR__ . '/Yii.php'); $application = new yii\console\Application([ - 'id' => 'yii-console', - 'basePath' => __DIR__ . '/console', + 'id' => 'yii-console', + 'basePath' => __DIR__ . '/console', ]); $exitCode = $application->run(); exit($exitCode); From 57692cd44877fdb70e6748da303ea41f0e8f95b9 Mon Sep 17 00:00:00 2001 From: Thiago Talma Date: Wed, 16 Apr 2014 19:47:28 -0300 Subject: [PATCH 2/3] Update error.php --- framework/views/errorHandler/error.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/framework/views/errorHandler/error.php b/framework/views/errorHandler/error.php index 47fc166f11..6427401a9c 100644 --- a/framework/views/errorHandler/error.php +++ b/framework/views/errorHandler/error.php @@ -1,6 +1,6 @@ endPage(); -} \ No newline at end of file +} From 8546b41bb829844c991d1512c81d57396f1e78cc Mon Sep 17 00:00:00 2001 From: Thiago Talma Date: Wed, 16 Apr 2014 19:59:25 -0300 Subject: [PATCH 3/3] Update error.php --- framework/views/errorHandler/error.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/framework/views/errorHandler/error.php b/framework/views/errorHandler/error.php index 6427401a9c..22b35121df 100644 --- a/framework/views/errorHandler/error.php +++ b/framework/views/errorHandler/error.php @@ -1,6 +1,6 @@