@@ -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 | { |
@@ -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)); |
@@ -45,7 +45,7 @@ discard block |
||
| 45 | 45 | * |
| 46 | 46 | * @param string $name The internal field name, passed to forms. |
| 47 | 47 | * @param string $title The human-readable field label. |
| 48 | - * @param mixed $value The value of the field. |
|
| 48 | + * @param integer $value The value of the field. |
|
| 49 | 49 | * @param string $config HTMLEditorConfig identifier to be used. Default to the active one. |
| 50 | 50 | */ |
| 51 | 51 | public function __construct($name, $title = null, $value = '', $config = null) { |
@@ -169,6 +169,10 @@ discard block |
||
| 169 | 169 | |
| 170 | 170 | protected $controller, $name; |
| 171 | 171 | |
| 172 | + /** |
|
| 173 | + * @param Controller|null $controller |
|
| 174 | + * @param string $name |
|
| 175 | + */ |
|
| 172 | 176 | public function __construct($controller, $name) { |
| 173 | 177 | parent::__construct(); |
| 174 | 178 | |
@@ -197,7 +201,7 @@ discard block |
||
| 197 | 201 | /** |
| 198 | 202 | * Searches the SiteTree for display in the dropdown |
| 199 | 203 | * |
| 200 | - * @return callback |
|
| 204 | + * @return DataList |
|
| 201 | 205 | */ |
| 202 | 206 | public function siteTreeSearchCallback($sourceObject, $labelField, $search) { |
| 203 | 207 | return DataObject::get($sourceObject)->filterAny(array( |
@@ -563,7 +567,7 @@ discard block |
||
| 563 | 567 | /** |
| 564 | 568 | * Find all anchors available on the given page. |
| 565 | 569 | * |
| 566 | - * @return array |
|
| 570 | + * @return string |
|
| 567 | 571 | */ |
| 568 | 572 | public function getanchors() { |
| 569 | 573 | $id = (int)$this->getRequest()->getVar('PageID'); |
@@ -607,6 +611,7 @@ discard block |
||
| 607 | 611 | * not the "master record" in the database - hence there's no form or saving logic. |
| 608 | 612 | * |
| 609 | 613 | * @param String Relative or absolute URL to file |
| 614 | + * @param HtmlEditorField_File $file |
|
| 610 | 615 | * @return FieldList |
| 611 | 616 | */ |
| 612 | 617 | protected function getFieldsForFile($url, $file) { |
@@ -628,6 +633,7 @@ discard block |
||
| 628 | 633 | } |
| 629 | 634 | |
| 630 | 635 | /** |
| 636 | + * @param HtmlEditorField_Embed $file |
|
| 631 | 637 | * @return FieldList |
| 632 | 638 | */ |
| 633 | 639 | protected function getFieldsForOembed($url, $file) { |
@@ -837,6 +843,7 @@ discard block |
||
| 837 | 843 | |
| 838 | 844 | /** |
| 839 | 845 | * @param Int |
| 846 | + * @param integer $parentID |
|
| 840 | 847 | * @return DataList |
| 841 | 848 | */ |
| 842 | 849 | protected function getFiles($parentID = null) { |
@@ -73,6 +73,9 @@ |
||
| 73 | 73 | return $this; |
| 74 | 74 | } |
| 75 | 75 | |
| 76 | + /** |
|
| 77 | + * @return string |
|
| 78 | + */ |
|
| 76 | 79 | public static function joinPhoneNumber( $value ) { |
| 77 | 80 | if( is_array( $value ) ) { |
| 78 | 81 | $completeNumber = ''; |
@@ -385,6 +385,7 @@ discard block |
||
| 385 | 385 | * - minutes |
| 386 | 386 | * - seconds |
| 387 | 387 | * This includes the singular forms as well |
| 388 | + * @param string $date |
|
| 388 | 389 | * @return string SQL datetime expression to query for a datetime (YYYY-MM-DD hh:mm:ss) which is the result of |
| 389 | 390 | * the addition |
| 390 | 391 | */ |
@@ -398,6 +399,7 @@ discard block |
||
| 398 | 399 | * e.g. '"SiteTree"."Created"' |
| 399 | 400 | * @param string $date2 to be substracted of $date1, can be either 'now', literal datetime |
| 400 | 401 | * like '1973-10-14 10:30:00' or field name, e.g. '"SiteTree"."Created"' |
| 402 | + * @param string $date1 |
|
| 401 | 403 | * @return string SQL datetime expression to query for the interval between $date1 and $date2 in seconds which |
| 402 | 404 | * is the result of the substraction |
| 403 | 405 | */ |
@@ -625,7 +627,7 @@ discard block |
||
| 625 | 627 | * @param boolean $create Flag indicating whether the database should be created |
| 626 | 628 | * if it doesn't exist. If $create is false and the database doesn't exist |
| 627 | 629 | * then an error will be raised |
| 628 | - * @param int|boolean $errorLevel The level of error reporting to enable for the query, or false if no error |
|
| 630 | + * @param boolean $errorLevel The level of error reporting to enable for the query, or false if no error |
|
| 629 | 631 | * should be raised |
| 630 | 632 | * @return boolean Flag indicating success |
| 631 | 633 | */ |
@@ -785,6 +787,7 @@ discard block |
||
| 785 | 787 | |
| 786 | 788 | /** |
| 787 | 789 | * @deprecated since version 4.0 Use DB::field_list instead |
| 790 | + * @param string $table |
|
| 788 | 791 | */ |
| 789 | 792 | public function fieldList($table) { |
| 790 | 793 | Deprecation::notice('4.0', 'Use DB::field_list instead'); |