@@ -162,7 +162,7 @@ |
||
162 | 162 | * @param string $mode clean mode |
163 | 163 | * @param array $tags array of tags |
164 | 164 | * @throws Zend_Cache_Exception |
165 | - * @return boolean true if no problem |
|
165 | + * @return boolean|null true if no problem |
|
166 | 166 | */ |
167 | 167 | public function clean($mode = Zend_Cache::CLEANING_MODE_ALL, $tags = array()) |
168 | 168 | { |
@@ -48,7 +48,7 @@ discard block |
||
48 | 48 | * @param string $locale Locale/Language to add data for, identical with locale identifier, |
49 | 49 | * see Zend_Locale for more information |
50 | 50 | * @param string $filename XMLTM file to add, full path must be given for access |
51 | - * @param array $option OPTIONAL Options to use |
|
51 | + * @param array $options OPTIONAL Options to use |
|
52 | 52 | * @throws Zend_Translation_Exception |
53 | 53 | * @return array |
54 | 54 | */ |
@@ -116,6 +116,9 @@ discard block |
||
116 | 116 | } |
117 | 117 | } |
118 | 118 | |
119 | + /** |
|
120 | + * @param string $filename |
|
121 | + */ |
|
119 | 122 | private function _findEncoding($filename) |
120 | 123 | { |
121 | 124 | $file = file_get_contents($filename, null, null, 0, 100); |
@@ -48,7 +48,7 @@ discard block |
||
48 | 48 | * @param string $locale Locale/Language to add data for, identical with locale identifier, |
49 | 49 | * see Zend_Locale for more information |
50 | 50 | * @param string $filename XMLTM file to add, full path must be given for access |
51 | - * @param array $option OPTIONAL Options to use |
|
51 | + * @param array $options OPTIONAL Options to use |
|
52 | 52 | * @throws Zend_Translation_Exception |
53 | 53 | * @return array |
54 | 54 | */ |
@@ -116,6 +116,9 @@ discard block |
||
116 | 116 | } |
117 | 117 | } |
118 | 118 | |
119 | + /** |
|
120 | + * @param string $filename |
|
121 | + */ |
|
119 | 122 | private function _findEncoding($filename) |
120 | 123 | { |
121 | 124 | $file = file_get_contents($filename, null, null, 0, 100); |
@@ -48,7 +48,7 @@ discard block |
||
48 | 48 | * @param string $locale Locale/Language to add data for, identical with locale identifier, |
49 | 49 | * see Zend_Locale for more information |
50 | 50 | * @param string $filename XMLTM file to add, full path must be given for access |
51 | - * @param array $option OPTIONAL Options to use |
|
51 | + * @param array $options OPTIONAL Options to use |
|
52 | 52 | * @throws Zend_Translation_Exception |
53 | 53 | * @return array |
54 | 54 | */ |
@@ -116,6 +116,9 @@ discard block |
||
116 | 116 | } |
117 | 117 | } |
118 | 118 | |
119 | + /** |
|
120 | + * @param string $filename |
|
121 | + */ |
|
119 | 122 | private function _findEncoding($filename) |
120 | 123 | { |
121 | 124 | $file = file_get_contents($filename, null, null, 0, 100); |
@@ -732,6 +732,9 @@ discard block |
||
732 | 732 | return $result; |
733 | 733 | } |
734 | 734 | |
735 | + /** |
|
736 | + * @param string $mode |
|
737 | + */ |
|
735 | 738 | protected function _get($dir, $mode, $tags = array()) |
736 | 739 | { |
737 | 740 | if (!is_dir($dir)) { |
@@ -819,6 +822,7 @@ discard block |
||
819 | 822 | /** |
820 | 823 | * Compute & return the expire time |
821 | 824 | * |
825 | + * @param integer $lifetime |
|
822 | 826 | * @return int expire time (unix timestamp) |
823 | 827 | */ |
824 | 828 | protected function _expireTime($lifetime) |
@@ -59,6 +59,10 @@ discard block |
||
59 | 59 | */ |
60 | 60 | protected $config; |
61 | 61 | |
62 | + /** |
|
63 | + * @param string $name |
|
64 | + * @param string $title |
|
65 | + */ |
|
62 | 66 | public function __construct($name, $title = null, $value = ""){ |
63 | 67 | $this->config = $this->config()->default_config; |
64 | 68 | |
@@ -71,6 +75,9 @@ discard block |
||
71 | 75 | parent::__construct($name, $title, $value); |
72 | 76 | } |
73 | 77 | |
78 | + /** |
|
79 | + * @param Form $form |
|
80 | + */ |
|
74 | 81 | public function setForm($form) { |
75 | 82 | parent::setForm($form); |
76 | 83 | |
@@ -81,6 +88,9 @@ discard block |
||
81 | 88 | return $this; |
82 | 89 | } |
83 | 90 | |
91 | + /** |
|
92 | + * @param string $name |
|
93 | + */ |
|
84 | 94 | public function setName($name) { |
85 | 95 | parent::setName($name); |
86 | 96 | |
@@ -93,7 +103,7 @@ discard block |
||
93 | 103 | |
94 | 104 | /** |
95 | 105 | * @param array $properties |
96 | - * @return HTMLText |
|
106 | + * @return string |
|
97 | 107 | */ |
98 | 108 | public function FieldHolder($properties = array()) { |
99 | 109 | $config = array( |
@@ -108,7 +118,7 @@ discard block |
||
108 | 118 | |
109 | 119 | /** |
110 | 120 | * @param array $properties |
111 | - * @return HTMLText |
|
121 | + * @return DBField |
|
112 | 122 | */ |
113 | 123 | public function Field($properties = array()) { |
114 | 124 | Requirements::css(FRAMEWORK_DIR . '/css/DatetimeField.css'); |
@@ -243,6 +253,7 @@ discard block |
||
243 | 253 | |
244 | 254 | /** |
245 | 255 | * @param FormField |
256 | + * @param DateField $field |
|
246 | 257 | */ |
247 | 258 | public function setDateField($field) { |
248 | 259 | $expected = $this->getName() . '[date]'; |
@@ -268,6 +279,7 @@ discard block |
||
268 | 279 | |
269 | 280 | /** |
270 | 281 | * @param FormField |
282 | + * @param TimeField $field |
|
271 | 283 | */ |
272 | 284 | public function setTimeField($field) { |
273 | 285 | $expected = $this->getName() . '[time]'; |
@@ -306,7 +318,7 @@ discard block |
||
306 | 318 | * to set field-specific config options. |
307 | 319 | * |
308 | 320 | * @param string $name |
309 | - * @param mixed $val |
|
321 | + * @param string $val |
|
310 | 322 | */ |
311 | 323 | public function setConfig($name, $val) { |
312 | 324 | $this->config[$name] = $val; |
@@ -324,7 +336,7 @@ discard block |
||
324 | 336 | * to get field-specific config options. |
325 | 337 | * |
326 | 338 | * @param String $name Optional, returns the whole configuration array if empty |
327 | - * @return mixed |
|
339 | + * @return string|null |
|
328 | 340 | */ |
329 | 341 | public function getConfig($name = null) { |
330 | 342 | if($name) { |
@@ -334,6 +346,9 @@ discard block |
||
334 | 346 | } |
335 | 347 | } |
336 | 348 | |
349 | + /** |
|
350 | + * @param RequiredFields $validator |
|
351 | + */ |
|
337 | 352 | public function validate($validator) { |
338 | 353 | $dateValid = $this->dateField->validate($validator); |
339 | 354 | $timeValid = $this->timeField->validate($validator); |
@@ -55,7 +55,7 @@ discard block |
||
55 | 55 | * Which columns are handled by this component |
56 | 56 | * |
57 | 57 | * @param GridField $gridField |
58 | - * @return array |
|
58 | + * @return string[] |
|
59 | 59 | */ |
60 | 60 | public function getColumnsHandled($gridField) { |
61 | 61 | return array('Actions'); |
@@ -76,7 +76,7 @@ discard block |
||
76 | 76 | * @param DataObject $record |
77 | 77 | * @param string $columnName |
78 | 78 | * |
79 | - * @return string - the HTML for the column |
|
79 | + * @return DBField - the HTML for the column |
|
80 | 80 | */ |
81 | 81 | public function getColumnContent($gridField, $record, $columnName) { |
82 | 82 | // No permission checks, handled through GridFieldDetailForm, |
@@ -17,7 +17,7 @@ discard block |
||
17 | 17 | |
18 | 18 | /** |
19 | 19 | * Create a new action button. |
20 | - * @param action The method to call when the button is clicked |
|
20 | + * @param action string method to call when the button is clicked |
|
21 | 21 | * @param title The label on the button |
22 | 22 | * @param extraClass A CSS class to apply to the button in addition to 'action' |
23 | 23 | */ |
@@ -32,7 +32,7 @@ discard block |
||
32 | 32 | |
33 | 33 | /** |
34 | 34 | * @param array $properties |
35 | - * @return HTMLText |
|
35 | + * @return DBField |
|
36 | 36 | */ |
37 | 37 | public function Field($properties = array()) { |
38 | 38 | if($this->includeDefaultJS) { |
@@ -78,7 +78,7 @@ discard block |
||
78 | 78 | |
79 | 79 | /** |
80 | 80 | * @param array $properties |
81 | - * @return HTMLText |
|
81 | + * @return DBField |
|
82 | 82 | */ |
83 | 83 | public function Field($properties = array()) { |
84 | 84 | return DBField::create_field('HTMLText', |
@@ -76,7 +76,7 @@ discard block |
||
76 | 76 | * |
77 | 77 | * @param string $name the field name |
78 | 78 | * @param string $title the field label |
79 | - * @param string|array $sourceObject The object-type to list in the tree. This could |
|
79 | + * @param string $sourceObject The object-type to list in the tree. This could |
|
80 | 80 | * be one of the following: |
81 | 81 | * - A DataObject class name with the {@link Hierarchy} extension. |
82 | 82 | * - An array of key/value pairs, like a {@link DropdownField} source. In |
@@ -204,7 +204,7 @@ discard block |
||
204 | 204 | } |
205 | 205 | |
206 | 206 | /** |
207 | - * @return HTMLText |
|
207 | + * @return DBField |
|
208 | 208 | */ |
209 | 209 | public function Field($properties = array()) { |
210 | 210 | Requirements::add_i18n_javascript(FRAMEWORK_DIR . '/javascript/lang'); |
@@ -385,7 +385,7 @@ discard block |
||
385 | 385 | * If a filter function has been set, that will be called. And if search text is set, |
386 | 386 | * filter on that too. Return true if all applicable conditions are true, false otherwise. |
387 | 387 | * @param $node |
388 | - * @return unknown_type |
|
388 | + * @return boolean |
|
389 | 389 | */ |
390 | 390 | public function filterMarking($node) { |
391 | 391 | if ($this->filterCallback && !call_user_func($this->filterCallback, $node)) return false; |
@@ -436,7 +436,6 @@ discard block |
||
436 | 436 | } |
437 | 437 | |
438 | 438 | /** |
439 | - * @param String $field |
|
440 | 439 | */ |
441 | 440 | public function setSourceObject($class) { |
442 | 441 | $this->sourceObject = $class; |