Commit 2939938c by Qiang Xue

Merge pull request #1177 from nukkumatti/master

Fixed phpDocs [skip ci]
parents a7175bae 2617dfba
......@@ -63,8 +63,7 @@ class BaseYii
* The array keys are the class names (without leading backslashes), and the array values
* are the corresponding class file paths (or path aliases). This property mainly affects
* how [[autoload()]] works.
* @see import
* @see autoload
* @see autoload()
*/
public static $classMap = [];
/**
......@@ -73,8 +72,8 @@ class BaseYii
public static $app;
/**
* @var array registered path aliases
* @see getAlias
* @see setAlias
* @see getAlias()
* @see setAlias()
*/
public static $aliases = ['@yii' => __DIR__];
/**
......@@ -95,7 +94,7 @@ class BaseYii
* ]
* ~~~
*
* @see createObject
* @see createObject()
*/
public static $objectConfig = [];
......@@ -136,7 +135,7 @@ class BaseYii
* If this is false and an invalid alias is given, false will be returned by this method.
* @return string|boolean the path corresponding to the alias, false if the root alias is not previously registered.
* @throws InvalidParamException if the alias is invalid while $throwException is true.
* @see setAlias
* @see setAlias()
*/
public static function getAlias($alias, $throwException = true)
{
......@@ -219,7 +218,7 @@ class BaseYii
* actual path first by calling [[getAlias()]].
*
* @throws InvalidParamException if $path is an invalid alias.
* @see getAlias
* @see getAlias()
*/
public static function setAlias($alias, $path)
{
......@@ -450,7 +449,7 @@ class BaseYii
* ~~~
* @param string $token token for the code block
* @param string $category the category of this log message
* @see endProfile
* @see endProfile()
*/
public static function beginProfile($token, $category = 'application')
{
......@@ -462,7 +461,7 @@ class BaseYii
* This has to be matched with a previous call to [[beginProfile]] with the same category name.
* @param string $token token for the code block
* @param string $category the category of this log message
* @see beginProfile
* @see beginProfile()
*/
public static function endProfile($token, $category = 'application')
{
......
......@@ -41,7 +41,7 @@ class Component extends Object
* @return mixed the property value or the value of a behavior's property
* @throws UnknownPropertyException if the property is not defined
* @throws InvalidCallException if the property is write-only.
* @see __set
* @see __set()
*/
public function __get($name)
{
......@@ -80,7 +80,7 @@ class Component extends Object
* @param mixed $value the property value
* @throws UnknownPropertyException if the property is not defined
* @throws InvalidCallException if the property is read-only.
* @see __get
* @see __get()
*/
public function __set($name, $value)
{
......@@ -225,8 +225,8 @@ class Component extends Object
* @param boolean $checkVars whether to treat member variables as properties
* @param boolean $checkBehaviors whether to treat behaviors' properties as properties of this component
* @return boolean whether the property is defined
* @see canGetProperty
* @see canSetProperty
* @see canGetProperty()
* @see canSetProperty()
*/
public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
......@@ -246,7 +246,7 @@ class Component extends Object
* @param boolean $checkVars whether to treat member variables as properties
* @param boolean $checkBehaviors whether to treat behaviors' properties as properties of this component
* @return boolean whether the property can be read
* @see canSetProperty
* @see canSetProperty()
*/
public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
......@@ -276,7 +276,7 @@ class Component extends Object
* @param boolean $checkVars whether to treat member variables as properties
* @param boolean $checkBehaviors whether to treat behaviors' properties as properties of this component
* @return boolean whether the property can be written
* @see canGetProperty
* @see canGetProperty()
*/
public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
......@@ -492,7 +492,7 @@ class Component extends Object
* - an object configuration array that will be passed to [[Yii::createObject()]] to create the behavior object.
*
* @return Behavior the behavior object
* @see detachBehavior
* @see detachBehavior()
*/
public function attachBehavior($name, $behavior)
{
......@@ -505,7 +505,7 @@ class Component extends Object
* Each behavior is indexed by its name and should be a [[Behavior]] object,
* a string specifying the behavior class, or an configuration array for creating the behavior.
* @param array $behaviors list of behaviors to be attached to the component
* @see attachBehavior
* @see attachBehavior()
*/
public function attachBehaviors($behaviors)
{
......
......@@ -111,7 +111,7 @@ class Controller extends Component implements ViewContextInterface
* @param array $params the parameters (name-value pairs) to be passed to the action.
* @return mixed the result of the action
* @throws InvalidRouteException if the requested action ID cannot be resolved into an action successfully.
* @see createAction
* @see createAction()
*/
public function runAction($id, $params = [])
{
......@@ -149,8 +149,7 @@ class Controller extends Component implements ViewContextInterface
* @param string $route the route to be handled, e.g., 'view', 'comment/view', '/admin/comment/view'.
* @param array $params the parameters to be passed to the action.
* @return mixed the result of the action
* @see runAction
* @see forward
* @see runAction()
*/
public function run($route, $params = [])
{
......
......@@ -144,7 +144,7 @@ class Model extends Component implements IteratorAggregate, ArrayAccess
* merge the parent rules with child rules using functions such as `array_merge()`.
*
* @return array validation rules
* @see scenarios
* @see scenarios()
*/
public function rules()
{
......@@ -255,7 +255,7 @@ class Model extends Component implements IteratorAggregate, ArrayAccess
* merge the parent labels with child labels using functions such as `array_merge()`.
*
* @return array attribute labels (name => label)
* @see generateAttributeLabel
* @see generateAttributeLabel()
*/
public function attributeLabels()
{
......@@ -444,8 +444,8 @@ class Model extends Component implements IteratorAggregate, ArrayAccess
* Returns the text label for the specified attribute.
* @param string $attribute the attribute name
* @return string the attribute label
* @see generateAttributeLabel
* @see attributeLabels
* @see generateAttributeLabel()
* @see attributeLabels()
*/
public function getAttributeLabel($attribute)
{
......@@ -483,8 +483,8 @@ class Model extends Component implements IteratorAggregate, ArrayAccess
* ]
* ~~~
*
* @see getFirstErrors
* @see getFirstError
* @see getFirstErrors()
* @see getFirstError()
*/
public function getErrors($attribute = null)
{
......@@ -498,8 +498,8 @@ class Model extends Component implements IteratorAggregate, ArrayAccess
/**
* Returns the first error of every attribute in the model.
* @return array the first errors. An empty array will be returned if there is no error.
* @see getErrors
* @see getFirstError
* @see getErrors()
* @see getFirstError()
*/
public function getFirstErrors()
{
......@@ -520,8 +520,8 @@ class Model extends Component implements IteratorAggregate, ArrayAccess
* Returns the first error of the specified attribute.
* @param string $attribute attribute name.
* @return string the error message. Null is returned if no error.
* @see getErrors
* @see getFirstErrors
* @see getErrors()
* @see getFirstErrors()
*/
public function getFirstError($attribute)
{
......
......@@ -64,7 +64,7 @@ class Object implements Arrayable
* @return mixed the property value
* @throws UnknownPropertyException if the property is not defined
* @throws InvalidCallException if the property is write-only
* @see __set
* @see __set()
*/
public function __get($name)
{
......@@ -87,7 +87,7 @@ class Object implements Arrayable
* @param mixed $value the property value
* @throws UnknownPropertyException if the property is not defined
* @throws InvalidCallException if the property is read-only
* @see __get
* @see __get()
*/
public function __set($name, $value)
{
......@@ -168,8 +168,8 @@ class Object implements Arrayable
* @param string $name the property name
* @param boolean $checkVars whether to treat member variables as properties
* @return boolean whether the property is defined
* @see canGetProperty
* @see canSetProperty
* @see canGetProperty()
* @see canSetProperty()
*/
public function hasProperty($name, $checkVars = true)
{
......@@ -187,7 +187,7 @@ class Object implements Arrayable
* @param string $name the property name
* @param boolean $checkVars whether to treat member variables as properties
* @return boolean whether the property can be read
* @see canSetProperty
* @see canSetProperty()
*/
public function canGetProperty($name, $checkVars = true)
{
......@@ -205,7 +205,7 @@ class Object implements Arrayable
* @param string $name the property name
* @param boolean $checkVars whether to treat member variables as properties
* @return boolean whether the property can be written
* @see canGetProperty
* @see canGetProperty()
*/
public function canSetProperty($name, $checkVars = true)
{
......
......@@ -123,7 +123,7 @@ class View extends Component
* existing [[context]] will be used.
* @return string the rendering result
* @throws InvalidParamException if the view cannot be resolved or the view file does not exist.
* @see renderFile
* @see renderFile()
*/
public function render($view, $params = [], $context = null)
{
......
......@@ -372,7 +372,7 @@ class ActiveRecord extends Model
* This method is overridden so that attributes and related objects can be accessed like properties.
* @param string $name property name
* @return mixed property value
* @see getAttribute
* @see getAttribute()
*/
public function __get($name)
{
......@@ -576,7 +576,7 @@ class ActiveRecord extends Model
* null will be returned.
* @param string $name the attribute name
* @return mixed the attribute value. Null if the attribute is not set or does not exist.
* @see hasAttribute
* @see hasAttribute()
*/
public function getAttribute($name)
{
......@@ -588,7 +588,7 @@ class ActiveRecord extends Model
* @param string $name the attribute name
* @param mixed $value the attribute value.
* @throws InvalidParamException if the named attribute does not exist.
* @see hasAttribute
* @see hasAttribute()
*/
public function setAttribute($name, $value)
{
......@@ -625,7 +625,7 @@ class ActiveRecord extends Model
* @param string $name the attribute name
* @return mixed the old attribute value. Null if the attribute is not loaded before
* or does not exist.
* @see hasAttribute
* @see hasAttribute()
*/
public function getOldAttribute($name)
{
......@@ -637,7 +637,7 @@ class ActiveRecord extends Model
* @param string $name the attribute name
* @param mixed $value the old attribute value.
* @throws InvalidParamException if the named attribute does not exist.
* @see hasAttribute
* @see hasAttribute()
*/
public function setOldAttribute($name, $value)
{
......@@ -1030,7 +1030,7 @@ class ActiveRecord extends Model
/**
* Sets the value indicating whether the record is new.
* @param boolean $value whether the record is new and should be inserted when calling [[save()]].
* @see getIsNewRecord
* @see getIsNewRecord()
*/
public function setIsNewRecord($value)
{
......
......@@ -39,12 +39,12 @@ class Query extends Component
{
/**
* Sort ascending
* @see orderBy
* @see orderBy()
*/
const SORT_ASC = false;
/**
* Sort descending
* @see orderBy
* @see orderBy()
*/
const SORT_DESC = true;
......
......@@ -291,7 +291,7 @@ abstract class Schema extends Object
* then this method will do nothing.
* @param string $name table name
* @return string the properly quoted table name
* @see quoteSimpleTableName
* @see quoteSimpleTableName()
*/
public function quoteTableName($name)
{
......@@ -316,7 +316,7 @@ abstract class Schema extends Object
* then this method will do nothing.
* @param string $name column name
* @return string the properly quoted column name
* @see quoteSimpleColumnName
* @see quoteSimpleColumnName()
*/
public function quoteColumnName($name)
{
......
......@@ -86,7 +86,7 @@ class BaseHtml
* @param boolean $doubleEncode whether to encode HTML entities in `$content`. If false,
* HTML entities in `$content` will not be further encoded.
* @return string the encoded content
* @see decode
* @see decode()
* @see http://www.php.net/manual/en/function.htmlspecialchars.php
*/
public static function encode($content, $doubleEncode = true)
......@@ -99,7 +99,7 @@ class BaseHtml
* This is the opposite of [[encode()]].
* @param string $content the content to be decoded
* @return string the decoded content
* @see encode
* @see encode()
* @see http://www.php.net/manual/en/function.htmlspecialchars-decode.php
*/
public static function decode($content)
......@@ -116,8 +116,8 @@ class BaseHtml
* the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]].
* If a value is null, the corresponding attribute will not be rendered.
* @return string the generated HTML tag
* @see beginTag
* @see endTag
* @see beginTag()
* @see endTag()
*/
public static function tag($name, $content = '', $options = [])
{
......@@ -132,8 +132,8 @@ class BaseHtml
* the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]].
* If a value is null, the corresponding attribute will not be rendered.
* @return string the generated start tag
* @see endTag
* @see tag
* @see endTag()
* @see tag()
*/
public static function beginTag($name, $options = [])
{
......@@ -144,8 +144,8 @@ class BaseHtml
* Generates an end tag.
* @param string $name the tag name
* @return string the generated end tag
* @see beginTag
* @see tag
* @see beginTag()
* @see tag()
*/
public static function endTag($name)
{
......@@ -187,7 +187,7 @@ class BaseHtml
* the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]].
* If a value is null, the corresponding attribute will not be rendered.
* @return string the generated link tag
* @see url
* @see url()
*/
public static function cssFile($url, $options = [])
{
......@@ -203,7 +203,7 @@ class BaseHtml
* the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]].
* If a value is null, the corresponding attribute will not be rendered.
* @return string the generated script tag
* @see url
* @see url()
*/
public static function jsFile($url, $options = [])
{
......@@ -222,7 +222,7 @@ class BaseHtml
* the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]].
* If a value is null, the corresponding attribute will not be rendered.
* @return string the generated form start tag.
* @see endForm
* @see endForm()
*/
public static function beginForm($action = '', $method = 'post', $options = [])
{
......@@ -271,7 +271,7 @@ class BaseHtml
/**
* Generates a form end tag.
* @return string the generated tag
* @see beginForm
* @see beginForm()
*/
public static function endForm()
{
......@@ -290,7 +290,7 @@ class BaseHtml
* the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]].
* If a value is null, the corresponding attribute will not be rendered.
* @return string the generated hyperlink
* @see url
* @see url()
*/
public static function a($text, $url = null, $options = [])
{
......
......@@ -328,7 +328,7 @@ class BaseInflector
* Converts a word like "send_email" to "SendEmail". It
* will remove non alphanumeric character from the word, so
* "who's online" will be converted to "WhoSOnline"
* @see variablize
* @see variablize()
* @param string $word the word to CamelCase
* @return string
*/
......
......@@ -36,8 +36,8 @@ class PhpManager extends Manager
* If not set, it will be using 'protected/data/rbac.php' as the data file.
* Make sure this file is writable by the Web server process if the authorization
* needs to be changed.
* @see loadFromFile
* @see saveToFile
* @see loadFromFile()
* @see saveToFile()
*/
public $authFile;
......@@ -517,7 +517,7 @@ class PhpManager extends Manager
* Loads the authorization data from a PHP script file.
* @param string $file the file path.
* @return array the authorization data
* @see saveToFile
* @see saveToFile()
*/
protected function loadFromFile($file)
{
......@@ -532,7 +532,7 @@ class PhpManager extends Manager
* Saves the authorization data to a PHP script file.
* @param array $data the authorization data
* @param string $file the file path.
* @see loadFromFile
* @see loadFromFile()
*/
protected function saveToFile($data, $file)
{
......
......@@ -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()
{
......
......@@ -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)
{
......
......@@ -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)
{
......
......@@ -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;
......
......@@ -104,7 +104,7 @@ class Menu extends Widget
/**
* @var boolean whether to automatically activate items according to whether their route setting
* matches the currently requested route.
* @see isItemActive
* @see isItemActive()
*/
public $activateItems = true;
/**
......@@ -137,14 +137,14 @@ class Menu extends Widget
* @var string the route used to determine if a menu item is active or not.
* If not set, it will use the route of the current request.
* @see params
* @see isItemActive
* @see isItemActive()
*/
public $route;
/**
* @var array the parameters used to determine if a menu item is active or not.
* If not set, it will use `$_GET`.
* @see route
* @see isItemActive
* @see isItemActive()
*/
public $params;
......
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