@@ -11,7 +11,7 @@ |
||
| 11 | 11 | |
| 12 | 12 | /** |
| 13 | 13 | * Represent the given form in a tabular style |
| 14 | - * @param form The form to decorate. |
|
| 14 | + * @param form Form form to decorate. |
|
| 15 | 15 | */ |
| 16 | 16 | public function __construct(Form $form) { |
| 17 | 17 | $this->form = $form; |
@@ -176,6 +176,7 @@ |
||
| 176 | 176 | * Add {@link RequiredField} objects together |
| 177 | 177 | * |
| 178 | 178 | * @param RequiredFields |
| 179 | + * @param RequiredFields $requiredFields |
|
| 179 | 180 | * |
| 180 | 181 | * @return RequiredFields |
| 181 | 182 | */ |
@@ -134,7 +134,7 @@ |
||
| 134 | 134 | |
| 135 | 135 | /** |
| 136 | 136 | * @param String $value Form field identifier |
| 137 | - * @param FormField $field Contents of the option |
|
| 137 | + * @param FormField $fields Contents of the option |
|
| 138 | 138 | * @param String $title Title to show for the radio button option |
| 139 | 139 | */ |
| 140 | 140 | function __construct($value, $fields = null, $title = null) { |
@@ -23,8 +23,6 @@ discard block |
||
| 23 | 23 | * @uses FormField::name_to_label() |
| 24 | 24 | * |
| 25 | 25 | * @param string $name Identifier of the tab, without characters like dots or spaces |
| 26 | - * @param string $title Natural language title of the tab. If its left out, |
|
| 27 | - * the class uses {@link FormField::name_to_label()} to produce a title from the {@link $name} parameter. |
|
| 28 | 26 | * @param FormField All following parameters are inserted as children to this tab |
| 29 | 27 | */ |
| 30 | 28 | public function __construct($name) { |
@@ -54,6 +52,9 @@ discard block |
||
| 54 | 52 | return $this->children; |
| 55 | 53 | } |
| 56 | 54 | |
| 55 | + /** |
|
| 56 | + * @param TabSet $val |
|
| 57 | + */ |
|
| 57 | 58 | public function setTabSet($val) { |
| 58 | 59 | $this->tabSet = $val; |
| 59 | 60 | return $this; |
@@ -29,8 +29,6 @@ |
||
| 29 | 29 | |
| 30 | 30 | /** |
| 31 | 31 | * @param string $name Identifier |
| 32 | - * @param string $title (Optional) Natural language title of the tabset |
|
| 33 | - * @param Tab|TabSet $unknown All further parameters are inserted as children into the TabSet |
|
| 34 | 32 | */ |
| 35 | 33 | public function __construct($name) { |
| 36 | 34 | $args = func_get_args(); |
@@ -50,6 +50,10 @@ discard block |
||
| 50 | 50 | */ |
| 51 | 51 | protected $valueObj = null; |
| 52 | 52 | |
| 53 | + /** |
|
| 54 | + * @param string $name |
|
| 55 | + * @param string $title |
|
| 56 | + */ |
|
| 53 | 57 | public function __construct($name, $title = null, $value = ""){ |
| 54 | 58 | if(!$this->locale) { |
| 55 | 59 | $this->locale = i18n::get_locale(); |
@@ -228,6 +232,9 @@ discard block |
||
| 228 | 232 | return $this->castedCopy('TimeField_Readonly'); |
| 229 | 233 | } |
| 230 | 234 | |
| 235 | + /** |
|
| 236 | + * @param string $class |
|
| 237 | + */ |
|
| 231 | 238 | public function castedCopy($class) { |
| 232 | 239 | $copy = parent::castedCopy($class); |
| 233 | 240 | if($copy->hasMethod('setConfig')) { |
@@ -118,7 +118,7 @@ discard block |
||
| 118 | 118 | |
| 119 | 119 | /** |
| 120 | 120 | * Return an instance of the cache used for i18n data. |
| 121 | - * @return Zend_Cache |
|
| 121 | + * @return Zend_Cache_Core |
|
| 122 | 122 | */ |
| 123 | 123 | public static function get_cache() { |
| 124 | 124 | return SS_Cache::factory('i18n', 'Output', array('lifetime' => null, 'automatic_serialization' => true)); |
@@ -2156,6 +2156,7 @@ discard block |
||
| 2156 | 2156 | |
| 2157 | 2157 | /** |
| 2158 | 2158 | * @param String |
| 2159 | + * @param string $name |
|
| 2159 | 2160 | * @return Zend_Translate |
| 2160 | 2161 | */ |
| 2161 | 2162 | public static function get_translator($name) { |
@@ -2169,6 +2170,7 @@ discard block |
||
| 2169 | 2170 | * @param Zend_Translate Needs to implement {@link i18nTranslateAdapterInterface} |
| 2170 | 2171 | * @param String If left blank will override the default translator. |
| 2171 | 2172 | * @param Int |
| 2173 | + * @param string $name |
|
| 2172 | 2174 | */ |
| 2173 | 2175 | public static function register_translator($translator, $name, $priority = 10) { |
| 2174 | 2176 | if (!is_int($priority)) throw new InvalidArgumentException("register_translator expects an int priority"); |
@@ -2298,7 +2300,7 @@ discard block |
||
| 2298 | 2300 | * |
| 2299 | 2301 | * @see get_locale_name() |
| 2300 | 2302 | * |
| 2301 | - * @param mixed $code Language code |
|
| 2303 | + * @param string $code Language code |
|
| 2302 | 2304 | * @param boolean $native If true, the native name will be returned |
| 2303 | 2305 | * @return Name of the language |
| 2304 | 2306 | */ |
@@ -2455,6 +2457,7 @@ discard block |
||
| 2455 | 2457 | * |
| 2456 | 2458 | * Note: Does not check for {@link $allowed_locales}. |
| 2457 | 2459 | * |
| 2460 | + * @param string $locale |
|
| 2458 | 2461 | * @return boolean |
| 2459 | 2462 | */ |
| 2460 | 2463 | public static function validate_locale($locale) { |
@@ -712,7 +712,8 @@ discard block |
||
| 712 | 712 | * Input for langArrayCodeForEntitySpec() should be suitable for insertion |
| 713 | 713 | * into single-quoted strings, so needs to be escaped already. |
| 714 | 714 | * |
| 715 | - * @param string $entity The entity name, e.g. CMSMain.BUTTONSAVE |
|
| 715 | + * @param string $entitySpec The entity name, e.g. CMSMain.BUTTONSAVE |
|
| 716 | + * @param string $locale |
|
| 716 | 717 | */ |
| 717 | 718 | public function langArrayCodeForEntitySpec($entityFullName, $entitySpec, $locale) { |
| 718 | 719 | $php = ''; |
@@ -775,6 +776,9 @@ discard block |
||
| 775 | 776 | return true; |
| 776 | 777 | } |
| 777 | 778 | |
| 779 | + /** |
|
| 780 | + * @param string $locale |
|
| 781 | + */ |
|
| 778 | 782 | public function getYaml($entities, $locale) { |
| 779 | 783 | // Unflatten array |
| 780 | 784 | $entitiesNested = array(); |
@@ -843,6 +847,7 @@ discard block |
||
| 843 | 847 | |
| 844 | 848 | /** |
| 845 | 849 | * Parses a template and returns any translatable entities |
| 850 | + * @param string $template |
|
| 846 | 851 | */ |
| 847 | 852 | public static function GetTranslatables($template) { |
| 848 | 853 | self::$entities = array(); |
@@ -387,7 +387,7 @@ discard block |
||
| 387 | 387 | * |
| 388 | 388 | * Note that columns may be double quoted as per ANSI sql standard |
| 389 | 389 | * |
| 390 | - * @return DataList |
|
| 390 | + * @return ArrayList |
|
| 391 | 391 | * @see SS_List::sort() |
| 392 | 392 | * @example $list->sort('Name'); // default ASC sorting |
| 393 | 393 | * @example $list->sort('Name DESC'); // DESC sorting |
@@ -523,6 +523,9 @@ discard block |
||
| 523 | 523 | return $list; |
| 524 | 524 | } |
| 525 | 525 | |
| 526 | + /** |
|
| 527 | + * @param integer $id |
|
| 528 | + */ |
|
| 526 | 529 | public function byID($id) { |
| 527 | 530 | $firstElement = $this->filter("ID", $id)->first(); |
| 528 | 531 | |
@@ -624,7 +627,6 @@ discard block |
||
| 624 | 627 | /** |
| 625 | 628 | * Returns whether an item with $key exists |
| 626 | 629 | * |
| 627 | - * @param mixed $key |
|
| 628 | 630 | * @return bool |
| 629 | 631 | */ |
| 630 | 632 | public function offsetExists($offset) { |
@@ -634,7 +636,6 @@ discard block |
||
| 634 | 636 | /** |
| 635 | 637 | * Returns item stored in list with index $key |
| 636 | 638 | * |
| 637 | - * @param mixed $key |
|
| 638 | 639 | * @return DataObject |
| 639 | 640 | */ |
| 640 | 641 | public function offsetGet($offset) { |
@@ -644,7 +645,6 @@ discard block |
||
| 644 | 645 | /** |
| 645 | 646 | * Set an item with the key in $key |
| 646 | 647 | * |
| 647 | - * @param mixed $key |
|
| 648 | 648 | * @param mixed $value |
| 649 | 649 | */ |
| 650 | 650 | public function offsetSet($offset, $value) { |
@@ -658,7 +658,6 @@ discard block |
||
| 658 | 658 | /** |
| 659 | 659 | * Unset an item with the key in $key |
| 660 | 660 | * |
| 661 | - * @param mixed $key |
|
| 662 | 661 | */ |
| 663 | 662 | public function offsetUnset($offset) { |
| 664 | 663 | unset($this->items[$offset]); |