php/yii2
1
0
Fork 0
mirror of https://github.com/yiisoft/yii2.git synced 2025-11-03 05:48:11 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fixes #12055: Changed boolean to bool and integer to int in phpdoc

Browse Source
This commit is contained in:
Robert Korulczyk
2016-11-07 00:51:39 +01:00
committed by Alexander Makarov
parent 940f7c7cd4
commit 4aa935e69e
292 changed files with 1670 additions and 1670 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
framework/widgets/ActiveField.php
View File

@ -97,33 +97,33 @@ class ActiveField extends Component
*/
public $hintOptions = ['class' => 'hint-block'];
/**
* @var boolean whether to enable client-side data validation.
* @var bool whether to enable client-side data validation.
* If not set, it will take the value of [[ActiveForm::enableClientValidation]].
*/
public $enableClientValidation;
/**
* @var boolean whether to enable AJAX-based data validation.
* @var bool whether to enable AJAX-based data validation.
* If not set, it will take the value of [[ActiveForm::enableAjaxValidation]].
*/
public $enableAjaxValidation;
/**
* @var boolean whether to perform validation when the value of the input field is changed.
* @var bool whether to perform validation when the value of the input field is changed.
* If not set, it will take the value of [[ActiveForm::validateOnChange]].
*/
public $validateOnChange;
/**
* @var boolean whether to perform validation when the input field loses focus.
* @var bool whether to perform validation when the input field loses focus.
* If not set, it will take the value of [[ActiveForm::validateOnBlur]].
*/
public $validateOnBlur;
/**
* @var boolean whether to perform validation while the user is typing in the input field.
* @var bool whether to perform validation while the user is typing in the input field.
* If not set, it will take the value of [[ActiveForm::validateOnType]].
* @see validationDelay
*/
public $validateOnType;
/**
* @var integer number of milliseconds that the validation should be delayed when the user types in the field
* @var int number of milliseconds that the validation should be delayed when the user types in the field
* and [[validateOnType]] is set `true`.
* If not set, it will take the value of [[ActiveForm::validationDelay]].
*/
@ -373,7 +373,7 @@ class ActiveField extends Component
*
* The following special options are recognized:
*
* - `maxlength`: integer|boolean, when `maxlength` is set `true` and the model attribute is validated
* - `maxlength`: int|bool, when `maxlength` is set `true` and the model attribute is validated
* by a string validator, the `maxlength` option will take the value of [[\yii\validators\StringValidator::max]].
* This is available since version 2.0.3.
*
@ -501,7 +501,7 @@ class ActiveField extends Component
*
* If you set a custom `id` for the input element, you may need to adjust the [[$selectors]] accordingly.
*
* @param boolean $enclosedByLabel whether to enclose the radio within the label.
* @param bool $enclosedByLabel whether to enclose the radio within the label.
* If `true`, the method will still use [[template]] to layout the radio button and the error message
* except that the radio is enclosed by the label tag.
* @return $this the field object itself.
@ -547,7 +547,7 @@ class ActiveField extends Component
*
* If you set a custom `id` for the input element, you may need to adjust the [[$selectors]] accordingly.
*
* @param boolean $enclosedByLabel whether to enclose the checkbox within the label.
* @param bool $enclosedByLabel whether to enclose the checkbox within the label.
* If `true`, the method will still use [[template]] to layout the checkbox and the error message
* except that the checkbox is enclosed by the label tag.
* @return $this the field object itself.

20
framework/widgets/ActiveForm.php
View File

@ -72,7 +72,7 @@ class ActiveForm extends Widget
*/
public $fieldConfig = [];
/**
* @var boolean whether to perform encoding on the error summary.
* @var bool whether to perform encoding on the error summary.
*/
public $encodeErrorSummary = true;
/**
@ -97,17 +97,17 @@ class ActiveForm extends Widget
*/
public $validatingCssClass = 'validating';
/**
* @var boolean whether to enable client-side data validation.
* @var bool whether to enable client-side data validation.
* If [[ActiveField::enableClientValidation]] is set, its value will take precedence for that input field.
*/
public $enableClientValidation = true;
/**
* @var boolean whether to enable AJAX-based data validation.
* @var bool whether to enable AJAX-based data validation.
* If [[ActiveField::enableAjaxValidation]] is set, its value will take precedence for that input field.
*/
public $enableAjaxValidation = false;
/**
* @var boolean whether to hook up `yii.activeForm` JavaScript plugin.
* @var bool whether to hook up `yii.activeForm` JavaScript plugin.
* This property must be set `true` if you want to support client validation and/or AJAX validation, or if you
* want to take advantage of the `yii.activeForm` plugin. When this is `false`, the form will not generate
* any JavaScript.
@ -120,27 +120,27 @@ class ActiveForm extends Widget
*/
public $validationUrl;
/**
* @var boolean whether to perform validation when the form is submitted.
* @var bool whether to perform validation when the form is submitted.
*/
public $validateOnSubmit = true;
/**
* @var boolean whether to perform validation when the value of an input field is changed.
* @var bool whether to perform validation when the value of an input field is changed.
* If [[ActiveField::validateOnChange]] is set, its value will take precedence for that input field.
*/
public $validateOnChange = true;
/**
* @var boolean whether to perform validation when an input field loses focus.
* @var bool whether to perform validation when an input field loses focus.
* If [[ActiveField::$validateOnBlur]] is set, its value will take precedence for that input field.
*/
public $validateOnBlur = true;
/**
* @var boolean whether to perform validation while the user is typing in an input field.
* @var bool whether to perform validation while the user is typing in an input field.
* If [[ActiveField::validateOnType]] is set, its value will take precedence for that input field.
* @see validationDelay
*/
public $validateOnType = false;
/**
* @var integer number of milliseconds that the validation should be delayed when the user types in the field
* @var int number of milliseconds that the validation should be delayed when the user types in the field
* and [[validateOnType]] is set `true`.
* If [[ActiveField::validationDelay]] is set, its value will take precedence for that input field.
*/
@ -154,7 +154,7 @@ class ActiveForm extends Widget
*/
public $ajaxDataType = 'json';
/**
* @var boolean whether to scroll to the first error after validation.
* @var bool whether to scroll to the first error after validation.
* @since 2.0.6
*/
public $scrollToError = true;

4
framework/widgets/BaseListView.php
View File

@ -71,7 +71,7 @@ abstract class BaseListView extends Widget
*/
public $summaryOptions = ['class' => 'summary'];
/**
* @var boolean whether to show the list view if [[dataProvider]] returns no data.
* @var bool whether to show the list view if [[dataProvider]] returns no data.
*/
public $showOnEmpty = false;
/**
@ -142,7 +142,7 @@ abstract class BaseListView extends Widget
* Renders a section of the specified name.
* If the named section is not supported, false will be returned.
* @param string $name the section name, e.g., `{summary}`, `{items}`.
* @return string|boolean the rendering result of the section, or false if the named section is not supported.
* @return string|bool the rendering result of the section, or false if the named section is not supported.
*/
public function renderSection($name)
{

2
framework/widgets/Block.php
View File

@ -39,7 +39,7 @@ use yii\base\Widget;
class Block extends Widget
{
/**
* @var boolean whether to render the block content in place. Defaults to false,
* @var bool whether to render the block content in place. Defaults to false,
* meaning the captured block content will not be displayed.
*/
public $renderInPlace = false;

2
framework/widgets/Breadcrumbs.php
View File

@ -64,7 +64,7 @@ class Breadcrumbs extends Widget
*/
public $options = ['class' => 'breadcrumb'];
/**
* @var boolean whether to HTML-encode the link labels.
* @var bool whether to HTML-encode the link labels.
*/
public $encodeLabels = true;
/**

2
framework/widgets/DetailView.php
View File

@ -157,7 +157,7 @@ class DetailView extends Widget
/**
* Renders a single attribute.
* @param array $attribute the specification of the attribute to be rendered.
* @param integer $index the zero-based index of the attribute in the [[attributes]] array
* @param int $index the zero-based index of the attribute in the [[attributes]] array
* @return string the rendering result
*/
protected function renderAttribute($attribute, $index)

6
framework/widgets/FragmentCache.php
View File

@ -32,7 +32,7 @@ class FragmentCache extends Widget
*/
public $cache = 'cache';
/**
* @var integer number of seconds that the data can remain valid in cache.
* @var int number of seconds that the data can remain valid in cache.
* Use 0 to indicate that the cached data will never expire.
*/
public $duration = 60;
@ -66,7 +66,7 @@ class FragmentCache extends Widget
*/
public $variations;
/**
* @var boolean whether to enable the fragment cache. You may use this property to turn on and off
* @var bool whether to enable the fragment cache. You may use this property to turn on and off
* the fragment cache according to specific setting (e.g. enable fragment cache only for GET requests).
*/
public $enabled = true;
@ -124,7 +124,7 @@ class FragmentCache extends Widget
}
/**
* @var string|boolean the cached content. False if the content is not cached.
* @var string|bool the cached content. False if the content is not cached.
*/
private $_content;

2
framework/widgets/InputWidget.php
View File

@ -75,7 +75,7 @@ class InputWidget extends Widget
}
/**
* @return boolean whether this widget is associated with a data model.
* @return bool whether this widget is associated with a data model.
*/
protected function hasModel()
{

20
framework/widgets/LinkPager.php
View File

@ -75,40 +75,40 @@ class LinkPager extends Widget
*/
public $disabledPageCssClass = 'disabled';
/**
* @var integer maximum number of page buttons that can be displayed. Defaults to 10.
* @var int maximum number of page buttons that can be displayed. Defaults to 10.
*/
public $maxButtonCount = 10;
/**
* @var string|boolean the label for the "next" page button. Note that this will NOT be HTML-encoded.
* @var string|bool the label for the "next" page button. Note that this will NOT be HTML-encoded.
* If this property is false, the "next" page button will not be displayed.
*/
public $nextPageLabel = '»';
/**
* @var string|boolean the text label for the previous page button. Note that this will NOT be HTML-encoded.
* @var string|bool the text label for the previous page button. Note that this will NOT be HTML-encoded.
* If this property is false, the "previous" page button will not be displayed.
*/
public $prevPageLabel = '«';
/**
* @var string|boolean the text label for the "first" page button. Note that this will NOT be HTML-encoded.
* @var string|bool the text label for the "first" page button. Note that this will NOT be HTML-encoded.
* If it's specified as true, page number will be used as label.
* Default is false that means the "first" page button will not be displayed.
*/
public $firstPageLabel = false;
/**
* @var string|boolean the text label for the "last" page button. Note that this will NOT be HTML-encoded.
* @var string|bool the text label for the "last" page button. Note that this will NOT be HTML-encoded.
* If it's specified as true, page number will be used as label.
* Default is false that means the "last" page button will not be displayed.
*/
public $lastPageLabel = false;
/**
* @var boolean whether to register link tags in the HTML header for prev, next, first and last page.
* @var bool whether to register link tags in the HTML header for prev, next, first and last page.
* Defaults to `false` to avoid conflicts when multiple pagers are used on one page.
* @see http://www.w3.org/TR/html401/struct/links.html#h-12.1.2
* @see registerLinkTags()
*/
public $registerLinkTags = false;
/**
* @var boolean Hide widget when only one page exist.
* @var bool Hide widget when only one page exist.
*/
public $hideOnSinglePage = true;
@ -203,10 +203,10 @@ class LinkPager extends Widget
* Renders a page button.
* You may override this method to customize the generation of page buttons.
* @param string $label the text label for the button
* @param integer $page the page number
* @param int $page the page number
* @param string $class the CSS class for the page button.
* @param boolean $disabled whether this page button is disabled
* @param boolean $active whether this page button is active
* @param bool $disabled whether this page button is disabled
* @param bool $active whether this page button is active
* @return string the rendering result
*/
protected function renderPageButton($label, $page, $class, $disabled, $active)

2
framework/widgets/ListView.php
View File

@ -86,7 +86,7 @@ class ListView extends BaseListView
* Renders a single data model.
* @param mixed $model the data model to be rendered
* @param mixed $key the key value associated with the data model
* @param integer $index the zero-based index of the data model in the model array returned by [[dataProvider]].
* @param int $index the zero-based index of the data model in the model array returned by [[dataProvider]].
* @return string the rendering result
*/
public function renderItem($model, $key, $index)

12
framework/widgets/Menu.php
View File

@ -105,7 +105,7 @@ class Menu extends Widget
*/
public $submenuTemplate = "\n<ul>\n{items}\n</ul>\n";
/**
* @var boolean whether the labels for menu items should be HTML-encoded.
* @var bool whether the labels for menu items should be HTML-encoded.
*/
public $encodeLabels = true;
/**
@ -113,18 +113,18 @@ class Menu extends Widget
*/
public $activeCssClass = 'active';
/**
* @var boolean whether to automatically activate items according to whether their route setting
* @var bool whether to automatically activate items according to whether their route setting
* matches the currently requested route.
* @see isItemActive()
*/
public $activateItems = true;
/**
* @var boolean whether to activate parent menu items when one of the corresponding child menu items is active.
* @var bool whether to activate parent menu items when one of the corresponding child menu items is active.
* The activated parent menu items will also have its CSS classes appended with [[activeCssClass]].
*/
public $activateParents = false;
/**
* @var boolean whether to hide empty menu items. An empty menu item is one whose `url` option is not
* @var bool whether to hide empty menu items. An empty menu item is one whose `url` option is not
* set and which has no visible child menu items.
*/
public $hideEmptyItems = true;
@ -253,7 +253,7 @@ class Menu extends Widget
/**
* Normalizes the [[items]] property to remove invisible items and activate certain items.
* @param array $items the items to be normalized.
* @param boolean $active whether there is an active child menu item.
* @param bool $active whether there is an active child menu item.
* @return array the normalized menu items
*/
protected function normalizeItems($items, &$active)
@ -301,7 +301,7 @@ class Menu extends Widget
* Only when its route and parameters match [[route]] and [[params]], respectively, will a menu item
* be considered active.
* @param array $item the menu item to be checked
* @return boolean whether the menu item is active
* @return bool whether the menu item is active
*/
protected function isItemActive($item)
{

10
framework/widgets/Pjax.php
View File

@ -74,21 +74,21 @@ class Pjax extends Widget
*/
public $submitEvent = 'submit';
/**
* @var boolean whether to enable push state.
* @var bool whether to enable push state.
*/
public $enablePushState = true;
/**
* @var boolean whether to enable replace state.
* @var bool whether to enable replace state.
*/
public $enableReplaceState = false;
/**
* @var integer pjax timeout setting (in milliseconds). This timeout is used when making AJAX requests.
* @var int pjax timeout setting (in milliseconds). This timeout is used when making AJAX requests.
* Use a bigger number if your server is slow. If the server does not respond within the timeout,
* a full page load will be triggered.
*/
public $timeout = 1000;
/**
* @var boolean|integer how to scroll the page when pjax response is received. If false, no page scroll will be made.
* @var bool|int how to scroll the page when pjax response is received. If false, no page scroll will be made.
* Use a number if you want to scroll to a particular place.
*/
public $scrollTo = false;
@ -168,7 +168,7 @@ class Pjax extends Widget
}
/**
* @return boolean whether the current request requires pjax response from this widget
* @return bool whether the current request requires pjax response from this widget
*/
protected function requiresPjax()
{