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
c582e589
Commit
c582e589
authored
Aug 28, 2013
by
Carsten Brandt
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
added note about differing property types
parent
ca69ef09
Hide whitespace changes
Inline
Side-by-side
Showing
8 changed files
with
26 additions
and
14 deletions
+26
-14
PhpDocController.php
build/controllers/PhpDocController.php
+5
-1
MemCache.php
framework/yii/caching/MemCache.php
+3
-2
AssetController.php
framework/yii/console/controllers/AssetController.php
+2
-1
DataProvider.php
framework/yii/data/DataProvider.php
+7
-5
Command.php
framework/yii/db/Command.php
+3
-2
Target.php
framework/yii/log/Target.php
+2
-1
AssetManager.php
framework/yii/web/AssetManager.php
+2
-1
User.php
framework/yii/web/User.php
+2
-1
No files found.
build/controllers/PhpDocController.php
View file @
c582e589
...
@@ -253,8 +253,12 @@ class PhpDocController extends Controller
...
@@ -253,8 +253,12 @@ class PhpDocController extends Controller
foreach
(
$props
as
$propName
=>
&
$prop
)
{
foreach
(
$props
as
$propName
=>
&
$prop
)
{
$docline
=
' * @'
;
$docline
=
' * @'
;
$docline
.=
'property'
;
// Do not use property-read and property-write as few IDEs support complex syntax.
$docline
.=
'property'
;
// Do not use property-read and property-write as few IDEs support complex syntax.
$note
=
''
;
if
(
isset
(
$prop
[
'get'
])
&&
isset
(
$prop
[
'set'
]))
{
if
(
isset
(
$prop
[
'get'
])
&&
isset
(
$prop
[
'set'
]))
{
$note
=
''
;
if
(
$prop
[
'get'
][
'type'
]
!=
$prop
[
'set'
][
'type'
])
{
$note
=
' Note that the type of this property differs in getter and setter.'
.
' See [[get'
.
ucfirst
(
$propName
)
.
'()]] and [[set'
.
ucfirst
(
$propName
)
.
'()]] for details.'
;
}
}
elseif
(
isset
(
$prop
[
'get'
]))
{
}
elseif
(
isset
(
$prop
[
'get'
]))
{
$note
=
' This property is read-only.'
;
$note
=
' This property is read-only.'
;
// $docline .= '-read';
// $docline .= '-read';
...
...
framework/yii/caching/MemCache.php
View file @
c582e589
...
@@ -53,8 +53,9 @@ use yii\base\InvalidConfigException;
...
@@ -53,8 +53,9 @@ use yii\base\InvalidConfigException;
* each server, such as `persistent`, `weight`, `timeout`. Please see [[MemCacheServer]] for available options.
* each server, such as `persistent`, `weight`, `timeout`. Please see [[MemCacheServer]] for available options.
*
*
* @property \Memcache|\Memcached $memcache The memcache (or memcached) object used by this cache component.
* @property \Memcache|\Memcached $memcache The memcache (or memcached) object used by this cache component.
* @property array $servers List of memcache server configurations. Each element must be an array
* This property is read-only.
* with the following keys: host, port, persistent, weight, timeout, retryInterval, status.
* @property MemCacheServer[] $servers List of memcache server configurations. Note that the type of this
* property differs in getter and setter. See [[getServers()]] and [[setServers()]] for details.
*
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
* @since 2.0
...
...
framework/yii/console/controllers/AssetController.php
View file @
c582e589
...
@@ -28,7 +28,8 @@ use yii\console\Controller;
...
@@ -28,7 +28,8 @@ use yii\console\Controller;
* Note: by default this command relies on an external tools to perform actual files compression,
* Note: by default this command relies on an external tools to perform actual files compression,
* check [[jsCompressor]] and [[cssCompressor]] for more details.
* check [[jsCompressor]] and [[cssCompressor]] for more details.
*
*
* @property \yii\web\AssetManager $assetManager Asset manager instance.
* @property \yii\web\AssetManager $assetManager Asset manager instance. Note that the type of this property
* differs in getter and setter. See [[getAssetManager()]] and [[setAssetManager()]] for details.
*
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
* @since 2.0
...
...
framework/yii/data/DataProvider.php
View file @
c582e589
...
@@ -17,9 +17,11 @@ use yii\base\InvalidParamException;
...
@@ -17,9 +17,11 @@ use yii\base\InvalidParamException;
* It implements the [[getPagination()]] and [[getSort()]] methods as specified by the [[IDataProvider]] interface.
* It implements the [[getPagination()]] and [[getSort()]] methods as specified by the [[IDataProvider]] interface.
*
*
* @property integer $count The number of data models in the current page. This property is read-only.
* @property integer $count The number of data models in the current page. This property is read-only.
* @property Pagination $pagination The pagination object. If this is false, it means the pagination is
* @property Pagination|boolean $pagination The pagination object. If this is false, it means the pagination
* disabled.
* is disabled. Note that the type of this property differs in getter and setter. See [[getPagination()]] and
* @property Sort $sort The sorting object. If this is false, it means the sorting is disabled.
* [[setPagination()]] for details.
* @property Sort|boolean $sort The sorting object. If this is false, it means that sorting is disabled. Note
* that the type of this property differs in getter and setter. See [[getSort()]] and [[setSort()]] for details.
*
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
* @since 2.0
...
@@ -37,7 +39,7 @@ abstract class DataProvider extends Component implements IDataProvider
...
@@ -37,7 +39,7 @@ abstract class DataProvider extends Component implements IDataProvider
private
$_pagination
;
private
$_pagination
;
/**
/**
* @return Pagination the pagination object. If this is false, it means the pagination is disabled.
* @return Pagination
|boolean
the pagination object. If this is false, it means the pagination is disabled.
*/
*/
public
function
getPagination
()
public
function
getPagination
()
{
{
...
@@ -80,7 +82,7 @@ abstract class DataProvider extends Component implements IDataProvider
...
@@ -80,7 +82,7 @@ abstract class DataProvider extends Component implements IDataProvider
}
}
/**
/**
* @return Sort the sorting object. If this is false, it means the sorting is disabled.
* @return Sort
|boolean
the sorting object. If this is false, it means the sorting is disabled.
*/
*/
public
function
getSort
()
public
function
getSort
()
{
{
...
...
framework/yii/db/Command.php
View file @
c582e589
...
@@ -44,7 +44,8 @@ use yii\caching\Cache;
...
@@ -44,7 +44,8 @@ use yii\caching\Cache;
*
*
* To build SELECT SQL statements, please use [[QueryBuilder]] instead.
* To build SELECT SQL statements, please use [[QueryBuilder]] instead.
*
*
* @property string $rawSql The raw SQL. This property is read-only.
* @property string $rawSql The raw SQL with parameter values inserted into the corresponding placeholders in
* [[sql]]. This property is read-only.
* @property string $sql The SQL statement to be executed.
* @property string $sql The SQL statement to be executed.
*
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @author Qiang Xue <qiang.xue@gmail.com>
...
@@ -103,7 +104,7 @@ class Command extends \yii\base\Component
...
@@ -103,7 +104,7 @@ class Command extends \yii\base\Component
* Returns the raw SQL by inserting parameter values into the corresponding placeholders in [[sql]].
* Returns the raw SQL by inserting parameter values into the corresponding placeholders in [[sql]].
* Note that the return value of this method should mainly be used for logging purpose.
* Note that the return value of this method should mainly be used for logging purpose.
* It is likely that this method returns an invalid SQL due to improper replacement of parameter placeholders.
* It is likely that this method returns an invalid SQL due to improper replacement of parameter placeholders.
* @return string the raw SQL
* @return string the raw SQL
with parameter values inserted into the corresponding placeholders in [[sql]].
*/
*/
public
function
getRawSql
()
public
function
getRawSql
()
{
{
...
...
framework/yii/log/Target.php
View file @
c582e589
...
@@ -23,7 +23,8 @@ use yii\base\InvalidConfigException;
...
@@ -23,7 +23,8 @@ use yii\base\InvalidConfigException;
* may specify [[except]] to exclude messages of certain categories.
* may specify [[except]] to exclude messages of certain categories.
*
*
* @property integer $levels The message levels that this target is interested in. This is a bitmap of level
* @property integer $levels The message levels that this target is interested in. This is a bitmap of level
* values. Defaults to 0, meaning all available levels.
* values. Defaults to 0, meaning all available levels. Note that the type of this property differs in getter
* and setter. See [[getLevels()]] and [[setLevels()]] for details.
*
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
* @since 2.0
...
...
framework/yii/web/AssetManager.php
View file @
c582e589
...
@@ -16,7 +16,8 @@ use yii\helpers\FileHelper;
...
@@ -16,7 +16,8 @@ use yii\helpers\FileHelper;
/**
/**
* AssetManager manages asset bundles and asset publishing.
* AssetManager manages asset bundles and asset publishing.
*
*
* @property IAssetConverter $converter The asset converter.
* @property IAssetConverter $converter The asset converter. Note that the type of this property differs in
* getter and setter. See [[getConverter()]] and [[setConverter()]] for details.
*
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
* @since 2.0
...
...
framework/yii/web/User.php
View file @
c582e589
...
@@ -25,7 +25,8 @@ use yii\base\InvalidConfigException;
...
@@ -25,7 +25,8 @@ use yii\base\InvalidConfigException;
* @property Identity $identity The identity object associated with the currently logged user. Null is
* @property Identity $identity The identity object associated with the currently logged user. Null is
* returned if the user is not logged in (not authenticated).
* returned if the user is not logged in (not authenticated).
* @property boolean $isGuest Whether the current user is a guest. This property is read-only.
* @property boolean $isGuest Whether the current user is a guest. This property is read-only.
* @property string $returnUrl The URL that the user should be redirected to after login.
* @property string $returnUrl The URL that the user should be redirected to after login. Note that the type
* of this property differs in getter and setter. See [[getReturnUrl()]] and [[setReturnUrl()]] for details.
*
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
* @since 2.0
...
...
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