Browse Source

phpdoc fixes

tags/2.0.7
Carsten Brandt 9 years ago
parent
commit
f620f4de90
  1. 1
      framework/base/Security.php
  2. 1
      framework/caching/ApcCache.php
  3. 4
      framework/console/controllers/ServeController.php
  4. 1
      framework/db/Connection.php
  5. 5
      framework/helpers/BaseInflector.php
  6. 1
      framework/helpers/BaseJson.php
  7. 1
      framework/helpers/BaseVarDumper.php
  8. 4
      framework/validators/FileValidator.php
  9. 9
      framework/validators/IpValidator.php
  10. 1
      framework/web/ErrorHandler.php
  11. 8
      framework/web/UnprocessableEntityHttpException.php
  12. 7
      framework/web/UrlRule.php
  13. 2
      framework/widgets/Pjax.php

1
framework/base/Security.php

@ -89,6 +89,7 @@ class Security extends Component
*/
public $passwordHashCost = 13;
/**
* Encrypts data using a password.
* Derives keys for encryption and authentication from the password using PBKDF2 and a random salt,

1
framework/caching/ApcCache.php

@ -32,6 +32,7 @@ class ApcCache extends Cache
*/
public $useApcu = false;
/**
* Initializes this application component.
* It checks if extension required is loaded.

4
framework/console/controllers/ServeController.php

@ -31,12 +31,10 @@ class ServeController extends Controller
* @var int port to serve on.
*/
public $port = 8080;
/**
* @var string path or path alias to directory to serve
*/
public $docroot = '@app/web';
/**
* @var string path to router script.
* See https://secure.php.net/manual/en/features.commandline.webserver.php
@ -47,7 +45,7 @@ class ServeController extends Controller
/**
* Runs PHP built-in web server
*
* @param string $address address to serve on. Either "host" or "host:port".
* @param string $address address to serve on. Either "host" or "host:port".
*
* @return int
*/

1
framework/db/Connection.php

@ -362,6 +362,7 @@ class Connection extends Component
* ```
*/
public $masterConfig = [];
/**
* @var Transaction the currently active transaction
*/

5
framework/helpers/BaseInflector.php

@ -231,7 +231,6 @@ class BaseInflector
'ø' => 'o', 'ù' => 'u', 'ú' => 'u', 'û' => 'u', 'ü' => 'u', 'ű' => 'u', 'ý' => 'y', 'þ' => 'th',
'ÿ' => 'y',
];
/**
* Shortcut for `Any-Latin; NFKD` transliteration rule. The rule is strict, letters will be transliterated with
* the closest sound-representation chars. The result may contain any UTF-8 chars. For example:
@ -245,7 +244,6 @@ class BaseInflector
* @since 2.0.7
*/
const TRANSLITERATE_STRICT = 'Any-Latin; NFKD';
/**
* Shortcut for `Any-Latin; Latin-ASCII` transliteration rule. The rule is medium, letters will be
* transliterated to characters of Latin-1 (ISO 8859-1) ASCII table. For example:
@ -259,7 +257,6 @@ class BaseInflector
* @since 2.0.7
*/
const TRANSLITERATE_MEDIUM = 'Any-Latin; Latin-ASCII';
/**
* Shortcut for `Any-Latin; Latin-ASCII; [\u0080-\uffff] remove` transliteration rule. The rule is loose,
* letters will be transliterated with the characters of Basic Latin Unicode Block.
@ -275,7 +272,6 @@ class BaseInflector
*/
const TRANSLITERATE_LOOSE = 'Any-Latin; Latin-ASCII; [\u0080-\uffff] remove';
/**
* @var mixed Either a [[\Transliterator]], or a string from which a [[\Transliterator]] can be built
* for transliteration. Used by [[transliterate()]] when intl is available. Defaults to [[TRANSLITERATE_LOOSE]]
@ -283,6 +279,7 @@ class BaseInflector
*/
public static $transliterator = self::TRANSLITERATE_LOOSE;
/**
* Converts a word to its plural form.
* Note that this is for English only!

1
framework/helpers/BaseJson.php

@ -37,6 +37,7 @@ class BaseJson
'JSON_ERROR_UNSUPPORTED_TYPE' => 'A value of a type that cannot be encoded was given', // PHP 5.5.0
];
/**
* Encodes the given value into a JSON string.
* The method enhances `json_encode()` by supporting JavaScript expressions.

1
framework/helpers/BaseVarDumper.php

@ -6,6 +6,7 @@
*/
namespace yii\helpers;
use yii\base\Arrayable;
use yii\base\InvalidValueException;

4
framework/validators/FileValidator.php

@ -92,7 +92,7 @@ class FileValidator extends Validator
* - {file}: the uploaded file name
* - {limit}: the maximum size allowed (see [[getSizeLimit()]])
* - {formattedLimit}: the maximum size formatted
* with [[\yii\i18n\Formatter::asShortSize()|Formatter::asShortSize()]]
* with [[\yii\i18n\Formatter::asShortSize()|Formatter::asShortSize()]]
*/
public $tooBig;
/**
@ -103,7 +103,7 @@ class FileValidator extends Validator
* - {file}: the uploaded file name
* - {limit}: the value of [[minSize]]
* - {formattedLimit}: the value of [[minSize]] formatted
* with [[\yii\i18n\Formatter::asShortSize()|Formatter::asShortSize()]
* with [[\yii\i18n\Formatter::asShortSize()|Formatter::asShortSize()]
*/
public $tooSmall;
/**

9
framework/validators/IpValidator.php

@ -45,7 +45,7 @@ class IpValidator extends Validator
* @var array The network aliases, that can be used in [[ranges]].
* - key - alias name
* - value - array of strings. String can be an IP range, IP address or another alias. String can be
* negated with [[NEGATION_CHAR]] (independent of `negation` option).
* negated with [[NEGATION_CHAR]] (independent of `negation` option).
*
* The following aliases are defined by default:
* - `*`: `any`
@ -90,7 +90,7 @@ class IpValidator extends Validator
* address without it. Works only when `subnet` is not `false`. For example:
* - `10.0.1.5` will normalized to `10.0.1.5/32`
* - `2008:db0::1` will be normalized to `2008:db0::1/128`
* Defaults to `false`.
* Defaults to `false`.
* @see subnet
*/
public $normalize = false;
@ -153,7 +153,6 @@ class IpValidator extends Validator
* - `{value}`: the value of the attribute being validated
*/
public $wrongIp;
/**
* @var string user-defined error message is used when validation fails due to subnet [[subnet]] set to 'only',
* but the CIDR prefix is not set.
@ -315,8 +314,8 @@ class IpValidator extends Validator
*
* @param $ip string
* @return string|array
* string - the validation was successful;
* array - an error occurred during the validation.
* string - the validation was successful;
* array - an error occurred during the validation.
* Array[0] contains the text of an error, array[1] contains values for the placeholders in the error message
*/
private function validateSubnet($ip)

1
framework/web/ErrorHandler.php

@ -68,6 +68,7 @@ class ErrorHandler extends \yii\base\ErrorHandler
*/
public $displayVars = ['_GET', '_POST', '_FILES', '_COOKIE', '_SESSION'];
/**
* Renders the exception.
* @param \Exception $exception the exception to be rendered.

8
framework/web/UnprocessableEntityHttpException.php

@ -8,13 +8,13 @@
namespace yii\web;
/**
* UnprocessableEntityHttpException represents an "Unprocessable Entity" HTTP
* UnprocessableEntityHttpException represents an "Unprocessable Entity" HTTP
* exception with status code 422.
*
* Use this exception to inform that the server understands the content type of
* the request entity and the syntax of that request entity is correct but the server
* was unable to process the contained instructions. For example, to return form
* validation errors.
* the request entity and the syntax of that request entity is correct but the server
* was unable to process the contained instructions. For example, to return form
* validation errors.
*
* @link http://www.webdav.org/specs/rfc2518.html#STATUS_422
* @author Jan Silva <janfrs3@gmail.com>

7
framework/web/UrlRule.php

@ -89,18 +89,19 @@ class UrlRule extends Object implements UrlRuleInterface
* @var boolean a value indicating if parameters should be url encoded.
*/
public $encodeParams = true;
/**
* @var array list of placeholders for matching parameters names. Used in [[parseRequest()]], [[createUrl()]]
* @var array list of placeholders for matching parameters names. Used in [[parseRequest()]], [[createUrl()]].
* On the rule initialization, the [[pattern]] parameters names will be replaced with placeholders.
* This array contains relations between the original parameters names and their placeholders.
* key - placeholder
* value - original name
* The array keys are the placeholders and the values are the original names.
*
* @see parseRequest()
* @see createUrl()
* @since 2.0.7
*/
protected $placeholders = [];
/**
* @var string the template for generating a new URL. This is derived from [[pattern]] and is used in generating URL.
*/

2
framework/widgets/Pjax.php

@ -48,6 +48,7 @@ class Pjax extends Widget
* @var array the HTML attributes for the widget container tag. The following special options are recognized:
*
* - `tag`: string, the tag name for the container. Defaults to `div`
* This option is available since version 2.0.7.
*
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
*/
@ -91,6 +92,7 @@ class Pjax extends Widget
*/
public $clientOptions;
/**
* @inheritdoc
*/

Loading…
Cancel
Save