Browse Source

missing `@since` annotations in helpers

tags/2.0.7
Carsten Brandt 9 years ago
parent
commit
ef5ce2d4c1
  1. 2
      framework/helpers/BaseArrayHelper.php
  2. 8
      framework/helpers/BaseHtml.php
  3. 4
      framework/helpers/BaseInflector.php

2
framework/helpers/BaseArrayHelper.php

@ -598,6 +598,7 @@ class BaseArrayHelper
* @return boolean `true` if `$needle` was found in `$haystack`, `false` otherwise. * @return boolean `true` if `$needle` was found in `$haystack`, `false` otherwise.
* @throws \InvalidArgumentException if `$haystack` is neither traversable nor an array. * @throws \InvalidArgumentException if `$haystack` is neither traversable nor an array.
* @see http://php.net/manual/en/function.in-array.php * @see http://php.net/manual/en/function.in-array.php
* @since 2.0.7
*/ */
public static function isIn($needle, $haystack, $strict = false) public static function isIn($needle, $haystack, $strict = false)
{ {
@ -626,6 +627,7 @@ class BaseArrayHelper
* @param boolean $strict Whether to enable strict (`===`) comparison. * @param boolean $strict Whether to enable strict (`===`) comparison.
* @throws \InvalidArgumentException if `$haystack` or `$needles` is neither traversable nor an array. * @throws \InvalidArgumentException if `$haystack` or `$needles` is neither traversable nor an array.
* @return boolean `true` if `$needles` is a subset of `$haystack`, `false` otherwise. * @return boolean `true` if `$needles` is a subset of `$haystack`, `false` otherwise.
* @since 2.0.7
*/ */
public static function isSubset($needles, $haystack, $strict = false) public static function isSubset($needles, $haystack, $strict = false)
{ {

8
framework/helpers/BaseHtml.php

@ -300,8 +300,11 @@ class BaseHtml
* the attributes of the resulting tag. The values will be HTML-encoded using [[encode()]]. * 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. * If a value is null, the corresponding attribute will not be rendered.
* See [[renderTagAttributes()]] for details on how attributes are being rendered. * See [[renderTagAttributes()]] for details on how attributes are being rendered.
*
* Special options: * Special options:
* - `csrf`: whether to generate the CSRF hidden input. When is not defined, defaults to true. *
* - `csrf`: whether to generate the CSRF hidden input. Defaults to true.
*
* @return string the generated form start tag. * @return string the generated form start tag.
* @see endForm() * @see endForm()
*/ */
@ -1001,7 +1004,8 @@ class BaseHtml
* *
* - encode: boolean, whether to HTML-encode the items. Defaults to true. * - encode: boolean, whether to HTML-encode the items. Defaults to true.
* This option is ignored if the `item` option is specified. * This option is ignored if the `item` option is specified.
* - separator: string, since 2.0.7 the HTML code that separates items. * - separator: string, the HTML code that separates items. Defaults to a simple newline (`"\n"`).
* This option is available since version 2.0.7.
* - itemOptions: array, the HTML attributes for the `li` tags. This option is ignored if the `item` option is specified. * - itemOptions: array, the HTML attributes for the `li` tags. This option is ignored if the `item` option is specified.
* - item: callable, a callback that is used to generate each individual list item. * - item: callable, a callback that is used to generate each individual list item.
* The signature of this callback must be: * The signature of this callback must be:

4
framework/helpers/BaseInflector.php

@ -242,6 +242,7 @@ class BaseInflector
* For detailed information see [unicode normalization forms](http://unicode.org/reports/tr15/#Normalization_Forms_Table) * For detailed information see [unicode normalization forms](http://unicode.org/reports/tr15/#Normalization_Forms_Table)
* @see http://unicode.org/reports/tr15/#Normalization_Forms_Table * @see http://unicode.org/reports/tr15/#Normalization_Forms_Table
* @see transliterate() * @see transliterate()
* @since 2.0.7
*/ */
const TRANSLITERATE_STRICT = 'Any-Latin; NFKD'; const TRANSLITERATE_STRICT = 'Any-Latin; NFKD';
@ -255,6 +256,7 @@ class BaseInflector
* For detailed information see [unicode normalization forms](http://unicode.org/reports/tr15/#Normalization_Forms_Table) * For detailed information see [unicode normalization forms](http://unicode.org/reports/tr15/#Normalization_Forms_Table)
* @see http://unicode.org/reports/tr15/#Normalization_Forms_Table * @see http://unicode.org/reports/tr15/#Normalization_Forms_Table
* @see transliterate() * @see transliterate()
* @since 2.0.7
*/ */
const TRANSLITERATE_MEDIUM = 'Any-Latin; Latin-ASCII'; const TRANSLITERATE_MEDIUM = 'Any-Latin; Latin-ASCII';
@ -269,6 +271,7 @@ class BaseInflector
* For detailed information see [unicode normalization forms](http://unicode.org/reports/tr15/#Normalization_Forms_Table) * For detailed information see [unicode normalization forms](http://unicode.org/reports/tr15/#Normalization_Forms_Table)
* @see http://unicode.org/reports/tr15/#Normalization_Forms_Table * @see http://unicode.org/reports/tr15/#Normalization_Forms_Table
* @see transliterate() * @see transliterate()
* @since 2.0.7
*/ */
const TRANSLITERATE_LOOSE = 'Any-Latin; Latin-ASCII; [\u0080-\uffff] remove'; const TRANSLITERATE_LOOSE = 'Any-Latin; Latin-ASCII; [\u0080-\uffff] remove';
@ -482,6 +485,7 @@ class BaseInflector
* @param string|\Transliterator $transliterator either a [[Transliterator]] or a string * @param string|\Transliterator $transliterator either a [[Transliterator]] or a string
* from which a [[Transliterator]] can be built. * from which a [[Transliterator]] can be built.
* @return string * @return string
* @since 2.0.7 this method is public.
*/ */
public static function transliterate($string, $transliterator = null) public static function transliterate($string, $transliterator = null)
{ {

Loading…
Cancel
Save