@@ -113,7 +113,7 @@ discard block |
||
113 | 113 | * |
114 | 114 | * @param string $driver name of driver class to initialize |
115 | 115 | * |
116 | - * @return mixed a newly created Image_Transform object, or a PEAR |
|
116 | + * @return string a newly created Image_Transform object, or a PEAR |
|
117 | 117 | * error object on error |
118 | 118 | * |
119 | 119 | * @see PEAR::isError() |
@@ -141,10 +141,10 @@ discard block |
||
141 | 141 | * |
142 | 142 | * @access public |
143 | 143 | * |
144 | - * @param mixed $new_x (0, number, percentage 10% or 0.1) |
|
145 | - * @param mixed $new_y (0, number, percentage 10% or 0.1) |
|
144 | + * @param integer $new_x (0, number, percentage 10% or 0.1) |
|
145 | + * @param integer $new_y (0, number, percentage 10% or 0.1) |
|
146 | 146 | * |
147 | - * @return mixed none or PEAR_error |
|
147 | + * @return PEAR_error|null none or PEAR_error |
|
148 | 148 | */ |
149 | 149 | function resize($new_x = 0, $new_y = 0) |
150 | 150 | { |
@@ -160,7 +160,7 @@ discard block |
||
160 | 160 | * Scale the image to have the max x dimension specified. |
161 | 161 | * |
162 | 162 | * @param int $new_x Size to scale X-dimension to |
163 | - * @return none |
|
163 | + * @return PEAR_error|null |
|
164 | 164 | */ |
165 | 165 | function scaleMaxX($new_x) |
166 | 166 | { |
@@ -173,7 +173,7 @@ discard block |
||
173 | 173 | * |
174 | 174 | * @access public |
175 | 175 | * @param int $new_y Size to scale Y-dimension to |
176 | - * @return none |
|
176 | + * @return PEAR_error|null |
|
177 | 177 | */ |
178 | 178 | function scaleMaxY($new_y) |
179 | 179 | { |
@@ -186,7 +186,7 @@ discard block |
||
186 | 186 | * |
187 | 187 | * @access public |
188 | 188 | * @param mixed (number, percentage 10% or 0.1) |
189 | - * @return mixed none or PEAR_error |
|
189 | + * @return PEAR_error|null none or PEAR_error |
|
190 | 190 | */ |
191 | 191 | function scale($size) |
192 | 192 | { |
@@ -206,7 +206,7 @@ discard block |
||
206 | 206 | * |
207 | 207 | * @access public |
208 | 208 | * @param int $size Percentage of original size to scale to |
209 | - * @return none |
|
209 | + * @return PEAR_error|null |
|
210 | 210 | */ |
211 | 211 | function scaleByPercentage($size) |
212 | 212 | { |
@@ -220,7 +220,7 @@ discard block |
||
220 | 220 | * |
221 | 221 | * @access public |
222 | 222 | * @param float $size Factor of original size to scale to |
223 | - * @return none |
|
223 | + * @return PEAR_error|null |
|
224 | 224 | */ |
225 | 225 | function scaleByFactor($size) |
226 | 226 | { |
@@ -234,7 +234,7 @@ discard block |
||
234 | 234 | * |
235 | 235 | * @access public |
236 | 236 | * @param int $size Max dimension in pixels |
237 | - * @return none |
|
237 | + * @return PEAR_error|null |
|
238 | 238 | */ |
239 | 239 | function scaleByLength($size) |
240 | 240 | { |
@@ -252,7 +252,7 @@ discard block |
||
252 | 252 | /** |
253 | 253 | * |
254 | 254 | * @access public |
255 | - * @return void |
|
255 | + * @return boolean|null |
|
256 | 256 | */ |
257 | 257 | function _get_image_details($image) |
258 | 258 | { |
@@ -310,10 +310,10 @@ discard block |
||
310 | 310 | * |
311 | 311 | * @access private |
312 | 312 | * |
313 | - * @param mixed $new_size (0, number, percentage 10% or 0.1) |
|
313 | + * @param integer $new_size (0, number, percentage 10% or 0.1) |
|
314 | 314 | * @param int $old_size |
315 | 315 | * |
316 | - * @return mixed none or PEAR_error |
|
316 | + * @return integer none or PEAR_error |
|
317 | 317 | */ |
318 | 318 | function _parse_size($new_size, $old_size) |
319 | 319 | { |
@@ -337,6 +337,10 @@ discard block |
||
337 | 337 | } |
338 | 338 | |
339 | 339 | //delete old tmp files, and allow only 1 file per remote host. |
340 | + |
|
341 | + /** |
|
342 | + * @param string $id |
|
343 | + */ |
|
340 | 344 | function cleanUp($id, $dir) |
341 | 345 | { |
342 | 346 | $d = dir($dir); |
@@ -525,7 +529,7 @@ discard block |
||
525 | 529 | * Reverse of rgb2colorname. |
526 | 530 | * |
527 | 531 | * @access public |
528 | - * @return PEAR_error |
|
532 | + * @return string |
|
529 | 533 | * |
530 | 534 | * @see rgb2colorname |
531 | 535 | */ |
@@ -133,6 +133,10 @@ discard block |
||
133 | 133 | |
134 | 134 | |
135 | 135 | // Analyze file by name |
136 | + |
|
137 | + /** |
|
138 | + * @param string $filename |
|
139 | + */ |
|
136 | 140 | public function Analyze($filename) { |
137 | 141 | |
138 | 142 | // Init and save values |
@@ -482,6 +486,12 @@ discard block |
||
482 | 486 | |
483 | 487 | |
484 | 488 | // Convert string between charsets -- iconv() wrapper |
489 | + |
|
490 | + /** |
|
491 | + * @param string $out_charset |
|
492 | + * |
|
493 | + * @return string |
|
494 | + */ |
|
485 | 495 | public function iconv($in_charset, $out_charset, $string, $drop01 = false) { |
486 | 496 | |
487 | 497 | if ($drop01 && ($string === "\x00" || $string === "\x01")) { |
@@ -509,6 +519,9 @@ discard block |
||
509 | 519 | |
510 | 520 | |
511 | 521 | |
522 | + /** |
|
523 | + * @param string $name |
|
524 | + */ |
|
512 | 525 | public function include_module($name) { |
513 | 526 | |
514 | 527 | if (!file_exists($this->include_path.'module.'.$name.'.php')) { |
@@ -520,6 +533,9 @@ discard block |
||
520 | 533 | |
521 | 534 | |
522 | 535 | |
536 | + /** |
|
537 | + * @param string $name |
|
538 | + */ |
|
523 | 539 | public function include_module_optional($name) { |
524 | 540 | |
525 | 541 | if (!file_exists($this->include_path.'module.'.$name.'.php')) { |
@@ -1208,6 +1224,9 @@ discard block |
||
1208 | 1224 | } |
1209 | 1225 | |
1210 | 1226 | |
1227 | + /** |
|
1228 | + * @param integer $whence |
|
1229 | + */ |
|
1211 | 1230 | protected function fseek($bytes, $whence = SEEK_SET) { |
1212 | 1231 | |
1213 | 1232 | if ($this->data_string_flag) { |
@@ -1325,6 +1344,10 @@ discard block |
||
1325 | 1344 | |
1326 | 1345 | |
1327 | 1346 | // Convert number to Little Endian byte string |
1347 | + |
|
1348 | + /** |
|
1349 | + * @param integer $number |
|
1350 | + */ |
|
1328 | 1351 | public static function LittleEndian2String($number, $minbytes=1, $synchsafe=false) { |
1329 | 1352 | $intstring = ''; |
1330 | 1353 | while ($number > 0) { |
@@ -1364,6 +1387,10 @@ discard block |
||
1364 | 1387 | |
1365 | 1388 | |
1366 | 1389 | // Convert Big Endian byte sybc safe string to int - max 32 bits |
1390 | + |
|
1391 | + /** |
|
1392 | + * @param string $byte_word |
|
1393 | + */ |
|
1367 | 1394 | public static function BigEndianSyncSafe2Int($byte_word) { |
1368 | 1395 | |
1369 | 1396 | $int_value = 0; |
@@ -1391,6 +1418,9 @@ discard block |
||
1391 | 1418 | |
1392 | 1419 | |
1393 | 1420 | |
1421 | + /** |
|
1422 | + * @param string $byte_word |
|
1423 | + */ |
|
1394 | 1424 | public static function BigEndian2Float($byte_word) { |
1395 | 1425 | |
1396 | 1426 | // ANSI/IEEE Standard 754-1985, Standard for Binary Floating Point Arithmetic |
@@ -1471,6 +1501,9 @@ discard block |
||
1471 | 1501 | |
1472 | 1502 | |
1473 | 1503 | |
1504 | + /** |
|
1505 | + * @param string $byte_word |
|
1506 | + */ |
|
1474 | 1507 | public static function LittleEndian2Float($byte_word) { |
1475 | 1508 | |
1476 | 1509 | return getid3_lib::BigEndian2Float(strrev($byte_word)); |
@@ -1478,6 +1511,9 @@ discard block |
||
1478 | 1511 | |
1479 | 1512 | |
1480 | 1513 | |
1514 | + /** |
|
1515 | + * @param string $binary_numerator |
|
1516 | + */ |
|
1481 | 1517 | public static function DecimalBinary2Float($binary_numerator) { |
1482 | 1518 | $numerator = bindec($binary_numerator); |
1483 | 1519 | $denominator = bindec('1'.str_repeat('0', strlen($binary_numerator))); |
@@ -1512,6 +1548,9 @@ discard block |
||
1512 | 1548 | // - OR just substring(data) if length is negative! |
1513 | 1549 | // indexes == 'IGNORE**' are ignored |
1514 | 1550 | |
1551 | + /** |
|
1552 | + * @param string $algorithm |
|
1553 | + */ |
|
1515 | 1554 | public static function ReadSequence($algorithm, &$target, &$data, $offset, $parts_array) { |
1516 | 1555 | |
1517 | 1556 | // Loop thru $parts_array |
@@ -203,6 +203,10 @@ |
||
203 | 203 | |
204 | 204 | |
205 | 205 | // Converts the file type |
206 | + |
|
207 | + /** |
|
208 | + * @param string $typflag |
|
209 | + */ |
|
206 | 210 | public static function get_flag_type($typflag) { |
207 | 211 | |
208 | 212 | static $flag_types = array ( |
@@ -384,6 +384,9 @@ discard block |
||
384 | 384 | |
385 | 385 | |
386 | 386 | |
387 | + /** |
|
388 | + * @param integer $index |
|
389 | + */ |
|
387 | 390 | public static function ZIPversionOSLookup($index) { |
388 | 391 | |
389 | 392 | static $lookup = array ( |
@@ -485,6 +488,9 @@ discard block |
||
485 | 488 | |
486 | 489 | |
487 | 490 | |
491 | + /** |
|
492 | + * @param string $separator |
|
493 | + */ |
|
488 | 494 | public static function CreateDeepArray($array_path, $separator, $value) { |
489 | 495 | |
490 | 496 | // assigns $value to a nested array path: |
@@ -1617,6 +1617,9 @@ |
||
1617 | 1617 | |
1618 | 1618 | |
1619 | 1619 | |
1620 | + /** |
|
1621 | + * @param string $guid_string |
|
1622 | + */ |
|
1620 | 1623 | public static function GUIDname($guid_string) { |
1621 | 1624 | |
1622 | 1625 | static $lookup = array ( |
@@ -273,6 +273,9 @@ discard block |
||
273 | 273 | public $pos; |
274 | 274 | |
275 | 275 | |
276 | + /** |
|
277 | + * @param string $bytes |
|
278 | + */ |
|
276 | 279 | public function AMFStream($bytes) { |
277 | 280 | |
278 | 281 | $this->bytes = $bytes; |
@@ -386,6 +389,9 @@ discard block |
||
386 | 389 | { |
387 | 390 | public $stream; |
388 | 391 | |
392 | + /** |
|
393 | + * @param AMFStream $stream |
|
394 | + */ |
|
389 | 395 | public function __construct($stream) { |
390 | 396 | |
391 | 397 | $this->stream = $stream; |
@@ -176,6 +176,11 @@ discard block |
||
176 | 176 | |
177 | 177 | |
178 | 178 | |
179 | + /** |
|
180 | + * @param string $atom_name |
|
181 | + * @param string $atom_data |
|
182 | + * @param double $base_offset |
|
183 | + */ |
|
179 | 184 | private function QuicktimeParseAtom($atom_name, $atom_size, $atom_data, $base_offset, &$atom_hierarchy) { |
180 | 185 | |
181 | 186 | // http://developer.apple.com/techpubs/quicktime/qtdevdocs/APIREF/INDEX/atomalphaindex.htm |
@@ -1147,6 +1152,9 @@ discard block |
||
1147 | 1152 | |
1148 | 1153 | |
1149 | 1154 | |
1155 | + /** |
|
1156 | + * @param integer $base_offset |
|
1157 | + */ |
|
1150 | 1158 | private function QuicktimeParseContainerAtom($atom_data, $base_offset, &$atom_hierarchy) { |
1151 | 1159 | |
1152 | 1160 | if ((strlen($atom_data) == 4) && (getid3_lib::BigEndian2Int($atom_data) == 0x00000000)) { |
@@ -1492,6 +1500,9 @@ discard block |
||
1492 | 1500 | |
1493 | 1501 | |
1494 | 1502 | |
1503 | + /** |
|
1504 | + * @param string $null_terminated_string |
|
1505 | + */ |
|
1495 | 1506 | public static function NoNullString($null_terminated_string) { |
1496 | 1507 | |
1497 | 1508 | // remove the single null terminator on null terminated strings |
@@ -1504,6 +1515,9 @@ discard block |
||
1504 | 1515 | |
1505 | 1516 | |
1506 | 1517 | |
1518 | + /** |
|
1519 | + * @param string $raw_data |
|
1520 | + */ |
|
1507 | 1521 | public static function FixedPoint8_8($raw_data) { |
1508 | 1522 | |
1509 | 1523 | return getid3_lib::BigEndian2Int($raw_data{0}) + (float)(getid3_lib::BigEndian2Int($raw_data{1}) / 256); |
@@ -1511,6 +1525,9 @@ discard block |
||
1511 | 1525 | |
1512 | 1526 | |
1513 | 1527 | |
1528 | + /** |
|
1529 | + * @param string $raw_data |
|
1530 | + */ |
|
1514 | 1531 | public static function FixedPoint16_16($raw_data) { |
1515 | 1532 | |
1516 | 1533 | return getid3_lib::BigEndian2Int(substr($raw_data, 0, 2)) + (float)(getid3_lib::BigEndian2Int(substr($raw_data, 2, 2)) / 65536); |
@@ -1518,6 +1535,9 @@ discard block |
||
1518 | 1535 | |
1519 | 1536 | |
1520 | 1537 | |
1538 | + /** |
|
1539 | + * @param string $raw_data |
|
1540 | + */ |
|
1521 | 1541 | public static function FixedPoint2_30($raw_data) { |
1522 | 1542 | |
1523 | 1543 | $binary_string = getid3_lib::BigEndian2Bin($raw_data); |
@@ -401,6 +401,9 @@ |
||
401 | 401 | |
402 | 402 | |
403 | 403 | |
404 | + /** |
|
405 | + * @param string $old_ra_header_data |
|
406 | + */ |
|
404 | 407 | public static function ParseOldRAheader($old_ra_header_data, &$parsed_array) { |
405 | 408 | |
406 | 409 | // http://www.freelists.org/archives/matroska-devel/07-2003/msg00010.html |
@@ -1155,6 +1155,9 @@ discard block |
||
1155 | 1155 | |
1156 | 1156 | |
1157 | 1157 | |
1158 | + /** |
|
1159 | + * @param integer $start_offset |
|
1160 | + */ |
|
1158 | 1161 | public function ParseRIFF($start_offset, $max_offset) { |
1159 | 1162 | |
1160 | 1163 | $getid3 = $this->getid3; |
@@ -1479,6 +1482,9 @@ discard block |
||
1479 | 1482 | |
1480 | 1483 | |
1481 | 1484 | |
1485 | + /** |
|
1486 | + * @param string $wavpack3_chunk_data |
|
1487 | + */ |
|
1482 | 1488 | private function RIFFparseWavPackHeader($wavpack3_chunk_data) { |
1483 | 1489 | |
1484 | 1490 | // typedef struct { |
@@ -2240,6 +2246,9 @@ discard block |
||
2240 | 2246 | |
2241 | 2247 | |
2242 | 2248 | |
2249 | + /** |
|
2250 | + * @param string $byte_word |
|
2251 | + */ |
|
2243 | 2252 | function BigEndian2Float($byte_word) { |
2244 | 2253 | |
2245 | 2254 | // ANSI/IEEE Standard 754-1985, Standard for Binary Floating Point Arithmetic |