@@ -709,7 +709,8 @@ discard block |
||
709 | 709 | * Input for langArrayCodeForEntitySpec() should be suitable for insertion |
710 | 710 | * into single-quoted strings, so needs to be escaped already. |
711 | 711 | * |
712 | - * @param string $entity The entity name, e.g. CMSMain.BUTTONSAVE |
|
712 | + * @param string $entitySpec The entity name, e.g. CMSMain.BUTTONSAVE |
|
713 | + * @param string $locale |
|
713 | 714 | */ |
714 | 715 | public function langArrayCodeForEntitySpec($entityFullName, $entitySpec, $locale) { |
715 | 716 | $php = ''; |
@@ -772,6 +773,9 @@ discard block |
||
772 | 773 | return true; |
773 | 774 | } |
774 | 775 | |
776 | + /** |
|
777 | + * @param string $locale |
|
778 | + */ |
|
775 | 779 | public function getYaml($entities, $locale) { |
776 | 780 | // Use the Zend copy of this script to prevent class conflicts when RailsYaml is included |
777 | 781 | require_once 'thirdparty/zend_translate_railsyaml/library/Translate/Adapter/thirdparty/sfYaml/lib' |
@@ -846,6 +850,7 @@ discard block |
||
846 | 850 | |
847 | 851 | /** |
848 | 852 | * Parses a template and returns any translatable entities |
853 | + * @param string $template |
|
849 | 854 | */ |
850 | 855 | public static function GetTranslatables($template) { |
851 | 856 | self::$entities = array(); |
@@ -47,6 +47,7 @@ discard block |
||
47 | 47 | /** |
48 | 48 | * Clear the aggregate cache for a given type, or pass nothing to clear all aggregate caches. |
49 | 49 | * {@link $class} is just effective if the cache backend supports tags. |
50 | + * @param string $class |
|
50 | 51 | */ |
51 | 52 | public static function flushCache($class=null) { |
52 | 53 | $cache = self::cache(); |
@@ -85,7 +86,7 @@ discard block |
||
85 | 86 | * Build the SQLSelect to calculate the aggregate |
86 | 87 | * This is a seperate function so that subtypes of Aggregate can change just this bit |
87 | 88 | * @param string $attr - the SQL field statement for selection (i.e. "MAX(LastUpdated)") |
88 | - * @return SQLSelect |
|
89 | + * @return DataList |
|
89 | 90 | */ |
90 | 91 | protected function query($attr) { |
91 | 92 | $query = DataList::create($this->type)->where($this->filter); |
@@ -44,6 +44,7 @@ discard block |
||
44 | 44 | * Create a new DataQuery. |
45 | 45 | * |
46 | 46 | * @param String The name of the DataObject class that you wish to query |
47 | + * @param string $dataClass |
|
47 | 48 | */ |
48 | 49 | public function __construct($dataClass) { |
49 | 50 | $this->dataClass = $dataClass; |
@@ -166,7 +167,7 @@ discard block |
||
166 | 167 | /** |
167 | 168 | * Ensure that the query is ready to execute. |
168 | 169 | * |
169 | - * @param array|null $queriedColumns Any columns to filter the query by |
|
170 | + * @param string[] $queriedColumns Any columns to filter the query by |
|
170 | 171 | * @return SQLQuery The finalised sql query |
171 | 172 | */ |
172 | 173 | public function getFinalisedQuery($queriedColumns = null) { |
@@ -664,7 +665,7 @@ discard block |
||
664 | 665 | * mappings to the query object state. This has to be called |
665 | 666 | * in any overloaded {@link SearchFilter->apply()} methods manually. |
666 | 667 | * |
667 | - * @param String|array $relation The array/dot-syntax relation to follow |
|
668 | + * @param string $relation The array/dot-syntax relation to follow |
|
668 | 669 | * @return The model class of the related item |
669 | 670 | */ |
670 | 671 | public function applyRelation($relation) { |
@@ -844,6 +845,7 @@ discard block |
||
844 | 845 | |
845 | 846 | /** |
846 | 847 | * Set an arbitrary query parameter, that can be used by decorators to add additional meta-data to the query. |
848 | + * @param string $key |
|
847 | 849 | */ |
848 | 850 | public function getQueryParam($key) { |
849 | 851 | if(isset($this->queryParams[$key])) return $this->queryParams[$key]; |
@@ -878,6 +880,9 @@ discard block |
||
878 | 880 | */ |
879 | 881 | protected $whereQuery; |
880 | 882 | |
883 | + /** |
|
884 | + * @param string $connective |
|
885 | + */ |
|
881 | 886 | public function __construct(DataQuery $base, $connective) { |
882 | 887 | $this->dataClass = $base->dataClass; |
883 | 888 | $this->query = $base->query; |
@@ -887,6 +892,9 @@ discard block |
||
887 | 892 | $base->where($this); |
888 | 893 | } |
889 | 894 | |
895 | + /** |
|
896 | + * @param string $filter |
|
897 | + */ |
|
890 | 898 | public function where($filter) { |
891 | 899 | if($filter) { |
892 | 900 | $this->whereQuery->addWhere($filter); |
@@ -23,6 +23,9 @@ discard block |
||
23 | 23 | */ |
24 | 24 | private static $currency_symbol = '$'; |
25 | 25 | |
26 | + /** |
|
27 | + * @param string $name |
|
28 | + */ |
|
26 | 29 | public function __construct($name = null, $wholeSize = 9, $decimalSize = 2, $defaultValue = 0) { |
27 | 30 | parent::__construct($name, $wholeSize, $decimalSize, $defaultValue); |
28 | 31 | } |
@@ -46,6 +49,9 @@ discard block |
||
46 | 49 | else return $val; |
47 | 50 | } |
48 | 51 | |
52 | + /** |
|
53 | + * @param string $value |
|
54 | + */ |
|
49 | 55 | public function setValue($value, $record = null) { |
50 | 56 | $matches = null; |
51 | 57 | if(is_numeric($value)) { |
@@ -28,6 +28,9 @@ discard block |
||
28 | 28 | private static $nice_format = 'd/m/Y'; |
29 | 29 | |
30 | 30 | |
31 | + /** |
|
32 | + * @param string|null $value |
|
33 | + */ |
|
31 | 34 | public function setValue($value, $record = null) { |
32 | 35 | if($value === false || $value === null || (is_string($value) && !strlen($value))) { |
33 | 36 | // don't try to evaluate empty values with strtotime() below, as it returns "1970-01-01" when it should be |
@@ -110,7 +113,7 @@ discard block |
||
110 | 113 | |
111 | 114 | /** |
112 | 115 | * Returns the day of the month. |
113 | - * @param boolean $includeOrdinals Include ordinal suffix to day, e.g. "th" or "rd" |
|
116 | + * @param boolean $includeOrdinal Include ordinal suffix to day, e.g. "th" or "rd" |
|
114 | 117 | * @return string |
115 | 118 | */ |
116 | 119 | public function DayOfMonth($includeOrdinal = false) { |
@@ -164,7 +167,7 @@ discard block |
||
164 | 167 | * Return a date formatted as per a CMS user's settings. |
165 | 168 | * |
166 | 169 | * @param Member $member |
167 | - * @return boolean | string A date formatted as per user-defined settings. |
|
170 | + * @return false|string | string A date formatted as per user-defined settings. |
|
168 | 171 | */ |
169 | 172 | public function FormatFromSettings($member = null) { |
170 | 173 | require_once 'Zend/Date.php'; |
@@ -209,6 +209,9 @@ |
||
209 | 209 | |
210 | 210 | } |
211 | 211 | |
212 | + /** |
|
213 | + * @param string $tableName |
|
214 | + */ |
|
212 | 215 | public function setTable($tableName) { |
213 | 216 | $this->tableName = $tableName; |
214 | 217 | } |
@@ -129,6 +129,7 @@ |
||
129 | 129 | |
130 | 130 | /** |
131 | 131 | * @param boolean |
132 | + * @param boolean $bool |
|
132 | 133 | */ |
133 | 134 | public function setAllowMultibyte($bool) { |
134 | 135 | $this->allowMultibyte = $bool; |
@@ -92,6 +92,9 @@ |
||
92 | 92 | return $return; |
93 | 93 | } |
94 | 94 | |
95 | + /** |
|
96 | + * @param boolean $index |
|
97 | + */ |
|
95 | 98 | function f($index) { |
96 | 99 | return stripslashes($this->row[$index]); |
97 | 100 | } |
@@ -63,6 +63,7 @@ discard block |
||
63 | 63 | * while automatically busting this cache every time the file is changed. |
64 | 64 | * |
65 | 65 | * @param bool |
66 | + * @param boolean $var |
|
66 | 67 | */ |
67 | 68 | public static function set_suffix_requirements($var) { |
68 | 69 | self::backend()->set_suffix_requirements($var); |
@@ -123,7 +124,7 @@ discard block |
||
123 | 124 | /** |
124 | 125 | * Return all registered custom scripts |
125 | 126 | * |
126 | - * @return array |
|
127 | + * @return string |
|
127 | 128 | */ |
128 | 129 | public static function get_custom_scripts() { |
129 | 130 | return self::backend()->get_custom_scripts(); |
@@ -531,7 +532,7 @@ discard block |
||
531 | 532 | /** |
532 | 533 | * Enable or disable the combination of CSS and JavaScript files |
533 | 534 | * |
534 | - * @param $enable |
|
535 | + * @param boolean $enable |
|
535 | 536 | */ |
536 | 537 | public function set_combined_files_enabled($enable) { |
537 | 538 | $this->combined_files_enabled = (bool) $enable; |
@@ -599,6 +600,7 @@ discard block |
||
599 | 600 | * Forces the JavaScript requirements to the end of the body, right before the closing tag |
600 | 601 | * |
601 | 602 | * @param bool |
603 | + * @param boolean $var |
|
602 | 604 | */ |
603 | 605 | public function set_force_js_to_bottom($var) { |
604 | 606 | $this->force_js_to_bottom = $var; |
@@ -638,7 +640,7 @@ discard block |
||
638 | 640 | /** |
639 | 641 | * Return all registered custom scripts |
640 | 642 | * |
641 | - * @return array |
|
643 | + * @return string |
|
642 | 644 | */ |
643 | 645 | public function get_custom_scripts() { |
644 | 646 | $requirements = ""; |
@@ -1051,7 +1053,7 @@ discard block |
||
1051 | 1053 | * @param array $files Array of filenames relative to docroot |
1052 | 1054 | * @param string $media |
1053 | 1055 | * |
1054 | - * @return bool|void |
|
1056 | + * @return false|null |
|
1055 | 1057 | */ |
1056 | 1058 | public function combine_files($combinedFileName, $files, $media = null) { |
1057 | 1059 | // duplicate check |