php/yii2
1
0
Fork 0
mirror of https://github.com/yiisoft/yii2.git synced 2025-08-14 14:28:27 +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

30
framework/helpers/BaseStringHelper.php
View File

@ -24,7 +24,7 @@ class BaseStringHelper
* Returns the number of bytes in the given string.
* This method ensures the string is treated as a byte array by using `mb_strlen()`.
* @param string $string the string being measured for length
* @return integer the number of bytes in the given string.
* @return int the number of bytes in the given string.
*/
public static function byteLength($string)
{
@ -35,8 +35,8 @@ class BaseStringHelper
* Returns the portion of string specified by the start and length parameters.
* This method ensures the string is treated as a byte array by using `mb_substr()`.
* @param string $string the input string. Must be one character or longer.
* @param integer $start the starting position
* @param integer $length the desired portion length. If not specified or `null`, there will be
* @param int $start the starting position
* @param int $length the desired portion length. If not specified or `null`, there will be
* no limit on length i.e. the output will be until the end of the string.
* @return string the extracted part of string, or FALSE on failure or an empty string.
* @see http://www.php.net/manual/en/function.substr.php
@ -95,10 +95,10 @@ class BaseStringHelper
* Truncates a string to the number of characters specified.
*
* @param string $string The string to truncate.
* @param integer $length How many characters from original string to include into truncated string.
* @param int $length How many characters from original string to include into truncated string.
* @param string $suffix String to append to the end of truncated string.
* @param string $encoding The charset to use, defaults to charset currently used by application.
* @param boolean $asHtml Whether to treat the string being truncated as HTML and preserve proper HTML tags.
* @param bool $asHtml Whether to treat the string being truncated as HTML and preserve proper HTML tags.
* This parameter is available since version 2.0.1.
* @return string the truncated string.
*/
@ -119,9 +119,9 @@ class BaseStringHelper
* Truncates a string to the number of words specified.
*
* @param string $string The string to truncate.
* @param integer $count How many words from original string to include into truncated string.
* @param int $count How many words from original string to include into truncated string.
* @param string $suffix String to append to the end of truncated string.
* @param boolean $asHtml Whether to treat the string being truncated as HTML and preserve proper HTML tags.
* @param bool $asHtml Whether to treat the string being truncated as HTML and preserve proper HTML tags.
* This parameter is available since version 2.0.1.
* @return string the truncated string.
*/
@ -143,9 +143,9 @@ class BaseStringHelper
* Truncate a string while preserving the HTML.
*
* @param string $string The string to truncate
* @param integer $count
* @param int $count
* @param string $suffix String to append to the end of the truncated string.
* @param string|boolean $encoding
* @param string|bool $encoding
* @return string
* @since 2.0.1
*/
@ -194,8 +194,8 @@ class BaseStringHelper
*
* @param string $string Input string
* @param string $with Part to search inside the $string
* @param boolean $caseSensitive Case sensitive search. Default is true. When case sensitive is enabled, $with must exactly match the starting of the string in order to get a true value.
* @return boolean Returns true if first input starts with second input, false otherwise
* @param bool $caseSensitive Case sensitive search. Default is true. When case sensitive is enabled, $with must exactly match the starting of the string in order to get a true value.
* @return bool Returns true if first input starts with second input, false otherwise
*/
public static function startsWith($string, $with, $caseSensitive = true)
{
@ -215,8 +215,8 @@ class BaseStringHelper
*
* @param string $string Input string to check
* @param string $with Part to search inside of the $string.
* @param boolean $caseSensitive Case sensitive search. Default is true. When case sensitive is enabled, $with must exactly match the ending of the string in order to get a true value.
* @return boolean Returns true if first input ends with second input, false otherwise
* @param bool $caseSensitive Case sensitive search. Default is true. When case sensitive is enabled, $with must exactly match the ending of the string in order to get a true value.
* @return bool Returns true if first input ends with second input, false otherwise
*/
public static function endsWith($string, $with, $caseSensitive = true)
{
@ -243,7 +243,7 @@ class BaseStringHelper
* - boolean - to trim normally;
* - string - custom characters to trim. Will be passed as a second argument to `trim()` function.
* - callable - will be called for each value instead of trim. Takes the only argument - value.
* @param boolean $skipEmpty Whether to skip empty strings between delimiters. Default is false.
* @param bool $skipEmpty Whether to skip empty strings between delimiters. Default is false.
* @return array
* @since 2.0.4
*/
@ -274,7 +274,7 @@ class BaseStringHelper
* @since 2.0.8
*
* @param string $string
* @return integer
* @return int
*/
public static function countWords($string)
{