Browse Source

added some class documentation

tags/2.0.0-beta
Carsten Brandt 11 years ago
parent
commit
147558ea19
  1. 2
      framework/yii/debug/LogTarget.php
  2. 2
      framework/yii/debug/Module.php
  3. 1
      framework/yii/web/AccessRule.php
  4. 2
      framework/yii/web/Application.php
  5. 2
      framework/yii/web/Controller.php
  6. 2
      framework/yii/web/HttpCache.php
  7. 2
      framework/yii/web/JqueryAsset.php
  8. 4
      framework/yii/web/JsExpression.php
  9. 2
      framework/yii/web/PageCache.php
  10. 5
      framework/yii/web/Request.php
  11. 4
      framework/yii/web/Response.php
  12. 6
      framework/yii/web/UploadedFile.php
  13. 1
      framework/yii/web/UserEvent.php

2
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 <qiang.xue@gmail.com>
* @since 2.0
*/

2
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 <qiang.xue@gmail.com>
* @since 2.0
*/

1
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 <qiang.xue@gmail.com>
* @since 2.0

2
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.

2
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 <qiang.xue@gmail.com>
* @since 2.0

2
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 <webmaster@dasourcerer.net>
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0

2
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 <qiang.xue@gmail.com>
* @since 2.0
*/

4
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 <qiang.xue@gmail.com>
* @since 2.0
*/

2
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 <qiang.xue@gmail.com>
* @since 2.0
*/

5
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.

4
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.

6
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

1
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 <qiang.xue@gmail.com>
* @since 2.0

Loading…
Cancel
Save