Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
Y
yii2
Project
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
PSDI Army
yii2
Commits
9b95a81b
Commit
9b95a81b
authored
Nov 12, 2013
by
Taras Gudz
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Fixed the rest phpDocs [skip ci]
parent
f9db4fec
Show whitespace changes
Inline
Side-by-side
Showing
13 changed files
with
66 additions
and
66 deletions
+66
-66
BaseYii.php
framework/yii/BaseYii.php
+8
-8
Component.php
framework/yii/base/Component.php
+8
-8
Controller.php
framework/yii/base/Controller.php
+2
-2
Model.php
framework/yii/base/Model.php
+10
-10
Object.php
framework/yii/base/Object.php
+6
-6
View.php
framework/yii/base/View.php
+1
-1
ActiveRecord.php
framework/yii/db/ActiveRecord.php
+6
-6
Query.php
framework/yii/db/Query.php
+2
-2
Schema.php
framework/yii/db/Schema.php
+2
-2
BaseHtml.php
framework/yii/helpers/BaseHtml.php
+13
-13
BaseInflector.php
framework/yii/helpers/BaseInflector.php
+1
-1
PhpManager.php
framework/yii/rbac/PhpManager.php
+4
-4
Menu.php
framework/yii/widgets/Menu.php
+3
-3
No files found.
framework/yii/BaseYii.php
View file @
9b95a81b
...
...
@@ -64,7 +64,7 @@ class BaseYii
* 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 +73,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 +95,7 @@ class BaseYii
* ]
* ~~~
*
* @see createObject
* @see createObject
()
*/
public
static
$objectConfig
=
[];
...
...
@@ -136,7 +136,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 +219,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 +450,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 +462,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'
)
{
...
...
framework/yii/base/Component.php
View file @
9b95a81b
...
...
@@ -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
)
{
...
...
framework/yii/base/Controller.php
View file @
9b95a81b
...
...
@@ -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,7 +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 runAction
()
* @see forward
*/
public
function
run
(
$route
,
$params
=
[])
...
...
framework/yii/base/Model.php
View file @
9b95a81b
...
...
@@ -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
)
{
...
...
framework/yii/base/Object.php
View file @
9b95a81b
...
...
@@ -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
)
{
...
...
framework/yii/base/View.php
View file @
9b95a81b
...
...
@@ -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
)
{
...
...
framework/yii/db/ActiveRecord.php
View file @
9b95a81b
...
...
@@ -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
)
{
...
...
framework/yii/db/Query.php
View file @
9b95a81b
...
...
@@ -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
;
...
...
framework/yii/db/Schema.php
View file @
9b95a81b
...
...
@@ -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
)
{
...
...
framework/yii/helpers/BaseHtml.php
View file @
9b95a81b
...
...
@@ -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
=
[])
{
...
...
framework/yii/helpers/BaseInflector.php
View file @
9b95a81b
...
...
@@ -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
*/
...
...
framework/yii/rbac/PhpManager.php
View file @
9b95a81b
...
...
@@ -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
)
{
...
...
framework/yii/widgets/Menu.php
View file @
9b95a81b
...
...
@@ -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
;
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment