@@ -336,7 +336,6 @@ discard block |
||
336 | 336 | /** |
337 | 337 | * Returns the modulus of the numerical position of the item in the data set. |
338 | 338 | * The count starts from $startIndex, which defaults to 1. |
339 | - * @param int $Mod The number to perform Mod operation to. |
|
340 | 339 | * @param int $startIndex Number to start count from. |
341 | 340 | * @return int |
342 | 341 | */ |
@@ -410,6 +409,10 @@ discard block |
||
410 | 409 | $this->underlay = $underlay ? $underlay : array(); |
411 | 410 | } |
412 | 411 | |
412 | + /** |
|
413 | + * @param string $interfaceToQuery |
|
414 | + * @param string $variableMethod |
|
415 | + */ |
|
413 | 416 | protected function createCallableArray(&$extraArray, $interfaceToQuery, $variableMethod, $createObject = false) { |
414 | 417 | $implementers = ClassInfo::implementorsOf($interfaceToQuery); |
415 | 418 | if($implementers) foreach($implementers as $implementer) { |
@@ -751,7 +754,7 @@ discard block |
||
751 | 754 | * |
752 | 755 | * @param $className string - valid class name |
753 | 756 | * @param $suffix string |
754 | - * @param $baseClass string |
|
757 | + * @param string $baseClass string |
|
755 | 758 | * |
756 | 759 | * @return array |
757 | 760 | */ |
@@ -1156,7 +1159,7 @@ discard block |
||
1156 | 1159 | * @param string $template Template name |
1157 | 1160 | * @param mixed $data Data context |
1158 | 1161 | * @param array $arguments Additional arguments |
1159 | - * @return string Evaluated result |
|
1162 | + * @return HTMLText Evaluated result |
|
1160 | 1163 | */ |
1161 | 1164 | public static function execute_template($template, $data, $arguments = null, $scope = null) { |
1162 | 1165 | $v = new SSViewer($template); |
@@ -1182,6 +1185,9 @@ discard block |
||
1182 | 1185 | return $v->process($data, $arguments); |
1183 | 1186 | } |
1184 | 1187 | |
1188 | + /** |
|
1189 | + * @param string $content |
|
1190 | + */ |
|
1185 | 1191 | public function parseTemplateContent($content, $template="") { |
1186 | 1192 | return $this->getParser()->compileString( |
1187 | 1193 | $content, |
@@ -1210,7 +1216,7 @@ discard block |
||
1210 | 1216 | * Return an appropriate base tag for the given template. |
1211 | 1217 | * It will be closed on an XHTML document, and unclosed on an HTML document. |
1212 | 1218 | * |
1213 | - * @param $contentGeneratedSoFar The content of the template generated so far; it should contain |
|
1219 | + * @param string $contentGeneratedSoFar The content of the template generated so far; it should contain |
|
1214 | 1220 | * the DOCTYPE declaration. |
1215 | 1221 | */ |
1216 | 1222 | public static function get_base_tag($contentGeneratedSoFar) { |
@@ -1251,6 +1257,9 @@ discard block |
||
1251 | 1257 | */ |
1252 | 1258 | protected $cacheTemplate; |
1253 | 1259 | |
1260 | + /** |
|
1261 | + * @param string $content |
|
1262 | + */ |
|
1254 | 1263 | public function __construct($content, TemplateParser $parser = null) { |
1255 | 1264 | if ($parser) { |
1256 | 1265 | $this->setParser($parser); |
@@ -36,6 +36,9 @@ |
||
36 | 36 | |
37 | 37 | protected $whitelist = false; |
38 | 38 | |
39 | + /** |
|
40 | + * @param string $name |
|
41 | + */ |
|
39 | 42 | public function __construct($name = null, $options = array()) { |
40 | 43 | if(is_string($options)) { |
41 | 44 | $options = array('whitelist' => $options); |
@@ -97,6 +97,9 @@ |
||
97 | 97 | return $return; |
98 | 98 | } |
99 | 99 | |
100 | + /** |
|
101 | + * @param boolean $index |
|
102 | + */ |
|
100 | 103 | function f($index) { |
101 | 104 | return stripslashes($this->row[$index]); |
102 | 105 | } |
@@ -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); |
@@ -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()->setSuffixRequirements($var); |
@@ -731,6 +732,7 @@ discard block |
||
731 | 732 | * Forces the JavaScript requirements to the end of the body, right before the closing tag |
732 | 733 | * |
733 | 734 | * @param bool |
735 | + * @param boolean $var |
|
734 | 736 | * @return $this |
735 | 737 | */ |
736 | 738 | public function setForceJSToBottom($var) { |
@@ -1521,8 +1523,8 @@ discard block |
||
1521 | 1523 | /** |
1522 | 1524 | * Given a filename and list of files, generate a new filename unique to these files |
1523 | 1525 | * |
1524 | - * @param string $name |
|
1525 | - * @param array $files |
|
1526 | + * @param array $fileList |
|
1527 | + * @param string $combinedFile |
|
1526 | 1528 | * @return string |
1527 | 1529 | */ |
1528 | 1530 | protected function hashedCombinedFilename($combinedFile, $fileList) { |
@@ -38,6 +38,7 @@ discard block |
||
38 | 38 | |
39 | 39 | /** |
40 | 40 | * @todo Move this to SS_Database or DB |
41 | + * @param string $class |
|
41 | 42 | */ |
42 | 43 | public static function hasTable($class) { |
43 | 44 | // Cache the list of all table names to reduce on DB traffic |
@@ -219,6 +220,7 @@ discard block |
||
219 | 220 | |
220 | 221 | /** |
221 | 222 | * Returns true if the given class implements the given interface |
223 | + * @param string $interfaceName |
|
222 | 224 | */ |
223 | 225 | public static function classImplements($className, $interfaceName) { |
224 | 226 | return in_array($className, self::implementorsOf($interfaceName)); |
@@ -269,6 +271,9 @@ discard block |
||
269 | 271 | |
270 | 272 | private static $method_from_cache = array(); |
271 | 273 | |
274 | + /** |
|
275 | + * @param string $method |
|
276 | + */ |
|
272 | 277 | public static function has_method_from($class, $method, $compclass) { |
273 | 278 | $lClass = strtolower($class); |
274 | 279 | $lMethod = strtolower($method); |