Commit 147558ea by Carsten Brandt

added some class documentation

parent 91c16782
...@@ -11,6 +11,8 @@ use Yii; ...@@ -11,6 +11,8 @@ use Yii;
use yii\log\Target; use yii\log\Target;
/** /**
* The debug LogTarget is used to store logs for later use in the debugger tool
*
* @author Qiang Xue <qiang.xue@gmail.com> * @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0 * @since 2.0
*/ */
......
...@@ -12,6 +12,8 @@ use yii\base\View; ...@@ -12,6 +12,8 @@ use yii\base\View;
use yii\web\HttpException; use yii\web\HttpException;
/** /**
* The Yii Debug Module provides the debug toolbar and debugger
*
* @author Qiang Xue <qiang.xue@gmail.com> * @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0 * @since 2.0
*/ */
......
...@@ -11,6 +11,7 @@ use yii\base\Component; ...@@ -11,6 +11,7 @@ use yii\base\Component;
use yii\base\Action; use yii\base\Action;
/** /**
* This class represents an access rule defined by the [[AccessControl]] action filter
* *
* @author Qiang Xue <qiang.xue@gmail.com> * @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0 * @since 2.0
......
...@@ -11,7 +11,7 @@ use Yii; ...@@ -11,7 +11,7 @@ use Yii;
use yii\base\InvalidRouteException; 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 AssetManager $assetManager The asset manager component. This property is read-only.
* @property string $homeUrl The homepage URL. * @property string $homeUrl The homepage URL.
......
...@@ -12,7 +12,7 @@ use yii\base\InlineAction; ...@@ -12,7 +12,7 @@ use yii\base\InlineAction;
use yii\helpers\Html; use yii\helpers\Html;
/** /**
* Controller is the base class of Web controllers. * Controller is the base class of web controllers.
* *
* @author Qiang Xue <qiang.xue@gmail.com> * @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0 * @since 2.0
......
...@@ -12,6 +12,8 @@ use yii\base\ActionFilter; ...@@ -12,6 +12,8 @@ use yii\base\ActionFilter;
use yii\base\Action; use yii\base\Action;
/** /**
* The HttpCache provides functionality for caching via HTTP Last-Modified and Etag headers
*
* @author Da:Sourcerer <webmaster@dasourcerer.net> * @author Da:Sourcerer <webmaster@dasourcerer.net>
* @author Qiang Xue <qiang.xue@gmail.com> * @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0 * @since 2.0
......
...@@ -8,6 +8,8 @@ ...@@ -8,6 +8,8 @@
namespace yii\web; namespace yii\web;
/** /**
* This asset bundle provides the [jquery javascript library](http://jquery.com/)
*
* @author Qiang Xue <qiang.xue@gmail.com> * @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0 * @since 2.0
*/ */
......
...@@ -11,8 +11,10 @@ use yii\base\Object; ...@@ -11,8 +11,10 @@ use yii\base\Object;
/** /**
* JsExpression marks a string as a JavaScript expression. * 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. * will be specially handled and encoded as a JavaScript expression instead of a string.
*
* @author Qiang Xue <qiang.xue@gmail.com> * @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0 * @since 2.0
*/ */
......
...@@ -14,6 +14,8 @@ use yii\base\View; ...@@ -14,6 +14,8 @@ use yii\base\View;
use yii\caching\Dependency; use yii\caching\Dependency;
/** /**
* The PageCache provides functionality for whole page caching
*
* @author Qiang Xue <qiang.xue@gmail.com> * @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0 * @since 2.0
*/ */
......
...@@ -12,6 +12,11 @@ use yii\base\InvalidConfigException; ...@@ -12,6 +12,11 @@ use yii\base\InvalidConfigException;
use yii\helpers\Security; 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 $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. * @property string $acceptTypes User browser accept types, null if not present. This property is read-only.
......
...@@ -17,6 +17,10 @@ use yii\helpers\Security; ...@@ -17,6 +17,10 @@ use yii\helpers\Security;
use yii\helpers\StringHelper; 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 CookieCollection $cookies The cookie collection. This property is read-only.
* @property HeaderCollection $headers The header collection. This property is read-only. * @property HeaderCollection $headers The header collection. This property is read-only.
......
...@@ -10,6 +10,12 @@ namespace yii\web; ...@@ -10,6 +10,12 @@ namespace yii\web;
use yii\helpers\Html; 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 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 * @property boolean $hasError Whether there is an error with the uploaded file. Check [[error]] for detailed
......
...@@ -10,6 +10,7 @@ namespace yii\web; ...@@ -10,6 +10,7 @@ namespace yii\web;
use yii\base\Event; use yii\base\Event;
/** /**
* This event class is used for Events triggered by the [[User]] class.
* *
* @author Qiang Xue <qiang.xue@gmail.com> * @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0 * @since 2.0
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment