@@ -56,7 +56,7 @@ discard block |
||
56 | 56 | * Test if a cache is available or not (for the given id) |
57 | 57 | * |
58 | 58 | * @param string $id cache id |
59 | - * @return mixed false (a cache is not available) or "last modified" timestamp (int) of the available cache record |
|
59 | + * @return boolean false (a cache is not available) or "last modified" timestamp (int) of the available cache record |
|
60 | 60 | */ |
61 | 61 | public function test($id) |
62 | 62 | { |
@@ -192,7 +192,7 @@ discard block |
||
192 | 192 | * - mtime : timestamp of last modification time |
193 | 193 | * |
194 | 194 | * @param string $id cache id |
195 | - * @return array array of metadatas (false if the cache id is not found) |
|
195 | + * @return boolean array of metadatas (false if the cache id is not found) |
|
196 | 196 | */ |
197 | 197 | public function getMetadatas($id) |
198 | 198 | { |
@@ -136,7 +136,7 @@ |
||
136 | 136 | * Helper method to calculate the correct class path |
137 | 137 | * |
138 | 138 | * @param string $class |
139 | - * @return False if not matched other wise the correct path |
|
139 | + * @return false|string if not matched other wise the correct path |
|
140 | 140 | */ |
141 | 141 | public function getClassPath($class) |
142 | 142 | { |
@@ -283,7 +283,7 @@ |
||
283 | 283 | * Whether or not a Plugin by a specific name is loaded |
284 | 284 | * |
285 | 285 | * @param string $name |
286 | - * @return Zend_Loader_PluginLoader |
|
286 | + * @return boolean |
|
287 | 287 | */ |
288 | 288 | public function isLoaded($name) |
289 | 289 | { |
@@ -110,7 +110,7 @@ discard block |
||
110 | 110 | |
111 | 111 | /** |
112 | 112 | * Provides a hook for mock unit tests despite no DI |
113 | - * @return Zend_Cache_Frontend |
|
113 | + * @return Zend_Cache_Core |
|
114 | 114 | */ |
115 | 115 | protected function getCache() |
116 | 116 | { |
@@ -244,6 +244,9 @@ discard block |
||
244 | 244 | * splt/complete before and after matchers) |
245 | 245 | * |
246 | 246 | * Public so that ManifestFileFinder can call it. Not for general use. |
247 | + * @param string $basename |
|
248 | + * @param string $pathname |
|
249 | + * @param boolean $depth |
|
247 | 250 | */ |
248 | 251 | public function addYAMLConfigFile($basename, $pathname, $depth) { |
249 | 252 | if (!preg_match('{/([^/]+)/_config/}', $pathname, $match)) return; |
@@ -467,7 +470,7 @@ discard block |
||
467 | 470 | * Returns false if the prefilterable parts of the rule aren't met, and true if they are |
468 | 471 | * |
469 | 472 | * @param $rules array - A hash of rules as allowed in the only or except portion of a config fragment header |
470 | - * @return bool - True if the rules are met, false if not. (Note that depending on whether we were passed an |
|
473 | + * @return boolean|string - True if the rules are met, false if not. (Note that depending on whether we were passed an |
|
471 | 474 | * only or an except rule, |
472 | 475 | * which values means accept or reject a fragment |
473 | 476 | */ |
@@ -191,7 +191,7 @@ |
||
191 | 191 | /** |
192 | 192 | * Returns the backend |
193 | 193 | * |
194 | - * @return Zend_Cache_Backend backend object |
|
194 | + * @return Zend_Cache_Backend_Interface backend object |
|
195 | 195 | */ |
196 | 196 | public function getBackend() |
197 | 197 | { |
@@ -555,6 +555,7 @@ discard block |
||
555 | 555 | * Returns the menu title for the given LeftAndMain subclass. |
556 | 556 | * Implemented static so that we can get this value without instantiating an object. |
557 | 557 | * Menu title is *not* internationalised. |
558 | + * @return string |
|
558 | 559 | */ |
559 | 560 | public static function menu_title_for_class($class) { |
560 | 561 | $title = Config::inst()->get($class, 'menu_title', Config::FIRST_SET); |
@@ -720,6 +721,7 @@ discard block |
||
720 | 721 | * Return a list of appropriate templates for this class, with the given suffix using |
721 | 722 | * {@link SSViewer::get_templates_by_class()} |
722 | 723 | * |
724 | + * @param string $suffix |
|
723 | 725 | * @return array |
724 | 726 | */ |
725 | 727 | public function getTemplatesWithSuffix($suffix) { |
@@ -1740,7 +1742,7 @@ discard block |
||
1740 | 1742 | } |
1741 | 1743 | |
1742 | 1744 | /** |
1743 | - * @return String |
|
1745 | + * @return DBField |
|
1744 | 1746 | */ |
1745 | 1747 | public function Locale() { |
1746 | 1748 | return DBField::create_field('DBLocale', i18n::get_locale()); |
@@ -1906,6 +1908,9 @@ discard block |
||
1906 | 1908 | return (parent::isFinished() || $this->isFinished); |
1907 | 1909 | } |
1908 | 1910 | |
1911 | + /** |
|
1912 | + * @param boolean $bool |
|
1913 | + */ |
|
1909 | 1914 | public function setIsFinished($bool) { |
1910 | 1915 | $this->isFinished = $bool; |
1911 | 1916 | } |
@@ -219,6 +219,7 @@ discard block |
||
219 | 219 | * via the standard template inclusion process. |
220 | 220 | * |
221 | 221 | * @param string |
222 | + * @param string $template |
|
222 | 223 | */ |
223 | 224 | public function setTemplate($template) { |
224 | 225 | $this->template = $template; |
@@ -315,6 +316,7 @@ discard block |
||
315 | 316 | /** |
316 | 317 | * Return the named field as an obj() call from $this->failover. |
317 | 318 | * Default to the given class if there's no casting information. |
319 | + * @param string $fieldName |
|
318 | 320 | */ |
319 | 321 | public function rssField($fieldName, $defaultClass = 'Varchar') { |
320 | 322 | if($fieldName) { |
@@ -126,6 +126,7 @@ |
||
126 | 126 | * |
127 | 127 | * @param string $title |
128 | 128 | * @param string $title |
129 | + * @param string|false $subtitle |
|
129 | 130 | */ |
130 | 131 | public function writeInfo($title, $subtitle, $description=false) { |
131 | 132 | echo '<div class="info">'; |
@@ -102,7 +102,7 @@ discard block |
||
102 | 102 | * Set a different instance than {@link Upload_Validator} |
103 | 103 | * for this upload session. |
104 | 104 | * |
105 | - * @param object $validator |
|
105 | + * @param Upload_Validator $validator |
|
106 | 106 | */ |
107 | 107 | public function setValidator($validator) { |
108 | 108 | $this->validator = $validator; |
@@ -223,7 +223,7 @@ discard block |
||
223 | 223 | * |
224 | 224 | * @param array $tmpFile |
225 | 225 | * @param File $file |
226 | - * @return Boolean |
|
226 | + * @return boolean|string |
|
227 | 227 | */ |
228 | 228 | public function loadIntoFile($tmpFile, $file, $folderPath = false) { |
229 | 229 | $this->file = $file; |
@@ -231,7 +231,8 @@ discard block |
||
231 | 231 | } |
232 | 232 | |
233 | 233 | /** |
234 | - * @return Boolean |
|
234 | + * @param boolean $bool |
|
235 | + * @return boolean|null |
|
235 | 236 | */ |
236 | 237 | public function setReplaceFile($bool) { |
237 | 238 | $this->replaceFile = $bool; |
@@ -295,7 +296,7 @@ discard block |
||
295 | 296 | /** |
296 | 297 | * Determines wether previous operations caused an error. |
297 | 298 | * |
298 | - * @return boolean |
|
299 | + * @return integer |
|
299 | 300 | */ |
300 | 301 | public function isError() { |
301 | 302 | return (count($this->errors)); |