diff --git a/framework/yii/debug/LogTarget.php b/framework/yii/debug/LogTarget.php index 3e36cd5..b415b50 100644 --- a/framework/yii/debug/LogTarget.php +++ b/framework/yii/debug/LogTarget.php @@ -11,6 +11,8 @@ use Yii; use yii\log\Target; /** + * The debug LogTarget is used to store logs for later use in the debugger tool + * * @author Qiang Xue * @since 2.0 */ diff --git a/framework/yii/debug/Module.php b/framework/yii/debug/Module.php index 2246520..dd027a7 100644 --- a/framework/yii/debug/Module.php +++ b/framework/yii/debug/Module.php @@ -12,6 +12,8 @@ use yii\base\View; use yii\web\HttpException; /** + * The Yii Debug Module provides the debug toolbar and debugger + * * @author Qiang Xue * @since 2.0 */ diff --git a/framework/yii/web/AccessRule.php b/framework/yii/web/AccessRule.php index 0de791c..7aeaac1 100644 --- a/framework/yii/web/AccessRule.php +++ b/framework/yii/web/AccessRule.php @@ -11,6 +11,7 @@ use yii\base\Component; use yii\base\Action; /** + * This class represents an access rule defined by the [[AccessControl]] action filter * * @author Qiang Xue * @since 2.0 diff --git a/framework/yii/web/Application.php b/framework/yii/web/Application.php index c0b8793..5fd2310 100644 --- a/framework/yii/web/Application.php +++ b/framework/yii/web/Application.php @@ -11,7 +11,7 @@ use Yii; use yii\base\InvalidRouteException; /** - * Application is the base class for all application classes. + * Application is the base class for all web application classes. * * @property AssetManager $assetManager The asset manager component. This property is read-only. * @property string $homeUrl The homepage URL. diff --git a/framework/yii/web/Controller.php b/framework/yii/web/Controller.php index b9aa68c..adb1b4d 100644 --- a/framework/yii/web/Controller.php +++ b/framework/yii/web/Controller.php @@ -12,7 +12,7 @@ use yii\base\InlineAction; use yii\helpers\Html; /** - * Controller is the base class of Web controllers. + * Controller is the base class of web controllers. * * @author Qiang Xue * @since 2.0 diff --git a/framework/yii/web/HttpCache.php b/framework/yii/web/HttpCache.php index cc9e6ed..d2f3923 100644 --- a/framework/yii/web/HttpCache.php +++ b/framework/yii/web/HttpCache.php @@ -12,6 +12,8 @@ use yii\base\ActionFilter; use yii\base\Action; /** + * The HttpCache provides functionality for caching via HTTP Last-Modified and Etag headers + * * @author Da:Sourcerer * @author Qiang Xue * @since 2.0 diff --git a/framework/yii/web/JqueryAsset.php b/framework/yii/web/JqueryAsset.php index 4585acd..9991eb4 100644 --- a/framework/yii/web/JqueryAsset.php +++ b/framework/yii/web/JqueryAsset.php @@ -8,6 +8,8 @@ namespace yii\web; /** + * This asset bundle provides the [jquery javascript library](http://jquery.com/) + * * @author Qiang Xue * @since 2.0 */ diff --git a/framework/yii/web/JsExpression.php b/framework/yii/web/JsExpression.php index 027c065..7daac08 100644 --- a/framework/yii/web/JsExpression.php +++ b/framework/yii/web/JsExpression.php @@ -11,8 +11,10 @@ use yii\base\Object; /** * JsExpression marks a string as a JavaScript expression. - * When using [[Json::encode()]] to encode a value, JsonExpression objects + * + * When using [[yii\helpers\Json::encode()]] to encode a value, JsonExpression objects * will be specially handled and encoded as a JavaScript expression instead of a string. + * * @author Qiang Xue * @since 2.0 */ diff --git a/framework/yii/web/PageCache.php b/framework/yii/web/PageCache.php index d28203e..9bc8981 100644 --- a/framework/yii/web/PageCache.php +++ b/framework/yii/web/PageCache.php @@ -14,6 +14,8 @@ use yii\base\View; use yii\caching\Dependency; /** + * The PageCache provides functionality for whole page caching + * * @author Qiang Xue * @since 2.0 */ diff --git a/framework/yii/web/Request.php b/framework/yii/web/Request.php index 55073a2..c6e1ce3 100644 --- a/framework/yii/web/Request.php +++ b/framework/yii/web/Request.php @@ -12,6 +12,11 @@ use yii\base\InvalidConfigException; use yii\helpers\Security; /** + * 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 + * parameters sent via other HTTP methods like PUT or DELETE. * * @property string $absoluteUrl The currently requested absolute URL. This property is read-only. * @property string $acceptTypes User browser accept types, null if not present. This property is read-only. diff --git a/framework/yii/web/Response.php b/framework/yii/web/Response.php index 286a0db..cfbc537 100644 --- a/framework/yii/web/Response.php +++ b/framework/yii/web/Response.php @@ -17,6 +17,10 @@ use yii\helpers\Security; use yii\helpers\StringHelper; /** + * 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]]. * * @property CookieCollection $cookies The cookie collection. This property is read-only. * @property HeaderCollection $headers The header collection. This property is read-only. diff --git a/framework/yii/web/UploadedFile.php b/framework/yii/web/UploadedFile.php index 609388f..21fc355 100644 --- a/framework/yii/web/UploadedFile.php +++ b/framework/yii/web/UploadedFile.php @@ -10,6 +10,12 @@ namespace yii\web; use yii\helpers\Html; /** + * UploadedFile represents the information for an uploaded file. + * + * You can call [[getInstance()]] to retrieve the instance of an uploaded file, + * and then use [[saveAs()]] to save it on the server. + * You may also query other information about the file, including [[name]], + * [[tempName]], [[type]], [[size]] and [[error]]. * * @property integer $error The error code. This property is read-only. * @property boolean $hasError Whether there is an error with the uploaded file. Check [[error]] for detailed diff --git a/framework/yii/web/UserEvent.php b/framework/yii/web/UserEvent.php index 4e39380..3e403da 100644 --- a/framework/yii/web/UserEvent.php +++ b/framework/yii/web/UserEvent.php @@ -10,6 +10,7 @@ namespace yii\web; use yii\base\Event; /** + * This event class is used for Events triggered by the [[User]] class. * * @author Qiang Xue * @since 2.0