Browse Source

Fixed phpDocs [skip ci]

tags/2.0.0-beta
Taras Gudz 11 years ago
parent
commit
f9db4fecb9
  1. 18
      framework/yii/web/Request.php
  2. 2
      framework/yii/web/UploadedFile.php
  3. 8
      framework/yii/web/User.php
  4. 14
      framework/yii/web/View.php

18
framework/yii/web/Request.php

@ -116,8 +116,8 @@ class Request extends \yii\base\Request
/**
* @var string|boolean the name of the POST parameter that is used to indicate if a request is a PUT, PATCH or DELETE
* request tunneled through POST. Default to '_method'.
* @see getMethod
* @see getRestParams
* @see getMethod()
* @see getRestParams()
*/
public $restVar = '_method';
@ -242,7 +242,7 @@ class Request extends \yii\base\Request
/**
* Returns the request parameters for the RESTful request.
* @return array the RESTful request parameters
* @see getMethod
* @see getMethod()
*/
public function getRestParams()
{
@ -298,7 +298,7 @@ class Request extends \yii\base\Request
* @param string $name the GET parameter name. If not specified, whole $_GET is returned.
* @param mixed $defaultValue the default parameter value if the GET parameter does not exist.
* @return mixed the GET parameter value
* @see getPost
* @see getPost()
*/
public function get($name = null, $defaultValue = null)
{
@ -324,7 +324,7 @@ class Request extends \yii\base\Request
* @param mixed $defaultValue the default parameter value if the POST parameter does not exist.
* @property array the POST request parameter values
* @return mixed the POST parameter value
* @see get
* @see get()
*/
public function getPost($name = null, $defaultValue = null)
{
@ -387,7 +387,7 @@ class Request extends \yii\base\Request
* By default this is determined based on the user request information.
* You may explicitly specify it by setting the [[setHostInfo()|hostInfo]] property.
* @return string schema and hostname part (with port number if needed) of the request URL (e.g. `http://www.yiiframework.com`)
* @see setHostInfo
* @see setHostInfo()
*/
public function getHostInfo()
{
@ -426,7 +426,7 @@ class Request extends \yii\base\Request
* This is similar to [[scriptUrl]] except that it does not include the script file name,
* and the ending slashes are removed.
* @return string the relative URL for the application
* @see setScriptUrl
* @see setScriptUrl()
*/
public function getBaseUrl()
{
@ -743,7 +743,7 @@ class Request extends \yii\base\Request
* Defaults to 80, or the port specified by the server if the current
* request is insecure.
* @return integer port number for insecure requests.
* @see setPort
* @see setPort()
*/
public function getPort()
{
@ -774,7 +774,7 @@ class Request extends \yii\base\Request
* Defaults to 443, or the port specified by the server if the current
* request is secure.
* @return integer port number for secure requests.
* @see setSecurePort
* @see setSecurePort()
*/
public function getSecurePort()
{

2
framework/yii/web/UploadedFile.php

@ -74,7 +74,7 @@ class UploadedFile extends Object
* For example, '[1]file' for tabular file uploading; and 'file[1]' for an element in a file array.
* @return UploadedFile the instance of the uploaded file.
* Null is returned if no file is uploaded for the specified model attribute.
* @see getInstanceByName
* @see getInstanceByName()
*/
public static function getInstance($model, $attribute)
{

8
framework/yii/web/User.php

@ -129,8 +129,8 @@ class User extends Component
* Returns the identity object associated with the currently logged user.
* @return IdentityInterface the identity object associated with the currently logged user.
* Null is returned if the user is not logged in (not authenticated).
* @see login
* @see logout
* @see login()
* @see logout()
*/
public function getIdentity()
{
@ -266,7 +266,7 @@ class User extends Component
* If this is null and the return URL was not set previously, [[Application::homeUrl]] will be redirected to.
* Please refer to [[setReturnUrl()]] on accepted format of the URL.
* @return string the URL that the user should be redirected to after login.
* @see loginRequired
* @see loginRequired()
*/
public function getReturnUrl($defaultUrl = null)
{
@ -413,7 +413,7 @@ class User extends Component
* information in the cookie.
* @param IdentityInterface $identity
* @param integer $duration number of seconds that the user can remain in logged-in status.
* @see loginByCookie
* @see loginByCookie()
*/
protected function sendIdentityCookie($identity, $duration)
{

14
framework/yii/web/View.php

@ -72,7 +72,7 @@ class View extends \yii\base\View
/**
* @var AssetBundle[] list of the registered asset bundles. The keys are the bundle names, and the values
* are the registered [[AssetBundle]] objects.
* @see registerAssetBundle
* @see registerAssetBundle()
*/
public $assetBundles = [];
/**
@ -81,32 +81,32 @@ class View extends \yii\base\View
public $title;
/**
* @var array the registered meta tags.
* @see registerMetaTag
* @see registerMetaTag()
*/
public $metaTags;
/**
* @var array the registered link tags.
* @see registerLinkTag
* @see registerLinkTag()
*/
public $linkTags;
/**
* @var array the registered CSS code blocks.
* @see registerCss
* @see registerCss()
*/
public $css;
/**
* @var array the registered CSS files.
* @see registerCssFile
* @see registerCssFile()
*/
public $cssFiles;
/**
* @var array the registered JS code blocks
* @see registerJs
* @see registerJs()
*/
public $js;
/**
* @var array the registered JS files.
* @see registerJsFile
* @see registerJsFile()
*/
public $jsFiles;

Loading…
Cancel
Save