@@ -260,289 +260,289 @@ discard block |
||
260 | 260 | */ |
261 | 261 | final class classObj |
262 | 262 | { |
263 | - /** |
|
264 | - * @var string |
|
265 | - */ |
|
266 | - public $group; |
|
267 | - |
|
268 | - /** |
|
269 | - * @var string |
|
270 | - */ |
|
271 | - public $keyimage; |
|
272 | - |
|
273 | - /** |
|
274 | - * Removed (6.2) - use addLabel, getLabel, ... |
|
275 | - * |
|
276 | - * @var labelObj |
|
277 | - */ |
|
278 | - public $label; |
|
279 | - |
|
280 | - /** |
|
281 | - * @var float |
|
282 | - */ |
|
283 | - public $maxscaledenom; |
|
284 | - |
|
285 | - /** |
|
286 | - * @var hashTableObj |
|
287 | - */ |
|
288 | - public $metadata; |
|
289 | - |
|
290 | - /** |
|
291 | - * @var float |
|
292 | - */ |
|
293 | - public $minscaledenom; |
|
294 | - |
|
295 | - /** |
|
296 | - * @var string |
|
297 | - */ |
|
298 | - public $name; |
|
299 | - |
|
300 | - /** |
|
301 | - * read-only (since 6.2) |
|
302 | - * |
|
303 | - * @var int |
|
304 | - */ |
|
305 | - public $numlabels; |
|
306 | - |
|
307 | - /** |
|
308 | - * read-only |
|
309 | - * |
|
310 | - * @var int |
|
311 | - */ |
|
312 | - public $numstyles; |
|
313 | - |
|
314 | - /** |
|
315 | - * MS_ON, MS_OFF or MS_DELETE |
|
316 | - * |
|
317 | - * @var int |
|
318 | - */ |
|
319 | - public $status; |
|
320 | - |
|
321 | - /** |
|
322 | - * @var string |
|
323 | - */ |
|
324 | - public $template; |
|
325 | - |
|
326 | - /** |
|
327 | - * @var string |
|
328 | - */ |
|
329 | - public $title; |
|
330 | - |
|
331 | - /** |
|
332 | - * @var int |
|
333 | - */ |
|
334 | - public $type; |
|
335 | - |
|
336 | - /** |
|
337 | - * The second argument class is optional. If given, the new class |
|
338 | - * created will be a copy of this class. |
|
339 | - * |
|
340 | - * @param layerObj $layer |
|
341 | - * @param classObj $class |
|
342 | - */ |
|
343 | - final public function __construct(layerObj $layer, classObj $class) {} |
|
344 | - |
|
345 | - /** |
|
346 | - * Old style constructor |
|
347 | - * |
|
348 | - * @param layerObj $layer |
|
349 | - * @param classObj $class |
|
350 | - * @return classObj |
|
351 | - */ |
|
352 | - final public function ms_newClassObj(layerObj $layer, classObj $class) {} |
|
353 | - |
|
354 | - /** |
|
355 | - * Add a labelObj to the classObj and return its index in the labels |
|
356 | - * array. |
|
357 | - * .. versionadded:: 6.2 |
|
358 | - * |
|
359 | - * @param labelObj $label |
|
360 | - * @return int |
|
361 | - */ |
|
362 | - final public function addLabel(labelObj $label) {} |
|
363 | - |
|
364 | - /** |
|
365 | - * Saves the object to a string. Provides the inverse option for |
|
366 | - * updateFromString. |
|
367 | - * |
|
368 | - * @return string |
|
369 | - */ |
|
370 | - final public function convertToString() {} |
|
371 | - |
|
372 | - /** |
|
373 | - * Draw the legend icon and return a new imageObj. |
|
374 | - * |
|
375 | - * @param int $width |
|
376 | - * @param int $height |
|
377 | - * @return imageObj |
|
378 | - */ |
|
379 | - final public function createLegendIcon($width, $height) {} |
|
380 | - |
|
381 | - /** |
|
382 | - * Delete the style specified by the style index. If there are any |
|
383 | - * style that follow the deleted style, their index will decrease by 1. |
|
384 | - * |
|
385 | - * @param int $index |
|
386 | - * @return int |
|
387 | - */ |
|
388 | - final public function deletestyle($index) {} |
|
389 | - |
|
390 | - /** |
|
391 | - * Draw the legend icon on im object at dstX, dstY. |
|
392 | - * Returns MS_SUCCESS/MS_FAILURE. |
|
393 | - * |
|
394 | - * @param int $width |
|
395 | - * @param int $height |
|
396 | - * @param imageObj $im |
|
397 | - * @param int $dstX |
|
398 | - * @param int $dstY |
|
399 | - * @return int |
|
400 | - */ |
|
401 | - final public function drawLegendIcon($width, $height, imageObj $im, $dstX, $dstY) {} |
|
402 | - |
|
403 | - /** |
|
404 | - * Free the object properties and break the internal references. |
|
405 | - * Note that you have to unset the php variable to free totally the |
|
406 | - * resources. |
|
407 | - * |
|
408 | - * @return void |
|
409 | - */ |
|
410 | - final public function free() {} |
|
411 | - |
|
412 | - /** |
|
413 | - * Returns the :ref:`expression <expressions>` string for the class |
|
414 | - * object. |
|
415 | - * |
|
416 | - * @return string |
|
417 | - */ |
|
418 | - final public function getExpressionString() {} |
|
419 | - |
|
420 | - /** |
|
421 | - * Return a reference to the labelObj at *index* in the labels array. |
|
422 | - * See the labelObj_ section for more details on multiple class |
|
423 | - * labels. |
|
424 | - * .. versionadded:: 6.2 |
|
425 | - * |
|
426 | - * @param int $index |
|
427 | - * @return labelObj |
|
428 | - */ |
|
429 | - final public function getLabel($index) {} |
|
430 | - |
|
431 | - /** |
|
432 | - * Fetch class metadata entry by name. Returns "" if no entry |
|
433 | - * matches the name. Note that the search is case sensitive. |
|
434 | - * .. note:: |
|
435 | - * getMetaData's query is case sensitive. |
|
436 | - * |
|
437 | - * @param string $name |
|
438 | - * @return int |
|
439 | - */ |
|
440 | - final public function getMetaData($name) {} |
|
441 | - |
|
442 | - /** |
|
443 | - * Return the style object using an index. index >= 0 && |
|
444 | - * index < class->numstyles. |
|
445 | - * |
|
446 | - * @param int $index |
|
447 | - * @return styleObj |
|
448 | - */ |
|
449 | - final public function getStyle($index) {} |
|
450 | - |
|
451 | - /** |
|
452 | - * Returns the text string for the class object. |
|
453 | - * |
|
454 | - * @return string |
|
455 | - */ |
|
456 | - final public function getTextString() {} |
|
457 | - |
|
458 | - /** |
|
459 | - * The style specified by the style index will be moved down into |
|
460 | - * the array of classes. Returns MS_SUCCESS or MS_FAILURE. |
|
461 | - * ex class->movestyledown(0) will have the effect of moving style 0 |
|
462 | - * up to position 1, and the style at position 1 will be moved |
|
463 | - * to position 0. |
|
464 | - * |
|
465 | - * @param int $index |
|
466 | - * @return int |
|
467 | - */ |
|
468 | - final public function movestyledown($index) {} |
|
469 | - |
|
470 | - /** |
|
471 | - * The style specified by the style index will be moved up into |
|
472 | - * the array of classes. Returns MS_SUCCESS or MS_FAILURE. |
|
473 | - * ex class->movestyleup(1) will have the effect of moving style 1 |
|
474 | - * up to position 0, and the style at position 0 will be moved |
|
475 | - * to position 1. |
|
476 | - * |
|
477 | - * @param int $index |
|
478 | - * @return int |
|
479 | - */ |
|
480 | - final public function movestyleup($index) {} |
|
481 | - |
|
482 | - /** |
|
483 | - * Remove the labelObj at *index* from the labels array and return a |
|
484 | - * reference to the labelObj. numlabels is decremented, and the |
|
485 | - * array is updated. |
|
486 | - * .. versionadded:: 6.2 |
|
487 | - * |
|
488 | - * @param int $index |
|
489 | - * @return labelObj |
|
490 | - */ |
|
491 | - final public function removeLabel($index) {} |
|
492 | - |
|
493 | - /** |
|
494 | - * Remove a metadata entry for the class. Returns MS_SUCCESS/MS_FAILURE. |
|
495 | - * |
|
496 | - * @param string $name |
|
497 | - * @return int |
|
498 | - */ |
|
499 | - final public function removeMetaData($name) {} |
|
500 | - |
|
501 | - /** |
|
502 | - * Set object property to a new value. |
|
503 | - * |
|
504 | - * @param string $property_name |
|
505 | - * @param $new_value |
|
506 | - * @return int |
|
507 | - */ |
|
508 | - final public function set($property_name, $new_value) {} |
|
509 | - |
|
510 | - /** |
|
511 | - * Set the :ref:`expression <expressions>` string for the class |
|
512 | - * object. |
|
513 | - * |
|
514 | - * @param string $expression |
|
515 | - * @return int |
|
516 | - */ |
|
517 | - final public function setExpression($expression) {} |
|
518 | - |
|
519 | - /** |
|
520 | - * Set a metadata entry for the class. Returns MS_SUCCESS/MS_FAILURE. |
|
521 | - * |
|
522 | - * @param string $name |
|
523 | - * @param string $value |
|
524 | - * @return int |
|
525 | - */ |
|
526 | - final public function setMetaData($name, $value) {} |
|
527 | - |
|
528 | - /** |
|
529 | - * Set the text string for the class object. |
|
530 | - * |
|
531 | - * @param string $text |
|
532 | - * @return int |
|
533 | - */ |
|
534 | - final public function settext($text) {} |
|
535 | - |
|
536 | - /** |
|
537 | - * Update a class from a string snippet. Returns MS_SUCCESS/MS_FAILURE. |
|
538 | - * .. code-block:: php |
|
539 | - * set the color |
|
540 | - * $oClass->updateFromString('CLASS STYLE COLOR 255 0 255 END END'); |
|
541 | - * |
|
542 | - * @param string $snippet |
|
543 | - * @return int |
|
544 | - */ |
|
545 | - final public function updateFromString($snippet) {} |
|
263 | + /** |
|
264 | + * @var string |
|
265 | + */ |
|
266 | + public $group; |
|
267 | + |
|
268 | + /** |
|
269 | + * @var string |
|
270 | + */ |
|
271 | + public $keyimage; |
|
272 | + |
|
273 | + /** |
|
274 | + * Removed (6.2) - use addLabel, getLabel, ... |
|
275 | + * |
|
276 | + * @var labelObj |
|
277 | + */ |
|
278 | + public $label; |
|
279 | + |
|
280 | + /** |
|
281 | + * @var float |
|
282 | + */ |
|
283 | + public $maxscaledenom; |
|
284 | + |
|
285 | + /** |
|
286 | + * @var hashTableObj |
|
287 | + */ |
|
288 | + public $metadata; |
|
289 | + |
|
290 | + /** |
|
291 | + * @var float |
|
292 | + */ |
|
293 | + public $minscaledenom; |
|
294 | + |
|
295 | + /** |
|
296 | + * @var string |
|
297 | + */ |
|
298 | + public $name; |
|
299 | + |
|
300 | + /** |
|
301 | + * read-only (since 6.2) |
|
302 | + * |
|
303 | + * @var int |
|
304 | + */ |
|
305 | + public $numlabels; |
|
306 | + |
|
307 | + /** |
|
308 | + * read-only |
|
309 | + * |
|
310 | + * @var int |
|
311 | + */ |
|
312 | + public $numstyles; |
|
313 | + |
|
314 | + /** |
|
315 | + * MS_ON, MS_OFF or MS_DELETE |
|
316 | + * |
|
317 | + * @var int |
|
318 | + */ |
|
319 | + public $status; |
|
320 | + |
|
321 | + /** |
|
322 | + * @var string |
|
323 | + */ |
|
324 | + public $template; |
|
325 | + |
|
326 | + /** |
|
327 | + * @var string |
|
328 | + */ |
|
329 | + public $title; |
|
330 | + |
|
331 | + /** |
|
332 | + * @var int |
|
333 | + */ |
|
334 | + public $type; |
|
335 | + |
|
336 | + /** |
|
337 | + * The second argument class is optional. If given, the new class |
|
338 | + * created will be a copy of this class. |
|
339 | + * |
|
340 | + * @param layerObj $layer |
|
341 | + * @param classObj $class |
|
342 | + */ |
|
343 | + final public function __construct(layerObj $layer, classObj $class) {} |
|
344 | + |
|
345 | + /** |
|
346 | + * Old style constructor |
|
347 | + * |
|
348 | + * @param layerObj $layer |
|
349 | + * @param classObj $class |
|
350 | + * @return classObj |
|
351 | + */ |
|
352 | + final public function ms_newClassObj(layerObj $layer, classObj $class) {} |
|
353 | + |
|
354 | + /** |
|
355 | + * Add a labelObj to the classObj and return its index in the labels |
|
356 | + * array. |
|
357 | + * .. versionadded:: 6.2 |
|
358 | + * |
|
359 | + * @param labelObj $label |
|
360 | + * @return int |
|
361 | + */ |
|
362 | + final public function addLabel(labelObj $label) {} |
|
363 | + |
|
364 | + /** |
|
365 | + * Saves the object to a string. Provides the inverse option for |
|
366 | + * updateFromString. |
|
367 | + * |
|
368 | + * @return string |
|
369 | + */ |
|
370 | + final public function convertToString() {} |
|
371 | + |
|
372 | + /** |
|
373 | + * Draw the legend icon and return a new imageObj. |
|
374 | + * |
|
375 | + * @param int $width |
|
376 | + * @param int $height |
|
377 | + * @return imageObj |
|
378 | + */ |
|
379 | + final public function createLegendIcon($width, $height) {} |
|
380 | + |
|
381 | + /** |
|
382 | + * Delete the style specified by the style index. If there are any |
|
383 | + * style that follow the deleted style, their index will decrease by 1. |
|
384 | + * |
|
385 | + * @param int $index |
|
386 | + * @return int |
|
387 | + */ |
|
388 | + final public function deletestyle($index) {} |
|
389 | + |
|
390 | + /** |
|
391 | + * Draw the legend icon on im object at dstX, dstY. |
|
392 | + * Returns MS_SUCCESS/MS_FAILURE. |
|
393 | + * |
|
394 | + * @param int $width |
|
395 | + * @param int $height |
|
396 | + * @param imageObj $im |
|
397 | + * @param int $dstX |
|
398 | + * @param int $dstY |
|
399 | + * @return int |
|
400 | + */ |
|
401 | + final public function drawLegendIcon($width, $height, imageObj $im, $dstX, $dstY) {} |
|
402 | + |
|
403 | + /** |
|
404 | + * Free the object properties and break the internal references. |
|
405 | + * Note that you have to unset the php variable to free totally the |
|
406 | + * resources. |
|
407 | + * |
|
408 | + * @return void |
|
409 | + */ |
|
410 | + final public function free() {} |
|
411 | + |
|
412 | + /** |
|
413 | + * Returns the :ref:`expression <expressions>` string for the class |
|
414 | + * object. |
|
415 | + * |
|
416 | + * @return string |
|
417 | + */ |
|
418 | + final public function getExpressionString() {} |
|
419 | + |
|
420 | + /** |
|
421 | + * Return a reference to the labelObj at *index* in the labels array. |
|
422 | + * See the labelObj_ section for more details on multiple class |
|
423 | + * labels. |
|
424 | + * .. versionadded:: 6.2 |
|
425 | + * |
|
426 | + * @param int $index |
|
427 | + * @return labelObj |
|
428 | + */ |
|
429 | + final public function getLabel($index) {} |
|
430 | + |
|
431 | + /** |
|
432 | + * Fetch class metadata entry by name. Returns "" if no entry |
|
433 | + * matches the name. Note that the search is case sensitive. |
|
434 | + * .. note:: |
|
435 | + * getMetaData's query is case sensitive. |
|
436 | + * |
|
437 | + * @param string $name |
|
438 | + * @return int |
|
439 | + */ |
|
440 | + final public function getMetaData($name) {} |
|
441 | + |
|
442 | + /** |
|
443 | + * Return the style object using an index. index >= 0 && |
|
444 | + * index < class->numstyles. |
|
445 | + * |
|
446 | + * @param int $index |
|
447 | + * @return styleObj |
|
448 | + */ |
|
449 | + final public function getStyle($index) {} |
|
450 | + |
|
451 | + /** |
|
452 | + * Returns the text string for the class object. |
|
453 | + * |
|
454 | + * @return string |
|
455 | + */ |
|
456 | + final public function getTextString() {} |
|
457 | + |
|
458 | + /** |
|
459 | + * The style specified by the style index will be moved down into |
|
460 | + * the array of classes. Returns MS_SUCCESS or MS_FAILURE. |
|
461 | + * ex class->movestyledown(0) will have the effect of moving style 0 |
|
462 | + * up to position 1, and the style at position 1 will be moved |
|
463 | + * to position 0. |
|
464 | + * |
|
465 | + * @param int $index |
|
466 | + * @return int |
|
467 | + */ |
|
468 | + final public function movestyledown($index) {} |
|
469 | + |
|
470 | + /** |
|
471 | + * The style specified by the style index will be moved up into |
|
472 | + * the array of classes. Returns MS_SUCCESS or MS_FAILURE. |
|
473 | + * ex class->movestyleup(1) will have the effect of moving style 1 |
|
474 | + * up to position 0, and the style at position 0 will be moved |
|
475 | + * to position 1. |
|
476 | + * |
|
477 | + * @param int $index |
|
478 | + * @return int |
|
479 | + */ |
|
480 | + final public function movestyleup($index) {} |
|
481 | + |
|
482 | + /** |
|
483 | + * Remove the labelObj at *index* from the labels array and return a |
|
484 | + * reference to the labelObj. numlabels is decremented, and the |
|
485 | + * array is updated. |
|
486 | + * .. versionadded:: 6.2 |
|
487 | + * |
|
488 | + * @param int $index |
|
489 | + * @return labelObj |
|
490 | + */ |
|
491 | + final public function removeLabel($index) {} |
|
492 | + |
|
493 | + /** |
|
494 | + * Remove a metadata entry for the class. Returns MS_SUCCESS/MS_FAILURE. |
|
495 | + * |
|
496 | + * @param string $name |
|
497 | + * @return int |
|
498 | + */ |
|
499 | + final public function removeMetaData($name) {} |
|
500 | + |
|
501 | + /** |
|
502 | + * Set object property to a new value. |
|
503 | + * |
|
504 | + * @param string $property_name |
|
505 | + * @param $new_value |
|
506 | + * @return int |
|
507 | + */ |
|
508 | + final public function set($property_name, $new_value) {} |
|
509 | + |
|
510 | + /** |
|
511 | + * Set the :ref:`expression <expressions>` string for the class |
|
512 | + * object. |
|
513 | + * |
|
514 | + * @param string $expression |
|
515 | + * @return int |
|
516 | + */ |
|
517 | + final public function setExpression($expression) {} |
|
518 | + |
|
519 | + /** |
|
520 | + * Set a metadata entry for the class. Returns MS_SUCCESS/MS_FAILURE. |
|
521 | + * |
|
522 | + * @param string $name |
|
523 | + * @param string $value |
|
524 | + * @return int |
|
525 | + */ |
|
526 | + final public function setMetaData($name, $value) {} |
|
527 | + |
|
528 | + /** |
|
529 | + * Set the text string for the class object. |
|
530 | + * |
|
531 | + * @param string $text |
|
532 | + * @return int |
|
533 | + */ |
|
534 | + final public function settext($text) {} |
|
535 | + |
|
536 | + /** |
|
537 | + * Update a class from a string snippet. Returns MS_SUCCESS/MS_FAILURE. |
|
538 | + * .. code-block:: php |
|
539 | + * set the color |
|
540 | + * $oClass->updateFromString('CLASS STYLE COLOR 255 0 255 END END'); |
|
541 | + * |
|
542 | + * @param string $snippet |
|
543 | + * @return int |
|
544 | + */ |
|
545 | + final public function updateFromString($snippet) {} |
|
546 | 546 | } |
547 | 547 | |
548 | 548 | /** |
@@ -550,60 +550,60 @@ discard block |
||
550 | 550 | */ |
551 | 551 | final class clusterObj |
552 | 552 | { |
553 | - /** |
|
554 | - * @var float |
|
555 | - */ |
|
556 | - public $buffer; |
|
557 | - |
|
558 | - /** |
|
559 | - * @var float |
|
560 | - */ |
|
561 | - public $maxdistance; |
|
562 | - |
|
563 | - /** |
|
564 | - * @var string |
|
565 | - */ |
|
566 | - public $region; |
|
567 | - |
|
568 | - /** |
|
569 | - * Saves the object to a string. Provides the inverse option for |
|
570 | - * updateFromString. |
|
571 | - * |
|
572 | - * @return string |
|
573 | - */ |
|
574 | - final public function convertToString() {} |
|
575 | - |
|
576 | - /** |
|
577 | - * Returns the :ref:`expression <expressions>` for this cluster |
|
578 | - * filter or NULL on error. |
|
579 | - * |
|
580 | - * @return string |
|
581 | - */ |
|
582 | - final public function getFilterString() {} |
|
583 | - |
|
584 | - /** |
|
585 | - * Returns the :ref:`expression <expressions>` for this cluster group |
|
586 | - * or NULL on error. |
|
587 | - * |
|
588 | - * @return string |
|
589 | - */ |
|
590 | - final public function getGroupString() {} |
|
591 | - |
|
592 | - /** |
|
593 | - * Set layer filter :ref:`expression <expressions>`. |
|
594 | - * |
|
595 | - * @param string $expression |
|
596 | - * @return int |
|
597 | - */ |
|
598 | - final public function setFilter($expression) {} |
|
599 | - |
|
600 | - /** |
|
601 | - * Set layer group :ref:`expression <expressions>`. |
|
602 | - * |
|
603 | - * @param string $expression |
|
604 | - * @return int |
|
605 | - */ |
|
606 | - final public function setGroup($expression) {} |
|
553 | + /** |
|
554 | + * @var float |
|
555 | + */ |
|
556 | + public $buffer; |
|
557 | + |
|
558 | + /** |
|
559 | + * @var float |
|
560 | + */ |
|
561 | + public $maxdistance; |
|
562 | + |
|
563 | + /** |
|
564 | + * @var string |
|
565 | + */ |
|
566 | + public $region; |
|
567 | + |
|
568 | + /** |
|
569 | + * Saves the object to a string. Provides the inverse option for |
|
570 | + * updateFromString. |
|
571 | + * |
|
572 | + * @return string |
|
573 | + */ |
|
574 | + final public function convertToString() {} |
|
575 | + |
|
576 | + /** |
|
577 | + * Returns the :ref:`expression <expressions>` for this cluster |
|
578 | + * filter or NULL on error. |
|
579 | + * |
|
580 | + * @return string |
|
581 | + */ |
|
582 | + final public function getFilterString() {} |
|
583 | + |
|
584 | + /** |
|
585 | + * Returns the :ref:`expression <expressions>` for this cluster group |
|
586 | + * or NULL on error. |
|
587 | + * |
|
588 | + * @return string |
|
589 | + */ |
|
590 | + final public function getGroupString() {} |
|
591 | + |
|
592 | + /** |
|
593 | + * Set layer filter :ref:`expression <expressions>`. |
|
594 | + * |
|
595 | + * @param string $expression |
|
596 | + * @return int |
|
597 | + */ |
|
598 | + final public function setFilter($expression) {} |
|
599 | + |
|
600 | + /** |
|
601 | + * Set layer group :ref:`expression <expressions>`. |
|
602 | + * |
|
603 | + * @param string $expression |
|
604 | + * @return int |
|
605 | + */ |
|
606 | + final public function setGroup($expression) {} |
|
607 | 607 | } |
608 | 608 | |
609 | 609 | /** |
@@ -611,62 +611,62 @@ discard block |
||
611 | 611 | */ |
612 | 612 | final class colorObj |
613 | 613 | { |
614 | - /** |
|
615 | - * @var int |
|
616 | - */ |
|
617 | - public $red; |
|
618 | - |
|
619 | - /** |
|
620 | - * @var int |
|
621 | - */ |
|
622 | - public $green; |
|
623 | - |
|
624 | - /** |
|
625 | - * @var int |
|
626 | - */ |
|
627 | - public $blue; |
|
628 | - |
|
629 | - /** |
|
630 | - * @var int |
|
631 | - */ |
|
632 | - public $alpha; |
|
633 | - |
|
634 | - /** |
|
635 | - * Get the color as a hex string "#rrggbb" or (if alpha is not 255) |
|
636 | - * "#rrggbbaa". |
|
637 | - * |
|
638 | - * @return string |
|
639 | - */ |
|
640 | - final public function toHex() {} |
|
641 | - |
|
642 | - /** |
|
643 | - * Set red, green, blue and alpha values. The hex string should have the form |
|
644 | - * "#rrggbb" (alpha will be set to 255) or "#rrggbbaa". Returns MS_SUCCESS. |
|
645 | - * |
|
646 | - * @param string $hex |
|
647 | - * @return int |
|
648 | - */ |
|
649 | - final public function setHex($hex) {} |
|
614 | + /** |
|
615 | + * @var int |
|
616 | + */ |
|
617 | + public $red; |
|
618 | + |
|
619 | + /** |
|
620 | + * @var int |
|
621 | + */ |
|
622 | + public $green; |
|
623 | + |
|
624 | + /** |
|
625 | + * @var int |
|
626 | + */ |
|
627 | + public $blue; |
|
628 | + |
|
629 | + /** |
|
630 | + * @var int |
|
631 | + */ |
|
632 | + public $alpha; |
|
633 | + |
|
634 | + /** |
|
635 | + * Get the color as a hex string "#rrggbb" or (if alpha is not 255) |
|
636 | + * "#rrggbbaa". |
|
637 | + * |
|
638 | + * @return string |
|
639 | + */ |
|
640 | + final public function toHex() {} |
|
641 | + |
|
642 | + /** |
|
643 | + * Set red, green, blue and alpha values. The hex string should have the form |
|
644 | + * "#rrggbb" (alpha will be set to 255) or "#rrggbbaa". Returns MS_SUCCESS. |
|
645 | + * |
|
646 | + * @param string $hex |
|
647 | + * @return int |
|
648 | + */ |
|
649 | + final public function setHex($hex) {} |
|
650 | 650 | } |
651 | 651 | |
652 | 652 | final class errorObj |
653 | 653 | { |
654 | - /** |
|
655 | - * //See error code constants above |
|
656 | - * |
|
657 | - * @var int |
|
658 | - */ |
|
659 | - public $code; |
|
660 | - |
|
661 | - /** |
|
662 | - * @var string |
|
663 | - */ |
|
664 | - public $message; |
|
665 | - |
|
666 | - /** |
|
667 | - * @var string |
|
668 | - */ |
|
669 | - public $routine; |
|
654 | + /** |
|
655 | + * //See error code constants above |
|
656 | + * |
|
657 | + * @var int |
|
658 | + */ |
|
659 | + public $code; |
|
660 | + |
|
661 | + /** |
|
662 | + * @var string |
|
663 | + */ |
|
664 | + public $message; |
|
665 | + |
|
666 | + /** |
|
667 | + * @var string |
|
668 | + */ |
|
669 | + public $routine; |
|
670 | 670 | } |
671 | 671 | |
672 | 672 | /** |
@@ -682,49 +682,49 @@ discard block |
||
682 | 682 | */ |
683 | 683 | final class gridObj |
684 | 684 | { |
685 | - /** |
|
686 | - * @var string |
|
687 | - */ |
|
688 | - public $labelformat; |
|
689 | - |
|
690 | - /** |
|
691 | - * @var float |
|
692 | - */ |
|
693 | - public $maxacrs; |
|
694 | - |
|
695 | - /** |
|
696 | - * @var float |
|
697 | - */ |
|
698 | - public $maxinterval; |
|
699 | - |
|
700 | - /** |
|
701 | - * @var float |
|
702 | - */ |
|
703 | - public $maxsubdivide; |
|
704 | - |
|
705 | - /** |
|
706 | - * @var float |
|
707 | - */ |
|
708 | - public $minarcs; |
|
709 | - |
|
710 | - /** |
|
711 | - * @var float |
|
712 | - */ |
|
713 | - public $mininterval; |
|
714 | - |
|
715 | - /** |
|
716 | - * @var float |
|
717 | - */ |
|
718 | - public $minsubdivide; |
|
719 | - |
|
720 | - /** |
|
721 | - * Set object property to a new value. |
|
722 | - * |
|
723 | - * @param string $property_name |
|
724 | - * @param $new_value |
|
725 | - * @return int |
|
726 | - */ |
|
727 | - final public function set($property_name, $new_value) {} |
|
685 | + /** |
|
686 | + * @var string |
|
687 | + */ |
|
688 | + public $labelformat; |
|
689 | + |
|
690 | + /** |
|
691 | + * @var float |
|
692 | + */ |
|
693 | + public $maxacrs; |
|
694 | + |
|
695 | + /** |
|
696 | + * @var float |
|
697 | + */ |
|
698 | + public $maxinterval; |
|
699 | + |
|
700 | + /** |
|
701 | + * @var float |
|
702 | + */ |
|
703 | + public $maxsubdivide; |
|
704 | + |
|
705 | + /** |
|
706 | + * @var float |
|
707 | + */ |
|
708 | + public $minarcs; |
|
709 | + |
|
710 | + /** |
|
711 | + * @var float |
|
712 | + */ |
|
713 | + public $mininterval; |
|
714 | + |
|
715 | + /** |
|
716 | + * @var float |
|
717 | + */ |
|
718 | + public $minsubdivide; |
|
719 | + |
|
720 | + /** |
|
721 | + * Set object property to a new value. |
|
722 | + * |
|
723 | + * @param string $property_name |
|
724 | + * @param $new_value |
|
725 | + * @return int |
|
726 | + */ |
|
727 | + final public function set($property_name, $new_value) {} |
|
728 | 728 | } |
729 | 729 | |
730 | 730 | /** |
@@ -737,48 +737,48 @@ discard block |
||
737 | 737 | */ |
738 | 738 | final class hashTableObj |
739 | 739 | { |
740 | - /** |
|
741 | - * Clear all items in the hashTable (To NULL). |
|
742 | - * |
|
743 | - * @return void |
|
744 | - */ |
|
745 | - final public function clear() {} |
|
746 | - |
|
747 | - /** |
|
748 | - * Fetch class metadata entry by name. Returns "" if no entry |
|
749 | - * matches the name. Note that the search is case sensitive. |
|
750 | - * |
|
751 | - * @param string $key |
|
752 | - * @return string |
|
753 | - */ |
|
754 | - final public function get($key) {} |
|
755 | - |
|
756 | - /** |
|
757 | - * Return the next key or first key if previousKey = NULL. |
|
758 | - * Return NULL if no item is in the hashTable or end of hashTable is |
|
759 | - * reached |
|
760 | - * |
|
761 | - * @param string $previousKey |
|
762 | - * @return string |
|
763 | - */ |
|
764 | - final public function nextkey($previousKey) {} |
|
765 | - |
|
766 | - /** |
|
767 | - * Remove a metadata entry in the hashTable. Returns MS_SUCCESS/MS_FAILURE. |
|
768 | - * |
|
769 | - * @param string $key |
|
770 | - * @return int |
|
771 | - */ |
|
772 | - final public function remove($key) {} |
|
773 | - |
|
774 | - /** |
|
775 | - * Set a metadata entry in the hashTable. Returns MS_SUCCESS/MS_FAILURE. |
|
776 | - * |
|
777 | - * @param string $key |
|
778 | - * @param string $value |
|
779 | - * @return int |
|
780 | - */ |
|
781 | - final public function set($key, $value) {} |
|
740 | + /** |
|
741 | + * Clear all items in the hashTable (To NULL). |
|
742 | + * |
|
743 | + * @return void |
|
744 | + */ |
|
745 | + final public function clear() {} |
|
746 | + |
|
747 | + /** |
|
748 | + * Fetch class metadata entry by name. Returns "" if no entry |
|
749 | + * matches the name. Note that the search is case sensitive. |
|
750 | + * |
|
751 | + * @param string $key |
|
752 | + * @return string |
|
753 | + */ |
|
754 | + final public function get($key) {} |
|
755 | + |
|
756 | + /** |
|
757 | + * Return the next key or first key if previousKey = NULL. |
|
758 | + * Return NULL if no item is in the hashTable or end of hashTable is |
|
759 | + * reached |
|
760 | + * |
|
761 | + * @param string $previousKey |
|
762 | + * @return string |
|
763 | + */ |
|
764 | + final public function nextkey($previousKey) {} |
|
765 | + |
|
766 | + /** |
|
767 | + * Remove a metadata entry in the hashTable. Returns MS_SUCCESS/MS_FAILURE. |
|
768 | + * |
|
769 | + * @param string $key |
|
770 | + * @return int |
|
771 | + */ |
|
772 | + final public function remove($key) {} |
|
773 | + |
|
774 | + /** |
|
775 | + * Set a metadata entry in the hashTable. Returns MS_SUCCESS/MS_FAILURE. |
|
776 | + * |
|
777 | + * @param string $key |
|
778 | + * @param string $value |
|
779 | + * @return int |
|
780 | + */ |
|
781 | + final public function set($key, $value) {} |
|
782 | 782 | } |
783 | 783 | |
784 | 784 | /** |
@@ -786,170 +786,170 @@ discard block |
||
786 | 786 | */ |
787 | 787 | final class imageObj |
788 | 788 | { |
789 | - /** |
|
790 | - * read-only |
|
791 | - * |
|
792 | - * @var int |
|
793 | - */ |
|
794 | - public $width; |
|
795 | - |
|
796 | - /** |
|
797 | - * read-only |
|
798 | - * |
|
799 | - * @var int |
|
800 | - */ |
|
801 | - public $height; |
|
802 | - |
|
803 | - /** |
|
804 | - * read-only |
|
805 | - * |
|
806 | - * @var int |
|
807 | - */ |
|
808 | - public $resolution; |
|
809 | - |
|
810 | - /** |
|
811 | - * read-only |
|
812 | - * |
|
813 | - * @var int |
|
814 | - */ |
|
815 | - public $resolutionfactor; |
|
816 | - |
|
817 | - /** |
|
818 | - * @var string |
|
819 | - */ |
|
820 | - public $imagepath; |
|
821 | - |
|
822 | - /** |
|
823 | - * @var string |
|
824 | - */ |
|
825 | - public $imageurl; |
|
826 | - |
|
827 | - /** |
|
828 | - * Copy srcImg on top of the current imageObj. |
|
829 | - * transparentColorHex is the color (in 0xrrggbb format) from srcImg |
|
830 | - * that should be considered transparent (i.e. those pixels won't |
|
831 | - * be copied). Pass -1 if you don't want any transparent color. |
|
832 | - * If optional dstx,dsty are provided then it defines the position |
|
833 | - * where the image should be copied (dstx,dsty = top-left corner |
|
834 | - * position). |
|
835 | - * The optional angle is a value between 0 and 360 degrees to rotate |
|
836 | - * the source image counterclockwise. Note that if an angle is specified |
|
837 | - * (even if its value is zero) then the dstx and dsty coordinates |
|
838 | - * specify the CENTER of the destination area. |
|
839 | - * Note: this function works only with 8 bits GD images (PNG or GIF). |
|
840 | - * |
|
841 | - * @param imageObj $srcImg |
|
842 | - * @param int $transparentColorHex |
|
843 | - * @param int $dstX |
|
844 | - * @param int $dstY |
|
845 | - * @param int $angle |
|
846 | - * @return void |
|
847 | - */ |
|
848 | - final public function pasteImage(imageObj $srcImg, $transparentColorHex, $dstX, $dstY, $angle) {} |
|
849 | - |
|
850 | - /** |
|
851 | - * Writes image object to specified filename. |
|
852 | - * Passing no filename or an empty filename sends output to stdout. In |
|
853 | - * this case, the PHP header() function should be used to set the |
|
854 | - * document's content-type prior to calling saveImage(). The output |
|
855 | - * format is the one that is currently selected in the map file. The |
|
856 | - * second argument oMap is not manadatory. It is usful when saving to |
|
857 | - * formats like GTIFF that needs georeference information contained in |
|
858 | - * the map file. On success, it returns either MS_SUCCESS if writing to an |
|
859 | - * external file, or the number of bytes written if output is sent to |
|
860 | - * stdout. |
|
861 | - * |
|
862 | - * @param string $filename |
|
863 | - * @param mapObj $oMap |
|
864 | - * @return int |
|
865 | - */ |
|
866 | - final public function saveImage($filename, mapObj $oMap) {} |
|
867 | - |
|
868 | - /** |
|
869 | - * Writes image to temp directory. Returns image URL. |
|
870 | - * The output format is the one that is currently selected in the |
|
871 | - * map file. |
|
872 | - * |
|
873 | - * @return string |
|
874 | - */ |
|
875 | - final public function saveWebImage() {} |
|
789 | + /** |
|
790 | + * read-only |
|
791 | + * |
|
792 | + * @var int |
|
793 | + */ |
|
794 | + public $width; |
|
795 | + |
|
796 | + /** |
|
797 | + * read-only |
|
798 | + * |
|
799 | + * @var int |
|
800 | + */ |
|
801 | + public $height; |
|
802 | + |
|
803 | + /** |
|
804 | + * read-only |
|
805 | + * |
|
806 | + * @var int |
|
807 | + */ |
|
808 | + public $resolution; |
|
809 | + |
|
810 | + /** |
|
811 | + * read-only |
|
812 | + * |
|
813 | + * @var int |
|
814 | + */ |
|
815 | + public $resolutionfactor; |
|
816 | + |
|
817 | + /** |
|
818 | + * @var string |
|
819 | + */ |
|
820 | + public $imagepath; |
|
821 | + |
|
822 | + /** |
|
823 | + * @var string |
|
824 | + */ |
|
825 | + public $imageurl; |
|
826 | + |
|
827 | + /** |
|
828 | + * Copy srcImg on top of the current imageObj. |
|
829 | + * transparentColorHex is the color (in 0xrrggbb format) from srcImg |
|
830 | + * that should be considered transparent (i.e. those pixels won't |
|
831 | + * be copied). Pass -1 if you don't want any transparent color. |
|
832 | + * If optional dstx,dsty are provided then it defines the position |
|
833 | + * where the image should be copied (dstx,dsty = top-left corner |
|
834 | + * position). |
|
835 | + * The optional angle is a value between 0 and 360 degrees to rotate |
|
836 | + * the source image counterclockwise. Note that if an angle is specified |
|
837 | + * (even if its value is zero) then the dstx and dsty coordinates |
|
838 | + * specify the CENTER of the destination area. |
|
839 | + * Note: this function works only with 8 bits GD images (PNG or GIF). |
|
840 | + * |
|
841 | + * @param imageObj $srcImg |
|
842 | + * @param int $transparentColorHex |
|
843 | + * @param int $dstX |
|
844 | + * @param int $dstY |
|
845 | + * @param int $angle |
|
846 | + * @return void |
|
847 | + */ |
|
848 | + final public function pasteImage(imageObj $srcImg, $transparentColorHex, $dstX, $dstY, $angle) {} |
|
849 | + |
|
850 | + /** |
|
851 | + * Writes image object to specified filename. |
|
852 | + * Passing no filename or an empty filename sends output to stdout. In |
|
853 | + * this case, the PHP header() function should be used to set the |
|
854 | + * document's content-type prior to calling saveImage(). The output |
|
855 | + * format is the one that is currently selected in the map file. The |
|
856 | + * second argument oMap is not manadatory. It is usful when saving to |
|
857 | + * formats like GTIFF that needs georeference information contained in |
|
858 | + * the map file. On success, it returns either MS_SUCCESS if writing to an |
|
859 | + * external file, or the number of bytes written if output is sent to |
|
860 | + * stdout. |
|
861 | + * |
|
862 | + * @param string $filename |
|
863 | + * @param mapObj $oMap |
|
864 | + * @return int |
|
865 | + */ |
|
866 | + final public function saveImage($filename, mapObj $oMap) {} |
|
867 | + |
|
868 | + /** |
|
869 | + * Writes image to temp directory. Returns image URL. |
|
870 | + * The output format is the one that is currently selected in the |
|
871 | + * map file. |
|
872 | + * |
|
873 | + * @return string |
|
874 | + */ |
|
875 | + final public function saveWebImage() {} |
|
876 | 876 | } |
877 | 877 | |
878 | 878 | final class labelcacheMemberObj |
879 | 879 | { |
880 | - /** |
|
881 | - * read-only |
|
882 | - * |
|
883 | - * @var int |
|
884 | - */ |
|
885 | - public $classindex; |
|
886 | - |
|
887 | - /** |
|
888 | - * read-only |
|
889 | - * |
|
890 | - * @var int |
|
891 | - */ |
|
892 | - public $featuresize; |
|
893 | - |
|
894 | - /** |
|
895 | - * read-only |
|
896 | - * |
|
897 | - * @var int |
|
898 | - */ |
|
899 | - public $layerindex; |
|
900 | - |
|
901 | - /** |
|
902 | - * read-only |
|
903 | - * |
|
904 | - * @var int |
|
905 | - */ |
|
906 | - public $markerid; |
|
907 | - |
|
908 | - /** |
|
909 | - * read-only |
|
910 | - * |
|
911 | - * @var int |
|
912 | - */ |
|
913 | - public $numstyles; |
|
914 | - |
|
915 | - /** |
|
916 | - * read-only |
|
917 | - * |
|
918 | - * @var int |
|
919 | - */ |
|
920 | - public $shapeindex; |
|
921 | - |
|
922 | - /** |
|
923 | - * read-only |
|
924 | - * |
|
925 | - * @var int |
|
926 | - */ |
|
927 | - public $status; |
|
928 | - |
|
929 | - /** |
|
930 | - * read-only |
|
931 | - * |
|
932 | - * @var string |
|
933 | - */ |
|
934 | - public $text; |
|
935 | - |
|
936 | - /** |
|
937 | - * read-only |
|
938 | - * |
|
939 | - * @var int |
|
940 | - */ |
|
941 | - public $tileindex; |
|
880 | + /** |
|
881 | + * read-only |
|
882 | + * |
|
883 | + * @var int |
|
884 | + */ |
|
885 | + public $classindex; |
|
886 | + |
|
887 | + /** |
|
888 | + * read-only |
|
889 | + * |
|
890 | + * @var int |
|
891 | + */ |
|
892 | + public $featuresize; |
|
893 | + |
|
894 | + /** |
|
895 | + * read-only |
|
896 | + * |
|
897 | + * @var int |
|
898 | + */ |
|
899 | + public $layerindex; |
|
900 | + |
|
901 | + /** |
|
902 | + * read-only |
|
903 | + * |
|
904 | + * @var int |
|
905 | + */ |
|
906 | + public $markerid; |
|
907 | + |
|
908 | + /** |
|
909 | + * read-only |
|
910 | + * |
|
911 | + * @var int |
|
912 | + */ |
|
913 | + public $numstyles; |
|
914 | + |
|
915 | + /** |
|
916 | + * read-only |
|
917 | + * |
|
918 | + * @var int |
|
919 | + */ |
|
920 | + public $shapeindex; |
|
921 | + |
|
922 | + /** |
|
923 | + * read-only |
|
924 | + * |
|
925 | + * @var int |
|
926 | + */ |
|
927 | + public $status; |
|
928 | + |
|
929 | + /** |
|
930 | + * read-only |
|
931 | + * |
|
932 | + * @var string |
|
933 | + */ |
|
934 | + public $text; |
|
935 | + |
|
936 | + /** |
|
937 | + * read-only |
|
938 | + * |
|
939 | + * @var int |
|
940 | + */ |
|
941 | + public $tileindex; |
|
942 | 942 | } |
943 | 943 | |
944 | 944 | final class labelcacheObj |
945 | 945 | { |
946 | - /** |
|
947 | - * Free the label cache. Always returns MS_SUCCESS. |
|
948 | - * Ex : map->labelcache->freeCache(); |
|
949 | - * |
|
950 | - * @return bool |
|
951 | - */ |
|
952 | - final public function freeCache() {} |
|
946 | + /** |
|
947 | + * Free the label cache. Always returns MS_SUCCESS. |
|
948 | + * Ex : map->labelcache->freeCache(); |
|
949 | + * |
|
950 | + * @return bool |
|
951 | + */ |
|
952 | + final public function freeCache() {} |
|
953 | 953 | } |
954 | 954 | |
955 | 955 | /** |
@@ -957,329 +957,329 @@ discard block |
||
957 | 957 | */ |
958 | 958 | final class labelObj |
959 | 959 | { |
960 | - /** |
|
961 | - * @var int |
|
962 | - */ |
|
963 | - public $align; |
|
964 | - |
|
965 | - /** |
|
966 | - * @var float |
|
967 | - */ |
|
968 | - public $angle; |
|
969 | - |
|
970 | - /** |
|
971 | - * @var int |
|
972 | - */ |
|
973 | - public $anglemode; |
|
974 | - |
|
975 | - /** |
|
976 | - * @var int |
|
977 | - */ |
|
978 | - public $antialias; |
|
979 | - |
|
980 | - /** |
|
981 | - * @var int |
|
982 | - */ |
|
983 | - public $autominfeaturesize; |
|
984 | - |
|
985 | - /** |
|
986 | - * (deprecated since 6.0) |
|
987 | - * |
|
988 | - * @var colorObj |
|
989 | - */ |
|
990 | - public $backgroundcolor; |
|
991 | - |
|
992 | - /** |
|
993 | - * (deprecated since 6.0) |
|
994 | - * |
|
995 | - * @var colorObj |
|
996 | - */ |
|
997 | - public $backgroundshadowcolor; |
|
998 | - |
|
999 | - /** |
|
1000 | - * (deprecated since 6.0) |
|
1001 | - * |
|
1002 | - * @var int |
|
1003 | - */ |
|
1004 | - public $backgroundshadowsizex; |
|
1005 | - |
|
1006 | - /** |
|
1007 | - * (deprecated since 6.0) |
|
1008 | - * |
|
1009 | - * @var int |
|
1010 | - */ |
|
1011 | - public $backgroundshadowsizey; |
|
1012 | - |
|
1013 | - /** |
|
1014 | - * @var int |
|
1015 | - */ |
|
1016 | - public $buffer; |
|
1017 | - |
|
1018 | - /** |
|
1019 | - * @var colorObj |
|
1020 | - */ |
|
1021 | - public $color; |
|
1022 | - |
|
1023 | - /** |
|
1024 | - * @var string |
|
1025 | - */ |
|
1026 | - public $encoding; |
|
1027 | - |
|
1028 | - /** |
|
1029 | - * @var string |
|
1030 | - */ |
|
1031 | - public $font; |
|
1032 | - |
|
1033 | - /** |
|
1034 | - * @var int |
|
1035 | - */ |
|
1036 | - public $force; |
|
1037 | - |
|
1038 | - /** |
|
1039 | - * @var int |
|
1040 | - */ |
|
1041 | - public $maxlength; |
|
1042 | - |
|
1043 | - /** |
|
1044 | - * @var int |
|
1045 | - */ |
|
1046 | - public $maxsize; |
|
1047 | - |
|
1048 | - /** |
|
1049 | - * @var int |
|
1050 | - */ |
|
1051 | - public $mindistance; |
|
1052 | - |
|
1053 | - /** |
|
1054 | - * @var int |
|
1055 | - */ |
|
1056 | - public $minfeaturesize; |
|
1057 | - |
|
1058 | - /** |
|
1059 | - * @var int |
|
1060 | - */ |
|
1061 | - public $minlength; |
|
1062 | - |
|
1063 | - /** |
|
1064 | - * @var int |
|
1065 | - */ |
|
1066 | - public $minsize; |
|
1067 | - |
|
1068 | - /** |
|
1069 | - * @var int |
|
1070 | - */ |
|
1071 | - public $numstyles; |
|
1072 | - |
|
1073 | - /** |
|
1074 | - * @var int |
|
1075 | - */ |
|
1076 | - public $offsetx; |
|
1077 | - |
|
1078 | - /** |
|
1079 | - * @var int |
|
1080 | - */ |
|
1081 | - public $offsety; |
|
1082 | - |
|
1083 | - /** |
|
1084 | - * @var colorObj |
|
1085 | - */ |
|
1086 | - public $outlinecolor; |
|
1087 | - |
|
1088 | - /** |
|
1089 | - * @var int |
|
1090 | - */ |
|
1091 | - public $outlinewidth; |
|
1092 | - |
|
1093 | - /** |
|
1094 | - * @var int |
|
1095 | - */ |
|
1096 | - public $partials; |
|
1097 | - |
|
1098 | - /** |
|
1099 | - * @var int |
|
1100 | - */ |
|
1101 | - public $position; |
|
1102 | - |
|
1103 | - /** |
|
1104 | - * @var int |
|
1105 | - */ |
|
1106 | - public $priority; |
|
1107 | - |
|
1108 | - /** |
|
1109 | - * @var int |
|
1110 | - */ |
|
1111 | - public $repeatdistance; |
|
1112 | - |
|
1113 | - /** |
|
1114 | - * @var colorObj |
|
1115 | - */ |
|
1116 | - public $shadowcolor; |
|
1117 | - |
|
1118 | - /** |
|
1119 | - * @var int |
|
1120 | - */ |
|
1121 | - public $shadowsizex; |
|
1122 | - |
|
1123 | - /** |
|
1124 | - * @var int |
|
1125 | - */ |
|
1126 | - public $shadowsizey; |
|
1127 | - |
|
1128 | - /** |
|
1129 | - * @var int |
|
1130 | - */ |
|
1131 | - public $size; |
|
1132 | - |
|
1133 | - /** |
|
1134 | - * @var int |
|
1135 | - */ |
|
1136 | - public $wrap; |
|
1137 | - |
|
1138 | - final public function __construct() {} |
|
1139 | - |
|
1140 | - /** |
|
1141 | - * Saves the object to a string. Provides the inverse option for |
|
1142 | - * updateFromString. |
|
1143 | - * |
|
1144 | - * @return string |
|
1145 | - */ |
|
1146 | - final public function convertToString() {} |
|
1147 | - |
|
1148 | - /** |
|
1149 | - * Delete the style specified by the style index. If there are any |
|
1150 | - * style that follow the deleted style, their index will decrease by 1. |
|
1151 | - * |
|
1152 | - * @param int $index |
|
1153 | - * @return int |
|
1154 | - */ |
|
1155 | - final public function deleteStyle($index) {} |
|
1156 | - |
|
1157 | - /** |
|
1158 | - * Free the object properties and break the internal references. |
|
1159 | - * Note that you have to unset the php variable to free totally the |
|
1160 | - * resources. |
|
1161 | - * |
|
1162 | - * @return void |
|
1163 | - */ |
|
1164 | - final public function free() {} |
|
1165 | - |
|
1166 | - /** |
|
1167 | - * Get the attribute binding for a specified label property. Returns |
|
1168 | - * NULL if there is no binding for this property. |
|
1169 | - * Example: |
|
1170 | - * .. code-block:: php |
|
1171 | - * $oLabel->setbinding(MS_LABEL_BINDING_COLOR, "FIELD_NAME_COLOR"); |
|
1172 | - * echo $oLabel->getbinding(MS_LABEL_BINDING_COLOR); // FIELD_NAME_COLOR |
|
1173 | - * |
|
1174 | - * @param mixed $labelbinding |
|
1175 | - * @return string |
|
1176 | - */ |
|
1177 | - final public function getBinding($labelbinding) {} |
|
1178 | - |
|
1179 | - /** |
|
1180 | - * Returns the label expression string. |
|
1181 | - * |
|
1182 | - * @return string |
|
1183 | - */ |
|
1184 | - final public function getExpressionString() {} |
|
1185 | - |
|
1186 | - /** |
|
1187 | - * Return the style object using an index. index >= 0 && |
|
1188 | - * index < label->numstyles. |
|
1189 | - * |
|
1190 | - * @param int $index |
|
1191 | - * @return styleObj |
|
1192 | - */ |
|
1193 | - final public function getStyle($index) {} |
|
1194 | - |
|
1195 | - /** |
|
1196 | - * Returns the label text string. |
|
1197 | - * |
|
1198 | - * @return string |
|
1199 | - */ |
|
1200 | - final public function getTextString() {} |
|
1201 | - |
|
1202 | - /** |
|
1203 | - * The style specified by the style index will be moved down into |
|
1204 | - * the array of classes. Returns MS_SUCCESS or MS_FAILURE. |
|
1205 | - * ex label->movestyledown(0) will have the effect of moving style 0 |
|
1206 | - * up to position 1, and the style at position 1 will be moved |
|
1207 | - * to position 0. |
|
1208 | - * |
|
1209 | - * @param int $index |
|
1210 | - * @return int |
|
1211 | - */ |
|
1212 | - final public function moveStyleDown($index) {} |
|
1213 | - |
|
1214 | - /** |
|
1215 | - * The style specified by the style index will be moved up into |
|
1216 | - * the array of classes. Returns MS_SUCCESS or MS_FAILURE. |
|
1217 | - * ex label->movestyleup(1) will have the effect of moving style 1 |
|
1218 | - * up to position 0, and the style at position 0 will be moved |
|
1219 | - * to position 1. |
|
1220 | - * |
|
1221 | - * @param int $index |
|
1222 | - * @return int |
|
1223 | - */ |
|
1224 | - final public function moveStyleUp($index) {} |
|
1225 | - |
|
1226 | - /** |
|
1227 | - * Remove the attribute binding for a specfiled style property. |
|
1228 | - * Example: |
|
1229 | - * .. code-block:: php |
|
1230 | - * $oStyle->removebinding(MS_LABEL_BINDING_COLOR); |
|
1231 | - * |
|
1232 | - * @param mixed $labelbinding |
|
1233 | - * @return int |
|
1234 | - */ |
|
1235 | - final public function removeBinding($labelbinding) {} |
|
1236 | - |
|
1237 | - /** |
|
1238 | - * Set object property to a new value. |
|
1239 | - * |
|
1240 | - * @param string $property_name |
|
1241 | - * @param $new_value |
|
1242 | - * @return int |
|
1243 | - */ |
|
1244 | - final public function set($property_name, $new_value) {} |
|
1245 | - |
|
1246 | - /** |
|
1247 | - * Set the attribute binding for a specified label property. |
|
1248 | - * Example: |
|
1249 | - * .. code-block:: php |
|
1250 | - * $oLabel->setbinding(MS_LABEL_BINDING_COLOR, "FIELD_NAME_COLOR"); |
|
1251 | - * This would bind the color parameter with the data (ie will extract |
|
1252 | - * the value of the color from the field called "FIELD_NAME_COLOR" |
|
1253 | - * |
|
1254 | - * @param mixed $labelbinding |
|
1255 | - * @param string $value |
|
1256 | - * @return int |
|
1257 | - */ |
|
1258 | - final public function setBinding($labelbinding, $value) {} |
|
1259 | - |
|
1260 | - /** |
|
1261 | - * Set the label expression. |
|
1262 | - * |
|
1263 | - * @param string $expression |
|
1264 | - * @return int |
|
1265 | - */ |
|
1266 | - final public function setExpression($expression) {} |
|
1267 | - |
|
1268 | - /** |
|
1269 | - * Set the label text. |
|
1270 | - * |
|
1271 | - * @param string $text |
|
1272 | - * @return int |
|
1273 | - */ |
|
1274 | - final public function setText($text) {} |
|
1275 | - |
|
1276 | - /** |
|
1277 | - * Update a label from a string snippet. Returns MS_SUCCESS/MS_FAILURE. |
|
1278 | - * |
|
1279 | - * @param string $snippet |
|
1280 | - * @return int |
|
1281 | - */ |
|
1282 | - final public function updateFromString($snippet) {} |
|
960 | + /** |
|
961 | + * @var int |
|
962 | + */ |
|
963 | + public $align; |
|
964 | + |
|
965 | + /** |
|
966 | + * @var float |
|
967 | + */ |
|
968 | + public $angle; |
|
969 | + |
|
970 | + /** |
|
971 | + * @var int |
|
972 | + */ |
|
973 | + public $anglemode; |
|
974 | + |
|
975 | + /** |
|
976 | + * @var int |
|
977 | + */ |
|
978 | + public $antialias; |
|
979 | + |
|
980 | + /** |
|
981 | + * @var int |
|
982 | + */ |
|
983 | + public $autominfeaturesize; |
|
984 | + |
|
985 | + /** |
|
986 | + * (deprecated since 6.0) |
|
987 | + * |
|
988 | + * @var colorObj |
|
989 | + */ |
|
990 | + public $backgroundcolor; |
|
991 | + |
|
992 | + /** |
|
993 | + * (deprecated since 6.0) |
|
994 | + * |
|
995 | + * @var colorObj |
|
996 | + */ |
|
997 | + public $backgroundshadowcolor; |
|
998 | + |
|
999 | + /** |
|
1000 | + * (deprecated since 6.0) |
|
1001 | + * |
|
1002 | + * @var int |
|
1003 | + */ |
|
1004 | + public $backgroundshadowsizex; |
|
1005 | + |
|
1006 | + /** |
|
1007 | + * (deprecated since 6.0) |
|
1008 | + * |
|
1009 | + * @var int |
|
1010 | + */ |
|
1011 | + public $backgroundshadowsizey; |
|
1012 | + |
|
1013 | + /** |
|
1014 | + * @var int |
|
1015 | + */ |
|
1016 | + public $buffer; |
|
1017 | + |
|
1018 | + /** |
|
1019 | + * @var colorObj |
|
1020 | + */ |
|
1021 | + public $color; |
|
1022 | + |
|
1023 | + /** |
|
1024 | + * @var string |
|
1025 | + */ |
|
1026 | + public $encoding; |
|
1027 | + |
|
1028 | + /** |
|
1029 | + * @var string |
|
1030 | + */ |
|
1031 | + public $font; |
|
1032 | + |
|
1033 | + /** |
|
1034 | + * @var int |
|
1035 | + */ |
|
1036 | + public $force; |
|
1037 | + |
|
1038 | + /** |
|
1039 | + * @var int |
|
1040 | + */ |
|
1041 | + public $maxlength; |
|
1042 | + |
|
1043 | + /** |
|
1044 | + * @var int |
|
1045 | + */ |
|
1046 | + public $maxsize; |
|
1047 | + |
|
1048 | + /** |
|
1049 | + * @var int |
|
1050 | + */ |
|
1051 | + public $mindistance; |
|
1052 | + |
|
1053 | + /** |
|
1054 | + * @var int |
|
1055 | + */ |
|
1056 | + public $minfeaturesize; |
|
1057 | + |
|
1058 | + /** |
|
1059 | + * @var int |
|
1060 | + */ |
|
1061 | + public $minlength; |
|
1062 | + |
|
1063 | + /** |
|
1064 | + * @var int |
|
1065 | + */ |
|
1066 | + public $minsize; |
|
1067 | + |
|
1068 | + /** |
|
1069 | + * @var int |
|
1070 | + */ |
|
1071 | + public $numstyles; |
|
1072 | + |
|
1073 | + /** |
|
1074 | + * @var int |
|
1075 | + */ |
|
1076 | + public $offsetx; |
|
1077 | + |
|
1078 | + /** |
|
1079 | + * @var int |
|
1080 | + */ |
|
1081 | + public $offsety; |
|
1082 | + |
|
1083 | + /** |
|
1084 | + * @var colorObj |
|
1085 | + */ |
|
1086 | + public $outlinecolor; |
|
1087 | + |
|
1088 | + /** |
|
1089 | + * @var int |
|
1090 | + */ |
|
1091 | + public $outlinewidth; |
|
1092 | + |
|
1093 | + /** |
|
1094 | + * @var int |
|
1095 | + */ |
|
1096 | + public $partials; |
|
1097 | + |
|
1098 | + /** |
|
1099 | + * @var int |
|
1100 | + */ |
|
1101 | + public $position; |
|
1102 | + |
|
1103 | + /** |
|
1104 | + * @var int |
|
1105 | + */ |
|
1106 | + public $priority; |
|
1107 | + |
|
1108 | + /** |
|
1109 | + * @var int |
|
1110 | + */ |
|
1111 | + public $repeatdistance; |
|
1112 | + |
|
1113 | + /** |
|
1114 | + * @var colorObj |
|
1115 | + */ |
|
1116 | + public $shadowcolor; |
|
1117 | + |
|
1118 | + /** |
|
1119 | + * @var int |
|
1120 | + */ |
|
1121 | + public $shadowsizex; |
|
1122 | + |
|
1123 | + /** |
|
1124 | + * @var int |
|
1125 | + */ |
|
1126 | + public $shadowsizey; |
|
1127 | + |
|
1128 | + /** |
|
1129 | + * @var int |
|
1130 | + */ |
|
1131 | + public $size; |
|
1132 | + |
|
1133 | + /** |
|
1134 | + * @var int |
|
1135 | + */ |
|
1136 | + public $wrap; |
|
1137 | + |
|
1138 | + final public function __construct() {} |
|
1139 | + |
|
1140 | + /** |
|
1141 | + * Saves the object to a string. Provides the inverse option for |
|
1142 | + * updateFromString. |
|
1143 | + * |
|
1144 | + * @return string |
|
1145 | + */ |
|
1146 | + final public function convertToString() {} |
|
1147 | + |
|
1148 | + /** |
|
1149 | + * Delete the style specified by the style index. If there are any |
|
1150 | + * style that follow the deleted style, their index will decrease by 1. |
|
1151 | + * |
|
1152 | + * @param int $index |
|
1153 | + * @return int |
|
1154 | + */ |
|
1155 | + final public function deleteStyle($index) {} |
|
1156 | + |
|
1157 | + /** |
|
1158 | + * Free the object properties and break the internal references. |
|
1159 | + * Note that you have to unset the php variable to free totally the |
|
1160 | + * resources. |
|
1161 | + * |
|
1162 | + * @return void |
|
1163 | + */ |
|
1164 | + final public function free() {} |
|
1165 | + |
|
1166 | + /** |
|
1167 | + * Get the attribute binding for a specified label property. Returns |
|
1168 | + * NULL if there is no binding for this property. |
|
1169 | + * Example: |
|
1170 | + * .. code-block:: php |
|
1171 | + * $oLabel->setbinding(MS_LABEL_BINDING_COLOR, "FIELD_NAME_COLOR"); |
|
1172 | + * echo $oLabel->getbinding(MS_LABEL_BINDING_COLOR); // FIELD_NAME_COLOR |
|
1173 | + * |
|
1174 | + * @param mixed $labelbinding |
|
1175 | + * @return string |
|
1176 | + */ |
|
1177 | + final public function getBinding($labelbinding) {} |
|
1178 | + |
|
1179 | + /** |
|
1180 | + * Returns the label expression string. |
|
1181 | + * |
|
1182 | + * @return string |
|
1183 | + */ |
|
1184 | + final public function getExpressionString() {} |
|
1185 | + |
|
1186 | + /** |
|
1187 | + * Return the style object using an index. index >= 0 && |
|
1188 | + * index < label->numstyles. |
|
1189 | + * |
|
1190 | + * @param int $index |
|
1191 | + * @return styleObj |
|
1192 | + */ |
|
1193 | + final public function getStyle($index) {} |
|
1194 | + |
|
1195 | + /** |
|
1196 | + * Returns the label text string. |
|
1197 | + * |
|
1198 | + * @return string |
|
1199 | + */ |
|
1200 | + final public function getTextString() {} |
|
1201 | + |
|
1202 | + /** |
|
1203 | + * The style specified by the style index will be moved down into |
|
1204 | + * the array of classes. Returns MS_SUCCESS or MS_FAILURE. |
|
1205 | + * ex label->movestyledown(0) will have the effect of moving style 0 |
|
1206 | + * up to position 1, and the style at position 1 will be moved |
|
1207 | + * to position 0. |
|
1208 | + * |
|
1209 | + * @param int $index |
|
1210 | + * @return int |
|
1211 | + */ |
|
1212 | + final public function moveStyleDown($index) {} |
|
1213 | + |
|
1214 | + /** |
|
1215 | + * The style specified by the style index will be moved up into |
|
1216 | + * the array of classes. Returns MS_SUCCESS or MS_FAILURE. |
|
1217 | + * ex label->movestyleup(1) will have the effect of moving style 1 |
|
1218 | + * up to position 0, and the style at position 0 will be moved |
|
1219 | + * to position 1. |
|
1220 | + * |
|
1221 | + * @param int $index |
|
1222 | + * @return int |
|
1223 | + */ |
|
1224 | + final public function moveStyleUp($index) {} |
|
1225 | + |
|
1226 | + /** |
|
1227 | + * Remove the attribute binding for a specfiled style property. |
|
1228 | + * Example: |
|
1229 | + * .. code-block:: php |
|
1230 | + * $oStyle->removebinding(MS_LABEL_BINDING_COLOR); |
|
1231 | + * |
|
1232 | + * @param mixed $labelbinding |
|
1233 | + * @return int |
|
1234 | + */ |
|
1235 | + final public function removeBinding($labelbinding) {} |
|
1236 | + |
|
1237 | + /** |
|
1238 | + * Set object property to a new value. |
|
1239 | + * |
|
1240 | + * @param string $property_name |
|
1241 | + * @param $new_value |
|
1242 | + * @return int |
|
1243 | + */ |
|
1244 | + final public function set($property_name, $new_value) {} |
|
1245 | + |
|
1246 | + /** |
|
1247 | + * Set the attribute binding for a specified label property. |
|
1248 | + * Example: |
|
1249 | + * .. code-block:: php |
|
1250 | + * $oLabel->setbinding(MS_LABEL_BINDING_COLOR, "FIELD_NAME_COLOR"); |
|
1251 | + * This would bind the color parameter with the data (ie will extract |
|
1252 | + * the value of the color from the field called "FIELD_NAME_COLOR" |
|
1253 | + * |
|
1254 | + * @param mixed $labelbinding |
|
1255 | + * @param string $value |
|
1256 | + * @return int |
|
1257 | + */ |
|
1258 | + final public function setBinding($labelbinding, $value) {} |
|
1259 | + |
|
1260 | + /** |
|
1261 | + * Set the label expression. |
|
1262 | + * |
|
1263 | + * @param string $expression |
|
1264 | + * @return int |
|
1265 | + */ |
|
1266 | + final public function setExpression($expression) {} |
|
1267 | + |
|
1268 | + /** |
|
1269 | + * Set the label text. |
|
1270 | + * |
|
1271 | + * @param string $text |
|
1272 | + * @return int |
|
1273 | + */ |
|
1274 | + final public function setText($text) {} |
|
1275 | + |
|
1276 | + /** |
|
1277 | + * Update a label from a string snippet. Returns MS_SUCCESS/MS_FAILURE. |
|
1278 | + * |
|
1279 | + * @param string $snippet |
|
1280 | + * @return int |
|
1281 | + */ |
|
1282 | + final public function updateFromString($snippet) {} |
|
1283 | 1283 | } |
1284 | 1284 | |
1285 | 1285 | /** |
@@ -1292,756 +1292,756 @@ discard block |
||
1292 | 1292 | */ |
1293 | 1293 | final class layerObj |
1294 | 1294 | { |
1295 | - /** |
|
1296 | - * @var int |
|
1297 | - */ |
|
1298 | - public $annotate; |
|
1299 | - |
|
1300 | - /** |
|
1301 | - * @var hashTableObj |
|
1302 | - */ |
|
1303 | - public $bindvals; |
|
1304 | - |
|
1305 | - /** |
|
1306 | - * @var string |
|
1307 | - */ |
|
1308 | - public $classgroup; |
|
1309 | - |
|
1310 | - /** |
|
1311 | - * @var string |
|
1312 | - */ |
|
1313 | - public $classitem; |
|
1314 | - |
|
1315 | - /** |
|
1316 | - * @var clusterObj |
|
1317 | - */ |
|
1318 | - public $cluster; |
|
1319 | - |
|
1320 | - /** |
|
1321 | - * @var string |
|
1322 | - */ |
|
1323 | - public $connection; |
|
1324 | - |
|
1325 | - /** |
|
1326 | - * read-only, use setConnectionType() to set it |
|
1327 | - * |
|
1328 | - * @var int |
|
1329 | - */ |
|
1330 | - public $connectiontype; |
|
1331 | - |
|
1332 | - /** |
|
1333 | - * @var string |
|
1334 | - */ |
|
1335 | - public $data; |
|
1336 | - |
|
1337 | - /** |
|
1338 | - * @var int |
|
1339 | - */ |
|
1340 | - public $debug; |
|
1341 | - |
|
1342 | - /** |
|
1343 | - * deprecated since 6.0 |
|
1344 | - * |
|
1345 | - * @var int |
|
1346 | - */ |
|
1347 | - public $dump; |
|
1348 | - |
|
1349 | - /** |
|
1350 | - * @var string |
|
1351 | - */ |
|
1352 | - public $filteritem; |
|
1353 | - |
|
1354 | - /** |
|
1355 | - * @var string |
|
1356 | - */ |
|
1357 | - public $footer; |
|
1358 | - |
|
1359 | - /** |
|
1360 | - * only available on a layer defined as grid (MS_GRATICULE) |
|
1361 | - * |
|
1362 | - * @var gridObj |
|
1363 | - */ |
|
1364 | - public $grid; |
|
1365 | - |
|
1366 | - /** |
|
1367 | - * @var string |
|
1368 | - */ |
|
1369 | - public $group; |
|
1370 | - |
|
1371 | - /** |
|
1372 | - * @var string |
|
1373 | - */ |
|
1374 | - public $header; |
|
1375 | - |
|
1376 | - /** |
|
1377 | - * read-only |
|
1378 | - * |
|
1379 | - * @var int |
|
1380 | - */ |
|
1381 | - public $index; |
|
1382 | - |
|
1383 | - /** |
|
1384 | - * @var int |
|
1385 | - */ |
|
1386 | - public $labelcache; |
|
1387 | - |
|
1388 | - /** |
|
1389 | - * @var string |
|
1390 | - */ |
|
1391 | - public $labelitem; |
|
1392 | - |
|
1393 | - /** |
|
1394 | - * @var float |
|
1395 | - */ |
|
1396 | - public $labelmaxscaledenom; |
|
1397 | - |
|
1398 | - /** |
|
1399 | - * @var float |
|
1400 | - */ |
|
1401 | - public $labelminscaledenom; |
|
1402 | - |
|
1403 | - /** |
|
1404 | - * @var string |
|
1405 | - */ |
|
1406 | - public $labelrequires; |
|
1407 | - |
|
1408 | - /** |
|
1409 | - * @var string |
|
1410 | - */ |
|
1411 | - public $mask; |
|
1412 | - |
|
1413 | - /** |
|
1414 | - * @var int |
|
1415 | - */ |
|
1416 | - public $maxfeatures; |
|
1417 | - |
|
1418 | - /** |
|
1419 | - * @var float |
|
1420 | - */ |
|
1421 | - public $maxscaledenom; |
|
1422 | - |
|
1423 | - /** |
|
1424 | - * @var hashTableObj |
|
1425 | - */ |
|
1426 | - public $metadata; |
|
1427 | - |
|
1428 | - /** |
|
1429 | - * @var float |
|
1430 | - */ |
|
1431 | - public $minscaledenom; |
|
1432 | - |
|
1433 | - /** |
|
1434 | - * @var string |
|
1435 | - */ |
|
1436 | - public $name; |
|
1437 | - |
|
1438 | - /** |
|
1439 | - * @var int |
|
1440 | - */ |
|
1441 | - public $num_processing; |
|
1442 | - |
|
1443 | - /** |
|
1444 | - * read-only |
|
1445 | - * |
|
1446 | - * @var int |
|
1447 | - */ |
|
1448 | - public $numclasses; |
|
1449 | - |
|
1450 | - /** |
|
1451 | - * @var colorObj |
|
1452 | - */ |
|
1453 | - public $offsite; |
|
1454 | - |
|
1455 | - /** |
|
1456 | - * @var int |
|
1457 | - */ |
|
1458 | - public $opacity; |
|
1459 | - |
|
1460 | - /** |
|
1461 | - * @var projectionObj |
|
1462 | - */ |
|
1463 | - public $projection; |
|
1464 | - |
|
1465 | - /** |
|
1466 | - * @var int |
|
1467 | - */ |
|
1468 | - public $postlabelcache; |
|
1469 | - |
|
1470 | - /** |
|
1471 | - * @var string |
|
1472 | - */ |
|
1473 | - public $requires; |
|
1474 | - |
|
1475 | - /** |
|
1476 | - * @var int |
|
1477 | - */ |
|
1478 | - public $sizeunits; |
|
1479 | - |
|
1480 | - /** |
|
1481 | - * @var int |
|
1482 | - */ |
|
1483 | - public $startindex; |
|
1484 | - |
|
1485 | - /** |
|
1486 | - * MS_ON, MS_OFF, MS_DEFAULT or MS_DELETE |
|
1487 | - * |
|
1488 | - * @var int |
|
1489 | - */ |
|
1490 | - public $status; |
|
1491 | - |
|
1492 | - /** |
|
1493 | - * @var string |
|
1494 | - */ |
|
1495 | - public $styleitem; |
|
1496 | - |
|
1497 | - /** |
|
1498 | - * @var float |
|
1499 | - */ |
|
1500 | - public $symbolscaledenom; |
|
1501 | - |
|
1502 | - /** |
|
1503 | - * @var string |
|
1504 | - */ |
|
1505 | - public $template; |
|
1506 | - |
|
1507 | - /** |
|
1508 | - * @var string |
|
1509 | - */ |
|
1510 | - public $tileindex; |
|
1511 | - |
|
1512 | - /** |
|
1513 | - * @var string |
|
1514 | - */ |
|
1515 | - public $tileitem; |
|
1516 | - |
|
1517 | - /** |
|
1518 | - * @var float |
|
1519 | - */ |
|
1520 | - public $tolerance; |
|
1521 | - |
|
1522 | - /** |
|
1523 | - * @var int |
|
1524 | - */ |
|
1525 | - public $toleranceunits; |
|
1526 | - |
|
1527 | - /** |
|
1528 | - * @var int |
|
1529 | - */ |
|
1530 | - public $transform; |
|
1531 | - |
|
1532 | - /** |
|
1533 | - * @var int |
|
1534 | - */ |
|
1535 | - public $type; |
|
1536 | - |
|
1537 | - /** |
|
1538 | - * Old style constructor |
|
1539 | - * |
|
1540 | - * @param mapObj $map |
|
1541 | - * @param layerObj $layer |
|
1542 | - * @return layerObj |
|
1543 | - */ |
|
1544 | - final public function ms_newLayerObj(mapObj $map, layerObj $layer) {} |
|
1545 | - |
|
1546 | - /** |
|
1547 | - * Add a new feature in a layer. Returns MS_SUCCESS or MS_FAILURE on |
|
1548 | - * error. |
|
1549 | - * |
|
1550 | - * @param shapeObj $shape |
|
1551 | - * @return int |
|
1552 | - */ |
|
1553 | - final public function addFeature(shapeObj $shape) {} |
|
1554 | - |
|
1555 | - /** |
|
1556 | - * Apply the :ref:`SLD <sld>` document to the layer object. |
|
1557 | - * The matching between the sld document and the layer will be done |
|
1558 | - * using the layer's name. |
|
1559 | - * If a namedlayer argument is passed (argument is optional), |
|
1560 | - * the NamedLayer in the sld that matchs it will be used to style |
|
1561 | - * the layer. |
|
1562 | - * See :ref:`SLD HowTo <sld>` for more information on the SLD support. |
|
1563 | - * |
|
1564 | - * @param string $sldxml |
|
1565 | - * @param string $namedlayer |
|
1566 | - * @return int |
|
1567 | - */ |
|
1568 | - final public function applySLD($sldxml, $namedlayer) {} |
|
1569 | - |
|
1570 | - /** |
|
1571 | - * Apply the :ref:`SLD <sld>` document pointed by the URL to the |
|
1572 | - * layer object. The matching between the sld document and the layer |
|
1573 | - * will be done using the layer's name. If a namedlayer argument is |
|
1574 | - * passed (argument is optional), the NamedLayer in the sld that |
|
1575 | - * matchs it will be used to style the layer. See :ref:`SLD HowTo <sld>` |
|
1576 | - * for more information on the SLD support. |
|
1577 | - * |
|
1578 | - * @param string $sldurl |
|
1579 | - * @param string $namedlayer |
|
1580 | - * @return int |
|
1581 | - */ |
|
1582 | - final public function applySLDURL($sldurl, $namedlayer) {} |
|
1583 | - |
|
1584 | - /** |
|
1585 | - * Clears all the processing strings. |
|
1586 | - * |
|
1587 | - * @return void |
|
1588 | - */ |
|
1589 | - final public function clearProcessing() {} |
|
1590 | - |
|
1591 | - /** |
|
1592 | - * Close layer previously opened with open(). |
|
1593 | - * |
|
1594 | - * @return void |
|
1595 | - */ |
|
1596 | - final public function close() {} |
|
1597 | - |
|
1598 | - /** |
|
1599 | - * Saves the object to a string. Provides the inverse option for |
|
1600 | - * updateFromString. |
|
1601 | - * |
|
1602 | - * @return string |
|
1603 | - */ |
|
1604 | - final public function convertToString() {} |
|
1605 | - |
|
1606 | - /** |
|
1607 | - * Draw a single layer, add labels to cache if required. |
|
1608 | - * Returns MS_SUCCESS or MS_FAILURE on error. |
|
1609 | - * |
|
1610 | - * @param imageObj $image |
|
1611 | - * @return int |
|
1612 | - */ |
|
1613 | - final public function draw(imageObj $image) {} |
|
1614 | - |
|
1615 | - /** |
|
1616 | - * Draw query map for a single layer. |
|
1617 | - * string executeWFSGetfeature() |
|
1618 | - * Executes a GetFeature request on a WFS layer and returns the |
|
1619 | - * name of the temporary GML file created. Returns an empty |
|
1620 | - * string on error. |
|
1621 | - * |
|
1622 | - * @param imageObj $image |
|
1623 | - * @return int |
|
1624 | - */ |
|
1625 | - final public function drawQuery(imageObj $image) {} |
|
1626 | - |
|
1627 | - /** |
|
1628 | - * Free the object properties and break the internal references. |
|
1629 | - * Note that you have to unset the php variable to free totally the |
|
1630 | - * resources. |
|
1631 | - * |
|
1632 | - * @return void |
|
1633 | - */ |
|
1634 | - final public function free() {} |
|
1635 | - |
|
1636 | - /** |
|
1637 | - * Returns an SLD XML string based on all the classes found in the |
|
1638 | - * layer (the layer must have `STATUS` `on`). |
|
1639 | - * |
|
1640 | - * @return string |
|
1641 | - */ |
|
1642 | - final public function generateSLD() {} |
|
1643 | - |
|
1644 | - /** |
|
1645 | - * Returns a classObj from the layer given an index value (0=first class) |
|
1646 | - * |
|
1647 | - * @param int $classIndex |
|
1648 | - * @return classObj |
|
1649 | - */ |
|
1650 | - final public function getClass($classIndex) {} |
|
1651 | - |
|
1652 | - /** |
|
1653 | - * Get the class index of a shape for a given scale. Returns -1 if no |
|
1654 | - * class matches. classgroup is an array of class ids to check |
|
1655 | - * (Optional). numclasses is the number of classes that the classgroup |
|
1656 | - * array contains. By default, all the layer classes will be checked. |
|
1657 | - * |
|
1658 | - * @param $shape |
|
1659 | - * @param $classgroup |
|
1660 | - * @param $numclasses |
|
1661 | - * @return int |
|
1662 | - */ |
|
1663 | - final public function getClassIndex($shape, $classgroup, $numclasses) {} |
|
1664 | - |
|
1665 | - /** |
|
1666 | - * Returns the layer's data extents or NULL on error. |
|
1667 | - * If the layer's EXTENT member is set then this value is used, |
|
1668 | - * otherwise this call opens/closes the layer to read the |
|
1669 | - * extents. This is quick on shapefiles, but can be |
|
1670 | - * an expensive operation on some file formats or data sources. |
|
1671 | - * This function is safe to use on both opened or closed layers: it |
|
1672 | - * is not necessary to call open()/close() before/after calling it. |
|
1673 | - * |
|
1674 | - * @return rectObj |
|
1675 | - */ |
|
1676 | - final public function getExtent() {} |
|
1677 | - |
|
1678 | - /** |
|
1679 | - * Returns the :ref:`expression <expressions>` for this layer or NULL |
|
1680 | - * on error. |
|
1681 | - * |
|
1682 | - * @return string|null |
|
1683 | - */ |
|
1684 | - final public function getFilterString() {} |
|
1685 | - |
|
1686 | - /** |
|
1687 | - * Returns an array containing the grid intersection coordinates. If |
|
1688 | - * there are no coordinates, it returns an empty array. |
|
1689 | - * |
|
1690 | - * @return array |
|
1691 | - */ |
|
1692 | - final public function getGridIntersectionCoordinates() {} |
|
1693 | - |
|
1694 | - /** |
|
1695 | - * Returns an array containing the items. Must call open function first. |
|
1696 | - * If there are no items, it returns an empty array. |
|
1697 | - * |
|
1698 | - * @return array |
|
1699 | - */ |
|
1700 | - final public function getItems() {} |
|
1701 | - |
|
1702 | - /** |
|
1703 | - * Fetch layer metadata entry by name. Returns "" if no entry |
|
1704 | - * matches the name. Note that the search is case sensitive. |
|
1705 | - * .. note:: |
|
1706 | - * getMetaData's query is case sensitive. |
|
1707 | - * |
|
1708 | - * @param string $name |
|
1709 | - * @return int |
|
1710 | - */ |
|
1711 | - final public function getMetaData($name) {} |
|
1712 | - |
|
1713 | - /** |
|
1714 | - * Returns the number of results in the last query. |
|
1715 | - * |
|
1716 | - * @return int |
|
1717 | - */ |
|
1718 | - final public function getNumResults() {} |
|
1719 | - |
|
1720 | - /** |
|
1721 | - * Returns an array containing the processing strings. |
|
1722 | - * If there are no processing strings, it returns an empty array. |
|
1723 | - * |
|
1724 | - * @return array |
|
1725 | - */ |
|
1726 | - final public function getProcessing() {} |
|
1727 | - |
|
1728 | - /** |
|
1729 | - * Returns a string representation of the :ref:`projection <projection>`. |
|
1730 | - * Returns NULL on error or if no projection is set. |
|
1731 | - * |
|
1732 | - * @return string |
|
1733 | - */ |
|
1734 | - final public function getProjection() {} |
|
1735 | - |
|
1736 | - /** |
|
1737 | - * Returns a resultObj by index from a layer object with |
|
1738 | - * index in the range 0 to numresults-1. |
|
1739 | - * Returns a valid object or FALSE(0) if index is invalid. |
|
1740 | - * |
|
1741 | - * @param int $index |
|
1742 | - * @return resultObj |
|
1743 | - */ |
|
1744 | - final public function getResult($index) {} |
|
1745 | - |
|
1746 | - /** |
|
1747 | - * Returns the bounding box of the latest result. |
|
1748 | - * |
|
1749 | - * @return rectObj |
|
1750 | - */ |
|
1751 | - final public function getResultsBounds() {} |
|
1752 | - |
|
1753 | - /** |
|
1754 | - * If the resultObj passed has a valid resultindex, retrieve shapeObj from |
|
1755 | - * a layer's resultset. (You get it from the resultObj returned by |
|
1756 | - * getResult() for instance). Otherwise, it will do a single query on |
|
1757 | - * the layer to fetch the shapeindex |
|
1758 | - * .. code-block:: php |
|
1759 | - * $map = new mapObj("gmap75.map"); |
|
1760 | - * $l = $map->getLayerByName("popplace"); |
|
1761 | - * $l->queryByRect($map->extent); |
|
1762 | - * for ($i = 0; $i < $l->getNumResults(); $i++) { |
|
1763 | - * $s = $l->getShape($l->getResult($i)); |
|
1764 | - * echo $s->getValue($l,"Name"); |
|
1765 | - * echo "\n"; |
|
1766 | - * } |
|
1767 | - * |
|
1768 | - * @param resultObj $result |
|
1769 | - * @return shapeObj |
|
1770 | - */ |
|
1771 | - final public function getShape(resultObj $result) {} |
|
1772 | - |
|
1773 | - /** |
|
1774 | - * Returns a WMS GetFeatureInfo URL (works only for WMS layers) |
|
1775 | - * clickX, clickY is the location of to query in pixel coordinates |
|
1776 | - * with (0,0) at the top left of the image. |
|
1777 | - * featureCount is the number of results to return. |
|
1778 | - * infoFormat is the format the format in which the result should be |
|
1779 | - * requested. Depends on remote server's capabilities. MapServer |
|
1780 | - * WMS servers support only "MIME" (and should support "GML.1" soon). |
|
1781 | - * Returns "" and outputs a warning if layer is not a WMS layer |
|
1782 | - * or if it is not queriable. |
|
1783 | - * |
|
1784 | - * @param int $clickX |
|
1785 | - * @param int $clickY |
|
1786 | - * @param int $featureCount |
|
1787 | - * @param string $infoFormat |
|
1788 | - * @return string |
|
1789 | - */ |
|
1790 | - final public function getWMSFeatureInfoURL($clickX, $clickY, $featureCount, $infoFormat) {} |
|
1791 | - |
|
1792 | - /** |
|
1793 | - * Returns MS_TRUE/MS_FALSE depending on whether the layer is |
|
1794 | - * currently visible in the map (i.e. turned on, in scale, etc.). |
|
1795 | - * |
|
1796 | - * @return bool |
|
1797 | - */ |
|
1798 | - final public function isVisible() {} |
|
1799 | - |
|
1800 | - /** |
|
1801 | - * The class specified by the class index will be moved down into |
|
1802 | - * the array of layers. Returns MS_SUCCESS or MS_FAILURE. |
|
1803 | - * ex layer->moveclassdown(0) will have the effect of moving class 0 |
|
1804 | - * up to position 1, and the class at position 1 will be moved |
|
1805 | - * to position 0. |
|
1806 | - * |
|
1807 | - * @param int $index |
|
1808 | - * @return int |
|
1809 | - */ |
|
1810 | - final public function moveclassdown($index) {} |
|
1811 | - |
|
1812 | - /** |
|
1813 | - * The class specified by the class index will be moved up into |
|
1814 | - * the array of layers. Returns MS_SUCCESS or MS_FAILURE. |
|
1815 | - * ex layer->moveclassup(1) will have the effect of moving class 1 |
|
1816 | - * up to position 0, and the class at position 0 will be moved |
|
1817 | - * to position 1. |
|
1818 | - * |
|
1819 | - * @param int $index |
|
1820 | - * @return int |
|
1821 | - */ |
|
1822 | - final public function moveclassup($index) {} |
|
1823 | - |
|
1824 | - /** |
|
1825 | - * Open the layer for use with getShape(). |
|
1826 | - * Returns MS_SUCCESS/MS_FAILURE. |
|
1827 | - * |
|
1828 | - * @return int |
|
1829 | - */ |
|
1830 | - final public function open() {} |
|
1831 | - |
|
1832 | - /** |
|
1833 | - * Called after msWhichShapes has been called to actually retrieve |
|
1834 | - * shapes within a given area. Returns a shape object or NULL on |
|
1835 | - * error. |
|
1836 | - * .. code-block:: php |
|
1837 | - * $map = ms_newmapobj("d:/msapps/gmap-ms40/htdocs/gmap75.map"); |
|
1838 | - * $layer = $map->getLayerByName('road'); |
|
1839 | - * $status = $layer->open(); |
|
1840 | - * $status = $layer->whichShapes($map->extent); |
|
1841 | - * while ($shape = $layer->nextShape()) |
|
1842 | - * { |
|
1843 | - * echo $shape->index ."<br>\n"; |
|
1844 | - * } |
|
1845 | - * $layer->close(); |
|
1846 | - * |
|
1847 | - * @return shapeObj |
|
1848 | - */ |
|
1849 | - final public function nextShape() {} |
|
1850 | - |
|
1851 | - /** |
|
1852 | - * Query layer for shapes that intersect current map extents. qitem |
|
1853 | - * is the item (attribute) on which the query is performed, and |
|
1854 | - * qstring is the expression to match. The query is performed on all |
|
1855 | - * the shapes that are part of a :ref:`CLASS` that contains a |
|
1856 | - * :ref:`TEMPLATE <template>` value or that match any class in a |
|
1857 | - * layer that contains a :ref:`LAYER` :ref:`TEMPLATE <template>` |
|
1858 | - * value. Note that the layer's FILTER/FILTERITEM are ignored by |
|
1859 | - * this function. Mode is MS_SINGLE or MS_MULTIPLE depending on |
|
1860 | - * number of results you want. Returns MS_SUCCESS if shapes were |
|
1861 | - * found or MS_FAILURE if nothing was found or if some other error |
|
1862 | - * happened (note that the error message in case nothing was found |
|
1863 | - * can be avoided in PHP using the '@' control operator). |
|
1864 | - * |
|
1865 | - * @param string $qitem |
|
1866 | - * @param string $qstring |
|
1867 | - * @param int $mode |
|
1868 | - * @return int |
|
1869 | - */ |
|
1870 | - final public function queryByAttributes($qitem, $qstring, $mode) {} |
|
1871 | - |
|
1872 | - /** |
|
1873 | - * Perform a query set based on a previous set of results from |
|
1874 | - * another layer. At present the results MUST be based on a polygon |
|
1875 | - * layer. |
|
1876 | - * Returns MS_SUCCESS if shapes were found or MS_FAILURE if nothing |
|
1877 | - * was found or if some other error happened (note that the error |
|
1878 | - * message in case nothing was found can be avoided in PHP using |
|
1879 | - * the '@' control operator). |
|
1880 | - * |
|
1881 | - * @param int $slayer |
|
1882 | - * @return int |
|
1883 | - */ |
|
1884 | - final public function queryByFeatures($slayer) {} |
|
1885 | - |
|
1886 | - /** |
|
1887 | - * Query layer at point location specified in georeferenced map |
|
1888 | - * coordinates (i.e. not pixels). |
|
1889 | - * The query is performed on all the shapes that are part of a CLASS |
|
1890 | - * that contains a TEMPLATE value or that match any class in a |
|
1891 | - * layer that contains a LAYER TEMPLATE value. |
|
1892 | - * Mode is MS_SINGLE or MS_MULTIPLE depending on number of results |
|
1893 | - * you want. |
|
1894 | - * Passing buffer -1 defaults to tolerances set in the map file |
|
1895 | - * (in pixels) but you can use a constant buffer (specified in |
|
1896 | - * ground units) instead. |
|
1897 | - * Returns MS_SUCCESS if shapes were found or MS_FAILURE if nothing |
|
1898 | - * was found or if some other error happened (note that the error |
|
1899 | - * message in case nothing was found can be avoided in PHP using |
|
1900 | - * the '@' control operator). |
|
1901 | - * |
|
1902 | - * @param pointObj $point |
|
1903 | - * @param int $mode |
|
1904 | - * @param float $buffer |
|
1905 | - * @return int |
|
1906 | - */ |
|
1907 | - final public function queryByPoint(pointObj $point, $mode, $buffer) {} |
|
1908 | - |
|
1909 | - /** |
|
1910 | - * Query layer using a rectangle specified in georeferenced map |
|
1911 | - * coordinates (i.e. not pixels). |
|
1912 | - * The query is performed on all the shapes that are part of a CLASS |
|
1913 | - * that contains a TEMPLATE value or that match any class in a |
|
1914 | - * layer that contains a LAYER TEMPLATE value. |
|
1915 | - * Returns MS_SUCCESS if shapes were found or MS_FAILURE if nothing |
|
1916 | - * was found or if some other error happened (note that the error |
|
1917 | - * message in case nothing was found can be avoided in PHP using |
|
1918 | - * the '@' control operator). |
|
1919 | - * |
|
1920 | - * @param rectObj $rect |
|
1921 | - * @return int |
|
1922 | - */ |
|
1923 | - final public function queryByRect(rectObj $rect) {} |
|
1924 | - |
|
1925 | - /** |
|
1926 | - * Query layer based on a single shape, the shape has to be a polygon |
|
1927 | - * at this point. |
|
1928 | - * Returns MS_SUCCESS if shapes were found or MS_FAILURE if nothing |
|
1929 | - * was found or if some other error happened (note that the error |
|
1930 | - * message in case nothing was found can be avoided in PHP using |
|
1931 | - * the '@' control operator). |
|
1932 | - * |
|
1933 | - * @param shapeObj $shape |
|
1934 | - * @return int |
|
1935 | - */ |
|
1936 | - final public function queryByShape(shapeObj $shape) {} |
|
1937 | - |
|
1938 | - /** |
|
1939 | - * Removes the class indicated and returns a copy, or NULL in the case |
|
1940 | - * of a failure. Note that subsequent classes will be renumbered by |
|
1941 | - * this operation. The numclasses field contains the number of classes |
|
1942 | - * available. |
|
1943 | - * |
|
1944 | - * @param int $index |
|
1945 | - * @return classObj|null |
|
1946 | - */ |
|
1947 | - final public function removeClass($index) {} |
|
1948 | - |
|
1949 | - /** |
|
1950 | - * Remove a metadata entry for the layer. Returns MS_SUCCESS/MS_FAILURE. |
|
1951 | - * |
|
1952 | - * @param string $name |
|
1953 | - * @return int |
|
1954 | - */ |
|
1955 | - final public function removeMetaData($name) {} |
|
1956 | - |
|
1957 | - /** |
|
1958 | - * Set object property to a new value. |
|
1959 | - * |
|
1960 | - * @param string $property_name |
|
1961 | - * @param $new_value |
|
1962 | - * @return int |
|
1963 | - */ |
|
1964 | - final public function set($property_name, $new_value) {} |
|
1965 | - |
|
1966 | - /** |
|
1967 | - * Changes the connectiontype of the layer and recreates the vtable |
|
1968 | - * according to the new connection type. This method should be used |
|
1969 | - * instead of setting the connectiontype parameter directly. |
|
1970 | - * In the case when the layer.connectiontype = MS_PLUGIN the plugin_library |
|
1971 | - * parameter should also be specified so as to select the library to |
|
1972 | - * load by MapServer. For the other connection types this parameter |
|
1973 | - * is not used. |
|
1974 | - * |
|
1975 | - * @param int $connectiontype |
|
1976 | - * @param string $plugin_library |
|
1977 | - * @return int |
|
1978 | - */ |
|
1979 | - final public function setConnectionType($connectiontype, $plugin_library) {} |
|
1980 | - |
|
1981 | - /** |
|
1982 | - * Set layer filter :ref:`expression <expressions>`. |
|
1983 | - * |
|
1984 | - * @param string $expression |
|
1985 | - * @return int |
|
1986 | - */ |
|
1987 | - final public function setFilter($expression) {} |
|
1988 | - |
|
1989 | - /** |
|
1990 | - * Set a metadata entry for the layer. Returns MS_SUCCESS/MS_FAILURE. |
|
1991 | - * int setProcessing(string) |
|
1992 | - * Add the string to the processing string list for the layer. |
|
1993 | - * The layer->num_processing is incremented by 1. |
|
1994 | - * Returns MS_SUCCESS or MS_FAILURE on error. |
|
1995 | - * .. code-block:: php |
|
1996 | - * $oLayer->setprocessing("SCALE_1=AUTO"); |
|
1997 | - * $oLayer->setprocessing("SCALE_2=AUTO"); |
|
1998 | - * |
|
1999 | - * @param string $name |
|
2000 | - * @param string $value |
|
2001 | - * @return int |
|
2002 | - */ |
|
2003 | - final public function setMetaData($name, $value) {} |
|
2004 | - |
|
2005 | - /** |
|
2006 | - * Set layer :ref:`projection <projection>` and coordinate system. |
|
2007 | - * Parameters are given as a single string of comma-delimited PROJ.4 |
|
2008 | - * parameters. Returns MS_SUCCESS or MS_FAILURE on error. |
|
2009 | - * |
|
2010 | - * @param string $proj_params |
|
2011 | - * @return int |
|
2012 | - */ |
|
2013 | - final public function setProjection($proj_params) {} |
|
2014 | - |
|
2015 | - /** |
|
2016 | - * Same as setProjection(), but takes an OGC WKT projection |
|
2017 | - * definition string as input. |
|
2018 | - * .. note:: |
|
2019 | - * setWKTProjection requires GDAL support |
|
2020 | - * |
|
2021 | - * @param string $proj_params |
|
2022 | - * @return int |
|
2023 | - */ |
|
2024 | - final public function setWKTProjection($proj_params) {} |
|
2025 | - |
|
2026 | - /** |
|
2027 | - * Update a layer from a string snippet. Returns MS_SUCCESS/MS_FAILURE. |
|
2028 | - * .. code-block:: php |
|
2029 | - * modify the name |
|
2030 | - * $oLayer->updateFromString('LAYER NAME land_fn2 END'); |
|
2031 | - * add a new class |
|
2032 | - * $oLayer->updateFromString('LAYER CLASS STYLE COLOR 255 255 0 END END END'); |
|
2033 | - * int whichshapes(rectobj) |
|
2034 | - * Performs a spatial, and optionally an attribute based feature |
|
2035 | - * search. The function basically prepares things so that candidate |
|
2036 | - * features can be accessed by query or drawing functions (eg using |
|
2037 | - * nextshape function). Returns MS_SUCCESS, MS_FAILURE or MS_DONE. |
|
2038 | - * MS_DONE is returned if the layer extent does not overlap the |
|
2039 | - * rectObj. |
|
2040 | - * |
|
2041 | - * @param string $snippet |
|
2042 | - * @return int |
|
2043 | - */ |
|
2044 | - final public function updateFromString($snippet) {} |
|
1295 | + /** |
|
1296 | + * @var int |
|
1297 | + */ |
|
1298 | + public $annotate; |
|
1299 | + |
|
1300 | + /** |
|
1301 | + * @var hashTableObj |
|
1302 | + */ |
|
1303 | + public $bindvals; |
|
1304 | + |
|
1305 | + /** |
|
1306 | + * @var string |
|
1307 | + */ |
|
1308 | + public $classgroup; |
|
1309 | + |
|
1310 | + /** |
|
1311 | + * @var string |
|
1312 | + */ |
|
1313 | + public $classitem; |
|
1314 | + |
|
1315 | + /** |
|
1316 | + * @var clusterObj |
|
1317 | + */ |
|
1318 | + public $cluster; |
|
1319 | + |
|
1320 | + /** |
|
1321 | + * @var string |
|
1322 | + */ |
|
1323 | + public $connection; |
|
1324 | + |
|
1325 | + /** |
|
1326 | + * read-only, use setConnectionType() to set it |
|
1327 | + * |
|
1328 | + * @var int |
|
1329 | + */ |
|
1330 | + public $connectiontype; |
|
1331 | + |
|
1332 | + /** |
|
1333 | + * @var string |
|
1334 | + */ |
|
1335 | + public $data; |
|
1336 | + |
|
1337 | + /** |
|
1338 | + * @var int |
|
1339 | + */ |
|
1340 | + public $debug; |
|
1341 | + |
|
1342 | + /** |
|
1343 | + * deprecated since 6.0 |
|
1344 | + * |
|
1345 | + * @var int |
|
1346 | + */ |
|
1347 | + public $dump; |
|
1348 | + |
|
1349 | + /** |
|
1350 | + * @var string |
|
1351 | + */ |
|
1352 | + public $filteritem; |
|
1353 | + |
|
1354 | + /** |
|
1355 | + * @var string |
|
1356 | + */ |
|
1357 | + public $footer; |
|
1358 | + |
|
1359 | + /** |
|
1360 | + * only available on a layer defined as grid (MS_GRATICULE) |
|
1361 | + * |
|
1362 | + * @var gridObj |
|
1363 | + */ |
|
1364 | + public $grid; |
|
1365 | + |
|
1366 | + /** |
|
1367 | + * @var string |
|
1368 | + */ |
|
1369 | + public $group; |
|
1370 | + |
|
1371 | + /** |
|
1372 | + * @var string |
|
1373 | + */ |
|
1374 | + public $header; |
|
1375 | + |
|
1376 | + /** |
|
1377 | + * read-only |
|
1378 | + * |
|
1379 | + * @var int |
|
1380 | + */ |
|
1381 | + public $index; |
|
1382 | + |
|
1383 | + /** |
|
1384 | + * @var int |
|
1385 | + */ |
|
1386 | + public $labelcache; |
|
1387 | + |
|
1388 | + /** |
|
1389 | + * @var string |
|
1390 | + */ |
|
1391 | + public $labelitem; |
|
1392 | + |
|
1393 | + /** |
|
1394 | + * @var float |
|
1395 | + */ |
|
1396 | + public $labelmaxscaledenom; |
|
1397 | + |
|
1398 | + /** |
|
1399 | + * @var float |
|
1400 | + */ |
|
1401 | + public $labelminscaledenom; |
|
1402 | + |
|
1403 | + /** |
|
1404 | + * @var string |
|
1405 | + */ |
|
1406 | + public $labelrequires; |
|
1407 | + |
|
1408 | + /** |
|
1409 | + * @var string |
|
1410 | + */ |
|
1411 | + public $mask; |
|
1412 | + |
|
1413 | + /** |
|
1414 | + * @var int |
|
1415 | + */ |
|
1416 | + public $maxfeatures; |
|
1417 | + |
|
1418 | + /** |
|
1419 | + * @var float |
|
1420 | + */ |
|
1421 | + public $maxscaledenom; |
|
1422 | + |
|
1423 | + /** |
|
1424 | + * @var hashTableObj |
|
1425 | + */ |
|
1426 | + public $metadata; |
|
1427 | + |
|
1428 | + /** |
|
1429 | + * @var float |
|
1430 | + */ |
|
1431 | + public $minscaledenom; |
|
1432 | + |
|
1433 | + /** |
|
1434 | + * @var string |
|
1435 | + */ |
|
1436 | + public $name; |
|
1437 | + |
|
1438 | + /** |
|
1439 | + * @var int |
|
1440 | + */ |
|
1441 | + public $num_processing; |
|
1442 | + |
|
1443 | + /** |
|
1444 | + * read-only |
|
1445 | + * |
|
1446 | + * @var int |
|
1447 | + */ |
|
1448 | + public $numclasses; |
|
1449 | + |
|
1450 | + /** |
|
1451 | + * @var colorObj |
|
1452 | + */ |
|
1453 | + public $offsite; |
|
1454 | + |
|
1455 | + /** |
|
1456 | + * @var int |
|
1457 | + */ |
|
1458 | + public $opacity; |
|
1459 | + |
|
1460 | + /** |
|
1461 | + * @var projectionObj |
|
1462 | + */ |
|
1463 | + public $projection; |
|
1464 | + |
|
1465 | + /** |
|
1466 | + * @var int |
|
1467 | + */ |
|
1468 | + public $postlabelcache; |
|
1469 | + |
|
1470 | + /** |
|
1471 | + * @var string |
|
1472 | + */ |
|
1473 | + public $requires; |
|
1474 | + |
|
1475 | + /** |
|
1476 | + * @var int |
|
1477 | + */ |
|
1478 | + public $sizeunits; |
|
1479 | + |
|
1480 | + /** |
|
1481 | + * @var int |
|
1482 | + */ |
|
1483 | + public $startindex; |
|
1484 | + |
|
1485 | + /** |
|
1486 | + * MS_ON, MS_OFF, MS_DEFAULT or MS_DELETE |
|
1487 | + * |
|
1488 | + * @var int |
|
1489 | + */ |
|
1490 | + public $status; |
|
1491 | + |
|
1492 | + /** |
|
1493 | + * @var string |
|
1494 | + */ |
|
1495 | + public $styleitem; |
|
1496 | + |
|
1497 | + /** |
|
1498 | + * @var float |
|
1499 | + */ |
|
1500 | + public $symbolscaledenom; |
|
1501 | + |
|
1502 | + /** |
|
1503 | + * @var string |
|
1504 | + */ |
|
1505 | + public $template; |
|
1506 | + |
|
1507 | + /** |
|
1508 | + * @var string |
|
1509 | + */ |
|
1510 | + public $tileindex; |
|
1511 | + |
|
1512 | + /** |
|
1513 | + * @var string |
|
1514 | + */ |
|
1515 | + public $tileitem; |
|
1516 | + |
|
1517 | + /** |
|
1518 | + * @var float |
|
1519 | + */ |
|
1520 | + public $tolerance; |
|
1521 | + |
|
1522 | + /** |
|
1523 | + * @var int |
|
1524 | + */ |
|
1525 | + public $toleranceunits; |
|
1526 | + |
|
1527 | + /** |
|
1528 | + * @var int |
|
1529 | + */ |
|
1530 | + public $transform; |
|
1531 | + |
|
1532 | + /** |
|
1533 | + * @var int |
|
1534 | + */ |
|
1535 | + public $type; |
|
1536 | + |
|
1537 | + /** |
|
1538 | + * Old style constructor |
|
1539 | + * |
|
1540 | + * @param mapObj $map |
|
1541 | + * @param layerObj $layer |
|
1542 | + * @return layerObj |
|
1543 | + */ |
|
1544 | + final public function ms_newLayerObj(mapObj $map, layerObj $layer) {} |
|
1545 | + |
|
1546 | + /** |
|
1547 | + * Add a new feature in a layer. Returns MS_SUCCESS or MS_FAILURE on |
|
1548 | + * error. |
|
1549 | + * |
|
1550 | + * @param shapeObj $shape |
|
1551 | + * @return int |
|
1552 | + */ |
|
1553 | + final public function addFeature(shapeObj $shape) {} |
|
1554 | + |
|
1555 | + /** |
|
1556 | + * Apply the :ref:`SLD <sld>` document to the layer object. |
|
1557 | + * The matching between the sld document and the layer will be done |
|
1558 | + * using the layer's name. |
|
1559 | + * If a namedlayer argument is passed (argument is optional), |
|
1560 | + * the NamedLayer in the sld that matchs it will be used to style |
|
1561 | + * the layer. |
|
1562 | + * See :ref:`SLD HowTo <sld>` for more information on the SLD support. |
|
1563 | + * |
|
1564 | + * @param string $sldxml |
|
1565 | + * @param string $namedlayer |
|
1566 | + * @return int |
|
1567 | + */ |
|
1568 | + final public function applySLD($sldxml, $namedlayer) {} |
|
1569 | + |
|
1570 | + /** |
|
1571 | + * Apply the :ref:`SLD <sld>` document pointed by the URL to the |
|
1572 | + * layer object. The matching between the sld document and the layer |
|
1573 | + * will be done using the layer's name. If a namedlayer argument is |
|
1574 | + * passed (argument is optional), the NamedLayer in the sld that |
|
1575 | + * matchs it will be used to style the layer. See :ref:`SLD HowTo <sld>` |
|
1576 | + * for more information on the SLD support. |
|
1577 | + * |
|
1578 | + * @param string $sldurl |
|
1579 | + * @param string $namedlayer |
|
1580 | + * @return int |
|
1581 | + */ |
|
1582 | + final public function applySLDURL($sldurl, $namedlayer) {} |
|
1583 | + |
|
1584 | + /** |
|
1585 | + * Clears all the processing strings. |
|
1586 | + * |
|
1587 | + * @return void |
|
1588 | + */ |
|
1589 | + final public function clearProcessing() {} |
|
1590 | + |
|
1591 | + /** |
|
1592 | + * Close layer previously opened with open(). |
|
1593 | + * |
|
1594 | + * @return void |
|
1595 | + */ |
|
1596 | + final public function close() {} |
|
1597 | + |
|
1598 | + /** |
|
1599 | + * Saves the object to a string. Provides the inverse option for |
|
1600 | + * updateFromString. |
|
1601 | + * |
|
1602 | + * @return string |
|
1603 | + */ |
|
1604 | + final public function convertToString() {} |
|
1605 | + |
|
1606 | + /** |
|
1607 | + * Draw a single layer, add labels to cache if required. |
|
1608 | + * Returns MS_SUCCESS or MS_FAILURE on error. |
|
1609 | + * |
|
1610 | + * @param imageObj $image |
|
1611 | + * @return int |
|
1612 | + */ |
|
1613 | + final public function draw(imageObj $image) {} |
|
1614 | + |
|
1615 | + /** |
|
1616 | + * Draw query map for a single layer. |
|
1617 | + * string executeWFSGetfeature() |
|
1618 | + * Executes a GetFeature request on a WFS layer and returns the |
|
1619 | + * name of the temporary GML file created. Returns an empty |
|
1620 | + * string on error. |
|
1621 | + * |
|
1622 | + * @param imageObj $image |
|
1623 | + * @return int |
|
1624 | + */ |
|
1625 | + final public function drawQuery(imageObj $image) {} |
|
1626 | + |
|
1627 | + /** |
|
1628 | + * Free the object properties and break the internal references. |
|
1629 | + * Note that you have to unset the php variable to free totally the |
|
1630 | + * resources. |
|
1631 | + * |
|
1632 | + * @return void |
|
1633 | + */ |
|
1634 | + final public function free() {} |
|
1635 | + |
|
1636 | + /** |
|
1637 | + * Returns an SLD XML string based on all the classes found in the |
|
1638 | + * layer (the layer must have `STATUS` `on`). |
|
1639 | + * |
|
1640 | + * @return string |
|
1641 | + */ |
|
1642 | + final public function generateSLD() {} |
|
1643 | + |
|
1644 | + /** |
|
1645 | + * Returns a classObj from the layer given an index value (0=first class) |
|
1646 | + * |
|
1647 | + * @param int $classIndex |
|
1648 | + * @return classObj |
|
1649 | + */ |
|
1650 | + final public function getClass($classIndex) {} |
|
1651 | + |
|
1652 | + /** |
|
1653 | + * Get the class index of a shape for a given scale. Returns -1 if no |
|
1654 | + * class matches. classgroup is an array of class ids to check |
|
1655 | + * (Optional). numclasses is the number of classes that the classgroup |
|
1656 | + * array contains. By default, all the layer classes will be checked. |
|
1657 | + * |
|
1658 | + * @param $shape |
|
1659 | + * @param $classgroup |
|
1660 | + * @param $numclasses |
|
1661 | + * @return int |
|
1662 | + */ |
|
1663 | + final public function getClassIndex($shape, $classgroup, $numclasses) {} |
|
1664 | + |
|
1665 | + /** |
|
1666 | + * Returns the layer's data extents or NULL on error. |
|
1667 | + * If the layer's EXTENT member is set then this value is used, |
|
1668 | + * otherwise this call opens/closes the layer to read the |
|
1669 | + * extents. This is quick on shapefiles, but can be |
|
1670 | + * an expensive operation on some file formats or data sources. |
|
1671 | + * This function is safe to use on both opened or closed layers: it |
|
1672 | + * is not necessary to call open()/close() before/after calling it. |
|
1673 | + * |
|
1674 | + * @return rectObj |
|
1675 | + */ |
|
1676 | + final public function getExtent() {} |
|
1677 | + |
|
1678 | + /** |
|
1679 | + * Returns the :ref:`expression <expressions>` for this layer or NULL |
|
1680 | + * on error. |
|
1681 | + * |
|
1682 | + * @return string|null |
|
1683 | + */ |
|
1684 | + final public function getFilterString() {} |
|
1685 | + |
|
1686 | + /** |
|
1687 | + * Returns an array containing the grid intersection coordinates. If |
|
1688 | + * there are no coordinates, it returns an empty array. |
|
1689 | + * |
|
1690 | + * @return array |
|
1691 | + */ |
|
1692 | + final public function getGridIntersectionCoordinates() {} |
|
1693 | + |
|
1694 | + /** |
|
1695 | + * Returns an array containing the items. Must call open function first. |
|
1696 | + * If there are no items, it returns an empty array. |
|
1697 | + * |
|
1698 | + * @return array |
|
1699 | + */ |
|
1700 | + final public function getItems() {} |
|
1701 | + |
|
1702 | + /** |
|
1703 | + * Fetch layer metadata entry by name. Returns "" if no entry |
|
1704 | + * matches the name. Note that the search is case sensitive. |
|
1705 | + * .. note:: |
|
1706 | + * getMetaData's query is case sensitive. |
|
1707 | + * |
|
1708 | + * @param string $name |
|
1709 | + * @return int |
|
1710 | + */ |
|
1711 | + final public function getMetaData($name) {} |
|
1712 | + |
|
1713 | + /** |
|
1714 | + * Returns the number of results in the last query. |
|
1715 | + * |
|
1716 | + * @return int |
|
1717 | + */ |
|
1718 | + final public function getNumResults() {} |
|
1719 | + |
|
1720 | + /** |
|
1721 | + * Returns an array containing the processing strings. |
|
1722 | + * If there are no processing strings, it returns an empty array. |
|
1723 | + * |
|
1724 | + * @return array |
|
1725 | + */ |
|
1726 | + final public function getProcessing() {} |
|
1727 | + |
|
1728 | + /** |
|
1729 | + * Returns a string representation of the :ref:`projection <projection>`. |
|
1730 | + * Returns NULL on error or if no projection is set. |
|
1731 | + * |
|
1732 | + * @return string |
|
1733 | + */ |
|
1734 | + final public function getProjection() {} |
|
1735 | + |
|
1736 | + /** |
|
1737 | + * Returns a resultObj by index from a layer object with |
|
1738 | + * index in the range 0 to numresults-1. |
|
1739 | + * Returns a valid object or FALSE(0) if index is invalid. |
|
1740 | + * |
|
1741 | + * @param int $index |
|
1742 | + * @return resultObj |
|
1743 | + */ |
|
1744 | + final public function getResult($index) {} |
|
1745 | + |
|
1746 | + /** |
|
1747 | + * Returns the bounding box of the latest result. |
|
1748 | + * |
|
1749 | + * @return rectObj |
|
1750 | + */ |
|
1751 | + final public function getResultsBounds() {} |
|
1752 | + |
|
1753 | + /** |
|
1754 | + * If the resultObj passed has a valid resultindex, retrieve shapeObj from |
|
1755 | + * a layer's resultset. (You get it from the resultObj returned by |
|
1756 | + * getResult() for instance). Otherwise, it will do a single query on |
|
1757 | + * the layer to fetch the shapeindex |
|
1758 | + * .. code-block:: php |
|
1759 | + * $map = new mapObj("gmap75.map"); |
|
1760 | + * $l = $map->getLayerByName("popplace"); |
|
1761 | + * $l->queryByRect($map->extent); |
|
1762 | + * for ($i = 0; $i < $l->getNumResults(); $i++) { |
|
1763 | + * $s = $l->getShape($l->getResult($i)); |
|
1764 | + * echo $s->getValue($l,"Name"); |
|
1765 | + * echo "\n"; |
|
1766 | + * } |
|
1767 | + * |
|
1768 | + * @param resultObj $result |
|
1769 | + * @return shapeObj |
|
1770 | + */ |
|
1771 | + final public function getShape(resultObj $result) {} |
|
1772 | + |
|
1773 | + /** |
|
1774 | + * Returns a WMS GetFeatureInfo URL (works only for WMS layers) |
|
1775 | + * clickX, clickY is the location of to query in pixel coordinates |
|
1776 | + * with (0,0) at the top left of the image. |
|
1777 | + * featureCount is the number of results to return. |
|
1778 | + * infoFormat is the format the format in which the result should be |
|
1779 | + * requested. Depends on remote server's capabilities. MapServer |
|
1780 | + * WMS servers support only "MIME" (and should support "GML.1" soon). |
|
1781 | + * Returns "" and outputs a warning if layer is not a WMS layer |
|
1782 | + * or if it is not queriable. |
|
1783 | + * |
|
1784 | + * @param int $clickX |
|
1785 | + * @param int $clickY |
|
1786 | + * @param int $featureCount |
|
1787 | + * @param string $infoFormat |
|
1788 | + * @return string |
|
1789 | + */ |
|
1790 | + final public function getWMSFeatureInfoURL($clickX, $clickY, $featureCount, $infoFormat) {} |
|
1791 | + |
|
1792 | + /** |
|
1793 | + * Returns MS_TRUE/MS_FALSE depending on whether the layer is |
|
1794 | + * currently visible in the map (i.e. turned on, in scale, etc.). |
|
1795 | + * |
|
1796 | + * @return bool |
|
1797 | + */ |
|
1798 | + final public function isVisible() {} |
|
1799 | + |
|
1800 | + /** |
|
1801 | + * The class specified by the class index will be moved down into |
|
1802 | + * the array of layers. Returns MS_SUCCESS or MS_FAILURE. |
|
1803 | + * ex layer->moveclassdown(0) will have the effect of moving class 0 |
|
1804 | + * up to position 1, and the class at position 1 will be moved |
|
1805 | + * to position 0. |
|
1806 | + * |
|
1807 | + * @param int $index |
|
1808 | + * @return int |
|
1809 | + */ |
|
1810 | + final public function moveclassdown($index) {} |
|
1811 | + |
|
1812 | + /** |
|
1813 | + * The class specified by the class index will be moved up into |
|
1814 | + * the array of layers. Returns MS_SUCCESS or MS_FAILURE. |
|
1815 | + * ex layer->moveclassup(1) will have the effect of moving class 1 |
|
1816 | + * up to position 0, and the class at position 0 will be moved |
|
1817 | + * to position 1. |
|
1818 | + * |
|
1819 | + * @param int $index |
|
1820 | + * @return int |
|
1821 | + */ |
|
1822 | + final public function moveclassup($index) {} |
|
1823 | + |
|
1824 | + /** |
|
1825 | + * Open the layer for use with getShape(). |
|
1826 | + * Returns MS_SUCCESS/MS_FAILURE. |
|
1827 | + * |
|
1828 | + * @return int |
|
1829 | + */ |
|
1830 | + final public function open() {} |
|
1831 | + |
|
1832 | + /** |
|
1833 | + * Called after msWhichShapes has been called to actually retrieve |
|
1834 | + * shapes within a given area. Returns a shape object or NULL on |
|
1835 | + * error. |
|
1836 | + * .. code-block:: php |
|
1837 | + * $map = ms_newmapobj("d:/msapps/gmap-ms40/htdocs/gmap75.map"); |
|
1838 | + * $layer = $map->getLayerByName('road'); |
|
1839 | + * $status = $layer->open(); |
|
1840 | + * $status = $layer->whichShapes($map->extent); |
|
1841 | + * while ($shape = $layer->nextShape()) |
|
1842 | + * { |
|
1843 | + * echo $shape->index ."<br>\n"; |
|
1844 | + * } |
|
1845 | + * $layer->close(); |
|
1846 | + * |
|
1847 | + * @return shapeObj |
|
1848 | + */ |
|
1849 | + final public function nextShape() {} |
|
1850 | + |
|
1851 | + /** |
|
1852 | + * Query layer for shapes that intersect current map extents. qitem |
|
1853 | + * is the item (attribute) on which the query is performed, and |
|
1854 | + * qstring is the expression to match. The query is performed on all |
|
1855 | + * the shapes that are part of a :ref:`CLASS` that contains a |
|
1856 | + * :ref:`TEMPLATE <template>` value or that match any class in a |
|
1857 | + * layer that contains a :ref:`LAYER` :ref:`TEMPLATE <template>` |
|
1858 | + * value. Note that the layer's FILTER/FILTERITEM are ignored by |
|
1859 | + * this function. Mode is MS_SINGLE or MS_MULTIPLE depending on |
|
1860 | + * number of results you want. Returns MS_SUCCESS if shapes were |
|
1861 | + * found or MS_FAILURE if nothing was found or if some other error |
|
1862 | + * happened (note that the error message in case nothing was found |
|
1863 | + * can be avoided in PHP using the '@' control operator). |
|
1864 | + * |
|
1865 | + * @param string $qitem |
|
1866 | + * @param string $qstring |
|
1867 | + * @param int $mode |
|
1868 | + * @return int |
|
1869 | + */ |
|
1870 | + final public function queryByAttributes($qitem, $qstring, $mode) {} |
|
1871 | + |
|
1872 | + /** |
|
1873 | + * Perform a query set based on a previous set of results from |
|
1874 | + * another layer. At present the results MUST be based on a polygon |
|
1875 | + * layer. |
|
1876 | + * Returns MS_SUCCESS if shapes were found or MS_FAILURE if nothing |
|
1877 | + * was found or if some other error happened (note that the error |
|
1878 | + * message in case nothing was found can be avoided in PHP using |
|
1879 | + * the '@' control operator). |
|
1880 | + * |
|
1881 | + * @param int $slayer |
|
1882 | + * @return int |
|
1883 | + */ |
|
1884 | + final public function queryByFeatures($slayer) {} |
|
1885 | + |
|
1886 | + /** |
|
1887 | + * Query layer at point location specified in georeferenced map |
|
1888 | + * coordinates (i.e. not pixels). |
|
1889 | + * The query is performed on all the shapes that are part of a CLASS |
|
1890 | + * that contains a TEMPLATE value or that match any class in a |
|
1891 | + * layer that contains a LAYER TEMPLATE value. |
|
1892 | + * Mode is MS_SINGLE or MS_MULTIPLE depending on number of results |
|
1893 | + * you want. |
|
1894 | + * Passing buffer -1 defaults to tolerances set in the map file |
|
1895 | + * (in pixels) but you can use a constant buffer (specified in |
|
1896 | + * ground units) instead. |
|
1897 | + * Returns MS_SUCCESS if shapes were found or MS_FAILURE if nothing |
|
1898 | + * was found or if some other error happened (note that the error |
|
1899 | + * message in case nothing was found can be avoided in PHP using |
|
1900 | + * the '@' control operator). |
|
1901 | + * |
|
1902 | + * @param pointObj $point |
|
1903 | + * @param int $mode |
|
1904 | + * @param float $buffer |
|
1905 | + * @return int |
|
1906 | + */ |
|
1907 | + final public function queryByPoint(pointObj $point, $mode, $buffer) {} |
|
1908 | + |
|
1909 | + /** |
|
1910 | + * Query layer using a rectangle specified in georeferenced map |
|
1911 | + * coordinates (i.e. not pixels). |
|
1912 | + * The query is performed on all the shapes that are part of a CLASS |
|
1913 | + * that contains a TEMPLATE value or that match any class in a |
|
1914 | + * layer that contains a LAYER TEMPLATE value. |
|
1915 | + * Returns MS_SUCCESS if shapes were found or MS_FAILURE if nothing |
|
1916 | + * was found or if some other error happened (note that the error |
|
1917 | + * message in case nothing was found can be avoided in PHP using |
|
1918 | + * the '@' control operator). |
|
1919 | + * |
|
1920 | + * @param rectObj $rect |
|
1921 | + * @return int |
|
1922 | + */ |
|
1923 | + final public function queryByRect(rectObj $rect) {} |
|
1924 | + |
|
1925 | + /** |
|
1926 | + * Query layer based on a single shape, the shape has to be a polygon |
|
1927 | + * at this point. |
|
1928 | + * Returns MS_SUCCESS if shapes were found or MS_FAILURE if nothing |
|
1929 | + * was found or if some other error happened (note that the error |
|
1930 | + * message in case nothing was found can be avoided in PHP using |
|
1931 | + * the '@' control operator). |
|
1932 | + * |
|
1933 | + * @param shapeObj $shape |
|
1934 | + * @return int |
|
1935 | + */ |
|
1936 | + final public function queryByShape(shapeObj $shape) {} |
|
1937 | + |
|
1938 | + /** |
|
1939 | + * Removes the class indicated and returns a copy, or NULL in the case |
|
1940 | + * of a failure. Note that subsequent classes will be renumbered by |
|
1941 | + * this operation. The numclasses field contains the number of classes |
|
1942 | + * available. |
|
1943 | + * |
|
1944 | + * @param int $index |
|
1945 | + * @return classObj|null |
|
1946 | + */ |
|
1947 | + final public function removeClass($index) {} |
|
1948 | + |
|
1949 | + /** |
|
1950 | + * Remove a metadata entry for the layer. Returns MS_SUCCESS/MS_FAILURE. |
|
1951 | + * |
|
1952 | + * @param string $name |
|
1953 | + * @return int |
|
1954 | + */ |
|
1955 | + final public function removeMetaData($name) {} |
|
1956 | + |
|
1957 | + /** |
|
1958 | + * Set object property to a new value. |
|
1959 | + * |
|
1960 | + * @param string $property_name |
|
1961 | + * @param $new_value |
|
1962 | + * @return int |
|
1963 | + */ |
|
1964 | + final public function set($property_name, $new_value) {} |
|
1965 | + |
|
1966 | + /** |
|
1967 | + * Changes the connectiontype of the layer and recreates the vtable |
|
1968 | + * according to the new connection type. This method should be used |
|
1969 | + * instead of setting the connectiontype parameter directly. |
|
1970 | + * In the case when the layer.connectiontype = MS_PLUGIN the plugin_library |
|
1971 | + * parameter should also be specified so as to select the library to |
|
1972 | + * load by MapServer. For the other connection types this parameter |
|
1973 | + * is not used. |
|
1974 | + * |
|
1975 | + * @param int $connectiontype |
|
1976 | + * @param string $plugin_library |
|
1977 | + * @return int |
|
1978 | + */ |
|
1979 | + final public function setConnectionType($connectiontype, $plugin_library) {} |
|
1980 | + |
|
1981 | + /** |
|
1982 | + * Set layer filter :ref:`expression <expressions>`. |
|
1983 | + * |
|
1984 | + * @param string $expression |
|
1985 | + * @return int |
|
1986 | + */ |
|
1987 | + final public function setFilter($expression) {} |
|
1988 | + |
|
1989 | + /** |
|
1990 | + * Set a metadata entry for the layer. Returns MS_SUCCESS/MS_FAILURE. |
|
1991 | + * int setProcessing(string) |
|
1992 | + * Add the string to the processing string list for the layer. |
|
1993 | + * The layer->num_processing is incremented by 1. |
|
1994 | + * Returns MS_SUCCESS or MS_FAILURE on error. |
|
1995 | + * .. code-block:: php |
|
1996 | + * $oLayer->setprocessing("SCALE_1=AUTO"); |
|
1997 | + * $oLayer->setprocessing("SCALE_2=AUTO"); |
|
1998 | + * |
|
1999 | + * @param string $name |
|
2000 | + * @param string $value |
|
2001 | + * @return int |
|
2002 | + */ |
|
2003 | + final public function setMetaData($name, $value) {} |
|
2004 | + |
|
2005 | + /** |
|
2006 | + * Set layer :ref:`projection <projection>` and coordinate system. |
|
2007 | + * Parameters are given as a single string of comma-delimited PROJ.4 |
|
2008 | + * parameters. Returns MS_SUCCESS or MS_FAILURE on error. |
|
2009 | + * |
|
2010 | + * @param string $proj_params |
|
2011 | + * @return int |
|
2012 | + */ |
|
2013 | + final public function setProjection($proj_params) {} |
|
2014 | + |
|
2015 | + /** |
|
2016 | + * Same as setProjection(), but takes an OGC WKT projection |
|
2017 | + * definition string as input. |
|
2018 | + * .. note:: |
|
2019 | + * setWKTProjection requires GDAL support |
|
2020 | + * |
|
2021 | + * @param string $proj_params |
|
2022 | + * @return int |
|
2023 | + */ |
|
2024 | + final public function setWKTProjection($proj_params) {} |
|
2025 | + |
|
2026 | + /** |
|
2027 | + * Update a layer from a string snippet. Returns MS_SUCCESS/MS_FAILURE. |
|
2028 | + * .. code-block:: php |
|
2029 | + * modify the name |
|
2030 | + * $oLayer->updateFromString('LAYER NAME land_fn2 END'); |
|
2031 | + * add a new class |
|
2032 | + * $oLayer->updateFromString('LAYER CLASS STYLE COLOR 255 255 0 END END END'); |
|
2033 | + * int whichshapes(rectobj) |
|
2034 | + * Performs a spatial, and optionally an attribute based feature |
|
2035 | + * search. The function basically prepares things so that candidate |
|
2036 | + * features can be accessed by query or drawing functions (eg using |
|
2037 | + * nextshape function). Returns MS_SUCCESS, MS_FAILURE or MS_DONE. |
|
2038 | + * MS_DONE is returned if the layer extent does not overlap the |
|
2039 | + * rectObj. |
|
2040 | + * |
|
2041 | + * @param string $snippet |
|
2042 | + * @return int |
|
2043 | + */ |
|
2044 | + final public function updateFromString($snippet) {} |
|
2045 | 2045 | } |
2046 | 2046 | |
2047 | 2047 | /** |
@@ -2049,1163 +2049,1163 @@ discard block |
||
2049 | 2049 | */ |
2050 | 2050 | final class legendObj |
2051 | 2051 | { |
2052 | - /** |
|
2053 | - * @var int |
|
2054 | - */ |
|
2055 | - public $height; |
|
2056 | - |
|
2057 | - /** |
|
2058 | - * @var colorObj |
|
2059 | - */ |
|
2060 | - public $imagecolor; |
|
2061 | - |
|
2062 | - /** |
|
2063 | - * @var int |
|
2064 | - */ |
|
2065 | - public $keysizex; |
|
2066 | - |
|
2067 | - /** |
|
2068 | - * @var int |
|
2069 | - */ |
|
2070 | - public $keysizey; |
|
2071 | - |
|
2072 | - /** |
|
2073 | - * @var int |
|
2074 | - */ |
|
2075 | - public $keyspacingx; |
|
2076 | - |
|
2077 | - /** |
|
2078 | - * @var int |
|
2079 | - */ |
|
2080 | - public $keyspacingy; |
|
2081 | - |
|
2082 | - /** |
|
2083 | - * @var labelObj |
|
2084 | - */ |
|
2085 | - public $label; |
|
2086 | - |
|
2087 | - /** |
|
2088 | - * Color of outline of box, -1 for no outline |
|
2089 | - * |
|
2090 | - * @var colorObj |
|
2091 | - */ |
|
2092 | - public $outlinecolor; |
|
2093 | - |
|
2094 | - /** |
|
2095 | - * for embedded legends, MS_UL, MS_UC, ... |
|
2096 | - * |
|
2097 | - * @var int |
|
2098 | - */ |
|
2099 | - public $position; |
|
2100 | - |
|
2101 | - /** |
|
2102 | - * MS_TRUE, MS_FALSE |
|
2103 | - * |
|
2104 | - * @var int |
|
2105 | - */ |
|
2106 | - public $postlabelcache; |
|
2107 | - |
|
2108 | - /** |
|
2109 | - * MS_ON, MS_OFF, MS_EMBED |
|
2110 | - * |
|
2111 | - * @var int |
|
2112 | - */ |
|
2113 | - public $status; |
|
2114 | - |
|
2115 | - /** |
|
2116 | - * @var string |
|
2117 | - */ |
|
2118 | - public $template; |
|
2119 | - |
|
2120 | - /** |
|
2121 | - * @var int |
|
2122 | - */ |
|
2123 | - public $width; |
|
2124 | - |
|
2125 | - /** |
|
2126 | - * Saves the object to a string. Provides the inverse option for |
|
2127 | - * updateFromString. |
|
2128 | - * |
|
2129 | - * @return string |
|
2130 | - */ |
|
2131 | - final public function convertToString() {} |
|
2132 | - |
|
2133 | - /** |
|
2134 | - * Free the object properties and break the internal references. |
|
2135 | - * Note that you have to unset the php variable to free totally the |
|
2136 | - * resources. |
|
2137 | - * |
|
2138 | - * @return void |
|
2139 | - */ |
|
2140 | - final public function free() {} |
|
2141 | - |
|
2142 | - /** |
|
2143 | - * Set object property to a new value. |
|
2144 | - * |
|
2145 | - * @param string $property_name |
|
2146 | - * @param $new_value |
|
2147 | - * @return int |
|
2148 | - */ |
|
2149 | - final public function set($property_name, $new_value) {} |
|
2150 | - |
|
2151 | - /** |
|
2152 | - * Update a legend from a string snippet. Returns MS_SUCCESS/MS_FAILURE. |
|
2153 | - * |
|
2154 | - * @param string $snippet |
|
2155 | - * @return int |
|
2156 | - */ |
|
2157 | - final public function updateFromString($snippet) {} |
|
2052 | + /** |
|
2053 | + * @var int |
|
2054 | + */ |
|
2055 | + public $height; |
|
2056 | + |
|
2057 | + /** |
|
2058 | + * @var colorObj |
|
2059 | + */ |
|
2060 | + public $imagecolor; |
|
2061 | + |
|
2062 | + /** |
|
2063 | + * @var int |
|
2064 | + */ |
|
2065 | + public $keysizex; |
|
2066 | + |
|
2067 | + /** |
|
2068 | + * @var int |
|
2069 | + */ |
|
2070 | + public $keysizey; |
|
2071 | + |
|
2072 | + /** |
|
2073 | + * @var int |
|
2074 | + */ |
|
2075 | + public $keyspacingx; |
|
2076 | + |
|
2077 | + /** |
|
2078 | + * @var int |
|
2079 | + */ |
|
2080 | + public $keyspacingy; |
|
2081 | + |
|
2082 | + /** |
|
2083 | + * @var labelObj |
|
2084 | + */ |
|
2085 | + public $label; |
|
2086 | + |
|
2087 | + /** |
|
2088 | + * Color of outline of box, -1 for no outline |
|
2089 | + * |
|
2090 | + * @var colorObj |
|
2091 | + */ |
|
2092 | + public $outlinecolor; |
|
2093 | + |
|
2094 | + /** |
|
2095 | + * for embedded legends, MS_UL, MS_UC, ... |
|
2096 | + * |
|
2097 | + * @var int |
|
2098 | + */ |
|
2099 | + public $position; |
|
2100 | + |
|
2101 | + /** |
|
2102 | + * MS_TRUE, MS_FALSE |
|
2103 | + * |
|
2104 | + * @var int |
|
2105 | + */ |
|
2106 | + public $postlabelcache; |
|
2107 | + |
|
2108 | + /** |
|
2109 | + * MS_ON, MS_OFF, MS_EMBED |
|
2110 | + * |
|
2111 | + * @var int |
|
2112 | + */ |
|
2113 | + public $status; |
|
2114 | + |
|
2115 | + /** |
|
2116 | + * @var string |
|
2117 | + */ |
|
2118 | + public $template; |
|
2119 | + |
|
2120 | + /** |
|
2121 | + * @var int |
|
2122 | + */ |
|
2123 | + public $width; |
|
2124 | + |
|
2125 | + /** |
|
2126 | + * Saves the object to a string. Provides the inverse option for |
|
2127 | + * updateFromString. |
|
2128 | + * |
|
2129 | + * @return string |
|
2130 | + */ |
|
2131 | + final public function convertToString() {} |
|
2132 | + |
|
2133 | + /** |
|
2134 | + * Free the object properties and break the internal references. |
|
2135 | + * Note that you have to unset the php variable to free totally the |
|
2136 | + * resources. |
|
2137 | + * |
|
2138 | + * @return void |
|
2139 | + */ |
|
2140 | + final public function free() {} |
|
2141 | + |
|
2142 | + /** |
|
2143 | + * Set object property to a new value. |
|
2144 | + * |
|
2145 | + * @param string $property_name |
|
2146 | + * @param $new_value |
|
2147 | + * @return int |
|
2148 | + */ |
|
2149 | + final public function set($property_name, $new_value) {} |
|
2150 | + |
|
2151 | + /** |
|
2152 | + * Update a legend from a string snippet. Returns MS_SUCCESS/MS_FAILURE. |
|
2153 | + * |
|
2154 | + * @param string $snippet |
|
2155 | + * @return int |
|
2156 | + */ |
|
2157 | + final public function updateFromString($snippet) {} |
|
2158 | 2158 | } |
2159 | 2159 | |
2160 | 2160 | final class lineObj |
2161 | 2161 | { |
2162 | - /** |
|
2163 | - * read-only |
|
2164 | - * |
|
2165 | - * @var int |
|
2166 | - */ |
|
2167 | - public $numpoints; |
|
2168 | - |
|
2169 | - final public function __construct() {} |
|
2170 | - |
|
2171 | - /** |
|
2172 | - * Old style constructor |
|
2173 | - * |
|
2174 | - * @return lineObj |
|
2175 | - */ |
|
2176 | - final public function ms_newLineObj() {} |
|
2177 | - |
|
2178 | - /** |
|
2179 | - * Add a point to the end of line. Returns MS_SUCCESS/MS_FAILURE. |
|
2180 | - * |
|
2181 | - * @param pointObj $point |
|
2182 | - * @return int |
|
2183 | - */ |
|
2184 | - final public function add(pointObj $point) {} |
|
2185 | - |
|
2186 | - /** |
|
2187 | - * Add a point to the end of line. Returns MS_SUCCESS/MS_FAILURE. |
|
2188 | - * .. note:: |
|
2189 | - * the 3rd parameter m is used for measured shape files only. |
|
2190 | - * It is not mandatory. |
|
2191 | - * |
|
2192 | - * @param float $x |
|
2193 | - * @param float $y |
|
2194 | - * @param float $m |
|
2195 | - * @return int |
|
2196 | - */ |
|
2197 | - final public function addXY($x, $y, $m) {} |
|
2198 | - |
|
2199 | - /** |
|
2200 | - * Add a point to the end of line. Returns MS_SUCCESS/MS_FAILURE. |
|
2201 | - * .. note:: |
|
2202 | - * the 4th parameter m is used for measured shape files only. |
|
2203 | - * It is not mandatory. |
|
2204 | - * |
|
2205 | - * @param float $x |
|
2206 | - * @param float $y |
|
2207 | - * @param float $z |
|
2208 | - * @param float $m |
|
2209 | - * @return int |
|
2210 | - */ |
|
2211 | - final public function addXYZ($x, $y, $z, $m) {} |
|
2212 | - |
|
2213 | - /** |
|
2214 | - * Returns a reference to point number i. |
|
2215 | - * |
|
2216 | - * @param int $i |
|
2217 | - * @return pointObj |
|
2218 | - */ |
|
2219 | - final public function point($i) {} |
|
2220 | - |
|
2221 | - /** |
|
2222 | - * Project the line from "in" projection (1st argument) to "out" |
|
2223 | - * projection (2nd argument). Returns MS_SUCCESS/MS_FAILURE. |
|
2224 | - * |
|
2225 | - * @param projectionObj $in |
|
2226 | - * @param projectionObj $out |
|
2227 | - * @return int |
|
2228 | - */ |
|
2229 | - final public function project(projectionObj $in, projectionObj $out) {} |
|
2162 | + /** |
|
2163 | + * read-only |
|
2164 | + * |
|
2165 | + * @var int |
|
2166 | + */ |
|
2167 | + public $numpoints; |
|
2168 | + |
|
2169 | + final public function __construct() {} |
|
2170 | + |
|
2171 | + /** |
|
2172 | + * Old style constructor |
|
2173 | + * |
|
2174 | + * @return lineObj |
|
2175 | + */ |
|
2176 | + final public function ms_newLineObj() {} |
|
2177 | + |
|
2178 | + /** |
|
2179 | + * Add a point to the end of line. Returns MS_SUCCESS/MS_FAILURE. |
|
2180 | + * |
|
2181 | + * @param pointObj $point |
|
2182 | + * @return int |
|
2183 | + */ |
|
2184 | + final public function add(pointObj $point) {} |
|
2185 | + |
|
2186 | + /** |
|
2187 | + * Add a point to the end of line. Returns MS_SUCCESS/MS_FAILURE. |
|
2188 | + * .. note:: |
|
2189 | + * the 3rd parameter m is used for measured shape files only. |
|
2190 | + * It is not mandatory. |
|
2191 | + * |
|
2192 | + * @param float $x |
|
2193 | + * @param float $y |
|
2194 | + * @param float $m |
|
2195 | + * @return int |
|
2196 | + */ |
|
2197 | + final public function addXY($x, $y, $m) {} |
|
2198 | + |
|
2199 | + /** |
|
2200 | + * Add a point to the end of line. Returns MS_SUCCESS/MS_FAILURE. |
|
2201 | + * .. note:: |
|
2202 | + * the 4th parameter m is used for measured shape files only. |
|
2203 | + * It is not mandatory. |
|
2204 | + * |
|
2205 | + * @param float $x |
|
2206 | + * @param float $y |
|
2207 | + * @param float $z |
|
2208 | + * @param float $m |
|
2209 | + * @return int |
|
2210 | + */ |
|
2211 | + final public function addXYZ($x, $y, $z, $m) {} |
|
2212 | + |
|
2213 | + /** |
|
2214 | + * Returns a reference to point number i. |
|
2215 | + * |
|
2216 | + * @param int $i |
|
2217 | + * @return pointObj |
|
2218 | + */ |
|
2219 | + final public function point($i) {} |
|
2220 | + |
|
2221 | + /** |
|
2222 | + * Project the line from "in" projection (1st argument) to "out" |
|
2223 | + * projection (2nd argument). Returns MS_SUCCESS/MS_FAILURE. |
|
2224 | + * |
|
2225 | + * @param projectionObj $in |
|
2226 | + * @param projectionObj $out |
|
2227 | + * @return int |
|
2228 | + */ |
|
2229 | + final public function project(projectionObj $in, projectionObj $out) {} |
|
2230 | 2230 | } |
2231 | 2231 | |
2232 | 2232 | final class mapObj |
2233 | 2233 | { |
2234 | - /** |
|
2235 | - * @var float |
|
2236 | - */ |
|
2237 | - public $cellsize; |
|
2238 | - |
|
2239 | - /** |
|
2240 | - * @var int |
|
2241 | - */ |
|
2242 | - public $debug; |
|
2243 | - |
|
2244 | - /** |
|
2245 | - * pixels per inch, defaults to 72 |
|
2246 | - * |
|
2247 | - * @var float |
|
2248 | - */ |
|
2249 | - public $defresolution; |
|
2250 | - |
|
2251 | - /** |
|
2252 | - * ; |
|
2253 | - * |
|
2254 | - * @var rectObj |
|
2255 | - */ |
|
2256 | - public $extent; |
|
2257 | - |
|
2258 | - /** |
|
2259 | - * read-only, set by setFontSet() |
|
2260 | - * |
|
2261 | - * @var string |
|
2262 | - */ |
|
2263 | - public $fontsetfilename; |
|
2264 | - |
|
2265 | - /** |
|
2266 | - * see setSize() |
|
2267 | - * |
|
2268 | - * @var int |
|
2269 | - */ |
|
2270 | - public $height; |
|
2271 | - |
|
2272 | - /** |
|
2273 | - * @var colorObj |
|
2274 | - */ |
|
2275 | - public $imagecolor; |
|
2276 | - |
|
2277 | - /** |
|
2278 | - * @var int |
|
2279 | - */ |
|
2280 | - public $keysizex; |
|
2281 | - |
|
2282 | - /** |
|
2283 | - * @var int |
|
2284 | - */ |
|
2285 | - public $keysizey; |
|
2286 | - |
|
2287 | - /** |
|
2288 | - * @var int |
|
2289 | - */ |
|
2290 | - public $keyspacingx; |
|
2291 | - |
|
2292 | - /** |
|
2293 | - * @var int |
|
2294 | - */ |
|
2295 | - public $keyspacingy; |
|
2296 | - |
|
2297 | - /** |
|
2298 | - * no members. Used only to free the |
|
2299 | - * label cache (map->labelcache->free() |
|
2300 | - * |
|
2301 | - * @var labelcacheObj |
|
2302 | - */ |
|
2303 | - public $labelcache; |
|
2304 | - |
|
2305 | - /** |
|
2306 | - * @var legendObj |
|
2307 | - */ |
|
2308 | - public $legend; |
|
2309 | - |
|
2310 | - /** |
|
2311 | - * @var string |
|
2312 | - */ |
|
2313 | - public $mappath; |
|
2314 | - |
|
2315 | - /** |
|
2316 | - * @var int |
|
2317 | - */ |
|
2318 | - public $maxsize; |
|
2319 | - |
|
2320 | - /** |
|
2321 | - * @var hashTableObj |
|
2322 | - */ |
|
2323 | - public $metadata; |
|
2324 | - |
|
2325 | - /** |
|
2326 | - * @var string |
|
2327 | - */ |
|
2328 | - public $name; |
|
2329 | - |
|
2330 | - /** |
|
2331 | - * read-only |
|
2332 | - * |
|
2333 | - * @var int |
|
2334 | - */ |
|
2335 | - public $numlayers; |
|
2336 | - |
|
2337 | - /** |
|
2338 | - * @var outputformatObj |
|
2339 | - */ |
|
2340 | - public $outputformat; |
|
2341 | - |
|
2342 | - /** |
|
2343 | - * read-only |
|
2344 | - * |
|
2345 | - * @var int |
|
2346 | - */ |
|
2347 | - public $numoutputformats; |
|
2348 | - |
|
2349 | - /** |
|
2350 | - * @var projectionObj |
|
2351 | - */ |
|
2352 | - public $projection; |
|
2353 | - |
|
2354 | - /** |
|
2355 | - * @var querymapObj |
|
2356 | - */ |
|
2357 | - public $querymap; |
|
2358 | - |
|
2359 | - /** |
|
2360 | - * @var referenceMapObj |
|
2361 | - */ |
|
2362 | - public $reference; |
|
2363 | - |
|
2364 | - /** |
|
2365 | - * pixels per inch, defaults to 72 |
|
2366 | - * |
|
2367 | - * @var float |
|
2368 | - */ |
|
2369 | - public $resolution; |
|
2370 | - |
|
2371 | - /** |
|
2372 | - * @var scalebarObj |
|
2373 | - */ |
|
2374 | - public $scalebar; |
|
2375 | - |
|
2376 | - /** |
|
2377 | - * read-only, set by drawMap() |
|
2378 | - * |
|
2379 | - * @var float |
|
2380 | - */ |
|
2381 | - public $scaledenom; |
|
2382 | - |
|
2383 | - /** |
|
2384 | - * @var string |
|
2385 | - */ |
|
2386 | - public $shapepath; |
|
2387 | - |
|
2388 | - /** |
|
2389 | - * @var int |
|
2390 | - */ |
|
2391 | - public $status; |
|
2392 | - |
|
2393 | - /** |
|
2394 | - * read-only, set by setSymbolSet() |
|
2395 | - * |
|
2396 | - * @var string |
|
2397 | - */ |
|
2398 | - public $symbolsetfilename; |
|
2399 | - |
|
2400 | - /** |
|
2401 | - * map units type |
|
2402 | - * |
|
2403 | - * @var int |
|
2404 | - */ |
|
2405 | - public $units; |
|
2406 | - |
|
2407 | - /** |
|
2408 | - * @var webObj |
|
2409 | - */ |
|
2410 | - public $web; |
|
2411 | - |
|
2412 | - /** |
|
2413 | - * see setSize() |
|
2414 | - * |
|
2415 | - * @var int |
|
2416 | - */ |
|
2417 | - public $width; |
|
2418 | - |
|
2419 | - /** |
|
2420 | - * Returns a new object to deal with a MapServer map file. |
|
2421 | - * Construct a new mapObj from a mapfile string. Returns a new object to deal |
|
2422 | - * with a MapServer map file. |
|
2423 | - * .. note:: |
|
2424 | - * By default, the SYMBOLSET, FONTSET, and other paths in the mapfile |
|
2425 | - * are relative to the mapfile location. If new_map_path is provided |
|
2426 | - * then this directory will be used as the base path for all the |
|
2427 | - * rewlative paths inside the mapfile. |
|
2428 | - * |
|
2429 | - * @param string $map_file_name |
|
2430 | - * @param string $new_map_path |
|
2431 | - */ |
|
2432 | - final public function __construct($map_file_name, $new_map_path) {} |
|
2433 | - |
|
2434 | - /** |
|
2435 | - * Old style constructor |
|
2436 | - * |
|
2437 | - * @param string $map_file_string |
|
2438 | - * @param string $new_map_path |
|
2439 | - * @return mapObj |
|
2440 | - */ |
|
2441 | - final public function ms_newMapObjFromString($map_file_string, $new_map_path) {} |
|
2442 | - |
|
2443 | - /** |
|
2444 | - * Applies the config options set in the map file. For example |
|
2445 | - * setting the PROJ_LIB using the setconfigoption only modifies |
|
2446 | - * the value in the map object. applyconfigoptions will actually |
|
2447 | - * change the PROJ_LIB value that will be used when dealing with |
|
2448 | - * projection. |
|
2449 | - * |
|
2450 | - * @return int |
|
2451 | - */ |
|
2452 | - final public function applyconfigoptions() {} |
|
2453 | - |
|
2454 | - /** |
|
2455 | - * Apply the :ref:`SLD` document to the map file. The matching between the |
|
2456 | - * sld document and the map file will be done using the layer's name. |
|
2457 | - * See :ref:`SLD HowTo <sld>` for more information on the SLD support. |
|
2458 | - * |
|
2459 | - * @param string $sldxml |
|
2460 | - * @return int |
|
2461 | - */ |
|
2462 | - final public function applySLD($sldxml) {} |
|
2463 | - |
|
2464 | - /** |
|
2465 | - * Apply the SLD document pointed by the URL to the map file. The |
|
2466 | - * matching between the sld document and the map file will be done |
|
2467 | - * using the layer's name. |
|
2468 | - * See :ref:`SLD HowTo <sld>` for more information on the SLD support. |
|
2469 | - * |
|
2470 | - * @param string $sldurl |
|
2471 | - * @return int |
|
2472 | - */ |
|
2473 | - final public function applySLDURL($sldurl) {} |
|
2474 | - |
|
2475 | - /** |
|
2476 | - * Saves the object to a string. |
|
2477 | - * .. note:: |
|
2478 | - * The inverse method updateFromString does not exist for the mapObj |
|
2479 | - * .. versionadded:: 6.4 |
|
2480 | - * |
|
2481 | - * @return string |
|
2482 | - */ |
|
2483 | - final public function convertToString() {} |
|
2484 | - |
|
2485 | - /** |
|
2486 | - * Render map and return an image object or NULL on error. |
|
2487 | - * |
|
2488 | - * @return imageObj|null |
|
2489 | - */ |
|
2490 | - final public function draw() {} |
|
2491 | - |
|
2492 | - /** |
|
2493 | - * Renders the labels for a map. Returns MS_SUCCESS or MS_FAILURE on error. |
|
2494 | - * |
|
2495 | - * @param imageObj $image |
|
2496 | - * @return int |
|
2497 | - */ |
|
2498 | - final public function drawLabelCache(imageObj $image) {} |
|
2499 | - |
|
2500 | - /** |
|
2501 | - * Render legend and return an image object. |
|
2502 | - * |
|
2503 | - * @return imageObj |
|
2504 | - */ |
|
2505 | - final public function drawLegend() {} |
|
2506 | - |
|
2507 | - /** |
|
2508 | - * Render a query map and return an image object or NULL on error. |
|
2509 | - * |
|
2510 | - * @return imageObj|null |
|
2511 | - */ |
|
2512 | - final public function drawQuery() {} |
|
2513 | - |
|
2514 | - /** |
|
2515 | - * Render reference map and return an image object. |
|
2516 | - * |
|
2517 | - * @return imageObj |
|
2518 | - */ |
|
2519 | - final public function drawReferenceMap() {} |
|
2520 | - |
|
2521 | - /** |
|
2522 | - * Render scale bar and return an image object. |
|
2523 | - * |
|
2524 | - * @return imageObj |
|
2525 | - */ |
|
2526 | - final public function drawScaleBar() {} |
|
2527 | - |
|
2528 | - /** |
|
2529 | - * embeds a legend. Actually the legend is just added to the label |
|
2530 | - * cache so you must invoke drawLabelCache() to actually do the |
|
2531 | - * rendering (unless postlabelcache is set in which case it is |
|
2532 | - * drawn right away). Returns MS_SUCCESS or MS_FAILURE on error. |
|
2533 | - * |
|
2534 | - * @param imageObj $image |
|
2535 | - * @return int |
|
2536 | - */ |
|
2537 | - final public function embedLegend(imageObj $image) {} |
|
2538 | - |
|
2539 | - /** |
|
2540 | - * embeds a scalebar. Actually the scalebar is just added to the label |
|
2541 | - * cache so you must invoke drawLabelCache() to actually do the rendering |
|
2542 | - * (unless postlabelcache is set in which case it is drawn right away). |
|
2543 | - * Returns MS_SUCCESS or MS_FAILURE on error. |
|
2544 | - * |
|
2545 | - * @param imageObj $image |
|
2546 | - * @return int |
|
2547 | - */ |
|
2548 | - final public function embedScalebar(imageObj $image) {} |
|
2549 | - |
|
2550 | - /** |
|
2551 | - * Free the object properties and break the internal references. |
|
2552 | - * Note that you have to unset the php variable to free totally the |
|
2553 | - * resources. |
|
2554 | - * void freeQuery(layerindex) |
|
2555 | - * Frees the query result on a specified layer. If the layerindex is -1, |
|
2556 | - * all queries on layers will be freed. |
|
2557 | - * |
|
2558 | - * @return void |
|
2559 | - */ |
|
2560 | - final public function free() {} |
|
2561 | - |
|
2562 | - /** |
|
2563 | - * Returns an SLD XML string based on all the classes found in all |
|
2564 | - * the layers that have `STATUS` `on`. |
|
2565 | - * |
|
2566 | - * @return string |
|
2567 | - */ |
|
2568 | - final public function generateSLD() {} |
|
2569 | - |
|
2570 | - /** |
|
2571 | - * Return an array containing all the group names used in the |
|
2572 | - * layers. If there are no groups, it returns an empty array. |
|
2573 | - * |
|
2574 | - * @return array |
|
2575 | - */ |
|
2576 | - final public function getAllGroupNames() {} |
|
2577 | - |
|
2578 | - /** |
|
2579 | - * Return an array containing all the layer names. |
|
2580 | - * If there are no layers, it returns an empty array. |
|
2581 | - * |
|
2582 | - * @return array |
|
2583 | - */ |
|
2584 | - final public function getAllLayerNames() {} |
|
2585 | - |
|
2586 | - /** |
|
2587 | - * Returns a colorObj corresponding to the color index in the |
|
2588 | - * palette. |
|
2589 | - * |
|
2590 | - * @param int $iCloIndex |
|
2591 | - * @return colorObj |
|
2592 | - */ |
|
2593 | - final public function getColorbyIndex($iCloIndex) {} |
|
2594 | - |
|
2595 | - /** |
|
2596 | - * Returns the config value associated with the key. |
|
2597 | - * Returns an empty sting if key not found. |
|
2598 | - * |
|
2599 | - * @param string $key |
|
2600 | - * @return string |
|
2601 | - */ |
|
2602 | - final public function getConfigOption($key) {} |
|
2603 | - |
|
2604 | - /** |
|
2605 | - * Returns a labelcacheMemberObj from the map given an index value |
|
2606 | - * (0=first label). Labelcache has to be enabled. |
|
2607 | - * .. code-block:: php |
|
2608 | - * while ($oLabelCacheMember = $oMap->getLabel($i)) { |
|
2609 | - * do something with the labelcachemember |
|
2610 | - * ++$i; |
|
2611 | - * } |
|
2612 | - * |
|
2613 | - * @param int $index |
|
2614 | - * @return labelcacheMemberObj |
|
2615 | - */ |
|
2616 | - final public function getLabel($index) {} |
|
2617 | - |
|
2618 | - /** |
|
2619 | - * Returns a layerObj from the map given an index value (0=first layer) |
|
2620 | - * |
|
2621 | - * @param int $index |
|
2622 | - * @return layerObj |
|
2623 | - */ |
|
2624 | - final public function getLayer($index) {} |
|
2625 | - |
|
2626 | - /** |
|
2627 | - * Returns a layerObj from the map given a layer name. |
|
2628 | - * Returns NULL if layer doesn't exist. |
|
2629 | - * |
|
2630 | - * @param string $layer_name |
|
2631 | - * @return layerObj |
|
2632 | - */ |
|
2633 | - final public function getLayerByName($layer_name) {} |
|
2634 | - |
|
2635 | - /** |
|
2636 | - * Return an array containing layer's index in the order which they |
|
2637 | - * are drawn. If there are no layers, it returns an empty array. |
|
2638 | - * |
|
2639 | - * @return array |
|
2640 | - */ |
|
2641 | - final public function getLayersDrawingOrder() {} |
|
2642 | - |
|
2643 | - /** |
|
2644 | - * Return an array containing all the layer's indexes given |
|
2645 | - * a group name. If there are no layers, it returns an empty array. |
|
2646 | - * |
|
2647 | - * @param string $groupname |
|
2648 | - * @return array |
|
2649 | - */ |
|
2650 | - final public function getLayersIndexByGroup($groupname) {} |
|
2651 | - |
|
2652 | - /** |
|
2653 | - * Fetch metadata entry by name (stored in the :ref:`WEB` object in |
|
2654 | - * the map file). Returns "" if no entry matches the name. |
|
2655 | - * .. note:: |
|
2656 | - * getMetaData's query is case sensitive. |
|
2657 | - * |
|
2658 | - * @param string $name |
|
2659 | - * @return int |
|
2660 | - */ |
|
2661 | - final public function getMetaData($name) {} |
|
2662 | - |
|
2663 | - /** |
|
2664 | - * Return the number of symbols in map. |
|
2665 | - * |
|
2666 | - * @return int |
|
2667 | - */ |
|
2668 | - final public function getNumSymbols() {} |
|
2669 | - |
|
2670 | - /** |
|
2671 | - * Returns a string representation of the projection. |
|
2672 | - * Returns NULL on error or if no projection is set. |
|
2673 | - * |
|
2674 | - * @return string |
|
2675 | - */ |
|
2676 | - final public function getProjection() {} |
|
2677 | - |
|
2678 | - /** |
|
2679 | - * Returns the symbol index using the name. |
|
2680 | - * |
|
2681 | - * @param string $symbol_name |
|
2682 | - * @return int |
|
2683 | - */ |
|
2684 | - final public function getSymbolByName($symbol_name) {} |
|
2685 | - |
|
2686 | - /** |
|
2687 | - * Returns the symbol object using a symbol id. Refer to |
|
2688 | - * the symbol object reference section for more details. |
|
2689 | - * int insertLayer( layerObj layer [, int nIndex=-1 ] ) |
|
2690 | - * Insert a copy of *layer* into the Map at index *nIndex*. The |
|
2691 | - * default value of *nIndex* is -1, which means the last possible |
|
2692 | - * index. Returns the index of the new Layer, or -1 in the case of a |
|
2693 | - * failure. |
|
2694 | - * |
|
2695 | - * @param int $symbolid |
|
2696 | - * @return symbolObj |
|
2697 | - */ |
|
2698 | - final public function getSymbolObjectById($symbolid) {} |
|
2699 | - |
|
2700 | - /** |
|
2701 | - * Available only if WMS support is enabled. Load a :ref:`WMS Map Context <map_context>` |
|
2702 | - * XML file into the current mapObj. If the |
|
2703 | - * map already contains some layers then the layers defined in the |
|
2704 | - * WMS Map context document are added to the current map. The 2nd |
|
2705 | - * argument unique_layer_name is optional and if set to MS_TRUE |
|
2706 | - * layers created will have a unique name (unique prefix added to the |
|
2707 | - * name). If set to MS_FALSE the layer name will be the the same name |
|
2708 | - * as in the context. The default value is MS_FALSE. Returns |
|
2709 | - * MS_SUCCESS/MS_FAILURE. |
|
2710 | - * |
|
2711 | - * @param string $filename |
|
2712 | - * @param bool $unique_layer_name |
|
2713 | - * @return int |
|
2714 | - */ |
|
2715 | - final public function loadMapContext($filename, $unique_layer_name) {} |
|
2716 | - |
|
2717 | - /** |
|
2718 | - * Load OWS request parameters (BBOX, LAYERS, &c.) into map. Returns |
|
2719 | - * MS_SUCCESS or MS_FAILURE. 2nd argument version is not mandatory. |
|
2720 | - * If not given, the version will be set to 1.1.1 |
|
2721 | - * int loadQuery(filename) |
|
2722 | - * Loads a query from a file. Returns MS_SUCCESS or MS_FAILURE. |
|
2723 | - * To be used with savequery. |
|
2724 | - * |
|
2725 | - * @param OwsrequestObj $request |
|
2726 | - * @param string $version |
|
2727 | - * @return int |
|
2728 | - */ |
|
2729 | - final public function loadOWSParameters(OwsrequestObj $request, $version) {} |
|
2730 | - |
|
2731 | - /** |
|
2732 | - * Move layer down in the hierarchy of drawing. |
|
2733 | - * Returns MS_SUCCESS or MS_FAILURE on error. |
|
2734 | - * |
|
2735 | - * @param int $layerindex |
|
2736 | - * @return int |
|
2737 | - */ |
|
2738 | - final public function moveLayerDown($layerindex) {} |
|
2739 | - |
|
2740 | - /** |
|
2741 | - * Move layer up in the hierarchy of drawing. |
|
2742 | - * Returns MS_SUCCESS or MS_FAILURE on error. |
|
2743 | - * |
|
2744 | - * @param int $layerindex |
|
2745 | - * @return int |
|
2746 | - */ |
|
2747 | - final public function moveLayerUp($layerindex) {} |
|
2748 | - |
|
2749 | - /** |
|
2750 | - * Offset the map extent based on the given distances in map coordinates. |
|
2751 | - * Returns MS_SUCCESS or MS_FAILURE. |
|
2752 | - * |
|
2753 | - * @param float $x |
|
2754 | - * @param float $y |
|
2755 | - * @return int |
|
2756 | - */ |
|
2757 | - final public function offsetExtent($x, $y) {} |
|
2758 | - |
|
2759 | - /** |
|
2760 | - * Processes and executes the passed OpenGIS Web Services request on |
|
2761 | - * the map. Returns MS_DONE (2) if there is no valid OWS request in |
|
2762 | - * the req object, MS_SUCCESS (0) if an OWS request was successfully |
|
2763 | - * processed and MS_FAILURE (1) if an OWS request was not |
|
2764 | - * successfully processed. OWS requests include :ref:`WMS <wms_server>`, |
|
2765 | - * :ref:`WFS <wfs_server>`, :ref:`WCS <wcs_server>` |
|
2766 | - * and :ref:`SOS <sos_server>` requests supported by MapServer. |
|
2767 | - * Results of a dispatched request are written to stdout and can be |
|
2768 | - * captured using the msIO services (ie. ms_ioinstallstdouttobuffer() |
|
2769 | - * and ms_iogetstdoutbufferstring()) |
|
2770 | - * |
|
2771 | - * @param OwsrequestObj $request |
|
2772 | - * @return int |
|
2773 | - */ |
|
2774 | - final public function owsDispatch(OwsrequestObj $request) {} |
|
2775 | - |
|
2776 | - /** |
|
2777 | - * Return a blank image object. |
|
2778 | - * |
|
2779 | - * @return imageObj |
|
2780 | - */ |
|
2781 | - final public function prepareImage() {} |
|
2782 | - |
|
2783 | - /** |
|
2784 | - * Calculate the scale of the map and set map->scaledenom. |
|
2785 | - * |
|
2786 | - * @return void |
|
2787 | - */ |
|
2788 | - final public function prepareQuery() {} |
|
2789 | - |
|
2790 | - /** |
|
2791 | - * Process legend template files and return the result in a buffer. |
|
2792 | - * .. seealso:: |
|
2793 | - * :ref:`processtemplate <processtemplate>` |
|
2794 | - * |
|
2795 | - * @param array $params |
|
2796 | - * @return string |
|
2797 | - */ |
|
2798 | - final public function processLegendTemplate(array $params) {} |
|
2799 | - |
|
2800 | - /** |
|
2801 | - * Process query template files and return the result in a buffer. |
|
2802 | - * Second argument generateimages is not mandatory. If not given |
|
2803 | - * it will be set to TRUE. |
|
2804 | - * .. seealso:: |
|
2805 | - * :ref:`processtemplate <processtemplate>` |
|
2806 | - * .. _processtemplate: |
|
2807 | - * |
|
2808 | - * @param array $params |
|
2809 | - * @param bool $generateimages |
|
2810 | - * @return string |
|
2811 | - */ |
|
2812 | - final public function processQueryTemplate(array $params, $generateimages) {} |
|
2813 | - |
|
2814 | - /** |
|
2815 | - * Process the template file specified in the web object and return the |
|
2816 | - * result in a buffer. The processing consists of opening the template |
|
2817 | - * file and replace all the tags found in it. Only tags that have an |
|
2818 | - * equivalent element in the map object are replaced (ex [scaledenom]). |
|
2819 | - * The are two exceptions to the previous statement : |
|
2820 | - * - [img], [scalebar], [ref], [legend] would be replaced with the |
|
2821 | - * appropriate url if the parameter generateimages is set to |
|
2822 | - * MS_TRUE. (Note : the images corresponding to the different objects |
|
2823 | - * are generated if the object is set to MS_ON in the map file) |
|
2824 | - * - the user can use the params parameter to specify tags and |
|
2825 | - * their values. For example if the user have a specific tag call |
|
2826 | - * [my_tag] and would like it to be replaced by "value_of_my_tag" |
|
2827 | - * he would do |
|
2828 | - * .. code-block:: php |
|
2829 | - * $tmparray["my_tag"] = "value_of_my_tag"; |
|
2830 | - * $map->processtemplate($tmparray, MS_FALSE); |
|
2831 | - * |
|
2832 | - * @param array $params |
|
2833 | - * @param bool $generateimages |
|
2834 | - * @return string |
|
2835 | - */ |
|
2836 | - final public function processTemplate(array $params, $generateimages) {} |
|
2837 | - |
|
2838 | - /** |
|
2839 | - * Perform a query based on a previous set of results from |
|
2840 | - * a layer. At present the results MUST be based on a polygon layer. |
|
2841 | - * Returns MS_SUCCESS if shapes were found or MS_FAILURE if nothing |
|
2842 | - * was found or if some other error happened (note that the error |
|
2843 | - * message in case nothing was found can be avoided in PHP using |
|
2844 | - * the '@' control operator). |
|
2845 | - * |
|
2846 | - * @param int $slayer |
|
2847 | - * @return int |
|
2848 | - */ |
|
2849 | - final public function queryByFeatures($slayer) {} |
|
2850 | - |
|
2851 | - /** |
|
2852 | - * Add a specific shape on a given layer to the query result. |
|
2853 | - * If addtoquery (which is a non mandatory argument) is set to MS_TRUE, |
|
2854 | - * the shape will be added to the existing query list. Default behavior |
|
2855 | - * is to free the existing query list and add only the new shape. |
|
2856 | - * |
|
2857 | - * @param $layerindex |
|
2858 | - * @param $tileindex |
|
2859 | - * @param $shapeindex |
|
2860 | - * @param $addtoquery |
|
2861 | - * @return int |
|
2862 | - */ |
|
2863 | - final public function queryByIndex($layerindex, $tileindex, $shapeindex, $addtoquery) {} |
|
2864 | - |
|
2865 | - /** |
|
2866 | - * Query all selected layers in map at point location specified in |
|
2867 | - * georeferenced map coordinates (i.e. not pixels). |
|
2868 | - * The query is performed on all the shapes that are part of a :ref:`CLASS` |
|
2869 | - * that contains a :ref:`TEMPLATE` value or that match any class in a |
|
2870 | - * layer that contains a :ref:`LAYER` :ref:`TEMPLATE <template>` value. |
|
2871 | - * Mode is MS_SINGLE or MS_MULTIPLE depending on number of results |
|
2872 | - * you want. |
|
2873 | - * Passing buffer -1 defaults to tolerances set in the map file |
|
2874 | - * (in pixels) but you can use a constant buffer (specified in |
|
2875 | - * ground units) instead. |
|
2876 | - * Returns MS_SUCCESS if shapes were found or MS_FAILURE if nothing |
|
2877 | - * was found or if some other error happened (note that the error |
|
2878 | - * message in case nothing was found can be avoided in PHP using |
|
2879 | - * the '@' control operator). |
|
2880 | - * |
|
2881 | - * @param pointObj $point |
|
2882 | - * @param int $mode |
|
2883 | - * @param float $buffer |
|
2884 | - * @return int |
|
2885 | - */ |
|
2886 | - final public function queryByPoint(pointObj $point, $mode, $buffer) {} |
|
2887 | - |
|
2888 | - /** |
|
2889 | - * Query all selected layers in map using a rectangle specified in |
|
2890 | - * georeferenced map coordinates (i.e. not pixels). The query is |
|
2891 | - * performed on all the shapes that are part of a :ref:`CLASS` that |
|
2892 | - * contains a :ref:`TEMPLATE` value or that match any class in a |
|
2893 | - * layer that contains a :ref:`LAYER` :ref:`TEMPLATE <template>` |
|
2894 | - * value. Returns MS_SUCCESS if shapes were found or MS_FAILURE if |
|
2895 | - * nothing was found or if some other error happened (note that the |
|
2896 | - * error message in case nothing was found can be avoided in PHP |
|
2897 | - * using the '@' control operator). |
|
2898 | - * |
|
2899 | - * @param rectObj $rect |
|
2900 | - * @return int |
|
2901 | - */ |
|
2902 | - final public function queryByRect(rectObj $rect) {} |
|
2903 | - |
|
2904 | - /** |
|
2905 | - * Query all selected layers in map based on a single shape, the |
|
2906 | - * shape has to be a polygon at this point. |
|
2907 | - * Returns MS_SUCCESS if shapes were found or MS_FAILURE if nothing |
|
2908 | - * was found or if some other error happened (note that the error |
|
2909 | - * message in case nothing was found can be avoided in PHP using |
|
2910 | - * the '@' control operator). |
|
2911 | - * |
|
2912 | - * @param shapeObj $shape |
|
2913 | - * @return int |
|
2914 | - */ |
|
2915 | - final public function queryByShape(shapeObj $shape) {} |
|
2916 | - |
|
2917 | - /** |
|
2918 | - * Remove a layer from the mapObj. The argument is the index of the |
|
2919 | - * layer to be removed. Returns the removed layerObj on success, else |
|
2920 | - * null. |
|
2921 | - * |
|
2922 | - * @param int $nIndex |
|
2923 | - * @return layerObj |
|
2924 | - */ |
|
2925 | - final public function removeLayer($nIndex) {} |
|
2926 | - |
|
2927 | - /** |
|
2928 | - * Remove a metadata entry for the map (stored in the WEB object in the map |
|
2929 | - * file). Returns MS_SUCCESS/MS_FAILURE. |
|
2930 | - * |
|
2931 | - * @param string $name |
|
2932 | - * @return int |
|
2933 | - */ |
|
2934 | - final public function removeMetaData($name) {} |
|
2935 | - |
|
2936 | - /** |
|
2937 | - * Save current map object state to a file. Returns -1 on error. |
|
2938 | - * Use absolute path. If a relative path is used, then it will be |
|
2939 | - * relative to the mapfile location. |
|
2940 | - * |
|
2941 | - * @param string $filename |
|
2942 | - * @return int |
|
2943 | - */ |
|
2944 | - final public function save($filename) {} |
|
2945 | - |
|
2946 | - /** |
|
2947 | - * Available only if WMS support is enabled. Save current map object |
|
2948 | - * state in :ref:`WMS Map Context <map_context>` format. Only WMS |
|
2949 | - * layers are saved in the WMS Map Context XML file. Returns |
|
2950 | - * MS_SUCCESS/MS_FAILURE. |
|
2951 | - * |
|
2952 | - * @param string $filename |
|
2953 | - * @return int |
|
2954 | - */ |
|
2955 | - final public function saveMapContext($filename) {} |
|
2956 | - |
|
2957 | - /** |
|
2958 | - * Save the current query in a file. Results determines the save format - |
|
2959 | - * MS_TRUE (or 1/true) saves the query results (tile index and shape index), |
|
2960 | - * MS_FALSE (or 0/false) the query parameters (and the query will be re-run |
|
2961 | - * in loadquery). Returns MS_SUCCESS or MS_FAILURE. Either save format can be |
|
2962 | - * used with loadquery. See RFC 65 and ticket #3647 for details of different |
|
2963 | - * save formats. |
|
2964 | - * |
|
2965 | - * @param string $filename |
|
2966 | - * @param int $results |
|
2967 | - * @return int |
|
2968 | - */ |
|
2969 | - final public function saveQuery($filename, $results) {} |
|
2970 | - |
|
2971 | - /** |
|
2972 | - * Scale the map extent using the zoomfactor and ensure the extent |
|
2973 | - * within the minscaledenom and maxscaledenom domain. If |
|
2974 | - * minscaledenom and/or maxscaledenom is 0 then the parameter is not |
|
2975 | - * taken into account. Returns MS_SUCCESS or MS_FAILURE. |
|
2976 | - * |
|
2977 | - * @param float $zoomfactor |
|
2978 | - * @param float $minscaledenom |
|
2979 | - * @param float $maxscaledenom |
|
2980 | - * @return int |
|
2981 | - */ |
|
2982 | - final public function scaleExtent($zoomfactor, $minscaledenom, $maxscaledenom) {} |
|
2983 | - |
|
2984 | - /** |
|
2985 | - * Selects the output format to be used in the map. |
|
2986 | - * Returns MS_SUCCESS/MS_FAILURE. |
|
2987 | - * .. note:: |
|
2988 | - * the type used should correspond to one of the output formats |
|
2989 | - * declared in the map file. The type argument passed is compared |
|
2990 | - * with the mimetype parameter in the output format structure and |
|
2991 | - * then to the name parameter in the structure. |
|
2992 | - * |
|
2993 | - * @param string $type |
|
2994 | - * @return int |
|
2995 | - */ |
|
2996 | - final public function selectOutputFormat($type) {} |
|
2997 | - |
|
2998 | - /** |
|
2999 | - * Appends outputformat object in the map object. |
|
3000 | - * Returns the new numoutputformats value. |
|
3001 | - * |
|
3002 | - * @param outputFormatObj $outputFormat |
|
3003 | - * @return int |
|
3004 | - */ |
|
3005 | - final public function appendOutputFormat(outputFormatObj $outputFormat) {} |
|
3006 | - |
|
3007 | - /** |
|
3008 | - * Remove outputformat from the map. |
|
3009 | - * Returns MS_SUCCESS/MS_FAILURE. |
|
3010 | - * |
|
3011 | - * @param string $name |
|
3012 | - * @return int |
|
3013 | - */ |
|
3014 | - final public function removeOutputFormat($name) {} |
|
3015 | - |
|
3016 | - /** |
|
3017 | - * Returns the outputformat at index position. |
|
3018 | - * |
|
3019 | - * @param int $index |
|
3020 | - * @return outputFormatObj |
|
3021 | - */ |
|
3022 | - final public function getOutputFormat($index) {} |
|
3023 | - |
|
3024 | - /** |
|
3025 | - * Set map object property to new value. |
|
3026 | - * |
|
3027 | - * @param string $property_name |
|
3028 | - * @param $new_value |
|
3029 | - * @return int |
|
3030 | - */ |
|
3031 | - final public function set($property_name, $new_value) {} |
|
3032 | - |
|
3033 | - /** |
|
3034 | - * Set the map center to the given map point. |
|
3035 | - * Returns MS_SUCCESS or MS_FAILURE. |
|
3036 | - * |
|
3037 | - * @param pointObj $center |
|
3038 | - * @return int |
|
3039 | - */ |
|
3040 | - final public function setCenter(pointObj $center) {} |
|
3041 | - |
|
3042 | - /** |
|
3043 | - * Sets a config parameter using the key and the value passed |
|
3044 | - * |
|
3045 | - * @param string $key |
|
3046 | - * @param string $value |
|
3047 | - * @return int |
|
3048 | - */ |
|
3049 | - final public function setConfigOption($key, $value) {} |
|
3050 | - |
|
3051 | - /** |
|
3052 | - * Set the map extents using the georef extents passed in argument. |
|
3053 | - * Returns MS_SUCCESS or MS_FAILURE on error. |
|
3054 | - * |
|
3055 | - * @param float $minx |
|
3056 | - * @param float $miny |
|
3057 | - * @param float $maxx |
|
3058 | - * @param float $maxy |
|
3059 | - * @return void |
|
3060 | - */ |
|
3061 | - final public function setExtent($minx, $miny, $maxx, $maxy) {} |
|
3062 | - |
|
3063 | - /** |
|
3064 | - * Load and set a new :ref:`fontset`. |
|
3065 | - * boolean setLayersDrawingOrder(array layeryindex) |
|
3066 | - * Set the layer's order array. The argument passed must be a valid |
|
3067 | - * array with all the layer's index. |
|
3068 | - * Returns MS_SUCCESS or MS_FAILURE on error. |
|
3069 | - * |
|
3070 | - * @param string $fileName |
|
3071 | - * @return int |
|
3072 | - */ |
|
3073 | - final public function setFontSet($fileName) {} |
|
3074 | - |
|
3075 | - /** |
|
3076 | - * Set a metadata entry for the map (stored in the WEB object in the map |
|
3077 | - * file). Returns MS_SUCCESS/MS_FAILURE. |
|
3078 | - * |
|
3079 | - * @param string $name |
|
3080 | - * @param string $value |
|
3081 | - * @return int |
|
3082 | - */ |
|
3083 | - final public function setMetaData($name, $value) {} |
|
3084 | - |
|
3085 | - /** |
|
3086 | - * Set map projection and coordinate system. Returns MS_SUCCESS or |
|
3087 | - * MS_FAILURE on error. |
|
3088 | - * Parameters are given as a single string of comma-delimited PROJ.4 |
|
3089 | - * parameters. The argument : bSetUnitsAndExtents is used to |
|
3090 | - * automatically update the map units and extents based on the new |
|
3091 | - * projection. Possible values are MS_TRUE and MS_FALSE. By default it is |
|
3092 | - * set at MS_FALSE. |
|
3093 | - * |
|
3094 | - * @param string $proj_params |
|
3095 | - * @param bool $bSetUnitsAndExtents |
|
3096 | - * @return int |
|
3097 | - */ |
|
3098 | - final public function setProjection($proj_params, $bSetUnitsAndExtents) {} |
|
3099 | - |
|
3100 | - /** |
|
3101 | - * Set map rotation angle. The map view rectangle (specified in |
|
3102 | - * EXTENTS) will be rotated by the indicated angle in the counter- |
|
3103 | - * clockwise direction. Note that this implies the rendered map |
|
3104 | - * will be rotated by the angle in the clockwise direction. |
|
3105 | - * Returns MS_SUCCESS or MS_FAILURE. |
|
3106 | - * |
|
3107 | - * @param float $rotation_angle |
|
3108 | - * @return int |
|
3109 | - */ |
|
3110 | - final public function setRotation($rotation_angle) {} |
|
3111 | - |
|
3112 | - /** |
|
3113 | - * Set the map width and height. This method updates the internal |
|
3114 | - * geotransform and other data structures required for map rotation |
|
3115 | - * so it should be used instead of setting the width and height members |
|
3116 | - * directly. |
|
3117 | - * Returns MS_SUCCESS or MS_FAILURE. |
|
3118 | - * |
|
3119 | - * @param int $width |
|
3120 | - * @param int $height |
|
3121 | - * @return int |
|
3122 | - */ |
|
3123 | - final public function setSize($width, $height) {} |
|
3124 | - |
|
3125 | - /** |
|
3126 | - * Load and set a symbol file dynamically. |
|
3127 | - * |
|
3128 | - * @param string $fileName |
|
3129 | - * @return int |
|
3130 | - */ |
|
3131 | - final public function setSymbolSet($fileName) {} |
|
3132 | - |
|
3133 | - /** |
|
3134 | - * Same as setProjection(), but takes an OGC WKT projection |
|
3135 | - * definition string as input. Returns MS_SUCCESS or MS_FAILURE on error. |
|
3136 | - * .. note:: |
|
3137 | - * setWKTProjection requires GDAL support |
|
3138 | - * |
|
3139 | - * @param string $proj_params |
|
3140 | - * @param bool $bSetUnitsAndExtents |
|
3141 | - * @return int |
|
3142 | - */ |
|
3143 | - final public function setWKTProjection($proj_params, $bSetUnitsAndExtents) {} |
|
3144 | - |
|
3145 | - /** |
|
3146 | - * Zoom to a given XY position. Returns MS_SUCCESS or MS_FAILURE on error. |
|
3147 | - * Parameters are |
|
3148 | - * - Zoom factor : positive values do zoom in, negative values |
|
3149 | - * zoom out. Factor of 1 will recenter. |
|
3150 | - * - Pixel position (pointObj) : x, y coordinates of the click, |
|
3151 | - * with (0,0) at the top-left |
|
3152 | - * - Width : width in pixel of the current image. |
|
3153 | - * - Height : Height in pixel of the current image. |
|
3154 | - * - Georef extent (rectObj) : current georef extents. |
|
3155 | - * - MaxGeoref extent (rectObj) : (optional) maximum georef extents. |
|
3156 | - * If provided then it will be impossible to zoom/pan outside of |
|
3157 | - * those extents. |
|
3158 | - * |
|
3159 | - * @param int $nZoomFactor |
|
3160 | - * @param pointObj $oPixelPos |
|
3161 | - * @param int $nImageWidth |
|
3162 | - * @param int $nImageHeight |
|
3163 | - * @param rectObj $oGeorefExt |
|
3164 | - * @return int |
|
3165 | - */ |
|
3166 | - final public function zoomPoint($nZoomFactor, pointObj $oPixelPos, $nImageWidth, $nImageHeight, rectObj $oGeorefExt) {} |
|
3167 | - |
|
3168 | - /** |
|
3169 | - * Set the map extents to a given extents. Returns MS_SUCCESS or |
|
3170 | - * MS_FAILURE on error. |
|
3171 | - * Parameters are : |
|
3172 | - * - oPixelExt (rect object) : Pixel Extents |
|
3173 | - * - Width : width in pixel of the current image. |
|
3174 | - * - Height : Height in pixel of the current image. |
|
3175 | - * - Georef extent (rectObj) : current georef extents. |
|
3176 | - * |
|
3177 | - * @param rectObj $oPixelExt |
|
3178 | - * @param int $nImageWidth |
|
3179 | - * @param int $nImageHeight |
|
3180 | - * @param rectObj $oGeorefExt |
|
3181 | - * @return int |
|
3182 | - */ |
|
3183 | - final public function zoomRectangle(rectObj $oPixelExt, $nImageWidth, $nImageHeight, rectObj $oGeorefExt) {} |
|
3184 | - |
|
3185 | - /** |
|
3186 | - * Zoom in or out to a given XY position so that the map is |
|
3187 | - * displayed at specified scale. Returns MS_SUCCESS or MS_FAILURE on error. |
|
3188 | - * Parameters are : |
|
3189 | - * - ScaleDenom : Scale denominator of the scale at which the map |
|
3190 | - * should be displayed. |
|
3191 | - * - Pixel position (pointObj) : x, y coordinates of the click, |
|
3192 | - * with (0,0) at the top-left |
|
3193 | - * - Width : width in pixel of the current image. |
|
3194 | - * - Height : Height in pixel of the current image. |
|
3195 | - * - Georef extent (rectObj) : current georef extents. |
|
3196 | - * - MaxGeoref extent (rectObj) : (optional) maximum georef extents. |
|
3197 | - * If provided then it will be impossible to zoom/pan outside of |
|
3198 | - * those extents. |
|
3199 | - * |
|
3200 | - * @param float $nScaleDenom |
|
3201 | - * @param pointObj $oPixelPos |
|
3202 | - * @param int $nImageWidth |
|
3203 | - * @param int $nImageHeight |
|
3204 | - * @param rectObj $oGeorefExt |
|
3205 | - * @param rectObj $oMaxGeorefExt |
|
3206 | - * @return int |
|
3207 | - */ |
|
3208 | - final public function zoomScale($nScaleDenom, pointObj $oPixelPos, $nImageWidth, $nImageHeight, rectObj $oGeorefExt, rectObj $oMaxGeorefExt) {} |
|
2234 | + /** |
|
2235 | + * @var float |
|
2236 | + */ |
|
2237 | + public $cellsize; |
|
2238 | + |
|
2239 | + /** |
|
2240 | + * @var int |
|
2241 | + */ |
|
2242 | + public $debug; |
|
2243 | + |
|
2244 | + /** |
|
2245 | + * pixels per inch, defaults to 72 |
|
2246 | + * |
|
2247 | + * @var float |
|
2248 | + */ |
|
2249 | + public $defresolution; |
|
2250 | + |
|
2251 | + /** |
|
2252 | + * ; |
|
2253 | + * |
|
2254 | + * @var rectObj |
|
2255 | + */ |
|
2256 | + public $extent; |
|
2257 | + |
|
2258 | + /** |
|
2259 | + * read-only, set by setFontSet() |
|
2260 | + * |
|
2261 | + * @var string |
|
2262 | + */ |
|
2263 | + public $fontsetfilename; |
|
2264 | + |
|
2265 | + /** |
|
2266 | + * see setSize() |
|
2267 | + * |
|
2268 | + * @var int |
|
2269 | + */ |
|
2270 | + public $height; |
|
2271 | + |
|
2272 | + /** |
|
2273 | + * @var colorObj |
|
2274 | + */ |
|
2275 | + public $imagecolor; |
|
2276 | + |
|
2277 | + /** |
|
2278 | + * @var int |
|
2279 | + */ |
|
2280 | + public $keysizex; |
|
2281 | + |
|
2282 | + /** |
|
2283 | + * @var int |
|
2284 | + */ |
|
2285 | + public $keysizey; |
|
2286 | + |
|
2287 | + /** |
|
2288 | + * @var int |
|
2289 | + */ |
|
2290 | + public $keyspacingx; |
|
2291 | + |
|
2292 | + /** |
|
2293 | + * @var int |
|
2294 | + */ |
|
2295 | + public $keyspacingy; |
|
2296 | + |
|
2297 | + /** |
|
2298 | + * no members. Used only to free the |
|
2299 | + * label cache (map->labelcache->free() |
|
2300 | + * |
|
2301 | + * @var labelcacheObj |
|
2302 | + */ |
|
2303 | + public $labelcache; |
|
2304 | + |
|
2305 | + /** |
|
2306 | + * @var legendObj |
|
2307 | + */ |
|
2308 | + public $legend; |
|
2309 | + |
|
2310 | + /** |
|
2311 | + * @var string |
|
2312 | + */ |
|
2313 | + public $mappath; |
|
2314 | + |
|
2315 | + /** |
|
2316 | + * @var int |
|
2317 | + */ |
|
2318 | + public $maxsize; |
|
2319 | + |
|
2320 | + /** |
|
2321 | + * @var hashTableObj |
|
2322 | + */ |
|
2323 | + public $metadata; |
|
2324 | + |
|
2325 | + /** |
|
2326 | + * @var string |
|
2327 | + */ |
|
2328 | + public $name; |
|
2329 | + |
|
2330 | + /** |
|
2331 | + * read-only |
|
2332 | + * |
|
2333 | + * @var int |
|
2334 | + */ |
|
2335 | + public $numlayers; |
|
2336 | + |
|
2337 | + /** |
|
2338 | + * @var outputformatObj |
|
2339 | + */ |
|
2340 | + public $outputformat; |
|
2341 | + |
|
2342 | + /** |
|
2343 | + * read-only |
|
2344 | + * |
|
2345 | + * @var int |
|
2346 | + */ |
|
2347 | + public $numoutputformats; |
|
2348 | + |
|
2349 | + /** |
|
2350 | + * @var projectionObj |
|
2351 | + */ |
|
2352 | + public $projection; |
|
2353 | + |
|
2354 | + /** |
|
2355 | + * @var querymapObj |
|
2356 | + */ |
|
2357 | + public $querymap; |
|
2358 | + |
|
2359 | + /** |
|
2360 | + * @var referenceMapObj |
|
2361 | + */ |
|
2362 | + public $reference; |
|
2363 | + |
|
2364 | + /** |
|
2365 | + * pixels per inch, defaults to 72 |
|
2366 | + * |
|
2367 | + * @var float |
|
2368 | + */ |
|
2369 | + public $resolution; |
|
2370 | + |
|
2371 | + /** |
|
2372 | + * @var scalebarObj |
|
2373 | + */ |
|
2374 | + public $scalebar; |
|
2375 | + |
|
2376 | + /** |
|
2377 | + * read-only, set by drawMap() |
|
2378 | + * |
|
2379 | + * @var float |
|
2380 | + */ |
|
2381 | + public $scaledenom; |
|
2382 | + |
|
2383 | + /** |
|
2384 | + * @var string |
|
2385 | + */ |
|
2386 | + public $shapepath; |
|
2387 | + |
|
2388 | + /** |
|
2389 | + * @var int |
|
2390 | + */ |
|
2391 | + public $status; |
|
2392 | + |
|
2393 | + /** |
|
2394 | + * read-only, set by setSymbolSet() |
|
2395 | + * |
|
2396 | + * @var string |
|
2397 | + */ |
|
2398 | + public $symbolsetfilename; |
|
2399 | + |
|
2400 | + /** |
|
2401 | + * map units type |
|
2402 | + * |
|
2403 | + * @var int |
|
2404 | + */ |
|
2405 | + public $units; |
|
2406 | + |
|
2407 | + /** |
|
2408 | + * @var webObj |
|
2409 | + */ |
|
2410 | + public $web; |
|
2411 | + |
|
2412 | + /** |
|
2413 | + * see setSize() |
|
2414 | + * |
|
2415 | + * @var int |
|
2416 | + */ |
|
2417 | + public $width; |
|
2418 | + |
|
2419 | + /** |
|
2420 | + * Returns a new object to deal with a MapServer map file. |
|
2421 | + * Construct a new mapObj from a mapfile string. Returns a new object to deal |
|
2422 | + * with a MapServer map file. |
|
2423 | + * .. note:: |
|
2424 | + * By default, the SYMBOLSET, FONTSET, and other paths in the mapfile |
|
2425 | + * are relative to the mapfile location. If new_map_path is provided |
|
2426 | + * then this directory will be used as the base path for all the |
|
2427 | + * rewlative paths inside the mapfile. |
|
2428 | + * |
|
2429 | + * @param string $map_file_name |
|
2430 | + * @param string $new_map_path |
|
2431 | + */ |
|
2432 | + final public function __construct($map_file_name, $new_map_path) {} |
|
2433 | + |
|
2434 | + /** |
|
2435 | + * Old style constructor |
|
2436 | + * |
|
2437 | + * @param string $map_file_string |
|
2438 | + * @param string $new_map_path |
|
2439 | + * @return mapObj |
|
2440 | + */ |
|
2441 | + final public function ms_newMapObjFromString($map_file_string, $new_map_path) {} |
|
2442 | + |
|
2443 | + /** |
|
2444 | + * Applies the config options set in the map file. For example |
|
2445 | + * setting the PROJ_LIB using the setconfigoption only modifies |
|
2446 | + * the value in the map object. applyconfigoptions will actually |
|
2447 | + * change the PROJ_LIB value that will be used when dealing with |
|
2448 | + * projection. |
|
2449 | + * |
|
2450 | + * @return int |
|
2451 | + */ |
|
2452 | + final public function applyconfigoptions() {} |
|
2453 | + |
|
2454 | + /** |
|
2455 | + * Apply the :ref:`SLD` document to the map file. The matching between the |
|
2456 | + * sld document and the map file will be done using the layer's name. |
|
2457 | + * See :ref:`SLD HowTo <sld>` for more information on the SLD support. |
|
2458 | + * |
|
2459 | + * @param string $sldxml |
|
2460 | + * @return int |
|
2461 | + */ |
|
2462 | + final public function applySLD($sldxml) {} |
|
2463 | + |
|
2464 | + /** |
|
2465 | + * Apply the SLD document pointed by the URL to the map file. The |
|
2466 | + * matching between the sld document and the map file will be done |
|
2467 | + * using the layer's name. |
|
2468 | + * See :ref:`SLD HowTo <sld>` for more information on the SLD support. |
|
2469 | + * |
|
2470 | + * @param string $sldurl |
|
2471 | + * @return int |
|
2472 | + */ |
|
2473 | + final public function applySLDURL($sldurl) {} |
|
2474 | + |
|
2475 | + /** |
|
2476 | + * Saves the object to a string. |
|
2477 | + * .. note:: |
|
2478 | + * The inverse method updateFromString does not exist for the mapObj |
|
2479 | + * .. versionadded:: 6.4 |
|
2480 | + * |
|
2481 | + * @return string |
|
2482 | + */ |
|
2483 | + final public function convertToString() {} |
|
2484 | + |
|
2485 | + /** |
|
2486 | + * Render map and return an image object or NULL on error. |
|
2487 | + * |
|
2488 | + * @return imageObj|null |
|
2489 | + */ |
|
2490 | + final public function draw() {} |
|
2491 | + |
|
2492 | + /** |
|
2493 | + * Renders the labels for a map. Returns MS_SUCCESS or MS_FAILURE on error. |
|
2494 | + * |
|
2495 | + * @param imageObj $image |
|
2496 | + * @return int |
|
2497 | + */ |
|
2498 | + final public function drawLabelCache(imageObj $image) {} |
|
2499 | + |
|
2500 | + /** |
|
2501 | + * Render legend and return an image object. |
|
2502 | + * |
|
2503 | + * @return imageObj |
|
2504 | + */ |
|
2505 | + final public function drawLegend() {} |
|
2506 | + |
|
2507 | + /** |
|
2508 | + * Render a query map and return an image object or NULL on error. |
|
2509 | + * |
|
2510 | + * @return imageObj|null |
|
2511 | + */ |
|
2512 | + final public function drawQuery() {} |
|
2513 | + |
|
2514 | + /** |
|
2515 | + * Render reference map and return an image object. |
|
2516 | + * |
|
2517 | + * @return imageObj |
|
2518 | + */ |
|
2519 | + final public function drawReferenceMap() {} |
|
2520 | + |
|
2521 | + /** |
|
2522 | + * Render scale bar and return an image object. |
|
2523 | + * |
|
2524 | + * @return imageObj |
|
2525 | + */ |
|
2526 | + final public function drawScaleBar() {} |
|
2527 | + |
|
2528 | + /** |
|
2529 | + * embeds a legend. Actually the legend is just added to the label |
|
2530 | + * cache so you must invoke drawLabelCache() to actually do the |
|
2531 | + * rendering (unless postlabelcache is set in which case it is |
|
2532 | + * drawn right away). Returns MS_SUCCESS or MS_FAILURE on error. |
|
2533 | + * |
|
2534 | + * @param imageObj $image |
|
2535 | + * @return int |
|
2536 | + */ |
|
2537 | + final public function embedLegend(imageObj $image) {} |
|
2538 | + |
|
2539 | + /** |
|
2540 | + * embeds a scalebar. Actually the scalebar is just added to the label |
|
2541 | + * cache so you must invoke drawLabelCache() to actually do the rendering |
|
2542 | + * (unless postlabelcache is set in which case it is drawn right away). |
|
2543 | + * Returns MS_SUCCESS or MS_FAILURE on error. |
|
2544 | + * |
|
2545 | + * @param imageObj $image |
|
2546 | + * @return int |
|
2547 | + */ |
|
2548 | + final public function embedScalebar(imageObj $image) {} |
|
2549 | + |
|
2550 | + /** |
|
2551 | + * Free the object properties and break the internal references. |
|
2552 | + * Note that you have to unset the php variable to free totally the |
|
2553 | + * resources. |
|
2554 | + * void freeQuery(layerindex) |
|
2555 | + * Frees the query result on a specified layer. If the layerindex is -1, |
|
2556 | + * all queries on layers will be freed. |
|
2557 | + * |
|
2558 | + * @return void |
|
2559 | + */ |
|
2560 | + final public function free() {} |
|
2561 | + |
|
2562 | + /** |
|
2563 | + * Returns an SLD XML string based on all the classes found in all |
|
2564 | + * the layers that have `STATUS` `on`. |
|
2565 | + * |
|
2566 | + * @return string |
|
2567 | + */ |
|
2568 | + final public function generateSLD() {} |
|
2569 | + |
|
2570 | + /** |
|
2571 | + * Return an array containing all the group names used in the |
|
2572 | + * layers. If there are no groups, it returns an empty array. |
|
2573 | + * |
|
2574 | + * @return array |
|
2575 | + */ |
|
2576 | + final public function getAllGroupNames() {} |
|
2577 | + |
|
2578 | + /** |
|
2579 | + * Return an array containing all the layer names. |
|
2580 | + * If there are no layers, it returns an empty array. |
|
2581 | + * |
|
2582 | + * @return array |
|
2583 | + */ |
|
2584 | + final public function getAllLayerNames() {} |
|
2585 | + |
|
2586 | + /** |
|
2587 | + * Returns a colorObj corresponding to the color index in the |
|
2588 | + * palette. |
|
2589 | + * |
|
2590 | + * @param int $iCloIndex |
|
2591 | + * @return colorObj |
|
2592 | + */ |
|
2593 | + final public function getColorbyIndex($iCloIndex) {} |
|
2594 | + |
|
2595 | + /** |
|
2596 | + * Returns the config value associated with the key. |
|
2597 | + * Returns an empty sting if key not found. |
|
2598 | + * |
|
2599 | + * @param string $key |
|
2600 | + * @return string |
|
2601 | + */ |
|
2602 | + final public function getConfigOption($key) {} |
|
2603 | + |
|
2604 | + /** |
|
2605 | + * Returns a labelcacheMemberObj from the map given an index value |
|
2606 | + * (0=first label). Labelcache has to be enabled. |
|
2607 | + * .. code-block:: php |
|
2608 | + * while ($oLabelCacheMember = $oMap->getLabel($i)) { |
|
2609 | + * do something with the labelcachemember |
|
2610 | + * ++$i; |
|
2611 | + * } |
|
2612 | + * |
|
2613 | + * @param int $index |
|
2614 | + * @return labelcacheMemberObj |
|
2615 | + */ |
|
2616 | + final public function getLabel($index) {} |
|
2617 | + |
|
2618 | + /** |
|
2619 | + * Returns a layerObj from the map given an index value (0=first layer) |
|
2620 | + * |
|
2621 | + * @param int $index |
|
2622 | + * @return layerObj |
|
2623 | + */ |
|
2624 | + final public function getLayer($index) {} |
|
2625 | + |
|
2626 | + /** |
|
2627 | + * Returns a layerObj from the map given a layer name. |
|
2628 | + * Returns NULL if layer doesn't exist. |
|
2629 | + * |
|
2630 | + * @param string $layer_name |
|
2631 | + * @return layerObj |
|
2632 | + */ |
|
2633 | + final public function getLayerByName($layer_name) {} |
|
2634 | + |
|
2635 | + /** |
|
2636 | + * Return an array containing layer's index in the order which they |
|
2637 | + * are drawn. If there are no layers, it returns an empty array. |
|
2638 | + * |
|
2639 | + * @return array |
|
2640 | + */ |
|
2641 | + final public function getLayersDrawingOrder() {} |
|
2642 | + |
|
2643 | + /** |
|
2644 | + * Return an array containing all the layer's indexes given |
|
2645 | + * a group name. If there are no layers, it returns an empty array. |
|
2646 | + * |
|
2647 | + * @param string $groupname |
|
2648 | + * @return array |
|
2649 | + */ |
|
2650 | + final public function getLayersIndexByGroup($groupname) {} |
|
2651 | + |
|
2652 | + /** |
|
2653 | + * Fetch metadata entry by name (stored in the :ref:`WEB` object in |
|
2654 | + * the map file). Returns "" if no entry matches the name. |
|
2655 | + * .. note:: |
|
2656 | + * getMetaData's query is case sensitive. |
|
2657 | + * |
|
2658 | + * @param string $name |
|
2659 | + * @return int |
|
2660 | + */ |
|
2661 | + final public function getMetaData($name) {} |
|
2662 | + |
|
2663 | + /** |
|
2664 | + * Return the number of symbols in map. |
|
2665 | + * |
|
2666 | + * @return int |
|
2667 | + */ |
|
2668 | + final public function getNumSymbols() {} |
|
2669 | + |
|
2670 | + /** |
|
2671 | + * Returns a string representation of the projection. |
|
2672 | + * Returns NULL on error or if no projection is set. |
|
2673 | + * |
|
2674 | + * @return string |
|
2675 | + */ |
|
2676 | + final public function getProjection() {} |
|
2677 | + |
|
2678 | + /** |
|
2679 | + * Returns the symbol index using the name. |
|
2680 | + * |
|
2681 | + * @param string $symbol_name |
|
2682 | + * @return int |
|
2683 | + */ |
|
2684 | + final public function getSymbolByName($symbol_name) {} |
|
2685 | + |
|
2686 | + /** |
|
2687 | + * Returns the symbol object using a symbol id. Refer to |
|
2688 | + * the symbol object reference section for more details. |
|
2689 | + * int insertLayer( layerObj layer [, int nIndex=-1 ] ) |
|
2690 | + * Insert a copy of *layer* into the Map at index *nIndex*. The |
|
2691 | + * default value of *nIndex* is -1, which means the last possible |
|
2692 | + * index. Returns the index of the new Layer, or -1 in the case of a |
|
2693 | + * failure. |
|
2694 | + * |
|
2695 | + * @param int $symbolid |
|
2696 | + * @return symbolObj |
|
2697 | + */ |
|
2698 | + final public function getSymbolObjectById($symbolid) {} |
|
2699 | + |
|
2700 | + /** |
|
2701 | + * Available only if WMS support is enabled. Load a :ref:`WMS Map Context <map_context>` |
|
2702 | + * XML file into the current mapObj. If the |
|
2703 | + * map already contains some layers then the layers defined in the |
|
2704 | + * WMS Map context document are added to the current map. The 2nd |
|
2705 | + * argument unique_layer_name is optional and if set to MS_TRUE |
|
2706 | + * layers created will have a unique name (unique prefix added to the |
|
2707 | + * name). If set to MS_FALSE the layer name will be the the same name |
|
2708 | + * as in the context. The default value is MS_FALSE. Returns |
|
2709 | + * MS_SUCCESS/MS_FAILURE. |
|
2710 | + * |
|
2711 | + * @param string $filename |
|
2712 | + * @param bool $unique_layer_name |
|
2713 | + * @return int |
|
2714 | + */ |
|
2715 | + final public function loadMapContext($filename, $unique_layer_name) {} |
|
2716 | + |
|
2717 | + /** |
|
2718 | + * Load OWS request parameters (BBOX, LAYERS, &c.) into map. Returns |
|
2719 | + * MS_SUCCESS or MS_FAILURE. 2nd argument version is not mandatory. |
|
2720 | + * If not given, the version will be set to 1.1.1 |
|
2721 | + * int loadQuery(filename) |
|
2722 | + * Loads a query from a file. Returns MS_SUCCESS or MS_FAILURE. |
|
2723 | + * To be used with savequery. |
|
2724 | + * |
|
2725 | + * @param OwsrequestObj $request |
|
2726 | + * @param string $version |
|
2727 | + * @return int |
|
2728 | + */ |
|
2729 | + final public function loadOWSParameters(OwsrequestObj $request, $version) {} |
|
2730 | + |
|
2731 | + /** |
|
2732 | + * Move layer down in the hierarchy of drawing. |
|
2733 | + * Returns MS_SUCCESS or MS_FAILURE on error. |
|
2734 | + * |
|
2735 | + * @param int $layerindex |
|
2736 | + * @return int |
|
2737 | + */ |
|
2738 | + final public function moveLayerDown($layerindex) {} |
|
2739 | + |
|
2740 | + /** |
|
2741 | + * Move layer up in the hierarchy of drawing. |
|
2742 | + * Returns MS_SUCCESS or MS_FAILURE on error. |
|
2743 | + * |
|
2744 | + * @param int $layerindex |
|
2745 | + * @return int |
|
2746 | + */ |
|
2747 | + final public function moveLayerUp($layerindex) {} |
|
2748 | + |
|
2749 | + /** |
|
2750 | + * Offset the map extent based on the given distances in map coordinates. |
|
2751 | + * Returns MS_SUCCESS or MS_FAILURE. |
|
2752 | + * |
|
2753 | + * @param float $x |
|
2754 | + * @param float $y |
|
2755 | + * @return int |
|
2756 | + */ |
|
2757 | + final public function offsetExtent($x, $y) {} |
|
2758 | + |
|
2759 | + /** |
|
2760 | + * Processes and executes the passed OpenGIS Web Services request on |
|
2761 | + * the map. Returns MS_DONE (2) if there is no valid OWS request in |
|
2762 | + * the req object, MS_SUCCESS (0) if an OWS request was successfully |
|
2763 | + * processed and MS_FAILURE (1) if an OWS request was not |
|
2764 | + * successfully processed. OWS requests include :ref:`WMS <wms_server>`, |
|
2765 | + * :ref:`WFS <wfs_server>`, :ref:`WCS <wcs_server>` |
|
2766 | + * and :ref:`SOS <sos_server>` requests supported by MapServer. |
|
2767 | + * Results of a dispatched request are written to stdout and can be |
|
2768 | + * captured using the msIO services (ie. ms_ioinstallstdouttobuffer() |
|
2769 | + * and ms_iogetstdoutbufferstring()) |
|
2770 | + * |
|
2771 | + * @param OwsrequestObj $request |
|
2772 | + * @return int |
|
2773 | + */ |
|
2774 | + final public function owsDispatch(OwsrequestObj $request) {} |
|
2775 | + |
|
2776 | + /** |
|
2777 | + * Return a blank image object. |
|
2778 | + * |
|
2779 | + * @return imageObj |
|
2780 | + */ |
|
2781 | + final public function prepareImage() {} |
|
2782 | + |
|
2783 | + /** |
|
2784 | + * Calculate the scale of the map and set map->scaledenom. |
|
2785 | + * |
|
2786 | + * @return void |
|
2787 | + */ |
|
2788 | + final public function prepareQuery() {} |
|
2789 | + |
|
2790 | + /** |
|
2791 | + * Process legend template files and return the result in a buffer. |
|
2792 | + * .. seealso:: |
|
2793 | + * :ref:`processtemplate <processtemplate>` |
|
2794 | + * |
|
2795 | + * @param array $params |
|
2796 | + * @return string |
|
2797 | + */ |
|
2798 | + final public function processLegendTemplate(array $params) {} |
|
2799 | + |
|
2800 | + /** |
|
2801 | + * Process query template files and return the result in a buffer. |
|
2802 | + * Second argument generateimages is not mandatory. If not given |
|
2803 | + * it will be set to TRUE. |
|
2804 | + * .. seealso:: |
|
2805 | + * :ref:`processtemplate <processtemplate>` |
|
2806 | + * .. _processtemplate: |
|
2807 | + * |
|
2808 | + * @param array $params |
|
2809 | + * @param bool $generateimages |
|
2810 | + * @return string |
|
2811 | + */ |
|
2812 | + final public function processQueryTemplate(array $params, $generateimages) {} |
|
2813 | + |
|
2814 | + /** |
|
2815 | + * Process the template file specified in the web object and return the |
|
2816 | + * result in a buffer. The processing consists of opening the template |
|
2817 | + * file and replace all the tags found in it. Only tags that have an |
|
2818 | + * equivalent element in the map object are replaced (ex [scaledenom]). |
|
2819 | + * The are two exceptions to the previous statement : |
|
2820 | + * - [img], [scalebar], [ref], [legend] would be replaced with the |
|
2821 | + * appropriate url if the parameter generateimages is set to |
|
2822 | + * MS_TRUE. (Note : the images corresponding to the different objects |
|
2823 | + * are generated if the object is set to MS_ON in the map file) |
|
2824 | + * - the user can use the params parameter to specify tags and |
|
2825 | + * their values. For example if the user have a specific tag call |
|
2826 | + * [my_tag] and would like it to be replaced by "value_of_my_tag" |
|
2827 | + * he would do |
|
2828 | + * .. code-block:: php |
|
2829 | + * $tmparray["my_tag"] = "value_of_my_tag"; |
|
2830 | + * $map->processtemplate($tmparray, MS_FALSE); |
|
2831 | + * |
|
2832 | + * @param array $params |
|
2833 | + * @param bool $generateimages |
|
2834 | + * @return string |
|
2835 | + */ |
|
2836 | + final public function processTemplate(array $params, $generateimages) {} |
|
2837 | + |
|
2838 | + /** |
|
2839 | + * Perform a query based on a previous set of results from |
|
2840 | + * a layer. At present the results MUST be based on a polygon layer. |
|
2841 | + * Returns MS_SUCCESS if shapes were found or MS_FAILURE if nothing |
|
2842 | + * was found or if some other error happened (note that the error |
|
2843 | + * message in case nothing was found can be avoided in PHP using |
|
2844 | + * the '@' control operator). |
|
2845 | + * |
|
2846 | + * @param int $slayer |
|
2847 | + * @return int |
|
2848 | + */ |
|
2849 | + final public function queryByFeatures($slayer) {} |
|
2850 | + |
|
2851 | + /** |
|
2852 | + * Add a specific shape on a given layer to the query result. |
|
2853 | + * If addtoquery (which is a non mandatory argument) is set to MS_TRUE, |
|
2854 | + * the shape will be added to the existing query list. Default behavior |
|
2855 | + * is to free the existing query list and add only the new shape. |
|
2856 | + * |
|
2857 | + * @param $layerindex |
|
2858 | + * @param $tileindex |
|
2859 | + * @param $shapeindex |
|
2860 | + * @param $addtoquery |
|
2861 | + * @return int |
|
2862 | + */ |
|
2863 | + final public function queryByIndex($layerindex, $tileindex, $shapeindex, $addtoquery) {} |
|
2864 | + |
|
2865 | + /** |
|
2866 | + * Query all selected layers in map at point location specified in |
|
2867 | + * georeferenced map coordinates (i.e. not pixels). |
|
2868 | + * The query is performed on all the shapes that are part of a :ref:`CLASS` |
|
2869 | + * that contains a :ref:`TEMPLATE` value or that match any class in a |
|
2870 | + * layer that contains a :ref:`LAYER` :ref:`TEMPLATE <template>` value. |
|
2871 | + * Mode is MS_SINGLE or MS_MULTIPLE depending on number of results |
|
2872 | + * you want. |
|
2873 | + * Passing buffer -1 defaults to tolerances set in the map file |
|
2874 | + * (in pixels) but you can use a constant buffer (specified in |
|
2875 | + * ground units) instead. |
|
2876 | + * Returns MS_SUCCESS if shapes were found or MS_FAILURE if nothing |
|
2877 | + * was found or if some other error happened (note that the error |
|
2878 | + * message in case nothing was found can be avoided in PHP using |
|
2879 | + * the '@' control operator). |
|
2880 | + * |
|
2881 | + * @param pointObj $point |
|
2882 | + * @param int $mode |
|
2883 | + * @param float $buffer |
|
2884 | + * @return int |
|
2885 | + */ |
|
2886 | + final public function queryByPoint(pointObj $point, $mode, $buffer) {} |
|
2887 | + |
|
2888 | + /** |
|
2889 | + * Query all selected layers in map using a rectangle specified in |
|
2890 | + * georeferenced map coordinates (i.e. not pixels). The query is |
|
2891 | + * performed on all the shapes that are part of a :ref:`CLASS` that |
|
2892 | + * contains a :ref:`TEMPLATE` value or that match any class in a |
|
2893 | + * layer that contains a :ref:`LAYER` :ref:`TEMPLATE <template>` |
|
2894 | + * value. Returns MS_SUCCESS if shapes were found or MS_FAILURE if |
|
2895 | + * nothing was found or if some other error happened (note that the |
|
2896 | + * error message in case nothing was found can be avoided in PHP |
|
2897 | + * using the '@' control operator). |
|
2898 | + * |
|
2899 | + * @param rectObj $rect |
|
2900 | + * @return int |
|
2901 | + */ |
|
2902 | + final public function queryByRect(rectObj $rect) {} |
|
2903 | + |
|
2904 | + /** |
|
2905 | + * Query all selected layers in map based on a single shape, the |
|
2906 | + * shape has to be a polygon at this point. |
|
2907 | + * Returns MS_SUCCESS if shapes were found or MS_FAILURE if nothing |
|
2908 | + * was found or if some other error happened (note that the error |
|
2909 | + * message in case nothing was found can be avoided in PHP using |
|
2910 | + * the '@' control operator). |
|
2911 | + * |
|
2912 | + * @param shapeObj $shape |
|
2913 | + * @return int |
|
2914 | + */ |
|
2915 | + final public function queryByShape(shapeObj $shape) {} |
|
2916 | + |
|
2917 | + /** |
|
2918 | + * Remove a layer from the mapObj. The argument is the index of the |
|
2919 | + * layer to be removed. Returns the removed layerObj on success, else |
|
2920 | + * null. |
|
2921 | + * |
|
2922 | + * @param int $nIndex |
|
2923 | + * @return layerObj |
|
2924 | + */ |
|
2925 | + final public function removeLayer($nIndex) {} |
|
2926 | + |
|
2927 | + /** |
|
2928 | + * Remove a metadata entry for the map (stored in the WEB object in the map |
|
2929 | + * file). Returns MS_SUCCESS/MS_FAILURE. |
|
2930 | + * |
|
2931 | + * @param string $name |
|
2932 | + * @return int |
|
2933 | + */ |
|
2934 | + final public function removeMetaData($name) {} |
|
2935 | + |
|
2936 | + /** |
|
2937 | + * Save current map object state to a file. Returns -1 on error. |
|
2938 | + * Use absolute path. If a relative path is used, then it will be |
|
2939 | + * relative to the mapfile location. |
|
2940 | + * |
|
2941 | + * @param string $filename |
|
2942 | + * @return int |
|
2943 | + */ |
|
2944 | + final public function save($filename) {} |
|
2945 | + |
|
2946 | + /** |
|
2947 | + * Available only if WMS support is enabled. Save current map object |
|
2948 | + * state in :ref:`WMS Map Context <map_context>` format. Only WMS |
|
2949 | + * layers are saved in the WMS Map Context XML file. Returns |
|
2950 | + * MS_SUCCESS/MS_FAILURE. |
|
2951 | + * |
|
2952 | + * @param string $filename |
|
2953 | + * @return int |
|
2954 | + */ |
|
2955 | + final public function saveMapContext($filename) {} |
|
2956 | + |
|
2957 | + /** |
|
2958 | + * Save the current query in a file. Results determines the save format - |
|
2959 | + * MS_TRUE (or 1/true) saves the query results (tile index and shape index), |
|
2960 | + * MS_FALSE (or 0/false) the query parameters (and the query will be re-run |
|
2961 | + * in loadquery). Returns MS_SUCCESS or MS_FAILURE. Either save format can be |
|
2962 | + * used with loadquery. See RFC 65 and ticket #3647 for details of different |
|
2963 | + * save formats. |
|
2964 | + * |
|
2965 | + * @param string $filename |
|
2966 | + * @param int $results |
|
2967 | + * @return int |
|
2968 | + */ |
|
2969 | + final public function saveQuery($filename, $results) {} |
|
2970 | + |
|
2971 | + /** |
|
2972 | + * Scale the map extent using the zoomfactor and ensure the extent |
|
2973 | + * within the minscaledenom and maxscaledenom domain. If |
|
2974 | + * minscaledenom and/or maxscaledenom is 0 then the parameter is not |
|
2975 | + * taken into account. Returns MS_SUCCESS or MS_FAILURE. |
|
2976 | + * |
|
2977 | + * @param float $zoomfactor |
|
2978 | + * @param float $minscaledenom |
|
2979 | + * @param float $maxscaledenom |
|
2980 | + * @return int |
|
2981 | + */ |
|
2982 | + final public function scaleExtent($zoomfactor, $minscaledenom, $maxscaledenom) {} |
|
2983 | + |
|
2984 | + /** |
|
2985 | + * Selects the output format to be used in the map. |
|
2986 | + * Returns MS_SUCCESS/MS_FAILURE. |
|
2987 | + * .. note:: |
|
2988 | + * the type used should correspond to one of the output formats |
|
2989 | + * declared in the map file. The type argument passed is compared |
|
2990 | + * with the mimetype parameter in the output format structure and |
|
2991 | + * then to the name parameter in the structure. |
|
2992 | + * |
|
2993 | + * @param string $type |
|
2994 | + * @return int |
|
2995 | + */ |
|
2996 | + final public function selectOutputFormat($type) {} |
|
2997 | + |
|
2998 | + /** |
|
2999 | + * Appends outputformat object in the map object. |
|
3000 | + * Returns the new numoutputformats value. |
|
3001 | + * |
|
3002 | + * @param outputFormatObj $outputFormat |
|
3003 | + * @return int |
|
3004 | + */ |
|
3005 | + final public function appendOutputFormat(outputFormatObj $outputFormat) {} |
|
3006 | + |
|
3007 | + /** |
|
3008 | + * Remove outputformat from the map. |
|
3009 | + * Returns MS_SUCCESS/MS_FAILURE. |
|
3010 | + * |
|
3011 | + * @param string $name |
|
3012 | + * @return int |
|
3013 | + */ |
|
3014 | + final public function removeOutputFormat($name) {} |
|
3015 | + |
|
3016 | + /** |
|
3017 | + * Returns the outputformat at index position. |
|
3018 | + * |
|
3019 | + * @param int $index |
|
3020 | + * @return outputFormatObj |
|
3021 | + */ |
|
3022 | + final public function getOutputFormat($index) {} |
|
3023 | + |
|
3024 | + /** |
|
3025 | + * Set map object property to new value. |
|
3026 | + * |
|
3027 | + * @param string $property_name |
|
3028 | + * @param $new_value |
|
3029 | + * @return int |
|
3030 | + */ |
|
3031 | + final public function set($property_name, $new_value) {} |
|
3032 | + |
|
3033 | + /** |
|
3034 | + * Set the map center to the given map point. |
|
3035 | + * Returns MS_SUCCESS or MS_FAILURE. |
|
3036 | + * |
|
3037 | + * @param pointObj $center |
|
3038 | + * @return int |
|
3039 | + */ |
|
3040 | + final public function setCenter(pointObj $center) {} |
|
3041 | + |
|
3042 | + /** |
|
3043 | + * Sets a config parameter using the key and the value passed |
|
3044 | + * |
|
3045 | + * @param string $key |
|
3046 | + * @param string $value |
|
3047 | + * @return int |
|
3048 | + */ |
|
3049 | + final public function setConfigOption($key, $value) {} |
|
3050 | + |
|
3051 | + /** |
|
3052 | + * Set the map extents using the georef extents passed in argument. |
|
3053 | + * Returns MS_SUCCESS or MS_FAILURE on error. |
|
3054 | + * |
|
3055 | + * @param float $minx |
|
3056 | + * @param float $miny |
|
3057 | + * @param float $maxx |
|
3058 | + * @param float $maxy |
|
3059 | + * @return void |
|
3060 | + */ |
|
3061 | + final public function setExtent($minx, $miny, $maxx, $maxy) {} |
|
3062 | + |
|
3063 | + /** |
|
3064 | + * Load and set a new :ref:`fontset`. |
|
3065 | + * boolean setLayersDrawingOrder(array layeryindex) |
|
3066 | + * Set the layer's order array. The argument passed must be a valid |
|
3067 | + * array with all the layer's index. |
|
3068 | + * Returns MS_SUCCESS or MS_FAILURE on error. |
|
3069 | + * |
|
3070 | + * @param string $fileName |
|
3071 | + * @return int |
|
3072 | + */ |
|
3073 | + final public function setFontSet($fileName) {} |
|
3074 | + |
|
3075 | + /** |
|
3076 | + * Set a metadata entry for the map (stored in the WEB object in the map |
|
3077 | + * file). Returns MS_SUCCESS/MS_FAILURE. |
|
3078 | + * |
|
3079 | + * @param string $name |
|
3080 | + * @param string $value |
|
3081 | + * @return int |
|
3082 | + */ |
|
3083 | + final public function setMetaData($name, $value) {} |
|
3084 | + |
|
3085 | + /** |
|
3086 | + * Set map projection and coordinate system. Returns MS_SUCCESS or |
|
3087 | + * MS_FAILURE on error. |
|
3088 | + * Parameters are given as a single string of comma-delimited PROJ.4 |
|
3089 | + * parameters. The argument : bSetUnitsAndExtents is used to |
|
3090 | + * automatically update the map units and extents based on the new |
|
3091 | + * projection. Possible values are MS_TRUE and MS_FALSE. By default it is |
|
3092 | + * set at MS_FALSE. |
|
3093 | + * |
|
3094 | + * @param string $proj_params |
|
3095 | + * @param bool $bSetUnitsAndExtents |
|
3096 | + * @return int |
|
3097 | + */ |
|
3098 | + final public function setProjection($proj_params, $bSetUnitsAndExtents) {} |
|
3099 | + |
|
3100 | + /** |
|
3101 | + * Set map rotation angle. The map view rectangle (specified in |
|
3102 | + * EXTENTS) will be rotated by the indicated angle in the counter- |
|
3103 | + * clockwise direction. Note that this implies the rendered map |
|
3104 | + * will be rotated by the angle in the clockwise direction. |
|
3105 | + * Returns MS_SUCCESS or MS_FAILURE. |
|
3106 | + * |
|
3107 | + * @param float $rotation_angle |
|
3108 | + * @return int |
|
3109 | + */ |
|
3110 | + final public function setRotation($rotation_angle) {} |
|
3111 | + |
|
3112 | + /** |
|
3113 | + * Set the map width and height. This method updates the internal |
|
3114 | + * geotransform and other data structures required for map rotation |
|
3115 | + * so it should be used instead of setting the width and height members |
|
3116 | + * directly. |
|
3117 | + * Returns MS_SUCCESS or MS_FAILURE. |
|
3118 | + * |
|
3119 | + * @param int $width |
|
3120 | + * @param int $height |
|
3121 | + * @return int |
|
3122 | + */ |
|
3123 | + final public function setSize($width, $height) {} |
|
3124 | + |
|
3125 | + /** |
|
3126 | + * Load and set a symbol file dynamically. |
|
3127 | + * |
|
3128 | + * @param string $fileName |
|
3129 | + * @return int |
|
3130 | + */ |
|
3131 | + final public function setSymbolSet($fileName) {} |
|
3132 | + |
|
3133 | + /** |
|
3134 | + * Same as setProjection(), but takes an OGC WKT projection |
|
3135 | + * definition string as input. Returns MS_SUCCESS or MS_FAILURE on error. |
|
3136 | + * .. note:: |
|
3137 | + * setWKTProjection requires GDAL support |
|
3138 | + * |
|
3139 | + * @param string $proj_params |
|
3140 | + * @param bool $bSetUnitsAndExtents |
|
3141 | + * @return int |
|
3142 | + */ |
|
3143 | + final public function setWKTProjection($proj_params, $bSetUnitsAndExtents) {} |
|
3144 | + |
|
3145 | + /** |
|
3146 | + * Zoom to a given XY position. Returns MS_SUCCESS or MS_FAILURE on error. |
|
3147 | + * Parameters are |
|
3148 | + * - Zoom factor : positive values do zoom in, negative values |
|
3149 | + * zoom out. Factor of 1 will recenter. |
|
3150 | + * - Pixel position (pointObj) : x, y coordinates of the click, |
|
3151 | + * with (0,0) at the top-left |
|
3152 | + * - Width : width in pixel of the current image. |
|
3153 | + * - Height : Height in pixel of the current image. |
|
3154 | + * - Georef extent (rectObj) : current georef extents. |
|
3155 | + * - MaxGeoref extent (rectObj) : (optional) maximum georef extents. |
|
3156 | + * If provided then it will be impossible to zoom/pan outside of |
|
3157 | + * those extents. |
|
3158 | + * |
|
3159 | + * @param int $nZoomFactor |
|
3160 | + * @param pointObj $oPixelPos |
|
3161 | + * @param int $nImageWidth |
|
3162 | + * @param int $nImageHeight |
|
3163 | + * @param rectObj $oGeorefExt |
|
3164 | + * @return int |
|
3165 | + */ |
|
3166 | + final public function zoomPoint($nZoomFactor, pointObj $oPixelPos, $nImageWidth, $nImageHeight, rectObj $oGeorefExt) {} |
|
3167 | + |
|
3168 | + /** |
|
3169 | + * Set the map extents to a given extents. Returns MS_SUCCESS or |
|
3170 | + * MS_FAILURE on error. |
|
3171 | + * Parameters are : |
|
3172 | + * - oPixelExt (rect object) : Pixel Extents |
|
3173 | + * - Width : width in pixel of the current image. |
|
3174 | + * - Height : Height in pixel of the current image. |
|
3175 | + * - Georef extent (rectObj) : current georef extents. |
|
3176 | + * |
|
3177 | + * @param rectObj $oPixelExt |
|
3178 | + * @param int $nImageWidth |
|
3179 | + * @param int $nImageHeight |
|
3180 | + * @param rectObj $oGeorefExt |
|
3181 | + * @return int |
|
3182 | + */ |
|
3183 | + final public function zoomRectangle(rectObj $oPixelExt, $nImageWidth, $nImageHeight, rectObj $oGeorefExt) {} |
|
3184 | + |
|
3185 | + /** |
|
3186 | + * Zoom in or out to a given XY position so that the map is |
|
3187 | + * displayed at specified scale. Returns MS_SUCCESS or MS_FAILURE on error. |
|
3188 | + * Parameters are : |
|
3189 | + * - ScaleDenom : Scale denominator of the scale at which the map |
|
3190 | + * should be displayed. |
|
3191 | + * - Pixel position (pointObj) : x, y coordinates of the click, |
|
3192 | + * with (0,0) at the top-left |
|
3193 | + * - Width : width in pixel of the current image. |
|
3194 | + * - Height : Height in pixel of the current image. |
|
3195 | + * - Georef extent (rectObj) : current georef extents. |
|
3196 | + * - MaxGeoref extent (rectObj) : (optional) maximum georef extents. |
|
3197 | + * If provided then it will be impossible to zoom/pan outside of |
|
3198 | + * those extents. |
|
3199 | + * |
|
3200 | + * @param float $nScaleDenom |
|
3201 | + * @param pointObj $oPixelPos |
|
3202 | + * @param int $nImageWidth |
|
3203 | + * @param int $nImageHeight |
|
3204 | + * @param rectObj $oGeorefExt |
|
3205 | + * @param rectObj $oMaxGeorefExt |
|
3206 | + * @return int |
|
3207 | + */ |
|
3208 | + final public function zoomScale($nScaleDenom, pointObj $oPixelPos, $nImageWidth, $nImageHeight, rectObj $oGeorefExt, rectObj $oMaxGeorefExt) {} |
|
3209 | 3209 | } |
3210 | 3210 | |
3211 | 3211 | /** |
@@ -3215,313 +3215,313 @@ discard block |
||
3215 | 3215 | */ |
3216 | 3216 | final class outputformatObj |
3217 | 3217 | { |
3218 | - /** |
|
3219 | - * @var string |
|
3220 | - */ |
|
3221 | - public $driver; |
|
3222 | - |
|
3223 | - /** |
|
3224 | - * @var string |
|
3225 | - */ |
|
3226 | - public $extension; |
|
3227 | - |
|
3228 | - /** |
|
3229 | - * MS_IMAGEMODE_* value. |
|
3230 | - * |
|
3231 | - * @var int |
|
3232 | - */ |
|
3233 | - public $imagemode; |
|
3234 | - |
|
3235 | - /** |
|
3236 | - * @var string |
|
3237 | - */ |
|
3238 | - public $mimetype; |
|
3239 | - |
|
3240 | - /** |
|
3241 | - * @var string |
|
3242 | - */ |
|
3243 | - public $name; |
|
3244 | - |
|
3245 | - /** |
|
3246 | - * @var int |
|
3247 | - */ |
|
3248 | - public $renderer; |
|
3249 | - |
|
3250 | - /** |
|
3251 | - * @var int |
|
3252 | - */ |
|
3253 | - public $transparent; |
|
3254 | - |
|
3255 | - /** |
|
3256 | - * Returns the associated value for the format option property passed |
|
3257 | - * as argument. Returns an empty string if property not found. |
|
3258 | - * |
|
3259 | - * @param string $property_name |
|
3260 | - * @return string |
|
3261 | - */ |
|
3262 | - final public function getOption($property_name) {} |
|
3263 | - |
|
3264 | - /** |
|
3265 | - * Set object property to a new value. |
|
3266 | - * |
|
3267 | - * @param string $property_name |
|
3268 | - * @param $new_value |
|
3269 | - * @return int |
|
3270 | - */ |
|
3271 | - final public function set($property_name, $new_value) {} |
|
3272 | - |
|
3273 | - /** |
|
3274 | - * Add or Modify the format option list. return true on success. |
|
3275 | - * .. code-block:: php |
|
3276 | - * $oMap->outputformat->setOption("OUTPUT_TYPE", "RASTER"); |
|
3277 | - * |
|
3278 | - * @param string $property_name |
|
3279 | - * @param string $new_value |
|
3280 | - * @return void |
|
3281 | - */ |
|
3282 | - final public function setOption($property_name, $new_value) {} |
|
3283 | - |
|
3284 | - /** |
|
3285 | - * Checks some internal consistency issues, Returns MS_SUCCESS or |
|
3286 | - * MS_FAILURE. Some problems are fixed up internally. May produce debug |
|
3287 | - * output if issues encountered. |
|
3288 | - * |
|
3289 | - * @return int |
|
3290 | - */ |
|
3291 | - final public function validate() {} |
|
3218 | + /** |
|
3219 | + * @var string |
|
3220 | + */ |
|
3221 | + public $driver; |
|
3222 | + |
|
3223 | + /** |
|
3224 | + * @var string |
|
3225 | + */ |
|
3226 | + public $extension; |
|
3227 | + |
|
3228 | + /** |
|
3229 | + * MS_IMAGEMODE_* value. |
|
3230 | + * |
|
3231 | + * @var int |
|
3232 | + */ |
|
3233 | + public $imagemode; |
|
3234 | + |
|
3235 | + /** |
|
3236 | + * @var string |
|
3237 | + */ |
|
3238 | + public $mimetype; |
|
3239 | + |
|
3240 | + /** |
|
3241 | + * @var string |
|
3242 | + */ |
|
3243 | + public $name; |
|
3244 | + |
|
3245 | + /** |
|
3246 | + * @var int |
|
3247 | + */ |
|
3248 | + public $renderer; |
|
3249 | + |
|
3250 | + /** |
|
3251 | + * @var int |
|
3252 | + */ |
|
3253 | + public $transparent; |
|
3254 | + |
|
3255 | + /** |
|
3256 | + * Returns the associated value for the format option property passed |
|
3257 | + * as argument. Returns an empty string if property not found. |
|
3258 | + * |
|
3259 | + * @param string $property_name |
|
3260 | + * @return string |
|
3261 | + */ |
|
3262 | + final public function getOption($property_name) {} |
|
3263 | + |
|
3264 | + /** |
|
3265 | + * Set object property to a new value. |
|
3266 | + * |
|
3267 | + * @param string $property_name |
|
3268 | + * @param $new_value |
|
3269 | + * @return int |
|
3270 | + */ |
|
3271 | + final public function set($property_name, $new_value) {} |
|
3272 | + |
|
3273 | + /** |
|
3274 | + * Add or Modify the format option list. return true on success. |
|
3275 | + * .. code-block:: php |
|
3276 | + * $oMap->outputformat->setOption("OUTPUT_TYPE", "RASTER"); |
|
3277 | + * |
|
3278 | + * @param string $property_name |
|
3279 | + * @param string $new_value |
|
3280 | + * @return void |
|
3281 | + */ |
|
3282 | + final public function setOption($property_name, $new_value) {} |
|
3283 | + |
|
3284 | + /** |
|
3285 | + * Checks some internal consistency issues, Returns MS_SUCCESS or |
|
3286 | + * MS_FAILURE. Some problems are fixed up internally. May produce debug |
|
3287 | + * output if issues encountered. |
|
3288 | + * |
|
3289 | + * @return int |
|
3290 | + */ |
|
3291 | + final public function validate() {} |
|
3292 | 3292 | } |
3293 | 3293 | |
3294 | 3294 | final class OwsrequestObj |
3295 | 3295 | { |
3296 | - /** |
|
3297 | - * (read-only) |
|
3298 | - * |
|
3299 | - * @var int |
|
3300 | - */ |
|
3301 | - public $numparams; |
|
3302 | - |
|
3303 | - /** |
|
3304 | - * (read-only): MS_GET_REQUEST or MS_POST_REQUEST |
|
3305 | - * |
|
3306 | - * @var int |
|
3307 | - */ |
|
3308 | - public $type; |
|
3309 | - |
|
3310 | - /** |
|
3311 | - * request = ms_newOwsrequestObj(); |
|
3312 | - * Create a new ows request object. |
|
3313 | - */ |
|
3314 | - final public function __construct() {} |
|
3315 | - |
|
3316 | - /** |
|
3317 | - * Add a request parameter, even if the parameter key was previousely set. |
|
3318 | - * This is useful when multiple parameters with the same key are required. |
|
3319 | - * For example : |
|
3320 | - * .. code-block:: php |
|
3321 | - * $request->addparameter('SIZE', 'x(100)'); |
|
3322 | - * $request->addparameter('SIZE', 'y(100)'); |
|
3323 | - * |
|
3324 | - * @param string $name |
|
3325 | - * @param string $value |
|
3326 | - * @return int |
|
3327 | - */ |
|
3328 | - final public function addParameter($name, $value) {} |
|
3329 | - |
|
3330 | - /** |
|
3331 | - * Return the name of the parameter at *index* in the request's array |
|
3332 | - * of parameter names. |
|
3333 | - * |
|
3334 | - * @param int $index |
|
3335 | - * @return string |
|
3336 | - */ |
|
3337 | - final public function getName($index) {} |
|
3338 | - |
|
3339 | - /** |
|
3340 | - * Return the value of the parameter at *index* in the request's array |
|
3341 | - * of parameter values. |
|
3342 | - * |
|
3343 | - * @param int $index |
|
3344 | - * @return string |
|
3345 | - */ |
|
3346 | - final public function getValue($index) {} |
|
3347 | - |
|
3348 | - /** |
|
3349 | - * Return the value associated with the parameter *name*. |
|
3350 | - * |
|
3351 | - * @param string $name |
|
3352 | - * @return string |
|
3353 | - */ |
|
3354 | - final public function getValueByName($name) {} |
|
3355 | - |
|
3356 | - /** |
|
3357 | - * Initializes the OWSRequest object from the cgi environment variables |
|
3358 | - * REQUEST_METHOD, QUERY_STRING and HTTP_COOKIE. Returns the number of |
|
3359 | - * name/value pairs collected. |
|
3360 | - * |
|
3361 | - * @return int |
|
3362 | - */ |
|
3363 | - final public function loadParams() {} |
|
3364 | - |
|
3365 | - /** |
|
3366 | - * Set a request parameter. For example : |
|
3367 | - * .. code-block:: php |
|
3368 | - * $request->setparameter('REQUEST', 'GetMap'); |
|
3369 | - * |
|
3370 | - * @param string $name |
|
3371 | - * @param string $value |
|
3372 | - * @return int |
|
3373 | - */ |
|
3374 | - final public function setParameter($name, $value) {} |
|
3296 | + /** |
|
3297 | + * (read-only) |
|
3298 | + * |
|
3299 | + * @var int |
|
3300 | + */ |
|
3301 | + public $numparams; |
|
3302 | + |
|
3303 | + /** |
|
3304 | + * (read-only): MS_GET_REQUEST or MS_POST_REQUEST |
|
3305 | + * |
|
3306 | + * @var int |
|
3307 | + */ |
|
3308 | + public $type; |
|
3309 | + |
|
3310 | + /** |
|
3311 | + * request = ms_newOwsrequestObj(); |
|
3312 | + * Create a new ows request object. |
|
3313 | + */ |
|
3314 | + final public function __construct() {} |
|
3315 | + |
|
3316 | + /** |
|
3317 | + * Add a request parameter, even if the parameter key was previousely set. |
|
3318 | + * This is useful when multiple parameters with the same key are required. |
|
3319 | + * For example : |
|
3320 | + * .. code-block:: php |
|
3321 | + * $request->addparameter('SIZE', 'x(100)'); |
|
3322 | + * $request->addparameter('SIZE', 'y(100)'); |
|
3323 | + * |
|
3324 | + * @param string $name |
|
3325 | + * @param string $value |
|
3326 | + * @return int |
|
3327 | + */ |
|
3328 | + final public function addParameter($name, $value) {} |
|
3329 | + |
|
3330 | + /** |
|
3331 | + * Return the name of the parameter at *index* in the request's array |
|
3332 | + * of parameter names. |
|
3333 | + * |
|
3334 | + * @param int $index |
|
3335 | + * @return string |
|
3336 | + */ |
|
3337 | + final public function getName($index) {} |
|
3338 | + |
|
3339 | + /** |
|
3340 | + * Return the value of the parameter at *index* in the request's array |
|
3341 | + * of parameter values. |
|
3342 | + * |
|
3343 | + * @param int $index |
|
3344 | + * @return string |
|
3345 | + */ |
|
3346 | + final public function getValue($index) {} |
|
3347 | + |
|
3348 | + /** |
|
3349 | + * Return the value associated with the parameter *name*. |
|
3350 | + * |
|
3351 | + * @param string $name |
|
3352 | + * @return string |
|
3353 | + */ |
|
3354 | + final public function getValueByName($name) {} |
|
3355 | + |
|
3356 | + /** |
|
3357 | + * Initializes the OWSRequest object from the cgi environment variables |
|
3358 | + * REQUEST_METHOD, QUERY_STRING and HTTP_COOKIE. Returns the number of |
|
3359 | + * name/value pairs collected. |
|
3360 | + * |
|
3361 | + * @return int |
|
3362 | + */ |
|
3363 | + final public function loadParams() {} |
|
3364 | + |
|
3365 | + /** |
|
3366 | + * Set a request parameter. For example : |
|
3367 | + * .. code-block:: php |
|
3368 | + * $request->setparameter('REQUEST', 'GetMap'); |
|
3369 | + * |
|
3370 | + * @param string $name |
|
3371 | + * @param string $value |
|
3372 | + * @return int |
|
3373 | + */ |
|
3374 | + final public function setParameter($name, $value) {} |
|
3375 | 3375 | } |
3376 | 3376 | |
3377 | 3377 | final class pointObj |
3378 | 3378 | { |
3379 | - /** |
|
3380 | - * @var float |
|
3381 | - */ |
|
3382 | - public $x; |
|
3383 | - |
|
3384 | - /** |
|
3385 | - * @var float |
|
3386 | - */ |
|
3387 | - public $y; |
|
3388 | - |
|
3389 | - /** |
|
3390 | - * used for 3d shape files. set to 0 for other types |
|
3391 | - * |
|
3392 | - * @var float |
|
3393 | - */ |
|
3394 | - public $z; |
|
3395 | - |
|
3396 | - /** |
|
3397 | - * used only for measured shape files - set to 0 for other types |
|
3398 | - * |
|
3399 | - * @var float |
|
3400 | - */ |
|
3401 | - public $m; |
|
3402 | - |
|
3403 | - final public function __construct() {} |
|
3404 | - |
|
3405 | - /** |
|
3406 | - * Old style constructor |
|
3407 | - * |
|
3408 | - * @return pointObj |
|
3409 | - */ |
|
3410 | - final public function ms_newPointObj() {} |
|
3411 | - |
|
3412 | - /** |
|
3413 | - * Calculates distance between a point ad a lined defined by the |
|
3414 | - * two points passed in argument. |
|
3415 | - * |
|
3416 | - * @param pointObj $p1 |
|
3417 | - * @param pointObj $p2 |
|
3418 | - * @return float |
|
3419 | - */ |
|
3420 | - final public function distanceToLine(pointObj $p1, pointObj $p2) {} |
|
3421 | - |
|
3422 | - /** |
|
3423 | - * Calculates distance between two points. |
|
3424 | - * |
|
3425 | - * @param pointObj $poPoint |
|
3426 | - * @return float |
|
3427 | - */ |
|
3428 | - final public function distanceToPoint(pointObj $poPoint) {} |
|
3429 | - |
|
3430 | - /** |
|
3431 | - * Calculates the minimum distance between a point and a shape. |
|
3432 | - * |
|
3433 | - * @param shapeObj $shape |
|
3434 | - * @return float |
|
3435 | - */ |
|
3436 | - final public function distanceToShape(shapeObj $shape) {} |
|
3437 | - |
|
3438 | - /** |
|
3439 | - * Draws the individual point using layer. The class_index is used |
|
3440 | - * to classify the point based on the classes defined for the layer. |
|
3441 | - * The text string is used to annotate the point. (Optional) |
|
3442 | - * Returns MS_SUCCESS/MS_FAILURE. |
|
3443 | - * |
|
3444 | - * @param mapObj $map |
|
3445 | - * @param layerObj $layer |
|
3446 | - * @param imageObj $img |
|
3447 | - * @param int $class_index |
|
3448 | - * @param string $text |
|
3449 | - * @return int |
|
3450 | - */ |
|
3451 | - final public function draw(mapObj $map, layerObj $layer, imageObj $img, $class_index, $text) {} |
|
3452 | - |
|
3453 | - /** |
|
3454 | - * Project the point from "in" projection (1st argument) to "out" |
|
3455 | - * projection (2nd argument). Returns MS_SUCCESS/MS_FAILURE. |
|
3456 | - * |
|
3457 | - * @param projectionObj $in |
|
3458 | - * @param projectionObj $out |
|
3459 | - * @return int |
|
3460 | - */ |
|
3461 | - final public function project(projectionObj $in, projectionObj $out) {} |
|
3462 | - |
|
3463 | - /** |
|
3464 | - * Set X,Y coordinate values. |
|
3465 | - * .. note:: |
|
3466 | - * the 3rd parameter m is used for measured shape files only. |
|
3467 | - * It is not mandatory. |
|
3468 | - * |
|
3469 | - * @param float $x |
|
3470 | - * @param float $y |
|
3471 | - * @param float $m |
|
3472 | - * @return int |
|
3473 | - */ |
|
3474 | - final public function setXY($x, $y, $m) {} |
|
3475 | - |
|
3476 | - /** |
|
3477 | - * Set X,Y,Z coordinate values. |
|
3478 | - * .. note:: |
|
3479 | - * the 4th parameter m is used for measured shape files only. |
|
3480 | - * It is not mandatory. |
|
3481 | - * |
|
3482 | - * @param float $x |
|
3483 | - * @param float $y |
|
3484 | - * @param float $z |
|
3485 | - * @param float $m |
|
3486 | - * @return int |
|
3487 | - */ |
|
3488 | - final public function setXYZ($x, $y, $z, $m) {} |
|
3379 | + /** |
|
3380 | + * @var float |
|
3381 | + */ |
|
3382 | + public $x; |
|
3383 | + |
|
3384 | + /** |
|
3385 | + * @var float |
|
3386 | + */ |
|
3387 | + public $y; |
|
3388 | + |
|
3389 | + /** |
|
3390 | + * used for 3d shape files. set to 0 for other types |
|
3391 | + * |
|
3392 | + * @var float |
|
3393 | + */ |
|
3394 | + public $z; |
|
3395 | + |
|
3396 | + /** |
|
3397 | + * used only for measured shape files - set to 0 for other types |
|
3398 | + * |
|
3399 | + * @var float |
|
3400 | + */ |
|
3401 | + public $m; |
|
3402 | + |
|
3403 | + final public function __construct() {} |
|
3404 | + |
|
3405 | + /** |
|
3406 | + * Old style constructor |
|
3407 | + * |
|
3408 | + * @return pointObj |
|
3409 | + */ |
|
3410 | + final public function ms_newPointObj() {} |
|
3411 | + |
|
3412 | + /** |
|
3413 | + * Calculates distance between a point ad a lined defined by the |
|
3414 | + * two points passed in argument. |
|
3415 | + * |
|
3416 | + * @param pointObj $p1 |
|
3417 | + * @param pointObj $p2 |
|
3418 | + * @return float |
|
3419 | + */ |
|
3420 | + final public function distanceToLine(pointObj $p1, pointObj $p2) {} |
|
3421 | + |
|
3422 | + /** |
|
3423 | + * Calculates distance between two points. |
|
3424 | + * |
|
3425 | + * @param pointObj $poPoint |
|
3426 | + * @return float |
|
3427 | + */ |
|
3428 | + final public function distanceToPoint(pointObj $poPoint) {} |
|
3429 | + |
|
3430 | + /** |
|
3431 | + * Calculates the minimum distance between a point and a shape. |
|
3432 | + * |
|
3433 | + * @param shapeObj $shape |
|
3434 | + * @return float |
|
3435 | + */ |
|
3436 | + final public function distanceToShape(shapeObj $shape) {} |
|
3437 | + |
|
3438 | + /** |
|
3439 | + * Draws the individual point using layer. The class_index is used |
|
3440 | + * to classify the point based on the classes defined for the layer. |
|
3441 | + * The text string is used to annotate the point. (Optional) |
|
3442 | + * Returns MS_SUCCESS/MS_FAILURE. |
|
3443 | + * |
|
3444 | + * @param mapObj $map |
|
3445 | + * @param layerObj $layer |
|
3446 | + * @param imageObj $img |
|
3447 | + * @param int $class_index |
|
3448 | + * @param string $text |
|
3449 | + * @return int |
|
3450 | + */ |
|
3451 | + final public function draw(mapObj $map, layerObj $layer, imageObj $img, $class_index, $text) {} |
|
3452 | + |
|
3453 | + /** |
|
3454 | + * Project the point from "in" projection (1st argument) to "out" |
|
3455 | + * projection (2nd argument). Returns MS_SUCCESS/MS_FAILURE. |
|
3456 | + * |
|
3457 | + * @param projectionObj $in |
|
3458 | + * @param projectionObj $out |
|
3459 | + * @return int |
|
3460 | + */ |
|
3461 | + final public function project(projectionObj $in, projectionObj $out) {} |
|
3462 | + |
|
3463 | + /** |
|
3464 | + * Set X,Y coordinate values. |
|
3465 | + * .. note:: |
|
3466 | + * the 3rd parameter m is used for measured shape files only. |
|
3467 | + * It is not mandatory. |
|
3468 | + * |
|
3469 | + * @param float $x |
|
3470 | + * @param float $y |
|
3471 | + * @param float $m |
|
3472 | + * @return int |
|
3473 | + */ |
|
3474 | + final public function setXY($x, $y, $m) {} |
|
3475 | + |
|
3476 | + /** |
|
3477 | + * Set X,Y,Z coordinate values. |
|
3478 | + * .. note:: |
|
3479 | + * the 4th parameter m is used for measured shape files only. |
|
3480 | + * It is not mandatory. |
|
3481 | + * |
|
3482 | + * @param float $x |
|
3483 | + * @param float $y |
|
3484 | + * @param float $z |
|
3485 | + * @param float $m |
|
3486 | + * @return int |
|
3487 | + */ |
|
3488 | + final public function setXYZ($x, $y, $z, $m) {} |
|
3489 | 3489 | } |
3490 | 3490 | |
3491 | 3491 | final class projectionObj |
3492 | 3492 | { |
3493 | - /** |
|
3494 | - * Creates a projection object based on the projection string passed |
|
3495 | - * as argument. |
|
3496 | - * $projInObj = ms_newprojectionobj("proj=latlong") |
|
3497 | - * will create a geographic projection class. |
|
3498 | - * The following example will convert a lat/long point to an LCC |
|
3499 | - * projection: |
|
3500 | - * $projInObj = ms_newprojectionobj("proj=latlong"); |
|
3501 | - * $projOutObj = ms_newprojectionobj("proj=lcc,ellps=GRS80,lat_0=49,". |
|
3502 | - * "lon_0=-95,lat_1=49,lat_2=77"); |
|
3503 | - * $poPoint = ms_newpointobj(); |
|
3504 | - * $poPoint->setXY(-92.0, 62.0); |
|
3505 | - * $poPoint->project($projInObj, $projOutObj); |
|
3506 | - * |
|
3507 | - * @param string $projectionString |
|
3508 | - */ |
|
3509 | - final public function __construct($projectionString) {} |
|
3510 | - |
|
3511 | - /** |
|
3512 | - * Old style constructor |
|
3513 | - * |
|
3514 | - * @param string $projectionString |
|
3515 | - * @return ProjectionObj |
|
3516 | - */ |
|
3517 | - final public function ms_newProjectionObj($projectionString) {} |
|
3518 | - |
|
3519 | - /** |
|
3520 | - * Returns the units of a projection object. Returns -1 on error. |
|
3521 | - * |
|
3522 | - * @return int |
|
3523 | - */ |
|
3524 | - final public function getUnits() {} |
|
3493 | + /** |
|
3494 | + * Creates a projection object based on the projection string passed |
|
3495 | + * as argument. |
|
3496 | + * $projInObj = ms_newprojectionobj("proj=latlong") |
|
3497 | + * will create a geographic projection class. |
|
3498 | + * The following example will convert a lat/long point to an LCC |
|
3499 | + * projection: |
|
3500 | + * $projInObj = ms_newprojectionobj("proj=latlong"); |
|
3501 | + * $projOutObj = ms_newprojectionobj("proj=lcc,ellps=GRS80,lat_0=49,". |
|
3502 | + * "lon_0=-95,lat_1=49,lat_2=77"); |
|
3503 | + * $poPoint = ms_newpointobj(); |
|
3504 | + * $poPoint->setXY(-92.0, 62.0); |
|
3505 | + * $poPoint->project($projInObj, $projOutObj); |
|
3506 | + * |
|
3507 | + * @param string $projectionString |
|
3508 | + */ |
|
3509 | + final public function __construct($projectionString) {} |
|
3510 | + |
|
3511 | + /** |
|
3512 | + * Old style constructor |
|
3513 | + * |
|
3514 | + * @param string $projectionString |
|
3515 | + * @return ProjectionObj |
|
3516 | + */ |
|
3517 | + final public function ms_newProjectionObj($projectionString) {} |
|
3518 | + |
|
3519 | + /** |
|
3520 | + * Returns the units of a projection object. Returns -1 on error. |
|
3521 | + * |
|
3522 | + * @return int |
|
3523 | + */ |
|
3524 | + final public function getUnits() {} |
|
3525 | 3525 | } |
3526 | 3526 | |
3527 | 3527 | /** |
@@ -3530,61 +3530,61 @@ discard block |
||
3530 | 3530 | */ |
3531 | 3531 | final class querymapObj |
3532 | 3532 | { |
3533 | - /** |
|
3534 | - * @var colorObj |
|
3535 | - */ |
|
3536 | - public $color; |
|
3537 | - |
|
3538 | - /** |
|
3539 | - * @var int |
|
3540 | - */ |
|
3541 | - public $height; |
|
3542 | - |
|
3543 | - /** |
|
3544 | - * @var int |
|
3545 | - */ |
|
3546 | - public $width; |
|
3547 | - |
|
3548 | - /** |
|
3549 | - * MS_NORMAL, MS_HILITE, MS_SELECTED |
|
3550 | - * |
|
3551 | - * @var int |
|
3552 | - */ |
|
3553 | - public $style; |
|
3554 | - |
|
3555 | - /** |
|
3556 | - * Saves the object to a string. Provides the inverse option for |
|
3557 | - * updateFromString. |
|
3558 | - * |
|
3559 | - * @return string |
|
3560 | - */ |
|
3561 | - final public function convertToString() {} |
|
3562 | - |
|
3563 | - /** |
|
3564 | - * Free the object properties and break the internal references. |
|
3565 | - * Note that you have to unset the php variable to free totally the resources. |
|
3566 | - * |
|
3567 | - * @return void |
|
3568 | - */ |
|
3569 | - final public function free() {} |
|
3570 | - |
|
3571 | - /** |
|
3572 | - * Set object property to a new value. |
|
3573 | - * |
|
3574 | - * @param string $property_name |
|
3575 | - * @param $new_value |
|
3576 | - * @return int |
|
3577 | - */ |
|
3578 | - final public function set($property_name, $new_value) {} |
|
3579 | - |
|
3580 | - /** |
|
3581 | - * Update a queryMap object from a string snippet. Returns |
|
3582 | - * MS_SUCCESS/MS_FAILURE. |
|
3583 | - * |
|
3584 | - * @param string $snippet |
|
3585 | - * @return int |
|
3586 | - */ |
|
3587 | - final public function updateFromString($snippet) {} |
|
3533 | + /** |
|
3534 | + * @var colorObj |
|
3535 | + */ |
|
3536 | + public $color; |
|
3537 | + |
|
3538 | + /** |
|
3539 | + * @var int |
|
3540 | + */ |
|
3541 | + public $height; |
|
3542 | + |
|
3543 | + /** |
|
3544 | + * @var int |
|
3545 | + */ |
|
3546 | + public $width; |
|
3547 | + |
|
3548 | + /** |
|
3549 | + * MS_NORMAL, MS_HILITE, MS_SELECTED |
|
3550 | + * |
|
3551 | + * @var int |
|
3552 | + */ |
|
3553 | + public $style; |
|
3554 | + |
|
3555 | + /** |
|
3556 | + * Saves the object to a string. Provides the inverse option for |
|
3557 | + * updateFromString. |
|
3558 | + * |
|
3559 | + * @return string |
|
3560 | + */ |
|
3561 | + final public function convertToString() {} |
|
3562 | + |
|
3563 | + /** |
|
3564 | + * Free the object properties and break the internal references. |
|
3565 | + * Note that you have to unset the php variable to free totally the resources. |
|
3566 | + * |
|
3567 | + * @return void |
|
3568 | + */ |
|
3569 | + final public function free() {} |
|
3570 | + |
|
3571 | + /** |
|
3572 | + * Set object property to a new value. |
|
3573 | + * |
|
3574 | + * @param string $property_name |
|
3575 | + * @param $new_value |
|
3576 | + * @return int |
|
3577 | + */ |
|
3578 | + final public function set($property_name, $new_value) {} |
|
3579 | + |
|
3580 | + /** |
|
3581 | + * Update a queryMap object from a string snippet. Returns |
|
3582 | + * MS_SUCCESS/MS_FAILURE. |
|
3583 | + * |
|
3584 | + * @param string $snippet |
|
3585 | + * @return int |
|
3586 | + */ |
|
3587 | + final public function updateFromString($snippet) {} |
|
3588 | 3588 | } |
3589 | 3589 | |
3590 | 3590 | /** |
@@ -3593,91 +3593,91 @@ discard block |
||
3593 | 3593 | */ |
3594 | 3594 | final class rectObj |
3595 | 3595 | { |
3596 | - /** |
|
3597 | - * @var float |
|
3598 | - */ |
|
3599 | - public $minx; |
|
3600 | - |
|
3601 | - /** |
|
3602 | - * @var float |
|
3603 | - */ |
|
3604 | - public $miny; |
|
3605 | - |
|
3606 | - /** |
|
3607 | - * @var float |
|
3608 | - */ |
|
3609 | - public $maxx; |
|
3610 | - |
|
3611 | - /** |
|
3612 | - * @var float |
|
3613 | - */ |
|
3614 | - public $maxy; |
|
3615 | - |
|
3616 | - /** |
|
3617 | - * .. note:: the members (minx, miny, maxx ,maxy) are initialized to -1; |
|
3618 | - */ |
|
3619 | - final public function __construct() {} |
|
3620 | - |
|
3621 | - /** |
|
3622 | - * Old style constructor |
|
3623 | - * |
|
3624 | - * @return RectObj |
|
3625 | - */ |
|
3626 | - final public function ms_newRectObj() {} |
|
3627 | - |
|
3628 | - /** |
|
3629 | - * Draws the individual rectangle using layer. The class_index is used |
|
3630 | - * to classify the rectangle based on the classes defined for the layer. |
|
3631 | - * The text string is used to annotate the rectangle. (Optional) |
|
3632 | - * Returns MS_SUCCESS/MS_FAILURE. |
|
3633 | - * |
|
3634 | - * @param mapObj $map |
|
3635 | - * @param layerObj $layer |
|
3636 | - * @param imageObj $img |
|
3637 | - * @param int $class_index |
|
3638 | - * @param string $text |
|
3639 | - * @return int |
|
3640 | - */ |
|
3641 | - final public function draw(mapObj $map, layerObj $layer, imageObj $img, $class_index, $text) {} |
|
3642 | - |
|
3643 | - /** |
|
3644 | - * Adjust extents of the rectangle to fit the width/height specified. |
|
3645 | - * |
|
3646 | - * @param int $width |
|
3647 | - * @param int $height |
|
3648 | - * @return float |
|
3649 | - */ |
|
3650 | - final public function fit($width, $height) {} |
|
3651 | - |
|
3652 | - /** |
|
3653 | - * Project the rectangle from "in" projection (1st argument) to "out" |
|
3654 | - * projection (2nd argument). Returns MS_SUCCESS/MS_FAILURE. |
|
3655 | - * |
|
3656 | - * @param projectionObj $in |
|
3657 | - * @param projectionObj $out |
|
3658 | - * @return int |
|
3659 | - */ |
|
3660 | - final public function project(projectionObj $in, projectionObj $out) {} |
|
3661 | - |
|
3662 | - /** |
|
3663 | - * Set object property to a new value. |
|
3664 | - * |
|
3665 | - * @param string $property_name |
|
3666 | - * @param $new_value |
|
3667 | - * @return int |
|
3668 | - */ |
|
3669 | - final public function set($property_name, $new_value) {} |
|
3670 | - |
|
3671 | - /** |
|
3672 | - * Set the rectangle extents. |
|
3673 | - * |
|
3674 | - * @param float $minx |
|
3675 | - * @param float $miny |
|
3676 | - * @param float $maxx |
|
3677 | - * @param float $maxy |
|
3678 | - * @return void |
|
3679 | - */ |
|
3680 | - final public function setextent($minx, $miny, $maxx, $maxy) {} |
|
3596 | + /** |
|
3597 | + * @var float |
|
3598 | + */ |
|
3599 | + public $minx; |
|
3600 | + |
|
3601 | + /** |
|
3602 | + * @var float |
|
3603 | + */ |
|
3604 | + public $miny; |
|
3605 | + |
|
3606 | + /** |
|
3607 | + * @var float |
|
3608 | + */ |
|
3609 | + public $maxx; |
|
3610 | + |
|
3611 | + /** |
|
3612 | + * @var float |
|
3613 | + */ |
|
3614 | + public $maxy; |
|
3615 | + |
|
3616 | + /** |
|
3617 | + * .. note:: the members (minx, miny, maxx ,maxy) are initialized to -1; |
|
3618 | + */ |
|
3619 | + final public function __construct() {} |
|
3620 | + |
|
3621 | + /** |
|
3622 | + * Old style constructor |
|
3623 | + * |
|
3624 | + * @return RectObj |
|
3625 | + */ |
|
3626 | + final public function ms_newRectObj() {} |
|
3627 | + |
|
3628 | + /** |
|
3629 | + * Draws the individual rectangle using layer. The class_index is used |
|
3630 | + * to classify the rectangle based on the classes defined for the layer. |
|
3631 | + * The text string is used to annotate the rectangle. (Optional) |
|
3632 | + * Returns MS_SUCCESS/MS_FAILURE. |
|
3633 | + * |
|
3634 | + * @param mapObj $map |
|
3635 | + * @param layerObj $layer |
|
3636 | + * @param imageObj $img |
|
3637 | + * @param int $class_index |
|
3638 | + * @param string $text |
|
3639 | + * @return int |
|
3640 | + */ |
|
3641 | + final public function draw(mapObj $map, layerObj $layer, imageObj $img, $class_index, $text) {} |
|
3642 | + |
|
3643 | + /** |
|
3644 | + * Adjust extents of the rectangle to fit the width/height specified. |
|
3645 | + * |
|
3646 | + * @param int $width |
|
3647 | + * @param int $height |
|
3648 | + * @return float |
|
3649 | + */ |
|
3650 | + final public function fit($width, $height) {} |
|
3651 | + |
|
3652 | + /** |
|
3653 | + * Project the rectangle from "in" projection (1st argument) to "out" |
|
3654 | + * projection (2nd argument). Returns MS_SUCCESS/MS_FAILURE. |
|
3655 | + * |
|
3656 | + * @param projectionObj $in |
|
3657 | + * @param projectionObj $out |
|
3658 | + * @return int |
|
3659 | + */ |
|
3660 | + final public function project(projectionObj $in, projectionObj $out) {} |
|
3661 | + |
|
3662 | + /** |
|
3663 | + * Set object property to a new value. |
|
3664 | + * |
|
3665 | + * @param string $property_name |
|
3666 | + * @param $new_value |
|
3667 | + * @return int |
|
3668 | + */ |
|
3669 | + final public function set($property_name, $new_value) {} |
|
3670 | + |
|
3671 | + /** |
|
3672 | + * Set the rectangle extents. |
|
3673 | + * |
|
3674 | + * @param float $minx |
|
3675 | + * @param float $miny |
|
3676 | + * @param float $maxx |
|
3677 | + * @param float $maxy |
|
3678 | + * @return void |
|
3679 | + */ |
|
3680 | + final public function setextent($minx, $miny, $maxx, $maxy) {} |
|
3681 | 3681 | } |
3682 | 3682 | |
3683 | 3683 | /** |
@@ -3685,138 +3685,138 @@ discard block |
||
3685 | 3685 | */ |
3686 | 3686 | final class referenceMapObj |
3687 | 3687 | { |
3688 | - /** |
|
3689 | - * @var ColorObj |
|
3690 | - */ |
|
3691 | - public $color; |
|
3692 | - |
|
3693 | - /** |
|
3694 | - * @var int |
|
3695 | - */ |
|
3696 | - public $height; |
|
3697 | - |
|
3698 | - /** |
|
3699 | - * @var rectObj |
|
3700 | - */ |
|
3701 | - public $extent; |
|
3702 | - |
|
3703 | - /** |
|
3704 | - * @var string |
|
3705 | - */ |
|
3706 | - public $image; |
|
3707 | - |
|
3708 | - /** |
|
3709 | - * @var int |
|
3710 | - */ |
|
3711 | - public $marker; |
|
3712 | - |
|
3713 | - /** |
|
3714 | - * @var string |
|
3715 | - */ |
|
3716 | - public $markername; |
|
3717 | - |
|
3718 | - /** |
|
3719 | - * @var int |
|
3720 | - */ |
|
3721 | - public $markersize; |
|
3722 | - |
|
3723 | - /** |
|
3724 | - * @var int |
|
3725 | - */ |
|
3726 | - public $maxboxsize; |
|
3727 | - |
|
3728 | - /** |
|
3729 | - * @var int |
|
3730 | - */ |
|
3731 | - public $minboxsize; |
|
3732 | - |
|
3733 | - /** |
|
3734 | - * @var ColorObj |
|
3735 | - */ |
|
3736 | - public $outlinecolor; |
|
3737 | - |
|
3738 | - /** |
|
3739 | - * @var int |
|
3740 | - */ |
|
3741 | - public $status; |
|
3742 | - |
|
3743 | - /** |
|
3744 | - * @var int |
|
3745 | - */ |
|
3746 | - public $width; |
|
3747 | - |
|
3748 | - /** |
|
3749 | - * Saves the object to a string. Provides the inverse option for |
|
3750 | - * updateFromString. |
|
3751 | - * |
|
3752 | - * @return string |
|
3753 | - */ |
|
3754 | - final public function convertToString() {} |
|
3755 | - |
|
3756 | - /** |
|
3757 | - * Free the object properties and break the internal references. |
|
3758 | - * Note that you have to unset the php variable to free totally the |
|
3759 | - * resources. |
|
3760 | - * |
|
3761 | - * @return void |
|
3762 | - */ |
|
3763 | - final public function free() {} |
|
3764 | - |
|
3765 | - /** |
|
3766 | - * Set object property to a new value. |
|
3767 | - * |
|
3768 | - * @param string $property_name |
|
3769 | - * @param $new_value |
|
3770 | - * @return int |
|
3771 | - */ |
|
3772 | - final public function set($property_name, $new_value) {} |
|
3773 | - |
|
3774 | - /** |
|
3775 | - * Update a referenceMap object from a string snippet. |
|
3776 | - * Returns MS_SUCCESS/MS_FAILURE. |
|
3777 | - * |
|
3778 | - * @param string $snippet |
|
3779 | - * @return int |
|
3780 | - */ |
|
3781 | - final public function updateFromString($snippet) {} |
|
3688 | + /** |
|
3689 | + * @var ColorObj |
|
3690 | + */ |
|
3691 | + public $color; |
|
3692 | + |
|
3693 | + /** |
|
3694 | + * @var int |
|
3695 | + */ |
|
3696 | + public $height; |
|
3697 | + |
|
3698 | + /** |
|
3699 | + * @var rectObj |
|
3700 | + */ |
|
3701 | + public $extent; |
|
3702 | + |
|
3703 | + /** |
|
3704 | + * @var string |
|
3705 | + */ |
|
3706 | + public $image; |
|
3707 | + |
|
3708 | + /** |
|
3709 | + * @var int |
|
3710 | + */ |
|
3711 | + public $marker; |
|
3712 | + |
|
3713 | + /** |
|
3714 | + * @var string |
|
3715 | + */ |
|
3716 | + public $markername; |
|
3717 | + |
|
3718 | + /** |
|
3719 | + * @var int |
|
3720 | + */ |
|
3721 | + public $markersize; |
|
3722 | + |
|
3723 | + /** |
|
3724 | + * @var int |
|
3725 | + */ |
|
3726 | + public $maxboxsize; |
|
3727 | + |
|
3728 | + /** |
|
3729 | + * @var int |
|
3730 | + */ |
|
3731 | + public $minboxsize; |
|
3732 | + |
|
3733 | + /** |
|
3734 | + * @var ColorObj |
|
3735 | + */ |
|
3736 | + public $outlinecolor; |
|
3737 | + |
|
3738 | + /** |
|
3739 | + * @var int |
|
3740 | + */ |
|
3741 | + public $status; |
|
3742 | + |
|
3743 | + /** |
|
3744 | + * @var int |
|
3745 | + */ |
|
3746 | + public $width; |
|
3747 | + |
|
3748 | + /** |
|
3749 | + * Saves the object to a string. Provides the inverse option for |
|
3750 | + * updateFromString. |
|
3751 | + * |
|
3752 | + * @return string |
|
3753 | + */ |
|
3754 | + final public function convertToString() {} |
|
3755 | + |
|
3756 | + /** |
|
3757 | + * Free the object properties and break the internal references. |
|
3758 | + * Note that you have to unset the php variable to free totally the |
|
3759 | + * resources. |
|
3760 | + * |
|
3761 | + * @return void |
|
3762 | + */ |
|
3763 | + final public function free() {} |
|
3764 | + |
|
3765 | + /** |
|
3766 | + * Set object property to a new value. |
|
3767 | + * |
|
3768 | + * @param string $property_name |
|
3769 | + * @param $new_value |
|
3770 | + * @return int |
|
3771 | + */ |
|
3772 | + final public function set($property_name, $new_value) {} |
|
3773 | + |
|
3774 | + /** |
|
3775 | + * Update a referenceMap object from a string snippet. |
|
3776 | + * Returns MS_SUCCESS/MS_FAILURE. |
|
3777 | + * |
|
3778 | + * @param string $snippet |
|
3779 | + * @return int |
|
3780 | + */ |
|
3781 | + final public function updateFromString($snippet) {} |
|
3782 | 3782 | } |
3783 | 3783 | |
3784 | 3784 | final class resultObj |
3785 | 3785 | { |
3786 | - /** |
|
3787 | - * read-only |
|
3788 | - * |
|
3789 | - * @var int |
|
3790 | - */ |
|
3791 | - public $classindex; |
|
3792 | - |
|
3793 | - /** |
|
3794 | - * read-only |
|
3795 | - * |
|
3796 | - * @var int |
|
3797 | - */ |
|
3798 | - public $resultindex; |
|
3799 | - |
|
3800 | - /** |
|
3801 | - * read-only |
|
3802 | - * |
|
3803 | - * @var int |
|
3804 | - */ |
|
3805 | - public $shapeindex; |
|
3806 | - |
|
3807 | - /** |
|
3808 | - * read-only |
|
3809 | - * |
|
3810 | - * @var int |
|
3811 | - */ |
|
3812 | - public $tileindex; |
|
3813 | - |
|
3814 | - /** |
|
3815 | - * or using the `layerObj`_'s getResult() method. |
|
3816 | - * |
|
3817 | - * @param int $shapeindex |
|
3818 | - */ |
|
3819 | - final public function __construct($shapeindex) {} |
|
3786 | + /** |
|
3787 | + * read-only |
|
3788 | + * |
|
3789 | + * @var int |
|
3790 | + */ |
|
3791 | + public $classindex; |
|
3792 | + |
|
3793 | + /** |
|
3794 | + * read-only |
|
3795 | + * |
|
3796 | + * @var int |
|
3797 | + */ |
|
3798 | + public $resultindex; |
|
3799 | + |
|
3800 | + /** |
|
3801 | + * read-only |
|
3802 | + * |
|
3803 | + * @var int |
|
3804 | + */ |
|
3805 | + public $shapeindex; |
|
3806 | + |
|
3807 | + /** |
|
3808 | + * read-only |
|
3809 | + * |
|
3810 | + * @var int |
|
3811 | + */ |
|
3812 | + public $tileindex; |
|
3813 | + |
|
3814 | + /** |
|
3815 | + * or using the `layerObj`_'s getResult() method. |
|
3816 | + * |
|
3817 | + * @param int $shapeindex |
|
3818 | + */ |
|
3819 | + final public function __construct($shapeindex) {} |
|
3820 | 3820 | } |
3821 | 3821 | |
3822 | 3822 | /** |
@@ -3824,611 +3824,611 @@ discard block |
||
3824 | 3824 | */ |
3825 | 3825 | final class scalebarObj |
3826 | 3826 | { |
3827 | - /** |
|
3828 | - * @var int |
|
3829 | - */ |
|
3830 | - public $align; |
|
3831 | - |
|
3832 | - /** |
|
3833 | - * @var colorObj |
|
3834 | - */ |
|
3835 | - public $backgroundcolor; |
|
3836 | - |
|
3837 | - /** |
|
3838 | - * @var colorObj |
|
3839 | - */ |
|
3840 | - public $color; |
|
3841 | - |
|
3842 | - /** |
|
3843 | - * @var int |
|
3844 | - */ |
|
3845 | - public $height; |
|
3846 | - |
|
3847 | - /** |
|
3848 | - * @var colorObj |
|
3849 | - */ |
|
3850 | - public $imagecolor; |
|
3851 | - |
|
3852 | - /** |
|
3853 | - * @var int |
|
3854 | - */ |
|
3855 | - public $intervals; |
|
3856 | - |
|
3857 | - /** |
|
3858 | - * @var labelObj |
|
3859 | - */ |
|
3860 | - public $label; |
|
3861 | - |
|
3862 | - /** |
|
3863 | - * @var colorObj |
|
3864 | - */ |
|
3865 | - public $outlinecolor; |
|
3866 | - |
|
3867 | - /** |
|
3868 | - * for embedded scalebars, MS_UL, MS_UC, ... |
|
3869 | - * |
|
3870 | - * @var int |
|
3871 | - */ |
|
3872 | - public $position; |
|
3873 | - |
|
3874 | - /** |
|
3875 | - * @var int |
|
3876 | - */ |
|
3877 | - public $postlabelcache; |
|
3878 | - |
|
3879 | - /** |
|
3880 | - * MS_ON, MS_OFF, MS_EMBED |
|
3881 | - * |
|
3882 | - * @var int |
|
3883 | - */ |
|
3884 | - public $status; |
|
3885 | - |
|
3886 | - /** |
|
3887 | - * @var int |
|
3888 | - */ |
|
3889 | - public $style; |
|
3890 | - |
|
3891 | - /** |
|
3892 | - * @var int |
|
3893 | - */ |
|
3894 | - public $units; |
|
3895 | - |
|
3896 | - /** |
|
3897 | - * @var int |
|
3898 | - */ |
|
3899 | - public $width; |
|
3900 | - |
|
3901 | - /** |
|
3902 | - * Saves the object to a string. Provides the inverse option for |
|
3903 | - * updateFromString. |
|
3904 | - * |
|
3905 | - * @return string |
|
3906 | - */ |
|
3907 | - final public function convertToString() {} |
|
3908 | - |
|
3909 | - /** |
|
3910 | - * Free the object properties and break the internal references. |
|
3911 | - * Note that you have to unset the php variable to free totally the |
|
3912 | - * resources. |
|
3913 | - * |
|
3914 | - * @return void |
|
3915 | - */ |
|
3916 | - final public function free() {} |
|
3917 | - |
|
3918 | - /** |
|
3919 | - * Set object property to a new value. |
|
3920 | - * |
|
3921 | - * @param string $property_name |
|
3922 | - * @param $new_value |
|
3923 | - * @return int |
|
3924 | - */ |
|
3925 | - final public function set($property_name, $new_value) {} |
|
3926 | - |
|
3927 | - /** |
|
3928 | - * Sets the imagecolor property (baclground) of the object. |
|
3929 | - * Returns MS_SUCCESS or MS_FAILURE on error. |
|
3930 | - * |
|
3931 | - * @param int $red |
|
3932 | - * @param int $green |
|
3933 | - * @param int $blue |
|
3934 | - * @return int |
|
3935 | - */ |
|
3936 | - final public function setImageColor($red, $green, $blue) {} |
|
3937 | - |
|
3938 | - /** |
|
3939 | - * Update a scalebar from a string snippet. Returns MS_SUCCESS/MS_FAILURE. |
|
3940 | - * |
|
3941 | - * @param string $snippet |
|
3942 | - * @return int |
|
3943 | - */ |
|
3944 | - final public function updateFromString($snippet) {} |
|
3827 | + /** |
|
3828 | + * @var int |
|
3829 | + */ |
|
3830 | + public $align; |
|
3831 | + |
|
3832 | + /** |
|
3833 | + * @var colorObj |
|
3834 | + */ |
|
3835 | + public $backgroundcolor; |
|
3836 | + |
|
3837 | + /** |
|
3838 | + * @var colorObj |
|
3839 | + */ |
|
3840 | + public $color; |
|
3841 | + |
|
3842 | + /** |
|
3843 | + * @var int |
|
3844 | + */ |
|
3845 | + public $height; |
|
3846 | + |
|
3847 | + /** |
|
3848 | + * @var colorObj |
|
3849 | + */ |
|
3850 | + public $imagecolor; |
|
3851 | + |
|
3852 | + /** |
|
3853 | + * @var int |
|
3854 | + */ |
|
3855 | + public $intervals; |
|
3856 | + |
|
3857 | + /** |
|
3858 | + * @var labelObj |
|
3859 | + */ |
|
3860 | + public $label; |
|
3861 | + |
|
3862 | + /** |
|
3863 | + * @var colorObj |
|
3864 | + */ |
|
3865 | + public $outlinecolor; |
|
3866 | + |
|
3867 | + /** |
|
3868 | + * for embedded scalebars, MS_UL, MS_UC, ... |
|
3869 | + * |
|
3870 | + * @var int |
|
3871 | + */ |
|
3872 | + public $position; |
|
3873 | + |
|
3874 | + /** |
|
3875 | + * @var int |
|
3876 | + */ |
|
3877 | + public $postlabelcache; |
|
3878 | + |
|
3879 | + /** |
|
3880 | + * MS_ON, MS_OFF, MS_EMBED |
|
3881 | + * |
|
3882 | + * @var int |
|
3883 | + */ |
|
3884 | + public $status; |
|
3885 | + |
|
3886 | + /** |
|
3887 | + * @var int |
|
3888 | + */ |
|
3889 | + public $style; |
|
3890 | + |
|
3891 | + /** |
|
3892 | + * @var int |
|
3893 | + */ |
|
3894 | + public $units; |
|
3895 | + |
|
3896 | + /** |
|
3897 | + * @var int |
|
3898 | + */ |
|
3899 | + public $width; |
|
3900 | + |
|
3901 | + /** |
|
3902 | + * Saves the object to a string. Provides the inverse option for |
|
3903 | + * updateFromString. |
|
3904 | + * |
|
3905 | + * @return string |
|
3906 | + */ |
|
3907 | + final public function convertToString() {} |
|
3908 | + |
|
3909 | + /** |
|
3910 | + * Free the object properties and break the internal references. |
|
3911 | + * Note that you have to unset the php variable to free totally the |
|
3912 | + * resources. |
|
3913 | + * |
|
3914 | + * @return void |
|
3915 | + */ |
|
3916 | + final public function free() {} |
|
3917 | + |
|
3918 | + /** |
|
3919 | + * Set object property to a new value. |
|
3920 | + * |
|
3921 | + * @param string $property_name |
|
3922 | + * @param $new_value |
|
3923 | + * @return int |
|
3924 | + */ |
|
3925 | + final public function set($property_name, $new_value) {} |
|
3926 | + |
|
3927 | + /** |
|
3928 | + * Sets the imagecolor property (baclground) of the object. |
|
3929 | + * Returns MS_SUCCESS or MS_FAILURE on error. |
|
3930 | + * |
|
3931 | + * @param int $red |
|
3932 | + * @param int $green |
|
3933 | + * @param int $blue |
|
3934 | + * @return int |
|
3935 | + */ |
|
3936 | + final public function setImageColor($red, $green, $blue) {} |
|
3937 | + |
|
3938 | + /** |
|
3939 | + * Update a scalebar from a string snippet. Returns MS_SUCCESS/MS_FAILURE. |
|
3940 | + * |
|
3941 | + * @param string $snippet |
|
3942 | + * @return int |
|
3943 | + */ |
|
3944 | + final public function updateFromString($snippet) {} |
|
3945 | 3945 | } |
3946 | 3946 | |
3947 | 3947 | final class shapefileObj |
3948 | 3948 | { |
3949 | - /** |
|
3950 | - * read-only |
|
3951 | - * |
|
3952 | - * @var rectObj |
|
3953 | - */ |
|
3954 | - public $bounds; |
|
3955 | - |
|
3956 | - /** |
|
3957 | - * read-only |
|
3958 | - * |
|
3959 | - * @var int |
|
3960 | - */ |
|
3961 | - public $numshapes; |
|
3962 | - |
|
3963 | - /** |
|
3964 | - * read-only |
|
3965 | - * |
|
3966 | - * @var string |
|
3967 | - */ |
|
3968 | - public $source; |
|
3969 | - |
|
3970 | - /** |
|
3971 | - * read-only |
|
3972 | - * |
|
3973 | - * @var int |
|
3974 | - */ |
|
3975 | - public $type; |
|
3976 | - |
|
3977 | - /** |
|
3978 | - * Opens a shapefile and returns a new object to deal with it. Filename |
|
3979 | - * should be passed with no extension. To create a new file (or |
|
3980 | - * overwrite an existing one), type should be one of MS_SHP_POINT, |
|
3981 | - * MS_SHP_ARC, MS_SHP_POLYGON or MS_SHP_MULTIPOINT. Pass type as -1 to |
|
3982 | - * open an existing file for read-only access, and type=-2 to open an |
|
3983 | - * existing file for update (append). |
|
3984 | - * |
|
3985 | - * @param string $filename |
|
3986 | - * @param int $type |
|
3987 | - */ |
|
3988 | - final public function __construct($filename, $type) {} |
|
3989 | - |
|
3990 | - /** |
|
3991 | - * Old style constructor |
|
3992 | - * |
|
3993 | - * @param string $filename |
|
3994 | - * @param int $type |
|
3995 | - * @return shapefileObj |
|
3996 | - */ |
|
3997 | - final public function ms_newShapefileObj($filename, $type) {} |
|
3998 | - |
|
3999 | - /** |
|
4000 | - * Appends a point to an open shapefile. |
|
4001 | - * |
|
4002 | - * @param pointObj $point |
|
4003 | - * @return int |
|
4004 | - */ |
|
4005 | - final public function addPoint(pointObj $point) {} |
|
4006 | - |
|
4007 | - /** |
|
4008 | - * Appends a shape to an open shapefile. |
|
4009 | - * |
|
4010 | - * @param shapeObj $shape |
|
4011 | - * @return int |
|
4012 | - */ |
|
4013 | - final public function addShape(shapeObj $shape) {} |
|
4014 | - |
|
4015 | - /** |
|
4016 | - * Free the object properties and break the internal references. |
|
4017 | - * Note that you have to unset the php variable to free totally the |
|
4018 | - * resources. |
|
4019 | - * .. note:: |
|
4020 | - * The shape file is closed (and changes committed) when |
|
4021 | - * the object is destroyed. You can explicitly close and save |
|
4022 | - * the changes by calling $shapefile->free(); |
|
4023 | - * unset($shapefile), which will also free the php object. |
|
4024 | - * |
|
4025 | - * @return void |
|
4026 | - */ |
|
4027 | - final public function free() {} |
|
4028 | - |
|
4029 | - /** |
|
4030 | - * Retrieve a shape's bounding box by index. |
|
4031 | - * |
|
4032 | - * @param int $i |
|
4033 | - * @return rectObj |
|
4034 | - */ |
|
4035 | - final public function getExtent($i) {} |
|
4036 | - |
|
4037 | - /** |
|
4038 | - * Retrieve point by index. |
|
4039 | - * |
|
4040 | - * @param int $i |
|
4041 | - * @return shapeObj |
|
4042 | - */ |
|
4043 | - final public function getPoint($i) {} |
|
4044 | - |
|
4045 | - /** |
|
4046 | - * Retrieve shape by index. |
|
4047 | - * |
|
4048 | - * @param int $i |
|
4049 | - * @return shapeObj |
|
4050 | - */ |
|
4051 | - final public function getShape($i) {} |
|
4052 | - |
|
4053 | - /** |
|
4054 | - * Retrieve shape by index. |
|
4055 | - * |
|
4056 | - * @param mapObj $map |
|
4057 | - * @param int $i |
|
4058 | - * @return shapeObj |
|
4059 | - */ |
|
4060 | - final public function getTransformed(mapObj $map, $i) {} |
|
3949 | + /** |
|
3950 | + * read-only |
|
3951 | + * |
|
3952 | + * @var rectObj |
|
3953 | + */ |
|
3954 | + public $bounds; |
|
3955 | + |
|
3956 | + /** |
|
3957 | + * read-only |
|
3958 | + * |
|
3959 | + * @var int |
|
3960 | + */ |
|
3961 | + public $numshapes; |
|
3962 | + |
|
3963 | + /** |
|
3964 | + * read-only |
|
3965 | + * |
|
3966 | + * @var string |
|
3967 | + */ |
|
3968 | + public $source; |
|
3969 | + |
|
3970 | + /** |
|
3971 | + * read-only |
|
3972 | + * |
|
3973 | + * @var int |
|
3974 | + */ |
|
3975 | + public $type; |
|
3976 | + |
|
3977 | + /** |
|
3978 | + * Opens a shapefile and returns a new object to deal with it. Filename |
|
3979 | + * should be passed with no extension. To create a new file (or |
|
3980 | + * overwrite an existing one), type should be one of MS_SHP_POINT, |
|
3981 | + * MS_SHP_ARC, MS_SHP_POLYGON or MS_SHP_MULTIPOINT. Pass type as -1 to |
|
3982 | + * open an existing file for read-only access, and type=-2 to open an |
|
3983 | + * existing file for update (append). |
|
3984 | + * |
|
3985 | + * @param string $filename |
|
3986 | + * @param int $type |
|
3987 | + */ |
|
3988 | + final public function __construct($filename, $type) {} |
|
3989 | + |
|
3990 | + /** |
|
3991 | + * Old style constructor |
|
3992 | + * |
|
3993 | + * @param string $filename |
|
3994 | + * @param int $type |
|
3995 | + * @return shapefileObj |
|
3996 | + */ |
|
3997 | + final public function ms_newShapefileObj($filename, $type) {} |
|
3998 | + |
|
3999 | + /** |
|
4000 | + * Appends a point to an open shapefile. |
|
4001 | + * |
|
4002 | + * @param pointObj $point |
|
4003 | + * @return int |
|
4004 | + */ |
|
4005 | + final public function addPoint(pointObj $point) {} |
|
4006 | + |
|
4007 | + /** |
|
4008 | + * Appends a shape to an open shapefile. |
|
4009 | + * |
|
4010 | + * @param shapeObj $shape |
|
4011 | + * @return int |
|
4012 | + */ |
|
4013 | + final public function addShape(shapeObj $shape) {} |
|
4014 | + |
|
4015 | + /** |
|
4016 | + * Free the object properties and break the internal references. |
|
4017 | + * Note that you have to unset the php variable to free totally the |
|
4018 | + * resources. |
|
4019 | + * .. note:: |
|
4020 | + * The shape file is closed (and changes committed) when |
|
4021 | + * the object is destroyed. You can explicitly close and save |
|
4022 | + * the changes by calling $shapefile->free(); |
|
4023 | + * unset($shapefile), which will also free the php object. |
|
4024 | + * |
|
4025 | + * @return void |
|
4026 | + */ |
|
4027 | + final public function free() {} |
|
4028 | + |
|
4029 | + /** |
|
4030 | + * Retrieve a shape's bounding box by index. |
|
4031 | + * |
|
4032 | + * @param int $i |
|
4033 | + * @return rectObj |
|
4034 | + */ |
|
4035 | + final public function getExtent($i) {} |
|
4036 | + |
|
4037 | + /** |
|
4038 | + * Retrieve point by index. |
|
4039 | + * |
|
4040 | + * @param int $i |
|
4041 | + * @return shapeObj |
|
4042 | + */ |
|
4043 | + final public function getPoint($i) {} |
|
4044 | + |
|
4045 | + /** |
|
4046 | + * Retrieve shape by index. |
|
4047 | + * |
|
4048 | + * @param int $i |
|
4049 | + * @return shapeObj |
|
4050 | + */ |
|
4051 | + final public function getShape($i) {} |
|
4052 | + |
|
4053 | + /** |
|
4054 | + * Retrieve shape by index. |
|
4055 | + * |
|
4056 | + * @param mapObj $map |
|
4057 | + * @param int $i |
|
4058 | + * @return shapeObj |
|
4059 | + */ |
|
4060 | + final public function getTransformed(mapObj $map, $i) {} |
|
4061 | 4061 | } |
4062 | 4062 | |
4063 | 4063 | final class shapeObj |
4064 | 4064 | { |
4065 | - /** |
|
4066 | - * read-only |
|
4067 | - * |
|
4068 | - * @var rectObj |
|
4069 | - */ |
|
4070 | - public $bounds; |
|
4071 | - |
|
4072 | - /** |
|
4073 | - * @var int |
|
4074 | - */ |
|
4075 | - public $classindex; |
|
4076 | - |
|
4077 | - /** |
|
4078 | - * @var int |
|
4079 | - */ |
|
4080 | - public $index; |
|
4081 | - |
|
4082 | - /** |
|
4083 | - * read-only |
|
4084 | - * |
|
4085 | - * @var int |
|
4086 | - */ |
|
4087 | - public $numlines; |
|
4088 | - |
|
4089 | - /** |
|
4090 | - * read-only |
|
4091 | - * |
|
4092 | - * @var int |
|
4093 | - */ |
|
4094 | - public $numvalues; |
|
4095 | - |
|
4096 | - /** |
|
4097 | - * read-only |
|
4098 | - * |
|
4099 | - * @var int |
|
4100 | - */ |
|
4101 | - public $tileindex; |
|
4102 | - |
|
4103 | - /** |
|
4104 | - * @var string |
|
4105 | - */ |
|
4106 | - public $text; |
|
4107 | - |
|
4108 | - /** |
|
4109 | - * read-only |
|
4110 | - * |
|
4111 | - * @var int |
|
4112 | - */ |
|
4113 | - public $type; |
|
4114 | - |
|
4115 | - /** |
|
4116 | - * read-only |
|
4117 | - * |
|
4118 | - * @var array |
|
4119 | - */ |
|
4120 | - public $values; |
|
4121 | - |
|
4122 | - /** |
|
4123 | - * 'type' is one of MS_SHAPE_POINT, MS_SHAPE_LINE, MS_SHAPE_POLYGON or |
|
4124 | - * MS_SHAPE_NULL |
|
4125 | - * Creates new shape object from WKT string. |
|
4126 | - * |
|
4127 | - * @param int $type |
|
4128 | - */ |
|
4129 | - final public function __construct($type) {} |
|
4130 | - |
|
4131 | - /** |
|
4132 | - * Old style constructor |
|
4133 | - * |
|
4134 | - * @param string $wkt |
|
4135 | - * @return ShapeObj |
|
4136 | - */ |
|
4137 | - final public function ms_shapeObjFromWkt($wkt) {} |
|
4138 | - |
|
4139 | - /** |
|
4140 | - * Add a line (i.e. a part) to the shape. |
|
4141 | - * |
|
4142 | - * @param lineObj $line |
|
4143 | - * @return int |
|
4144 | - */ |
|
4145 | - final public function add(lineObj $line) {} |
|
4146 | - |
|
4147 | - /** |
|
4148 | - * Returns the boundary of the shape. |
|
4149 | - * Only available if php/mapscript is built with GEOS library. |
|
4150 | - * shapeObj buffer(width) |
|
4151 | - * Returns a new buffered shapeObj based on the supplied distance (given |
|
4152 | - * in the coordinates of the existing shapeObj). |
|
4153 | - * Only available if php/mapscript is built with GEOS library. |
|
4154 | - * |
|
4155 | - * @return shapeObj |
|
4156 | - */ |
|
4157 | - final public function boundary() {} |
|
4158 | - |
|
4159 | - /** |
|
4160 | - * Returns true if shape2 passed as argument is entirely within the shape. |
|
4161 | - * Else return false. |
|
4162 | - * Only available if php/mapscript is built with GEOS |
|
4163 | - * library. |
|
4164 | - * |
|
4165 | - * @param shapeObj $shape2 |
|
4166 | - * @return int |
|
4167 | - */ |
|
4168 | - final public function containsShape(shapeObj $shape2) {} |
|
4169 | - |
|
4170 | - /** |
|
4171 | - * Returns a shape object representing the convex hull of shape. |
|
4172 | - * Only available if php/mapscript is built with GEOS |
|
4173 | - * library. |
|
4174 | - * |
|
4175 | - * @return shapeObj |
|
4176 | - */ |
|
4177 | - final public function convexhull() {} |
|
4178 | - |
|
4179 | - /** |
|
4180 | - * Returns MS_TRUE if the point is inside the shape, MS_FALSE otherwise. |
|
4181 | - * |
|
4182 | - * @param pointObj $point |
|
4183 | - * @return bool |
|
4184 | - */ |
|
4185 | - final public function contains(pointObj $point) {} |
|
4186 | - |
|
4187 | - /** |
|
4188 | - * Returns true if the shape passed as argument crosses the shape. |
|
4189 | - * Else return false. |
|
4190 | - * Only available if php/mapscript is built with GEOS library. |
|
4191 | - * |
|
4192 | - * @param shapeObj $shape |
|
4193 | - * @return int |
|
4194 | - */ |
|
4195 | - final public function crosses(shapeObj $shape) {} |
|
4196 | - |
|
4197 | - /** |
|
4198 | - * Returns a shape object representing the difference of the |
|
4199 | - * shape object with the one passed as parameter. |
|
4200 | - * Only available if php/mapscript is built with GEOS library. |
|
4201 | - * |
|
4202 | - * @param shapeObj $shape |
|
4203 | - * @return shapeObj |
|
4204 | - */ |
|
4205 | - final public function difference(shapeObj $shape) {} |
|
4206 | - |
|
4207 | - /** |
|
4208 | - * Returns true if the shape passed as argument is disjoint to the |
|
4209 | - * shape. Else return false. |
|
4210 | - * Only available if php/mapscript is built with GEOS library. |
|
4211 | - * |
|
4212 | - * @param shapeObj $shape |
|
4213 | - * @return int |
|
4214 | - */ |
|
4215 | - final public function disjoint(shapeObj $shape) {} |
|
4216 | - |
|
4217 | - /** |
|
4218 | - * Draws the individual shape using layer. |
|
4219 | - * Returns MS_SUCCESS/MS_FAILURE. |
|
4220 | - * |
|
4221 | - * @param mapObj $map |
|
4222 | - * @param layerObj $layer |
|
4223 | - * @param imageObj $img |
|
4224 | - * @return int |
|
4225 | - */ |
|
4226 | - final public function draw(mapObj $map, layerObj $layer, imageObj $img) {} |
|
4227 | - |
|
4228 | - /** |
|
4229 | - * Returns true if the shape passed as argument is equal to the |
|
4230 | - * shape (geometry only). Else return false. |
|
4231 | - * Only available if php/mapscript is built with GEOS library. |
|
4232 | - * |
|
4233 | - * @param shapeObj $shape |
|
4234 | - * @return int |
|
4235 | - */ |
|
4236 | - final public function equals(shapeObj $shape) {} |
|
4237 | - |
|
4238 | - /** |
|
4239 | - * Free the object properties and break the internal references. |
|
4240 | - * Note that you have to unset the php variable to free totally the resources. |
|
4241 | - * |
|
4242 | - * @return void |
|
4243 | - */ |
|
4244 | - final public function free() {} |
|
4245 | - |
|
4246 | - /** |
|
4247 | - * Returns the area of the shape (if applicable). |
|
4248 | - * Only available if php/mapscript is built with GEOS library. |
|
4249 | - * |
|
4250 | - * @return float |
|
4251 | - */ |
|
4252 | - final public function getArea() {} |
|
4253 | - |
|
4254 | - /** |
|
4255 | - * Returns a point object representing the centroid of the shape. |
|
4256 | - * Only available if php/mapscript is built with GEOS library. |
|
4257 | - * |
|
4258 | - * @return pointObj |
|
4259 | - */ |
|
4260 | - final public function getCentroid() {} |
|
4261 | - |
|
4262 | - /** |
|
4263 | - * Returns a point object with coordinates suitable for labelling |
|
4264 | - * the shape. |
|
4265 | - * |
|
4266 | - * @return pointObj |
|
4267 | - */ |
|
4268 | - final public function getLabelPoint() {} |
|
4269 | - |
|
4270 | - /** |
|
4271 | - * Returns the length (or perimeter) of the shape. |
|
4272 | - * Only available if php/mapscript is built with GEOS library. |
|
4273 | - * pointObj getMeasureUsingPoint(pointObj point) |
|
4274 | - * Apply only on Measured shape files. Given an XY Location, find the |
|
4275 | - * nearest point on the shape object. Return a point object |
|
4276 | - * of this point with the m value set. |
|
4277 | - * |
|
4278 | - * @return float |
|
4279 | - */ |
|
4280 | - final public function getLength() {} |
|
4281 | - |
|
4282 | - /** |
|
4283 | - * Apply only on Measured shape files. Given a measure m, retun the |
|
4284 | - * corresponding XY location on the shapeobject. |
|
4285 | - * |
|
4286 | - * @param float $m |
|
4287 | - * @return pointObj |
|
4288 | - */ |
|
4289 | - final public function getPointUsingMeasure($m) {} |
|
4290 | - |
|
4291 | - /** |
|
4292 | - * Returns the value for a given field name. |
|
4293 | - * |
|
4294 | - * @param layerObj $layer |
|
4295 | - * @param string $filedname |
|
4296 | - * @return string |
|
4297 | - */ |
|
4298 | - final public function getValue(layerObj $layer, $filedname) {} |
|
4299 | - |
|
4300 | - /** |
|
4301 | - * Returns a shape object representing the intersection of the shape |
|
4302 | - * object with the one passed as parameter. |
|
4303 | - * Only available if php/mapscript is built with GEOS library. |
|
4304 | - * |
|
4305 | - * @param shapeObj $shape |
|
4306 | - * @return shapeObj |
|
4307 | - */ |
|
4308 | - final public function intersection(shapeObj $shape) {} |
|
4309 | - |
|
4310 | - /** |
|
4311 | - * Returns MS_TRUE if the two shapes intersect, MS_FALSE otherwise. |
|
4312 | - * |
|
4313 | - * @param shapeObj $shape |
|
4314 | - * @return bool |
|
4315 | - */ |
|
4316 | - final public function intersects(shapeObj $shape) {} |
|
4317 | - |
|
4318 | - /** |
|
4319 | - * Returns a reference to line number i. |
|
4320 | - * |
|
4321 | - * @param int $i |
|
4322 | - * @return lineObj |
|
4323 | - */ |
|
4324 | - final public function line($i) {} |
|
4325 | - |
|
4326 | - /** |
|
4327 | - * Returns true if the shape passed as argument overlaps the shape. |
|
4328 | - * Else returns false. |
|
4329 | - * Only available if php/mapscript is built with GEOS library. |
|
4330 | - * |
|
4331 | - * @param shapeObj $shape |
|
4332 | - * @return int |
|
4333 | - */ |
|
4334 | - final public function overlaps(shapeObj $shape) {} |
|
4335 | - |
|
4336 | - /** |
|
4337 | - * Project the shape from "in" projection (1st argument) to "out" |
|
4338 | - * projection (2nd argument). Returns MS_SUCCESS/MS_FAILURE. |
|
4339 | - * |
|
4340 | - * @param projectionObj $in |
|
4341 | - * @param projectionObj $out |
|
4342 | - * @return int |
|
4343 | - */ |
|
4344 | - final public function project(projectionObj $in, projectionObj $out) {} |
|
4345 | - |
|
4346 | - /** |
|
4347 | - * Set object property to a new value. |
|
4348 | - * |
|
4349 | - * @param string $property_name |
|
4350 | - * @param $new_value |
|
4351 | - * @return int |
|
4352 | - */ |
|
4353 | - final public function set($property_name, $new_value) {} |
|
4354 | - |
|
4355 | - /** |
|
4356 | - * Updates the bounds property of the shape. |
|
4357 | - * Must be called to calculate new bounding box after new parts have been |
|
4358 | - * added. |
|
4359 | - * |
|
4360 | - * @return int |
|
4361 | - */ |
|
4362 | - final public function setBounds() {} |
|
4363 | - |
|
4364 | - /** |
|
4365 | - * Given a tolerance, returns a simplified shape object or NULL on |
|
4366 | - * error. Only available if php/mapscript is built with GEOS library |
|
4367 | - * (>=3.0). |
|
4368 | - * |
|
4369 | - * @param float $tolerance |
|
4370 | - * @return shapeObj|null |
|
4371 | - */ |
|
4372 | - final public function simplify($tolerance) {} |
|
4373 | - |
|
4374 | - /** |
|
4375 | - * Returns the computed symmetric difference of the supplied and |
|
4376 | - * existing shape. |
|
4377 | - * Only available if php/mapscript is built with GEOS library. |
|
4378 | - * |
|
4379 | - * @param shapeObj $shape |
|
4380 | - * @return shapeObj |
|
4381 | - */ |
|
4382 | - final public function symdifference(shapeObj $shape) {} |
|
4383 | - |
|
4384 | - /** |
|
4385 | - * Given a tolerance, returns a simplified shape object or NULL on |
|
4386 | - * error. Only available if php/mapscript is built with GEOS library |
|
4387 | - * (>=3.0). |
|
4388 | - * |
|
4389 | - * @param float $tolerance |
|
4390 | - * @return shapeObj|null |
|
4391 | - */ |
|
4392 | - final public function topologyPreservingSimplify($tolerance) {} |
|
4393 | - |
|
4394 | - /** |
|
4395 | - * Returns true if the shape passed as argument touches the shape. |
|
4396 | - * Else return false. |
|
4397 | - * Only available if php/mapscript is built with GEOS library. |
|
4398 | - * |
|
4399 | - * @param shapeObj $shape |
|
4400 | - * @return int |
|
4401 | - */ |
|
4402 | - final public function touches(shapeObj $shape) {} |
|
4403 | - |
|
4404 | - /** |
|
4405 | - * Returns WKT representation of the shape's geometry. |
|
4406 | - * |
|
4407 | - * @return string |
|
4408 | - */ |
|
4409 | - final public function toWkt() {} |
|
4410 | - |
|
4411 | - /** |
|
4412 | - * Returns a shape object representing the union of the shape object |
|
4413 | - * with the one passed as parameter. |
|
4414 | - * Only available if php/mapscript is built with GEOS |
|
4415 | - * library |
|
4416 | - * |
|
4417 | - * @param shapeObj $shape |
|
4418 | - * @return shapeObj |
|
4419 | - */ |
|
4420 | - final public function union(shapeObj $shape) {} |
|
4421 | - |
|
4422 | - /** |
|
4423 | - * Returns true if the shape is entirely within the shape2 passed as |
|
4424 | - * argument. |
|
4425 | - * Else returns false. |
|
4426 | - * Only available if php/mapscript is built with GEOS library. |
|
4427 | - * |
|
4428 | - * @param shapeObj $shape2 |
|
4429 | - * @return int |
|
4430 | - */ |
|
4431 | - final public function within(shapeObj $shape2) {} |
|
4065 | + /** |
|
4066 | + * read-only |
|
4067 | + * |
|
4068 | + * @var rectObj |
|
4069 | + */ |
|
4070 | + public $bounds; |
|
4071 | + |
|
4072 | + /** |
|
4073 | + * @var int |
|
4074 | + */ |
|
4075 | + public $classindex; |
|
4076 | + |
|
4077 | + /** |
|
4078 | + * @var int |
|
4079 | + */ |
|
4080 | + public $index; |
|
4081 | + |
|
4082 | + /** |
|
4083 | + * read-only |
|
4084 | + * |
|
4085 | + * @var int |
|
4086 | + */ |
|
4087 | + public $numlines; |
|
4088 | + |
|
4089 | + /** |
|
4090 | + * read-only |
|
4091 | + * |
|
4092 | + * @var int |
|
4093 | + */ |
|
4094 | + public $numvalues; |
|
4095 | + |
|
4096 | + /** |
|
4097 | + * read-only |
|
4098 | + * |
|
4099 | + * @var int |
|
4100 | + */ |
|
4101 | + public $tileindex; |
|
4102 | + |
|
4103 | + /** |
|
4104 | + * @var string |
|
4105 | + */ |
|
4106 | + public $text; |
|
4107 | + |
|
4108 | + /** |
|
4109 | + * read-only |
|
4110 | + * |
|
4111 | + * @var int |
|
4112 | + */ |
|
4113 | + public $type; |
|
4114 | + |
|
4115 | + /** |
|
4116 | + * read-only |
|
4117 | + * |
|
4118 | + * @var array |
|
4119 | + */ |
|
4120 | + public $values; |
|
4121 | + |
|
4122 | + /** |
|
4123 | + * 'type' is one of MS_SHAPE_POINT, MS_SHAPE_LINE, MS_SHAPE_POLYGON or |
|
4124 | + * MS_SHAPE_NULL |
|
4125 | + * Creates new shape object from WKT string. |
|
4126 | + * |
|
4127 | + * @param int $type |
|
4128 | + */ |
|
4129 | + final public function __construct($type) {} |
|
4130 | + |
|
4131 | + /** |
|
4132 | + * Old style constructor |
|
4133 | + * |
|
4134 | + * @param string $wkt |
|
4135 | + * @return ShapeObj |
|
4136 | + */ |
|
4137 | + final public function ms_shapeObjFromWkt($wkt) {} |
|
4138 | + |
|
4139 | + /** |
|
4140 | + * Add a line (i.e. a part) to the shape. |
|
4141 | + * |
|
4142 | + * @param lineObj $line |
|
4143 | + * @return int |
|
4144 | + */ |
|
4145 | + final public function add(lineObj $line) {} |
|
4146 | + |
|
4147 | + /** |
|
4148 | + * Returns the boundary of the shape. |
|
4149 | + * Only available if php/mapscript is built with GEOS library. |
|
4150 | + * shapeObj buffer(width) |
|
4151 | + * Returns a new buffered shapeObj based on the supplied distance (given |
|
4152 | + * in the coordinates of the existing shapeObj). |
|
4153 | + * Only available if php/mapscript is built with GEOS library. |
|
4154 | + * |
|
4155 | + * @return shapeObj |
|
4156 | + */ |
|
4157 | + final public function boundary() {} |
|
4158 | + |
|
4159 | + /** |
|
4160 | + * Returns true if shape2 passed as argument is entirely within the shape. |
|
4161 | + * Else return false. |
|
4162 | + * Only available if php/mapscript is built with GEOS |
|
4163 | + * library. |
|
4164 | + * |
|
4165 | + * @param shapeObj $shape2 |
|
4166 | + * @return int |
|
4167 | + */ |
|
4168 | + final public function containsShape(shapeObj $shape2) {} |
|
4169 | + |
|
4170 | + /** |
|
4171 | + * Returns a shape object representing the convex hull of shape. |
|
4172 | + * Only available if php/mapscript is built with GEOS |
|
4173 | + * library. |
|
4174 | + * |
|
4175 | + * @return shapeObj |
|
4176 | + */ |
|
4177 | + final public function convexhull() {} |
|
4178 | + |
|
4179 | + /** |
|
4180 | + * Returns MS_TRUE if the point is inside the shape, MS_FALSE otherwise. |
|
4181 | + * |
|
4182 | + * @param pointObj $point |
|
4183 | + * @return bool |
|
4184 | + */ |
|
4185 | + final public function contains(pointObj $point) {} |
|
4186 | + |
|
4187 | + /** |
|
4188 | + * Returns true if the shape passed as argument crosses the shape. |
|
4189 | + * Else return false. |
|
4190 | + * Only available if php/mapscript is built with GEOS library. |
|
4191 | + * |
|
4192 | + * @param shapeObj $shape |
|
4193 | + * @return int |
|
4194 | + */ |
|
4195 | + final public function crosses(shapeObj $shape) {} |
|
4196 | + |
|
4197 | + /** |
|
4198 | + * Returns a shape object representing the difference of the |
|
4199 | + * shape object with the one passed as parameter. |
|
4200 | + * Only available if php/mapscript is built with GEOS library. |
|
4201 | + * |
|
4202 | + * @param shapeObj $shape |
|
4203 | + * @return shapeObj |
|
4204 | + */ |
|
4205 | + final public function difference(shapeObj $shape) {} |
|
4206 | + |
|
4207 | + /** |
|
4208 | + * Returns true if the shape passed as argument is disjoint to the |
|
4209 | + * shape. Else return false. |
|
4210 | + * Only available if php/mapscript is built with GEOS library. |
|
4211 | + * |
|
4212 | + * @param shapeObj $shape |
|
4213 | + * @return int |
|
4214 | + */ |
|
4215 | + final public function disjoint(shapeObj $shape) {} |
|
4216 | + |
|
4217 | + /** |
|
4218 | + * Draws the individual shape using layer. |
|
4219 | + * Returns MS_SUCCESS/MS_FAILURE. |
|
4220 | + * |
|
4221 | + * @param mapObj $map |
|
4222 | + * @param layerObj $layer |
|
4223 | + * @param imageObj $img |
|
4224 | + * @return int |
|
4225 | + */ |
|
4226 | + final public function draw(mapObj $map, layerObj $layer, imageObj $img) {} |
|
4227 | + |
|
4228 | + /** |
|
4229 | + * Returns true if the shape passed as argument is equal to the |
|
4230 | + * shape (geometry only). Else return false. |
|
4231 | + * Only available if php/mapscript is built with GEOS library. |
|
4232 | + * |
|
4233 | + * @param shapeObj $shape |
|
4234 | + * @return int |
|
4235 | + */ |
|
4236 | + final public function equals(shapeObj $shape) {} |
|
4237 | + |
|
4238 | + /** |
|
4239 | + * Free the object properties and break the internal references. |
|
4240 | + * Note that you have to unset the php variable to free totally the resources. |
|
4241 | + * |
|
4242 | + * @return void |
|
4243 | + */ |
|
4244 | + final public function free() {} |
|
4245 | + |
|
4246 | + /** |
|
4247 | + * Returns the area of the shape (if applicable). |
|
4248 | + * Only available if php/mapscript is built with GEOS library. |
|
4249 | + * |
|
4250 | + * @return float |
|
4251 | + */ |
|
4252 | + final public function getArea() {} |
|
4253 | + |
|
4254 | + /** |
|
4255 | + * Returns a point object representing the centroid of the shape. |
|
4256 | + * Only available if php/mapscript is built with GEOS library. |
|
4257 | + * |
|
4258 | + * @return pointObj |
|
4259 | + */ |
|
4260 | + final public function getCentroid() {} |
|
4261 | + |
|
4262 | + /** |
|
4263 | + * Returns a point object with coordinates suitable for labelling |
|
4264 | + * the shape. |
|
4265 | + * |
|
4266 | + * @return pointObj |
|
4267 | + */ |
|
4268 | + final public function getLabelPoint() {} |
|
4269 | + |
|
4270 | + /** |
|
4271 | + * Returns the length (or perimeter) of the shape. |
|
4272 | + * Only available if php/mapscript is built with GEOS library. |
|
4273 | + * pointObj getMeasureUsingPoint(pointObj point) |
|
4274 | + * Apply only on Measured shape files. Given an XY Location, find the |
|
4275 | + * nearest point on the shape object. Return a point object |
|
4276 | + * of this point with the m value set. |
|
4277 | + * |
|
4278 | + * @return float |
|
4279 | + */ |
|
4280 | + final public function getLength() {} |
|
4281 | + |
|
4282 | + /** |
|
4283 | + * Apply only on Measured shape files. Given a measure m, retun the |
|
4284 | + * corresponding XY location on the shapeobject. |
|
4285 | + * |
|
4286 | + * @param float $m |
|
4287 | + * @return pointObj |
|
4288 | + */ |
|
4289 | + final public function getPointUsingMeasure($m) {} |
|
4290 | + |
|
4291 | + /** |
|
4292 | + * Returns the value for a given field name. |
|
4293 | + * |
|
4294 | + * @param layerObj $layer |
|
4295 | + * @param string $filedname |
|
4296 | + * @return string |
|
4297 | + */ |
|
4298 | + final public function getValue(layerObj $layer, $filedname) {} |
|
4299 | + |
|
4300 | + /** |
|
4301 | + * Returns a shape object representing the intersection of the shape |
|
4302 | + * object with the one passed as parameter. |
|
4303 | + * Only available if php/mapscript is built with GEOS library. |
|
4304 | + * |
|
4305 | + * @param shapeObj $shape |
|
4306 | + * @return shapeObj |
|
4307 | + */ |
|
4308 | + final public function intersection(shapeObj $shape) {} |
|
4309 | + |
|
4310 | + /** |
|
4311 | + * Returns MS_TRUE if the two shapes intersect, MS_FALSE otherwise. |
|
4312 | + * |
|
4313 | + * @param shapeObj $shape |
|
4314 | + * @return bool |
|
4315 | + */ |
|
4316 | + final public function intersects(shapeObj $shape) {} |
|
4317 | + |
|
4318 | + /** |
|
4319 | + * Returns a reference to line number i. |
|
4320 | + * |
|
4321 | + * @param int $i |
|
4322 | + * @return lineObj |
|
4323 | + */ |
|
4324 | + final public function line($i) {} |
|
4325 | + |
|
4326 | + /** |
|
4327 | + * Returns true if the shape passed as argument overlaps the shape. |
|
4328 | + * Else returns false. |
|
4329 | + * Only available if php/mapscript is built with GEOS library. |
|
4330 | + * |
|
4331 | + * @param shapeObj $shape |
|
4332 | + * @return int |
|
4333 | + */ |
|
4334 | + final public function overlaps(shapeObj $shape) {} |
|
4335 | + |
|
4336 | + /** |
|
4337 | + * Project the shape from "in" projection (1st argument) to "out" |
|
4338 | + * projection (2nd argument). Returns MS_SUCCESS/MS_FAILURE. |
|
4339 | + * |
|
4340 | + * @param projectionObj $in |
|
4341 | + * @param projectionObj $out |
|
4342 | + * @return int |
|
4343 | + */ |
|
4344 | + final public function project(projectionObj $in, projectionObj $out) {} |
|
4345 | + |
|
4346 | + /** |
|
4347 | + * Set object property to a new value. |
|
4348 | + * |
|
4349 | + * @param string $property_name |
|
4350 | + * @param $new_value |
|
4351 | + * @return int |
|
4352 | + */ |
|
4353 | + final public function set($property_name, $new_value) {} |
|
4354 | + |
|
4355 | + /** |
|
4356 | + * Updates the bounds property of the shape. |
|
4357 | + * Must be called to calculate new bounding box after new parts have been |
|
4358 | + * added. |
|
4359 | + * |
|
4360 | + * @return int |
|
4361 | + */ |
|
4362 | + final public function setBounds() {} |
|
4363 | + |
|
4364 | + /** |
|
4365 | + * Given a tolerance, returns a simplified shape object or NULL on |
|
4366 | + * error. Only available if php/mapscript is built with GEOS library |
|
4367 | + * (>=3.0). |
|
4368 | + * |
|
4369 | + * @param float $tolerance |
|
4370 | + * @return shapeObj|null |
|
4371 | + */ |
|
4372 | + final public function simplify($tolerance) {} |
|
4373 | + |
|
4374 | + /** |
|
4375 | + * Returns the computed symmetric difference of the supplied and |
|
4376 | + * existing shape. |
|
4377 | + * Only available if php/mapscript is built with GEOS library. |
|
4378 | + * |
|
4379 | + * @param shapeObj $shape |
|
4380 | + * @return shapeObj |
|
4381 | + */ |
|
4382 | + final public function symdifference(shapeObj $shape) {} |
|
4383 | + |
|
4384 | + /** |
|
4385 | + * Given a tolerance, returns a simplified shape object or NULL on |
|
4386 | + * error. Only available if php/mapscript is built with GEOS library |
|
4387 | + * (>=3.0). |
|
4388 | + * |
|
4389 | + * @param float $tolerance |
|
4390 | + * @return shapeObj|null |
|
4391 | + */ |
|
4392 | + final public function topologyPreservingSimplify($tolerance) {} |
|
4393 | + |
|
4394 | + /** |
|
4395 | + * Returns true if the shape passed as argument touches the shape. |
|
4396 | + * Else return false. |
|
4397 | + * Only available if php/mapscript is built with GEOS library. |
|
4398 | + * |
|
4399 | + * @param shapeObj $shape |
|
4400 | + * @return int |
|
4401 | + */ |
|
4402 | + final public function touches(shapeObj $shape) {} |
|
4403 | + |
|
4404 | + /** |
|
4405 | + * Returns WKT representation of the shape's geometry. |
|
4406 | + * |
|
4407 | + * @return string |
|
4408 | + */ |
|
4409 | + final public function toWkt() {} |
|
4410 | + |
|
4411 | + /** |
|
4412 | + * Returns a shape object representing the union of the shape object |
|
4413 | + * with the one passed as parameter. |
|
4414 | + * Only available if php/mapscript is built with GEOS |
|
4415 | + * library |
|
4416 | + * |
|
4417 | + * @param shapeObj $shape |
|
4418 | + * @return shapeObj |
|
4419 | + */ |
|
4420 | + final public function union(shapeObj $shape) {} |
|
4421 | + |
|
4422 | + /** |
|
4423 | + * Returns true if the shape is entirely within the shape2 passed as |
|
4424 | + * argument. |
|
4425 | + * Else returns false. |
|
4426 | + * Only available if php/mapscript is built with GEOS library. |
|
4427 | + * |
|
4428 | + * @param shapeObj $shape2 |
|
4429 | + * @return int |
|
4430 | + */ |
|
4431 | + final public function within(shapeObj $shape2) {} |
|
4432 | 4432 | } |
4433 | 4433 | |
4434 | 4434 | /** |
@@ -4436,375 +4436,375 @@ discard block |
||
4436 | 4436 | */ |
4437 | 4437 | final class styleObj |
4438 | 4438 | { |
4439 | - /** |
|
4440 | - * @var float |
|
4441 | - */ |
|
4442 | - public $angle; |
|
4443 | - |
|
4444 | - /** |
|
4445 | - * @var int |
|
4446 | - */ |
|
4447 | - public $antialias; |
|
4448 | - |
|
4449 | - /** |
|
4450 | - * @var colorObj |
|
4451 | - */ |
|
4452 | - public $backgroundcolor; |
|
4453 | - |
|
4454 | - /** |
|
4455 | - * @var colorObj |
|
4456 | - */ |
|
4457 | - public $color; |
|
4458 | - |
|
4459 | - /** |
|
4460 | - * @var float |
|
4461 | - */ |
|
4462 | - public $maxsize; |
|
4463 | - |
|
4464 | - /** |
|
4465 | - * @var float |
|
4466 | - */ |
|
4467 | - public $maxvalue; |
|
4468 | - |
|
4469 | - /** |
|
4470 | - * @var float |
|
4471 | - */ |
|
4472 | - public $maxwidth; |
|
4473 | - |
|
4474 | - /** |
|
4475 | - * @var float |
|
4476 | - */ |
|
4477 | - public $minsize; |
|
4478 | - |
|
4479 | - /** |
|
4480 | - * @var float |
|
4481 | - */ |
|
4482 | - public $minvalue; |
|
4483 | - |
|
4484 | - /** |
|
4485 | - * @var float |
|
4486 | - */ |
|
4487 | - public $minwidth; |
|
4488 | - |
|
4489 | - /** |
|
4490 | - * @var int |
|
4491 | - */ |
|
4492 | - public $offsetx; |
|
4493 | - |
|
4494 | - /** |
|
4495 | - * @var int |
|
4496 | - */ |
|
4497 | - public $offsety; |
|
4498 | - |
|
4499 | - /** |
|
4500 | - * only supported for the AGG driver |
|
4501 | - * |
|
4502 | - * @var int |
|
4503 | - */ |
|
4504 | - public $opacity; |
|
4505 | - |
|
4506 | - /** |
|
4507 | - * @var colorObj |
|
4508 | - */ |
|
4509 | - public $outlinecolor; |
|
4510 | - |
|
4511 | - /** |
|
4512 | - * @var string |
|
4513 | - */ |
|
4514 | - public $rangeitem; |
|
4515 | - |
|
4516 | - /** |
|
4517 | - * @var float |
|
4518 | - */ |
|
4519 | - public $size; |
|
4520 | - |
|
4521 | - /** |
|
4522 | - * @var int |
|
4523 | - */ |
|
4524 | - public $symbol; |
|
4525 | - |
|
4526 | - /** |
|
4527 | - * @var string |
|
4528 | - */ |
|
4529 | - public $symbolname; |
|
4530 | - |
|
4531 | - /** |
|
4532 | - * @var float |
|
4533 | - */ |
|
4534 | - public $width; |
|
4535 | - |
|
4536 | - /** |
|
4537 | - * The second argument 'style' is optional. If given, the new style |
|
4538 | - * created will be a copy of the style passed as argument. |
|
4539 | - * |
|
4540 | - * @param labelObj $label |
|
4541 | - * @param styleObj $style |
|
4542 | - */ |
|
4543 | - final public function __construct(labelObj $label, styleObj $style) {} |
|
4544 | - |
|
4545 | - /** |
|
4546 | - * Old style constructor |
|
4547 | - * |
|
4548 | - * @param classObj $class |
|
4549 | - * @param styleObj $style |
|
4550 | - * @return styleObj |
|
4551 | - */ |
|
4552 | - final public function ms_newStyleObj(classObj $class, styleObj $style) {} |
|
4553 | - |
|
4554 | - /** |
|
4555 | - * Saves the object to a string. Provides the inverse option for |
|
4556 | - * updateFromString. |
|
4557 | - * |
|
4558 | - * @return string |
|
4559 | - */ |
|
4560 | - final public function convertToString() {} |
|
4561 | - |
|
4562 | - /** |
|
4563 | - * Free the object properties and break the internal references. |
|
4564 | - * Note that you have to unset the php variable to free totally the |
|
4565 | - * resources. |
|
4566 | - * |
|
4567 | - * @return void |
|
4568 | - */ |
|
4569 | - final public function free() {} |
|
4570 | - |
|
4571 | - /** |
|
4572 | - * Get the attribute binding for a specfiled style property. Returns |
|
4573 | - * NULL if there is no binding for this property. |
|
4574 | - * .. code-block:: php |
|
4575 | - * $oStyle->setbinding(MS_STYLE_BINDING_COLOR, "FIELD_NAME_COLOR"); |
|
4576 | - * echo $oStyle->getbinding(MS_STYLE_BINDING_COLOR); // FIELD_NAME_COLOR |
|
4577 | - * |
|
4578 | - * @param mixed $stylebinding |
|
4579 | - * @return string |
|
4580 | - */ |
|
4581 | - final public function getBinding($stylebinding) {} |
|
4582 | - |
|
4583 | - /** |
|
4584 | - * @return string |
|
4585 | - */ |
|
4586 | - final public function getGeomTransform() {} |
|
4587 | - |
|
4588 | - /** |
|
4589 | - * Remove the attribute binding for a specfiled style property. |
|
4590 | - * Added in MapServer 5.0. |
|
4591 | - * .. code-block:: php |
|
4592 | - * $oStyle->removebinding(MS_STYLE_BINDING_COLOR); |
|
4593 | - * |
|
4594 | - * @param mixed $stylebinding |
|
4595 | - * @return int |
|
4596 | - */ |
|
4597 | - final public function removeBinding($stylebinding) {} |
|
4598 | - |
|
4599 | - /** |
|
4600 | - * Set object property to a new value. |
|
4601 | - * |
|
4602 | - * @param string $property_name |
|
4603 | - * @param $new_value |
|
4604 | - * @return int |
|
4605 | - */ |
|
4606 | - final public function set($property_name, $new_value) {} |
|
4607 | - |
|
4608 | - /** |
|
4609 | - * Set the attribute binding for a specfiled style property. |
|
4610 | - * Added in MapServer 5.0. |
|
4611 | - * .. code-block:: php |
|
4612 | - * $oStyle->setbinding(MS_STYLE_BINDING_COLOR, "FIELD_NAME_COLOR"); |
|
4613 | - * This would bind the color parameter with the data (ie will extract |
|
4614 | - * the value of the color from the field called "FIELD_NAME_COLOR" |
|
4615 | - * |
|
4616 | - * @param mixed $stylebinding |
|
4617 | - * @param string $value |
|
4618 | - * @return int |
|
4619 | - */ |
|
4620 | - final public function setBinding($stylebinding, $value) {} |
|
4621 | - |
|
4622 | - /** |
|
4623 | - * @param string $value |
|
4624 | - * @return int |
|
4625 | - */ |
|
4626 | - final public function setGeomTransform($value) {} |
|
4627 | - |
|
4628 | - /** |
|
4629 | - * Update a style from a string snippet. Returns MS_SUCCESS/MS_FAILURE. |
|
4630 | - * |
|
4631 | - * @param string $snippet |
|
4632 | - * @return int |
|
4633 | - */ |
|
4634 | - final public function updateFromString($snippet) {} |
|
4439 | + /** |
|
4440 | + * @var float |
|
4441 | + */ |
|
4442 | + public $angle; |
|
4443 | + |
|
4444 | + /** |
|
4445 | + * @var int |
|
4446 | + */ |
|
4447 | + public $antialias; |
|
4448 | + |
|
4449 | + /** |
|
4450 | + * @var colorObj |
|
4451 | + */ |
|
4452 | + public $backgroundcolor; |
|
4453 | + |
|
4454 | + /** |
|
4455 | + * @var colorObj |
|
4456 | + */ |
|
4457 | + public $color; |
|
4458 | + |
|
4459 | + /** |
|
4460 | + * @var float |
|
4461 | + */ |
|
4462 | + public $maxsize; |
|
4463 | + |
|
4464 | + /** |
|
4465 | + * @var float |
|
4466 | + */ |
|
4467 | + public $maxvalue; |
|
4468 | + |
|
4469 | + /** |
|
4470 | + * @var float |
|
4471 | + */ |
|
4472 | + public $maxwidth; |
|
4473 | + |
|
4474 | + /** |
|
4475 | + * @var float |
|
4476 | + */ |
|
4477 | + public $minsize; |
|
4478 | + |
|
4479 | + /** |
|
4480 | + * @var float |
|
4481 | + */ |
|
4482 | + public $minvalue; |
|
4483 | + |
|
4484 | + /** |
|
4485 | + * @var float |
|
4486 | + */ |
|
4487 | + public $minwidth; |
|
4488 | + |
|
4489 | + /** |
|
4490 | + * @var int |
|
4491 | + */ |
|
4492 | + public $offsetx; |
|
4493 | + |
|
4494 | + /** |
|
4495 | + * @var int |
|
4496 | + */ |
|
4497 | + public $offsety; |
|
4498 | + |
|
4499 | + /** |
|
4500 | + * only supported for the AGG driver |
|
4501 | + * |
|
4502 | + * @var int |
|
4503 | + */ |
|
4504 | + public $opacity; |
|
4505 | + |
|
4506 | + /** |
|
4507 | + * @var colorObj |
|
4508 | + */ |
|
4509 | + public $outlinecolor; |
|
4510 | + |
|
4511 | + /** |
|
4512 | + * @var string |
|
4513 | + */ |
|
4514 | + public $rangeitem; |
|
4515 | + |
|
4516 | + /** |
|
4517 | + * @var float |
|
4518 | + */ |
|
4519 | + public $size; |
|
4520 | + |
|
4521 | + /** |
|
4522 | + * @var int |
|
4523 | + */ |
|
4524 | + public $symbol; |
|
4525 | + |
|
4526 | + /** |
|
4527 | + * @var string |
|
4528 | + */ |
|
4529 | + public $symbolname; |
|
4530 | + |
|
4531 | + /** |
|
4532 | + * @var float |
|
4533 | + */ |
|
4534 | + public $width; |
|
4535 | + |
|
4536 | + /** |
|
4537 | + * The second argument 'style' is optional. If given, the new style |
|
4538 | + * created will be a copy of the style passed as argument. |
|
4539 | + * |
|
4540 | + * @param labelObj $label |
|
4541 | + * @param styleObj $style |
|
4542 | + */ |
|
4543 | + final public function __construct(labelObj $label, styleObj $style) {} |
|
4544 | + |
|
4545 | + /** |
|
4546 | + * Old style constructor |
|
4547 | + * |
|
4548 | + * @param classObj $class |
|
4549 | + * @param styleObj $style |
|
4550 | + * @return styleObj |
|
4551 | + */ |
|
4552 | + final public function ms_newStyleObj(classObj $class, styleObj $style) {} |
|
4553 | + |
|
4554 | + /** |
|
4555 | + * Saves the object to a string. Provides the inverse option for |
|
4556 | + * updateFromString. |
|
4557 | + * |
|
4558 | + * @return string |
|
4559 | + */ |
|
4560 | + final public function convertToString() {} |
|
4561 | + |
|
4562 | + /** |
|
4563 | + * Free the object properties and break the internal references. |
|
4564 | + * Note that you have to unset the php variable to free totally the |
|
4565 | + * resources. |
|
4566 | + * |
|
4567 | + * @return void |
|
4568 | + */ |
|
4569 | + final public function free() {} |
|
4570 | + |
|
4571 | + /** |
|
4572 | + * Get the attribute binding for a specfiled style property. Returns |
|
4573 | + * NULL if there is no binding for this property. |
|
4574 | + * .. code-block:: php |
|
4575 | + * $oStyle->setbinding(MS_STYLE_BINDING_COLOR, "FIELD_NAME_COLOR"); |
|
4576 | + * echo $oStyle->getbinding(MS_STYLE_BINDING_COLOR); // FIELD_NAME_COLOR |
|
4577 | + * |
|
4578 | + * @param mixed $stylebinding |
|
4579 | + * @return string |
|
4580 | + */ |
|
4581 | + final public function getBinding($stylebinding) {} |
|
4582 | + |
|
4583 | + /** |
|
4584 | + * @return string |
|
4585 | + */ |
|
4586 | + final public function getGeomTransform() {} |
|
4587 | + |
|
4588 | + /** |
|
4589 | + * Remove the attribute binding for a specfiled style property. |
|
4590 | + * Added in MapServer 5.0. |
|
4591 | + * .. code-block:: php |
|
4592 | + * $oStyle->removebinding(MS_STYLE_BINDING_COLOR); |
|
4593 | + * |
|
4594 | + * @param mixed $stylebinding |
|
4595 | + * @return int |
|
4596 | + */ |
|
4597 | + final public function removeBinding($stylebinding) {} |
|
4598 | + |
|
4599 | + /** |
|
4600 | + * Set object property to a new value. |
|
4601 | + * |
|
4602 | + * @param string $property_name |
|
4603 | + * @param $new_value |
|
4604 | + * @return int |
|
4605 | + */ |
|
4606 | + final public function set($property_name, $new_value) {} |
|
4607 | + |
|
4608 | + /** |
|
4609 | + * Set the attribute binding for a specfiled style property. |
|
4610 | + * Added in MapServer 5.0. |
|
4611 | + * .. code-block:: php |
|
4612 | + * $oStyle->setbinding(MS_STYLE_BINDING_COLOR, "FIELD_NAME_COLOR"); |
|
4613 | + * This would bind the color parameter with the data (ie will extract |
|
4614 | + * the value of the color from the field called "FIELD_NAME_COLOR" |
|
4615 | + * |
|
4616 | + * @param mixed $stylebinding |
|
4617 | + * @param string $value |
|
4618 | + * @return int |
|
4619 | + */ |
|
4620 | + final public function setBinding($stylebinding, $value) {} |
|
4621 | + |
|
4622 | + /** |
|
4623 | + * @param string $value |
|
4624 | + * @return int |
|
4625 | + */ |
|
4626 | + final public function setGeomTransform($value) {} |
|
4627 | + |
|
4628 | + /** |
|
4629 | + * Update a style from a string snippet. Returns MS_SUCCESS/MS_FAILURE. |
|
4630 | + * |
|
4631 | + * @param string $snippet |
|
4632 | + * @return int |
|
4633 | + */ |
|
4634 | + final public function updateFromString($snippet) {} |
|
4635 | 4635 | } |
4636 | 4636 | |
4637 | 4637 | final class symbolObj |
4638 | 4638 | { |
4639 | - /** |
|
4640 | - * @var int |
|
4641 | - */ |
|
4642 | - public $antialias; |
|
4643 | - |
|
4644 | - /** |
|
4645 | - * @var string |
|
4646 | - */ |
|
4647 | - public $character; |
|
4648 | - |
|
4649 | - /** |
|
4650 | - * @var int |
|
4651 | - */ |
|
4652 | - public $filled; |
|
4653 | - |
|
4654 | - /** |
|
4655 | - * @var string |
|
4656 | - */ |
|
4657 | - public $font; |
|
4658 | - |
|
4659 | - /** |
|
4660 | - * read-only |
|
4661 | - * |
|
4662 | - * @var string |
|
4663 | - */ |
|
4664 | - public $imagepath; |
|
4665 | - |
|
4666 | - /** |
|
4667 | - * If set to TRUE, the symbol will be saved |
|
4668 | - * inside the mapfile. |
|
4669 | - * |
|
4670 | - * @var int |
|
4671 | - */ |
|
4672 | - public $inmapfile; |
|
4673 | - |
|
4674 | - /** |
|
4675 | - * read-only |
|
4676 | - * |
|
4677 | - * @var int |
|
4678 | - */ |
|
4679 | - public $patternlength; |
|
4680 | - |
|
4681 | - /** |
|
4682 | - * @var int |
|
4683 | - */ |
|
4684 | - public $position; |
|
4685 | - |
|
4686 | - /** |
|
4687 | - * @var string |
|
4688 | - */ |
|
4689 | - public $name; |
|
4690 | - |
|
4691 | - /** |
|
4692 | - * read-only |
|
4693 | - * |
|
4694 | - * @var int |
|
4695 | - */ |
|
4696 | - public $numpoints; |
|
4697 | - |
|
4698 | - /** |
|
4699 | - * @var float |
|
4700 | - */ |
|
4701 | - public $sizex; |
|
4702 | - |
|
4703 | - /** |
|
4704 | - * @var float |
|
4705 | - */ |
|
4706 | - public $sizey; |
|
4707 | - |
|
4708 | - /** |
|
4709 | - * @var int |
|
4710 | - */ |
|
4711 | - public $transparent; |
|
4712 | - |
|
4713 | - /** |
|
4714 | - * @var int |
|
4715 | - */ |
|
4716 | - public $transparentcolor; |
|
4717 | - |
|
4718 | - /** |
|
4719 | - * Creates a new symbol with default values in the symbolist. |
|
4720 | - * .. note:: |
|
4721 | - * Using the new constructor, the symbol is automatically returned. The |
|
4722 | - * If a symbol with the same name exists, it (or its id) will be returned. |
|
4723 | - * $nId = ms_newSymbolObj($map, "symbol-test"); |
|
4724 | - * $oSymbol = $map->getSymbolObjectById($nId); |
|
4725 | - * |
|
4726 | - * @param mapObj $map |
|
4727 | - * @param string $symbolname |
|
4728 | - */ |
|
4729 | - final public function __construct(mapObj $map, $symbolname) {} |
|
4730 | - |
|
4731 | - /** |
|
4732 | - * Old style constructor |
|
4733 | - * |
|
4734 | - * @param mapObj $map |
|
4735 | - * @param string $symbolname |
|
4736 | - * @return int |
|
4737 | - */ |
|
4738 | - final public function ms_newSymbolObj(mapObj $map, $symbolname) {} |
|
4739 | - |
|
4740 | - /** |
|
4741 | - * Free the object properties and break the internal references. |
|
4742 | - * Note that you have to unset the php variable to free totally the |
|
4743 | - * resources. |
|
4744 | - * |
|
4745 | - * @return void |
|
4746 | - */ |
|
4747 | - final public function free() {} |
|
4748 | - |
|
4749 | - /** |
|
4750 | - * Returns an array containing the pattern. If there is no pattern, it |
|
4751 | - * returns an empty array. |
|
4752 | - * |
|
4753 | - * @return array |
|
4754 | - */ |
|
4755 | - final public function getPatternArray() {} |
|
4756 | - |
|
4757 | - /** |
|
4758 | - * Returns an array containing the points of the symbol. Refer to |
|
4759 | - * setpoints to see how the array should be interpreted. If there are no |
|
4760 | - * points, it returns an empty array. |
|
4761 | - * |
|
4762 | - * @return array |
|
4763 | - */ |
|
4764 | - final public function getPointsArray() {} |
|
4765 | - |
|
4766 | - /** |
|
4767 | - * Set object property to a new value. |
|
4768 | - * |
|
4769 | - * @param string $property_name |
|
4770 | - * @param $new_value |
|
4771 | - * @return int |
|
4772 | - */ |
|
4773 | - final public function set($property_name, $new_value) {} |
|
4774 | - |
|
4775 | - /** |
|
4776 | - * Loads a pixmap symbol specified by the filename. |
|
4777 | - * The file should be of either Gif or Png format. |
|
4778 | - * |
|
4779 | - * @param string $filename |
|
4780 | - * @return int |
|
4781 | - */ |
|
4782 | - final public function setImagePath($filename) {} |
|
4783 | - |
|
4784 | - /** |
|
4785 | - * Set the pattern of the symbol (used for dash patterns). |
|
4786 | - * Returns MS_SUCCESS/MS_FAILURE. |
|
4787 | - * |
|
4788 | - * @param array $int |
|
4789 | - * @return int |
|
4790 | - */ |
|
4791 | - final public function setPattern(array $int) {} |
|
4792 | - |
|
4793 | - /** |
|
4794 | - * Set the points of the symbol. Note that the values passed is an |
|
4795 | - * array containing the x and y values of the points. Returns |
|
4796 | - * MS_SUCCESS/MS_FAILURE. |
|
4797 | - * Example: |
|
4798 | - * .. code-block:: php |
|
4799 | - * $array[0] = 1 # x value of the first point |
|
4800 | - * $array[1] = 0 # y values of the first point |
|
4801 | - * $array[2] = 1 # x value of the 2nd point |
|
4802 | - * .... |
|
4803 | - * |
|
4804 | - * @param array $double |
|
4805 | - * @return int |
|
4806 | - */ |
|
4807 | - final public function setPoints(array $double) {} |
|
4639 | + /** |
|
4640 | + * @var int |
|
4641 | + */ |
|
4642 | + public $antialias; |
|
4643 | + |
|
4644 | + /** |
|
4645 | + * @var string |
|
4646 | + */ |
|
4647 | + public $character; |
|
4648 | + |
|
4649 | + /** |
|
4650 | + * @var int |
|
4651 | + */ |
|
4652 | + public $filled; |
|
4653 | + |
|
4654 | + /** |
|
4655 | + * @var string |
|
4656 | + */ |
|
4657 | + public $font; |
|
4658 | + |
|
4659 | + /** |
|
4660 | + * read-only |
|
4661 | + * |
|
4662 | + * @var string |
|
4663 | + */ |
|
4664 | + public $imagepath; |
|
4665 | + |
|
4666 | + /** |
|
4667 | + * If set to TRUE, the symbol will be saved |
|
4668 | + * inside the mapfile. |
|
4669 | + * |
|
4670 | + * @var int |
|
4671 | + */ |
|
4672 | + public $inmapfile; |
|
4673 | + |
|
4674 | + /** |
|
4675 | + * read-only |
|
4676 | + * |
|
4677 | + * @var int |
|
4678 | + */ |
|
4679 | + public $patternlength; |
|
4680 | + |
|
4681 | + /** |
|
4682 | + * @var int |
|
4683 | + */ |
|
4684 | + public $position; |
|
4685 | + |
|
4686 | + /** |
|
4687 | + * @var string |
|
4688 | + */ |
|
4689 | + public $name; |
|
4690 | + |
|
4691 | + /** |
|
4692 | + * read-only |
|
4693 | + * |
|
4694 | + * @var int |
|
4695 | + */ |
|
4696 | + public $numpoints; |
|
4697 | + |
|
4698 | + /** |
|
4699 | + * @var float |
|
4700 | + */ |
|
4701 | + public $sizex; |
|
4702 | + |
|
4703 | + /** |
|
4704 | + * @var float |
|
4705 | + */ |
|
4706 | + public $sizey; |
|
4707 | + |
|
4708 | + /** |
|
4709 | + * @var int |
|
4710 | + */ |
|
4711 | + public $transparent; |
|
4712 | + |
|
4713 | + /** |
|
4714 | + * @var int |
|
4715 | + */ |
|
4716 | + public $transparentcolor; |
|
4717 | + |
|
4718 | + /** |
|
4719 | + * Creates a new symbol with default values in the symbolist. |
|
4720 | + * .. note:: |
|
4721 | + * Using the new constructor, the symbol is automatically returned. The |
|
4722 | + * If a symbol with the same name exists, it (or its id) will be returned. |
|
4723 | + * $nId = ms_newSymbolObj($map, "symbol-test"); |
|
4724 | + * $oSymbol = $map->getSymbolObjectById($nId); |
|
4725 | + * |
|
4726 | + * @param mapObj $map |
|
4727 | + * @param string $symbolname |
|
4728 | + */ |
|
4729 | + final public function __construct(mapObj $map, $symbolname) {} |
|
4730 | + |
|
4731 | + /** |
|
4732 | + * Old style constructor |
|
4733 | + * |
|
4734 | + * @param mapObj $map |
|
4735 | + * @param string $symbolname |
|
4736 | + * @return int |
|
4737 | + */ |
|
4738 | + final public function ms_newSymbolObj(mapObj $map, $symbolname) {} |
|
4739 | + |
|
4740 | + /** |
|
4741 | + * Free the object properties and break the internal references. |
|
4742 | + * Note that you have to unset the php variable to free totally the |
|
4743 | + * resources. |
|
4744 | + * |
|
4745 | + * @return void |
|
4746 | + */ |
|
4747 | + final public function free() {} |
|
4748 | + |
|
4749 | + /** |
|
4750 | + * Returns an array containing the pattern. If there is no pattern, it |
|
4751 | + * returns an empty array. |
|
4752 | + * |
|
4753 | + * @return array |
|
4754 | + */ |
|
4755 | + final public function getPatternArray() {} |
|
4756 | + |
|
4757 | + /** |
|
4758 | + * Returns an array containing the points of the symbol. Refer to |
|
4759 | + * setpoints to see how the array should be interpreted. If there are no |
|
4760 | + * points, it returns an empty array. |
|
4761 | + * |
|
4762 | + * @return array |
|
4763 | + */ |
|
4764 | + final public function getPointsArray() {} |
|
4765 | + |
|
4766 | + /** |
|
4767 | + * Set object property to a new value. |
|
4768 | + * |
|
4769 | + * @param string $property_name |
|
4770 | + * @param $new_value |
|
4771 | + * @return int |
|
4772 | + */ |
|
4773 | + final public function set($property_name, $new_value) {} |
|
4774 | + |
|
4775 | + /** |
|
4776 | + * Loads a pixmap symbol specified by the filename. |
|
4777 | + * The file should be of either Gif or Png format. |
|
4778 | + * |
|
4779 | + * @param string $filename |
|
4780 | + * @return int |
|
4781 | + */ |
|
4782 | + final public function setImagePath($filename) {} |
|
4783 | + |
|
4784 | + /** |
|
4785 | + * Set the pattern of the symbol (used for dash patterns). |
|
4786 | + * Returns MS_SUCCESS/MS_FAILURE. |
|
4787 | + * |
|
4788 | + * @param array $int |
|
4789 | + * @return int |
|
4790 | + */ |
|
4791 | + final public function setPattern(array $int) {} |
|
4792 | + |
|
4793 | + /** |
|
4794 | + * Set the points of the symbol. Note that the values passed is an |
|
4795 | + * array containing the x and y values of the points. Returns |
|
4796 | + * MS_SUCCESS/MS_FAILURE. |
|
4797 | + * Example: |
|
4798 | + * .. code-block:: php |
|
4799 | + * $array[0] = 1 # x value of the first point |
|
4800 | + * $array[1] = 0 # y values of the first point |
|
4801 | + * $array[2] = 1 # x value of the 2nd point |
|
4802 | + * .... |
|
4803 | + * |
|
4804 | + * @param array $double |
|
4805 | + * @return int |
|
4806 | + */ |
|
4807 | + final public function setPoints(array $double) {} |
|
4808 | 4808 | } |
4809 | 4809 | |
4810 | 4810 | /** |
@@ -4812,134 +4812,134 @@ discard block |
||
4812 | 4812 | */ |
4813 | 4813 | final class webObj |
4814 | 4814 | { |
4815 | - /** |
|
4816 | - * @var string |
|
4817 | - */ |
|
4818 | - public $browseformat; |
|
4819 | - |
|
4820 | - /** |
|
4821 | - * read-only |
|
4822 | - * |
|
4823 | - * @var string |
|
4824 | - */ |
|
4825 | - public $empty; |
|
4826 | - |
|
4827 | - /** |
|
4828 | - * read-only |
|
4829 | - * |
|
4830 | - * @var string |
|
4831 | - */ |
|
4832 | - public $error; |
|
4833 | - |
|
4834 | - /** |
|
4835 | - * read-only |
|
4836 | - * |
|
4837 | - * @var rectObj |
|
4838 | - */ |
|
4839 | - public $extent; |
|
4840 | - |
|
4841 | - /** |
|
4842 | - * @var string |
|
4843 | - */ |
|
4844 | - public $footer; |
|
4845 | - |
|
4846 | - /** |
|
4847 | - * @var string |
|
4848 | - */ |
|
4849 | - public $header; |
|
4850 | - |
|
4851 | - /** |
|
4852 | - * @var string |
|
4853 | - */ |
|
4854 | - public $imagepath; |
|
4855 | - |
|
4856 | - /** |
|
4857 | - * @var string |
|
4858 | - */ |
|
4859 | - public $imageurl; |
|
4860 | - |
|
4861 | - /** |
|
4862 | - * @var string |
|
4863 | - */ |
|
4864 | - public $legendformat; |
|
4865 | - |
|
4866 | - /** |
|
4867 | - * @var string |
|
4868 | - */ |
|
4869 | - public $log; |
|
4870 | - |
|
4871 | - /** |
|
4872 | - * @var float |
|
4873 | - */ |
|
4874 | - public $maxscaledenom; |
|
4875 | - |
|
4876 | - /** |
|
4877 | - * @var string |
|
4878 | - */ |
|
4879 | - public $maxtemplate; |
|
4880 | - |
|
4881 | - /** |
|
4882 | - * @var hashTableObj |
|
4883 | - */ |
|
4884 | - public $metadata; |
|
4885 | - |
|
4886 | - /** |
|
4887 | - * @var float |
|
4888 | - */ |
|
4889 | - public $minscaledenom; |
|
4890 | - |
|
4891 | - /** |
|
4892 | - * @var string |
|
4893 | - */ |
|
4894 | - public $mintemplate; |
|
4895 | - |
|
4896 | - /** |
|
4897 | - * @var string |
|
4898 | - */ |
|
4899 | - public $queryformat; |
|
4900 | - |
|
4901 | - /** |
|
4902 | - * @var string |
|
4903 | - */ |
|
4904 | - public $template; |
|
4905 | - |
|
4906 | - /** |
|
4907 | - * @var string |
|
4908 | - */ |
|
4909 | - public $temppath; |
|
4910 | - |
|
4911 | - /** |
|
4912 | - * Saves the object to a string. Provides the inverse option for |
|
4913 | - * updateFromString. |
|
4914 | - * |
|
4915 | - * @return string |
|
4916 | - */ |
|
4917 | - final public function convertToString() {} |
|
4918 | - |
|
4919 | - /** |
|
4920 | - * Free the object properties and break the internal references. |
|
4921 | - * Note that you have to unset the php variable to free totally the |
|
4922 | - * resources. |
|
4923 | - * |
|
4924 | - * @return void |
|
4925 | - */ |
|
4926 | - final public function free() {} |
|
4927 | - |
|
4928 | - /** |
|
4929 | - * Set object property to a new value. |
|
4930 | - * |
|
4931 | - * @param string $property_name |
|
4932 | - * @param $new_value |
|
4933 | - * @return int |
|
4934 | - */ |
|
4935 | - final public function set($property_name, $new_value) {} |
|
4936 | - |
|
4937 | - /** |
|
4938 | - * Update a web object from a string snippet. Returns |
|
4939 | - * MS_SUCCESS/MS_FAILURE. |
|
4940 | - * |
|
4941 | - * @param string $snippet |
|
4942 | - * @return int |
|
4943 | - */ |
|
4944 | - final public function updateFromString($snippet) {} |
|
4815 | + /** |
|
4816 | + * @var string |
|
4817 | + */ |
|
4818 | + public $browseformat; |
|
4819 | + |
|
4820 | + /** |
|
4821 | + * read-only |
|
4822 | + * |
|
4823 | + * @var string |
|
4824 | + */ |
|
4825 | + public $empty; |
|
4826 | + |
|
4827 | + /** |
|
4828 | + * read-only |
|
4829 | + * |
|
4830 | + * @var string |
|
4831 | + */ |
|
4832 | + public $error; |
|
4833 | + |
|
4834 | + /** |
|
4835 | + * read-only |
|
4836 | + * |
|
4837 | + * @var rectObj |
|
4838 | + */ |
|
4839 | + public $extent; |
|
4840 | + |
|
4841 | + /** |
|
4842 | + * @var string |
|
4843 | + */ |
|
4844 | + public $footer; |
|
4845 | + |
|
4846 | + /** |
|
4847 | + * @var string |
|
4848 | + */ |
|
4849 | + public $header; |
|
4850 | + |
|
4851 | + /** |
|
4852 | + * @var string |
|
4853 | + */ |
|
4854 | + public $imagepath; |
|
4855 | + |
|
4856 | + /** |
|
4857 | + * @var string |
|
4858 | + */ |
|
4859 | + public $imageurl; |
|
4860 | + |
|
4861 | + /** |
|
4862 | + * @var string |
|
4863 | + */ |
|
4864 | + public $legendformat; |
|
4865 | + |
|
4866 | + /** |
|
4867 | + * @var string |
|
4868 | + */ |
|
4869 | + public $log; |
|
4870 | + |
|
4871 | + /** |
|
4872 | + * @var float |
|
4873 | + */ |
|
4874 | + public $maxscaledenom; |
|
4875 | + |
|
4876 | + /** |
|
4877 | + * @var string |
|
4878 | + */ |
|
4879 | + public $maxtemplate; |
|
4880 | + |
|
4881 | + /** |
|
4882 | + * @var hashTableObj |
|
4883 | + */ |
|
4884 | + public $metadata; |
|
4885 | + |
|
4886 | + /** |
|
4887 | + * @var float |
|
4888 | + */ |
|
4889 | + public $minscaledenom; |
|
4890 | + |
|
4891 | + /** |
|
4892 | + * @var string |
|
4893 | + */ |
|
4894 | + public $mintemplate; |
|
4895 | + |
|
4896 | + /** |
|
4897 | + * @var string |
|
4898 | + */ |
|
4899 | + public $queryformat; |
|
4900 | + |
|
4901 | + /** |
|
4902 | + * @var string |
|
4903 | + */ |
|
4904 | + public $template; |
|
4905 | + |
|
4906 | + /** |
|
4907 | + * @var string |
|
4908 | + */ |
|
4909 | + public $temppath; |
|
4910 | + |
|
4911 | + /** |
|
4912 | + * Saves the object to a string. Provides the inverse option for |
|
4913 | + * updateFromString. |
|
4914 | + * |
|
4915 | + * @return string |
|
4916 | + */ |
|
4917 | + final public function convertToString() {} |
|
4918 | + |
|
4919 | + /** |
|
4920 | + * Free the object properties and break the internal references. |
|
4921 | + * Note that you have to unset the php variable to free totally the |
|
4922 | + * resources. |
|
4923 | + * |
|
4924 | + * @return void |
|
4925 | + */ |
|
4926 | + final public function free() {} |
|
4927 | + |
|
4928 | + /** |
|
4929 | + * Set object property to a new value. |
|
4930 | + * |
|
4931 | + * @param string $property_name |
|
4932 | + * @param $new_value |
|
4933 | + * @return int |
|
4934 | + */ |
|
4935 | + final public function set($property_name, $new_value) {} |
|
4936 | + |
|
4937 | + /** |
|
4938 | + * Update a web object from a string snippet. Returns |
|
4939 | + * MS_SUCCESS/MS_FAILURE. |
|
4940 | + * |
|
4941 | + * @param string $snippet |
|
4942 | + * @return int |
|
4943 | + */ |
|
4944 | + final public function updateFromString($snippet) {} |
|
4945 | 4945 | } |
@@ -258,8 +258,7 @@ discard block |
||
258 | 258 | * Class Objects can be returned by the `layerObj`_ class, or can be |
259 | 259 | * created using: |
260 | 260 | */ |
261 | -final class classObj |
|
262 | -{ |
|
261 | +final class classObj { |
|
263 | 262 | /** |
264 | 263 | * @var string |
265 | 264 | */ |
@@ -548,8 +547,7 @@ discard block |
||
548 | 547 | /** |
549 | 548 | * Instance of clusterObj is always embedded inside the `layerObj`_. |
550 | 549 | */ |
551 | -final class clusterObj |
|
552 | -{ |
|
550 | +final class clusterObj { |
|
553 | 551 | /** |
554 | 552 | * @var float |
555 | 553 | */ |
@@ -609,8 +607,7 @@ discard block |
||
609 | 607 | /** |
610 | 608 | * Instances of colorObj are always embedded inside other classes. |
611 | 609 | */ |
612 | -final class colorObj |
|
613 | -{ |
|
610 | +final class colorObj { |
|
614 | 611 | /** |
615 | 612 | * @var int |
616 | 613 | */ |
@@ -649,8 +646,7 @@ discard block |
||
649 | 646 | final public function setHex($hex) {} |
650 | 647 | } |
651 | 648 | |
652 | -final class errorObj |
|
653 | -{ |
|
649 | +final class errorObj { |
|
654 | 650 | /** |
655 | 651 | * //See error code constants above |
656 | 652 | * |
@@ -680,8 +676,7 @@ discard block |
||
680 | 676 | * ms_newgridobj($oLayer); |
681 | 677 | * $oLayer->grid->set("labelformat", "DDMMSS"); |
682 | 678 | */ |
683 | -final class gridObj |
|
684 | -{ |
|
679 | +final class gridObj { |
|
685 | 680 | /** |
686 | 681 | * @var string |
687 | 682 | */ |
@@ -735,8 +730,7 @@ discard block |
||
735 | 730 | * while ($key = $hashTable->nextkey($key)) |
736 | 731 | * echo "Key: ".$key." value: ".$hashTable->get($key)."<br/>"; |
737 | 732 | */ |
738 | -final class hashTableObj |
|
739 | -{ |
|
733 | +final class hashTableObj { |
|
740 | 734 | /** |
741 | 735 | * Clear all items in the hashTable (To NULL). |
742 | 736 | * |
@@ -784,8 +778,7 @@ discard block |
||
784 | 778 | /** |
785 | 779 | * Instances of imageObj are always created by the `mapObj`_ class methods. |
786 | 780 | */ |
787 | -final class imageObj |
|
788 | -{ |
|
781 | +final class imageObj { |
|
789 | 782 | /** |
790 | 783 | * read-only |
791 | 784 | * |
@@ -875,8 +868,7 @@ discard block |
||
875 | 868 | final public function saveWebImage() {} |
876 | 869 | } |
877 | 870 | |
878 | -final class labelcacheMemberObj |
|
879 | -{ |
|
871 | +final class labelcacheMemberObj { |
|
880 | 872 | /** |
881 | 873 | * read-only |
882 | 874 | * |
@@ -941,8 +933,7 @@ discard block |
||
941 | 933 | public $tileindex; |
942 | 934 | } |
943 | 935 | |
944 | -final class labelcacheObj |
|
945 | -{ |
|
936 | +final class labelcacheObj { |
|
946 | 937 | /** |
947 | 938 | * Free the label cache. Always returns MS_SUCCESS. |
948 | 939 | * Ex : map->labelcache->freeCache(); |
@@ -955,8 +946,7 @@ discard block |
||
955 | 946 | /** |
956 | 947 | * labelObj are always embedded inside other classes. |
957 | 948 | */ |
958 | -final class labelObj |
|
959 | -{ |
|
949 | +final class labelObj { |
|
960 | 950 | /** |
961 | 951 | * @var int |
962 | 952 | */ |
@@ -1290,8 +1280,7 @@ discard block |
||
1290 | 1280 | * argument then all members of a this layer will be copied in the new |
1291 | 1281 | * layer created. |
1292 | 1282 | */ |
1293 | -final class layerObj |
|
1294 | -{ |
|
1283 | +final class layerObj { |
|
1295 | 1284 | /** |
1296 | 1285 | * @var int |
1297 | 1286 | */ |
@@ -2047,8 +2036,7 @@ discard block |
||
2047 | 2036 | /** |
2048 | 2037 | * Instances of legendObj are always are always embedded inside the `mapObj`_. |
2049 | 2038 | */ |
2050 | -final class legendObj |
|
2051 | -{ |
|
2039 | +final class legendObj { |
|
2052 | 2040 | /** |
2053 | 2041 | * @var int |
2054 | 2042 | */ |
@@ -2157,8 +2145,7 @@ discard block |
||
2157 | 2145 | final public function updateFromString($snippet) {} |
2158 | 2146 | } |
2159 | 2147 | |
2160 | -final class lineObj |
|
2161 | -{ |
|
2148 | +final class lineObj { |
|
2162 | 2149 | /** |
2163 | 2150 | * read-only |
2164 | 2151 | * |
@@ -2229,8 +2216,7 @@ discard block |
||
2229 | 2216 | final public function project(projectionObj $in, projectionObj $out) {} |
2230 | 2217 | } |
2231 | 2218 | |
2232 | -final class mapObj |
|
2233 | -{ |
|
2219 | +final class mapObj { |
|
2234 | 2220 | /** |
2235 | 2221 | * @var float |
2236 | 2222 | */ |
@@ -3213,8 +3199,7 @@ discard block |
||
3213 | 3199 | * It is uses a read only. |
3214 | 3200 | * No constructor available (coming soon, see ticket 979) |
3215 | 3201 | */ |
3216 | -final class outputformatObj |
|
3217 | -{ |
|
3202 | +final class outputformatObj { |
|
3218 | 3203 | /** |
3219 | 3204 | * @var string |
3220 | 3205 | */ |
@@ -3291,8 +3276,7 @@ discard block |
||
3291 | 3276 | final public function validate() {} |
3292 | 3277 | } |
3293 | 3278 | |
3294 | -final class OwsrequestObj |
|
3295 | -{ |
|
3279 | +final class OwsrequestObj { |
|
3296 | 3280 | /** |
3297 | 3281 | * (read-only) |
3298 | 3282 | * |
@@ -3374,8 +3358,7 @@ discard block |
||
3374 | 3358 | final public function setParameter($name, $value) {} |
3375 | 3359 | } |
3376 | 3360 | |
3377 | -final class pointObj |
|
3378 | -{ |
|
3361 | +final class pointObj { |
|
3379 | 3362 | /** |
3380 | 3363 | * @var float |
3381 | 3364 | */ |
@@ -3488,8 +3471,7 @@ discard block |
||
3488 | 3471 | final public function setXYZ($x, $y, $z, $m) {} |
3489 | 3472 | } |
3490 | 3473 | |
3491 | -final class projectionObj |
|
3492 | -{ |
|
3474 | +final class projectionObj { |
|
3493 | 3475 | /** |
3494 | 3476 | * Creates a projection object based on the projection string passed |
3495 | 3477 | * as argument. |
@@ -3528,8 +3510,7 @@ discard block |
||
3528 | 3510 | * Instances of querymapObj are always are always embedded inside the |
3529 | 3511 | * `mapObj`_. |
3530 | 3512 | */ |
3531 | -final class querymapObj |
|
3532 | -{ |
|
3513 | +final class querymapObj { |
|
3533 | 3514 | /** |
3534 | 3515 | * @var colorObj |
3535 | 3516 | */ |
@@ -3591,8 +3572,7 @@ discard block |
||
3591 | 3572 | * rectObj are sometimes embedded inside other objects. New ones can |
3592 | 3573 | * also be created with: |
3593 | 3574 | */ |
3594 | -final class rectObj |
|
3595 | -{ |
|
3575 | +final class rectObj { |
|
3596 | 3576 | /** |
3597 | 3577 | * @var float |
3598 | 3578 | */ |
@@ -3683,8 +3663,7 @@ discard block |
||
3683 | 3663 | /** |
3684 | 3664 | * Instances of referenceMapObj are always embedded inside the `mapObj`_. |
3685 | 3665 | */ |
3686 | -final class referenceMapObj |
|
3687 | -{ |
|
3666 | +final class referenceMapObj { |
|
3688 | 3667 | /** |
3689 | 3668 | * @var ColorObj |
3690 | 3669 | */ |
@@ -3781,8 +3760,7 @@ discard block |
||
3781 | 3760 | final public function updateFromString($snippet) {} |
3782 | 3761 | } |
3783 | 3762 | |
3784 | -final class resultObj |
|
3785 | -{ |
|
3763 | +final class resultObj { |
|
3786 | 3764 | /** |
3787 | 3765 | * read-only |
3788 | 3766 | * |
@@ -3822,8 +3800,7 @@ discard block |
||
3822 | 3800 | /** |
3823 | 3801 | * Instances of scalebarObj are always embedded inside the `mapObj`_. |
3824 | 3802 | */ |
3825 | -final class scalebarObj |
|
3826 | -{ |
|
3803 | +final class scalebarObj { |
|
3827 | 3804 | /** |
3828 | 3805 | * @var int |
3829 | 3806 | */ |
@@ -3944,8 +3921,7 @@ discard block |
||
3944 | 3921 | final public function updateFromString($snippet) {} |
3945 | 3922 | } |
3946 | 3923 | |
3947 | -final class shapefileObj |
|
3948 | -{ |
|
3924 | +final class shapefileObj { |
|
3949 | 3925 | /** |
3950 | 3926 | * read-only |
3951 | 3927 | * |
@@ -4060,8 +4036,7 @@ discard block |
||
4060 | 4036 | final public function getTransformed(mapObj $map, $i) {} |
4061 | 4037 | } |
4062 | 4038 | |
4063 | -final class shapeObj |
|
4064 | -{ |
|
4039 | +final class shapeObj { |
|
4065 | 4040 | /** |
4066 | 4041 | * read-only |
4067 | 4042 | * |
@@ -4434,8 +4409,7 @@ discard block |
||
4434 | 4409 | /** |
4435 | 4410 | * Instances of styleObj are always embedded inside a `classObj`_ or `labelObj`_. |
4436 | 4411 | */ |
4437 | -final class styleObj |
|
4438 | -{ |
|
4412 | +final class styleObj { |
|
4439 | 4413 | /** |
4440 | 4414 | * @var float |
4441 | 4415 | */ |
@@ -4634,8 +4608,7 @@ discard block |
||
4634 | 4608 | final public function updateFromString($snippet) {} |
4635 | 4609 | } |
4636 | 4610 | |
4637 | -final class symbolObj |
|
4638 | -{ |
|
4611 | +final class symbolObj { |
|
4639 | 4612 | /** |
4640 | 4613 | * @var int |
4641 | 4614 | */ |
@@ -4810,8 +4783,7 @@ discard block |
||
4810 | 4783 | /** |
4811 | 4784 | * Instances of webObj are always are always embedded inside the `mapObj`_. |
4812 | 4785 | */ |
4813 | -final class webObj |
|
4814 | -{ |
|
4786 | +final class webObj { |
|
4815 | 4787 | /** |
4816 | 4788 | * @var string |
4817 | 4789 | */ |
@@ -28,7 +28,7 @@ discard block |
||
28 | 28 | * @return string|false the converted string or <b>FALSE</b> on failure. |
29 | 29 | */ |
30 | 30 | #[Pure] |
31 | -function iconv(string $from_encoding, string $to_encoding, string $string): string|false {} |
|
31 | +function iconv(string $from_encoding, string $to_encoding, string $string): string | false {} |
|
32 | 32 | |
33 | 33 | /** |
34 | 34 | * Convert character encoding as output buffer handler |
@@ -60,7 +60,7 @@ discard block |
||
60 | 60 | * </p> |
61 | 61 | */ |
62 | 62 | #[Pure] |
63 | -function iconv_get_encoding(string $type = "all"): array|string|false {} |
|
63 | +function iconv_get_encoding(string $type = "all"): array | string | false {} |
|
64 | 64 | |
65 | 65 | /** |
66 | 66 | * Set current setting for character encoding conversion |
@@ -92,7 +92,7 @@ discard block |
||
92 | 92 | * @return int|false the character count of <i>str</i>, as an integer. False on error. |
93 | 93 | */ |
94 | 94 | #[Pure] |
95 | -function iconv_strlen(string $string, ?string $encoding = 'ini_get("iconv.internal_encoding")'): int|false {} |
|
95 | +function iconv_strlen(string $string, ?string $encoding = 'ini_get("iconv.internal_encoding")'): int | false {} |
|
96 | 96 | |
97 | 97 | /** |
98 | 98 | * Cut out part of a string |
@@ -147,7 +147,7 @@ discard block |
||
147 | 147 | * </p> |
148 | 148 | */ |
149 | 149 | #[Pure] |
150 | -function iconv_substr(string $string, int $offset, ?int $length, ?string $encoding = 'ini_get("iconv.internal_encoding")'): string|false {} |
|
150 | +function iconv_substr(string $string, int $offset, ?int $length, ?string $encoding = 'ini_get("iconv.internal_encoding")'): string | false {} |
|
151 | 151 | |
152 | 152 | /** |
153 | 153 | * Finds position of first occurrence of a needle within a haystack |
@@ -175,7 +175,7 @@ discard block |
||
175 | 175 | * </p> |
176 | 176 | */ |
177 | 177 | #[Pure] |
178 | -function iconv_strpos(string $haystack, string $needle, int $offset = 0, ?string $encoding = 'ini_get("iconv.internal_encoding")'): int|false {} |
|
178 | +function iconv_strpos(string $haystack, string $needle, int $offset = 0, ?string $encoding = 'ini_get("iconv.internal_encoding")'): int | false {} |
|
179 | 179 | |
180 | 180 | /** |
181 | 181 | * Finds the last occurrence of a needle within a haystack |
@@ -199,7 +199,7 @@ discard block |
||
199 | 199 | * </p> |
200 | 200 | */ |
201 | 201 | #[Pure] |
202 | -function iconv_strrpos(string $haystack, string $needle, ?string $encoding = 'ini_get("iconv.internal_encoding")'): int|false {} |
|
202 | +function iconv_strrpos(string $haystack, string $needle, ?string $encoding = 'ini_get("iconv.internal_encoding")'): int | false {} |
|
203 | 203 | |
204 | 204 | /** |
205 | 205 | * Composes a MIME header field |
@@ -300,7 +300,7 @@ discard block |
||
300 | 300 | * or <b>FALSE</b> if an error occurs during the encoding. |
301 | 301 | */ |
302 | 302 | #[Pure] |
303 | -function iconv_mime_encode(string $field_name, string $field_value, array $options): string|false {} |
|
303 | +function iconv_mime_encode(string $field_name, string $field_value, array $options): string | false {} |
|
304 | 304 | |
305 | 305 | /** |
306 | 306 | * Decodes a MIME header field |
@@ -352,7 +352,7 @@ discard block |
||
352 | 352 | * or <b>FALSE</b> if an error occurs during the decoding. |
353 | 353 | */ |
354 | 354 | #[Pure] |
355 | -function iconv_mime_decode(string $string, int $mode = 0, ?string $encoding = 'ini_get("iconv.internal_encoding")'): string|false {} |
|
355 | +function iconv_mime_decode(string $string, int $mode = 0, ?string $encoding = 'ini_get("iconv.internal_encoding")'): string | false {} |
|
356 | 356 | |
357 | 357 | /** |
358 | 358 | * Decodes multiple MIME header fields at once |
@@ -413,7 +413,7 @@ discard block |
||
413 | 413 | * </p> |
414 | 414 | */ |
415 | 415 | #[Pure] |
416 | -function iconv_mime_decode_headers(string $headers, int $mode = 0, ?string $encoding = 'ini_get("iconv.internal_encoding")'): array|false {} |
|
416 | +function iconv_mime_decode_headers(string $headers, int $mode = 0, ?string $encoding = 'ini_get("iconv.internal_encoding")'): array | false {} |
|
417 | 417 | |
418 | 418 | /** |
419 | 419 | * string |
@@ -196,8 +196,8 @@ |
||
196 | 196 | */ |
197 | 197 | #[LanguageLevelTypeAware(['7.3' => 'int'], default: 'bool')] |
198 | 198 | function bcscale( |
199 | - #[PhpStormStubsElementAvailable(from: '5.3', to: '7.2')] int $scale, |
|
200 | - #[PhpStormStubsElementAvailable(from: '7.3')] #[LanguageLevelTypeAware(['8.0' => 'int|null'], default: 'int')] $scale = null |
|
199 | + #[PhpStormStubsElementAvailable(from: '5.3', to: '7.2')] int $scale, |
|
200 | + #[PhpStormStubsElementAvailable(from: '7.3')] #[LanguageLevelTypeAware(['8.0' => 'int|null'], default: 'int')] $scale = null |
|
201 | 201 | ) {} |
202 | 202 | |
203 | 203 | /** |
@@ -83,7 +83,7 @@ discard block |
||
83 | 83 | * <i>divisor</i> is 0. |
84 | 84 | */ |
85 | 85 | #[Pure] |
86 | -#[PhpStormStubsElementAvailable(to: '7.4')] |
|
86 | +#[PhpStormStubsElementAvailable(to : '7.4')] |
|
87 | 87 | function bcdiv(string $num1, string $num2, ?int $scale = 0): ?string {} |
88 | 88 | |
89 | 89 | /** |
@@ -127,7 +127,7 @@ discard block |
||
127 | 127 | * <i>divisor</i> is 0. |
128 | 128 | */ |
129 | 129 | #[Pure] |
130 | -#[PhpStormStubsElementAvailable(to: '7.4')] |
|
130 | +#[PhpStormStubsElementAvailable(to : '7.4')] |
|
131 | 131 | function bcmod(string $num1, string $num2, ?int $scale = 0): ?string {} |
132 | 132 | |
133 | 133 | /** |
@@ -185,7 +185,7 @@ discard block |
||
185 | 185 | * <i>operand</i> is negative. |
186 | 186 | */ |
187 | 187 | #[Pure] |
188 | -#[LanguageLevelTypeAware(["8.0" => "string"], default: "?string")] |
|
188 | +#[LanguageLevelTypeAware(["8.0" => "string"], default : "?string")] |
|
189 | 189 | function bcsqrt(string $num, ?int $scale) {} |
190 | 190 | |
191 | 191 | /** |
@@ -194,10 +194,10 @@ discard block |
||
194 | 194 | * @param int $scale |
195 | 195 | * @return int|bool |
196 | 196 | */ |
197 | -#[LanguageLevelTypeAware(['7.3' => 'int'], default: 'bool')] |
|
197 | +#[LanguageLevelTypeAware(['7.3' => 'int'], default : 'bool')] |
|
198 | 198 | function bcscale( |
199 | - #[PhpStormStubsElementAvailable(from: '5.3', to: '7.2')] int $scale, |
|
200 | - #[PhpStormStubsElementAvailable(from: '7.3')] #[LanguageLevelTypeAware(['8.0' => 'int|null'], default: 'int')] $scale = null |
|
199 | + #[PhpStormStubsElementAvailable(from : '5.3', to : '7.2')] int $scale, |
|
200 | + #[PhpStormStubsElementAvailable(from : '7.3')] #[LanguageLevelTypeAware(['8.0' => 'int|null'], default : 'int')] $scale = null |
|
201 | 201 | ) {} |
202 | 202 | |
203 | 203 | /** |
@@ -244,5 +244,5 @@ discard block |
||
244 | 244 | * is 0 or <i>exponent</i> is negative. |
245 | 245 | */ |
246 | 246 | #[Pure] |
247 | -#[LanguageLevelTypeAware(["8.0" => "string"], default: "?string")] |
|
247 | +#[LanguageLevelTypeAware(["8.0" => "string"], default : "?string")] |
|
248 | 248 | function bcpowmod(string $num, string $exponent, string $modulus, ?int $scale = 0) {} |
@@ -10,85 +10,85 @@ discard block |
||
10 | 10 | |
11 | 11 | class __PHP_Incomplete_Class |
12 | 12 | { |
13 | - /** |
|
14 | - * @var string |
|
15 | - */ |
|
16 | - public $__PHP_Incomplete_Class_Name; |
|
13 | + /** |
|
14 | + * @var string |
|
15 | + */ |
|
16 | + public $__PHP_Incomplete_Class_Name; |
|
17 | 17 | } |
18 | 18 | |
19 | 19 | class php_user_filter |
20 | 20 | { |
21 | - #[LanguageLevelTypeAware(['8.1' => 'string'], default: '')] |
|
22 | - public $filtername; |
|
21 | + #[LanguageLevelTypeAware(['8.1' => 'string'], default: '')] |
|
22 | + public $filtername; |
|
23 | 23 | |
24 | - #[LanguageLevelTypeAware(['8.1' => 'mixed'], default: '')] |
|
25 | - public $params; |
|
24 | + #[LanguageLevelTypeAware(['8.1' => 'mixed'], default: '')] |
|
25 | + public $params; |
|
26 | 26 | |
27 | - public $stream; |
|
27 | + public $stream; |
|
28 | 28 | |
29 | - /** |
|
30 | - * @link https://php.net/manual/en/php-user-filter.filter.php |
|
31 | - * @param resource $in <p> is a resource pointing to a <i>bucket brigade</i< which contains one or more <i>bucket</i> objects containing data to be filtered.</p> |
|
32 | - * @param resource $out <p>is a resource pointing to a second bucket brigade into which your modified buckets should be placed.</p> |
|
33 | - * @param int &$consumed <p>which must <i>always</i> be declared by reference, should be incremented by the length of the data which your filter reads in and alters. In most cases this means you will increment consumed by <i>$bucket->datalen</i> for each <i>$bucket</i>.</p> |
|
34 | - * @param bool $closing <p>If the stream is in the process of closing (and therefore this is the last pass through the filterchain), the closing parameter will be set to <b>TRUE</b> |
|
35 | - * @return int <p> |
|
36 | - * The <b>filter()</b> method must return one of |
|
37 | - * three values upon completion. |
|
38 | - * </p><table> |
|
39 | - * |
|
40 | - * <thead> |
|
41 | - * <tr> |
|
42 | - * <th>Return Value</th> |
|
43 | - * <th>Meaning</th> |
|
44 | - * </tr> |
|
45 | - * |
|
46 | - * </thead> |
|
47 | - * |
|
48 | - * <tbody class="tbody"> |
|
49 | - * <tr> |
|
50 | - * <td><b>PSFS_PASS_ON</b></td> |
|
51 | - * <td> |
|
52 | - * Filter processed successfully with data available in the |
|
53 | - * <code class="parameter">out</code> <em>bucket brigade</em>. |
|
54 | - * </td> |
|
55 | - * </tr> |
|
56 | - * |
|
57 | - * <tr> |
|
58 | - * <td><b>PSFS_FEED_ME</b></td> |
|
59 | - * <td> |
|
60 | - * Filter processed successfully, however no data was available to |
|
61 | - * return. More data is required from the stream or prior filter. |
|
62 | - * </td> |
|
63 | - * </tr> |
|
64 | - * |
|
65 | - * <tr> |
|
66 | - * <td><b>PSFS_ERR_FATAL</b> (default)</td> |
|
67 | - * <td> |
|
68 | - * The filter experienced an unrecoverable error and cannot continue. |
|
69 | - * </td> |
|
70 | - * </tr> |
|
71 | - */ |
|
72 | - #[TentativeType] |
|
73 | - public function filter( |
|
74 | - $in, |
|
75 | - $out, |
|
76 | - &$consumed, |
|
77 | - #[LanguageLevelTypeAware(['8.0' => 'bool'], default: '')] $closing |
|
78 | - ): int {} |
|
29 | + /** |
|
30 | + * @link https://php.net/manual/en/php-user-filter.filter.php |
|
31 | + * @param resource $in <p> is a resource pointing to a <i>bucket brigade</i< which contains one or more <i>bucket</i> objects containing data to be filtered.</p> |
|
32 | + * @param resource $out <p>is a resource pointing to a second bucket brigade into which your modified buckets should be placed.</p> |
|
33 | + * @param int &$consumed <p>which must <i>always</i> be declared by reference, should be incremented by the length of the data which your filter reads in and alters. In most cases this means you will increment consumed by <i>$bucket->datalen</i> for each <i>$bucket</i>.</p> |
|
34 | + * @param bool $closing <p>If the stream is in the process of closing (and therefore this is the last pass through the filterchain), the closing parameter will be set to <b>TRUE</b> |
|
35 | + * @return int <p> |
|
36 | + * The <b>filter()</b> method must return one of |
|
37 | + * three values upon completion. |
|
38 | + * </p><table> |
|
39 | + * |
|
40 | + * <thead> |
|
41 | + * <tr> |
|
42 | + * <th>Return Value</th> |
|
43 | + * <th>Meaning</th> |
|
44 | + * </tr> |
|
45 | + * |
|
46 | + * </thead> |
|
47 | + * |
|
48 | + * <tbody class="tbody"> |
|
49 | + * <tr> |
|
50 | + * <td><b>PSFS_PASS_ON</b></td> |
|
51 | + * <td> |
|
52 | + * Filter processed successfully with data available in the |
|
53 | + * <code class="parameter">out</code> <em>bucket brigade</em>. |
|
54 | + * </td> |
|
55 | + * </tr> |
|
56 | + * |
|
57 | + * <tr> |
|
58 | + * <td><b>PSFS_FEED_ME</b></td> |
|
59 | + * <td> |
|
60 | + * Filter processed successfully, however no data was available to |
|
61 | + * return. More data is required from the stream or prior filter. |
|
62 | + * </td> |
|
63 | + * </tr> |
|
64 | + * |
|
65 | + * <tr> |
|
66 | + * <td><b>PSFS_ERR_FATAL</b> (default)</td> |
|
67 | + * <td> |
|
68 | + * The filter experienced an unrecoverable error and cannot continue. |
|
69 | + * </td> |
|
70 | + * </tr> |
|
71 | + */ |
|
72 | + #[TentativeType] |
|
73 | + public function filter( |
|
74 | + $in, |
|
75 | + $out, |
|
76 | + &$consumed, |
|
77 | + #[LanguageLevelTypeAware(['8.0' => 'bool'], default: '')] $closing |
|
78 | + ): int {} |
|
79 | 79 | |
80 | - /** |
|
81 | - * @link https://php.net/manual/en/php-user-filter.oncreate.php |
|
82 | - * @return bool |
|
83 | - */ |
|
84 | - #[TentativeType] |
|
85 | - public function onCreate(): bool {} |
|
80 | + /** |
|
81 | + * @link https://php.net/manual/en/php-user-filter.oncreate.php |
|
82 | + * @return bool |
|
83 | + */ |
|
84 | + #[TentativeType] |
|
85 | + public function onCreate(): bool {} |
|
86 | 86 | |
87 | - /** |
|
88 | - * @link https://php.net/manual/en/php-user-filter.onclose.php |
|
89 | - */ |
|
90 | - #[TentativeType] |
|
91 | - public function onClose(): void {} |
|
87 | + /** |
|
88 | + * @link https://php.net/manual/en/php-user-filter.onclose.php |
|
89 | + */ |
|
90 | + #[TentativeType] |
|
91 | + public function onClose(): void {} |
|
92 | 92 | } |
93 | 93 | |
94 | 94 | /** |
@@ -96,42 +96,42 @@ discard block |
||
96 | 96 | */ |
97 | 97 | class Directory |
98 | 98 | { |
99 | - /** |
|
100 | - * @var string The directory that was opened. |
|
101 | - */ |
|
102 | - #[LanguageLevelTypeAware(['8.1' => 'string'], default: '')] |
|
103 | - public $path; |
|
99 | + /** |
|
100 | + * @var string The directory that was opened. |
|
101 | + */ |
|
102 | + #[LanguageLevelTypeAware(['8.1' => 'string'], default: '')] |
|
103 | + public $path; |
|
104 | 104 | |
105 | - /** |
|
106 | - * @var resource Can be used with other directory functions such as {@see readdir()}, {@see rewinddir()} and {@see closedir()}. |
|
107 | - */ |
|
108 | - #[LanguageLevelTypeAware(['8.1' => 'mixed'], default: '')] |
|
109 | - public $handle; |
|
105 | + /** |
|
106 | + * @var resource Can be used with other directory functions such as {@see readdir()}, {@see rewinddir()} and {@see closedir()}. |
|
107 | + */ |
|
108 | + #[LanguageLevelTypeAware(['8.1' => 'mixed'], default: '')] |
|
109 | + public $handle; |
|
110 | 110 | |
111 | - /** |
|
112 | - * Close directory handle. |
|
113 | - * Same as closedir(), only dir_handle defaults to $this. |
|
114 | - * @param resource $dir_handle [optional] |
|
115 | - * @link https://secure.php.net/manual/en/directory.close.php |
|
116 | - */ |
|
117 | - public function close($dir_handle = null) {} |
|
111 | + /** |
|
112 | + * Close directory handle. |
|
113 | + * Same as closedir(), only dir_handle defaults to $this. |
|
114 | + * @param resource $dir_handle [optional] |
|
115 | + * @link https://secure.php.net/manual/en/directory.close.php |
|
116 | + */ |
|
117 | + public function close($dir_handle = null) {} |
|
118 | 118 | |
119 | - /** |
|
120 | - * Rewind directory handle. |
|
121 | - * Same as rewinddir(), only dir_handle defaults to $this. |
|
122 | - * @param resource $dir_handle [optional] |
|
123 | - * @link https://secure.php.net/manual/en/directory.rewind.php |
|
124 | - */ |
|
125 | - public function rewind($dir_handle = null) {} |
|
119 | + /** |
|
120 | + * Rewind directory handle. |
|
121 | + * Same as rewinddir(), only dir_handle defaults to $this. |
|
122 | + * @param resource $dir_handle [optional] |
|
123 | + * @link https://secure.php.net/manual/en/directory.rewind.php |
|
124 | + */ |
|
125 | + public function rewind($dir_handle = null) {} |
|
126 | 126 | |
127 | - /** |
|
128 | - * Read entry from directory handle. |
|
129 | - * Same as readdir(), only dir_handle defaults to $this. |
|
130 | - * @param resource $dir_handle [optional] |
|
131 | - * @return string|false |
|
132 | - * @link https://secure.php.net/manual/en/directory.read.php |
|
133 | - */ |
|
134 | - public function read($dir_handle = null) {} |
|
127 | + /** |
|
128 | + * Read entry from directory handle. |
|
129 | + * Same as readdir(), only dir_handle defaults to $this. |
|
130 | + * @param resource $dir_handle [optional] |
|
131 | + * @return string|false |
|
132 | + * @link https://secure.php.net/manual/en/directory.read.php |
|
133 | + */ |
|
134 | + public function read($dir_handle = null) {} |
|
135 | 135 | } |
136 | 136 | |
137 | 137 | /** |
@@ -200,7 +200,7 @@ discard block |
||
200 | 200 | * remaining in the delay |
201 | 201 | * </p> |
202 | 202 | */ |
203 | -function time_nanosleep(int $seconds, int $nanoseconds): array|bool {} |
|
203 | +function time_nanosleep(int $seconds, int $nanoseconds): array | bool {} |
|
204 | 204 | |
205 | 205 | /** |
206 | 206 | * Make the script sleep until the specified time |
@@ -277,7 +277,7 @@ discard block |
||
277 | 277 | */ |
278 | 278 | #[Pure] |
279 | 279 | #[Deprecated(since: '8.1')] |
280 | -function strptime(string $timestamp, string $format): array|false {} |
|
280 | +function strptime(string $timestamp, string $format): array | false {} |
|
281 | 281 | |
282 | 282 | /** |
283 | 283 | * Flush the output buffer |
@@ -427,7 +427,7 @@ discard block |
||
427 | 427 | * @return string The converted string. |
428 | 428 | */ |
429 | 429 | #[Pure] |
430 | -function htmlspecialchars(string $string, int $flags = ENT_QUOTES|ENT_SUBSTITUTE, ?string $encoding = 'UTF-8', bool $double_encode = true): string {} |
|
430 | +function htmlspecialchars(string $string, int $flags = ENT_QUOTES | ENT_SUBSTITUTE, ?string $encoding = 'UTF-8', bool $double_encode = true): string {} |
|
431 | 431 | |
432 | 432 | /** |
433 | 433 | * Convert all applicable characters to HTML entities |
@@ -473,7 +473,7 @@ discard block |
||
473 | 473 | * @return string the encoded string. |
474 | 474 | */ |
475 | 475 | #[Pure] |
476 | -function htmlentities(string $string, int $flags = ENT_QUOTES|ENT_SUBSTITUTE, ?string $encoding, bool $double_encode = true): string {} |
|
476 | +function htmlentities(string $string, int $flags = ENT_QUOTES | ENT_SUBSTITUTE, ?string $encoding, bool $double_encode = true): string {} |
|
477 | 477 | |
478 | 478 | /** |
479 | 479 | * Convert HTML entities to their corresponding characters |
@@ -514,7 +514,7 @@ discard block |
||
514 | 514 | * @return string the decoded string. |
515 | 515 | */ |
516 | 516 | #[Pure] |
517 | -function html_entity_decode(string $string, int $flags = ENT_QUOTES|ENT_SUBSTITUTE, ?string $encoding): string {} |
|
517 | +function html_entity_decode(string $string, int $flags = ENT_QUOTES | ENT_SUBSTITUTE, ?string $encoding): string {} |
|
518 | 518 | |
519 | 519 | /** |
520 | 520 | * Convert special HTML entities back to characters |
@@ -548,7 +548,7 @@ discard block |
||
548 | 548 | * @return string the decoded string. |
549 | 549 | */ |
550 | 550 | #[Pure] |
551 | -function htmlspecialchars_decode(string $string, int $flags = ENT_QUOTES|ENT_SUBSTITUTE): string {} |
|
551 | +function htmlspecialchars_decode(string $string, int $flags = ENT_QUOTES | ENT_SUBSTITUTE): string {} |
|
552 | 552 | |
553 | 553 | /** |
554 | 554 | * Returns the translation table used by <function>htmlspecialchars</function> and <function>htmlentities</function> |
@@ -724,7 +724,7 @@ discard block |
||
724 | 724 | * @return array the translation table as an array. |
725 | 725 | */ |
726 | 726 | #[Pure] |
727 | -function get_html_translation_table(int $table, int $flags = ENT_QUOTES|ENT_SUBSTITUTE, string $encoding = "UTF-8"): array {} |
|
727 | +function get_html_translation_table(int $table, int $flags = ENT_QUOTES | ENT_SUBSTITUTE, string $encoding = "UTF-8"): array {} |
|
728 | 728 | |
729 | 729 | /** |
730 | 730 | * Calculate the sha1 hash of a string |
@@ -756,7 +756,7 @@ discard block |
||
756 | 756 | * @return string|false a string on success, false otherwise. |
757 | 757 | */ |
758 | 758 | #[Pure] |
759 | -function sha1_file(string $filename, bool $binary = false): string|false {} |
|
759 | +function sha1_file(string $filename, bool $binary = false): string | false {} |
|
760 | 760 | |
761 | 761 | /** |
762 | 762 | * Calculate the md5 hash of a string |
@@ -787,7 +787,7 @@ discard block |
||
787 | 787 | * @return string|false a string on success, false otherwise. |
788 | 788 | */ |
789 | 789 | #[Pure] |
790 | -function md5_file(string $filename, bool $binary = false): string|false {} |
|
790 | +function md5_file(string $filename, bool $binary = false): string | false {} |
|
791 | 791 | |
792 | 792 | /** |
793 | 793 | * Calculates the crc32 polynomial of a string |
@@ -811,7 +811,7 @@ discard block |
||
811 | 811 | * value. It returns false on error or if no IPTC data was found. |
812 | 812 | */ |
813 | 813 | #[Pure] |
814 | -function iptcparse(string $iptc_block): array|false {} |
|
814 | +function iptcparse(string $iptc_block): array | false {} |
|
815 | 815 | |
816 | 816 | /** |
817 | 817 | * Embeds binary IPTC data into a JPEG image. |
@@ -830,7 +830,7 @@ discard block |
||
830 | 830 | * @return string|bool If success and spool flag is lower than 2 then the JPEG will not be |
831 | 831 | * returned as a string, false on errors. |
832 | 832 | */ |
833 | -function iptcembed(string $iptc_data, string $filename, int $spool): string|bool {} |
|
833 | +function iptcembed(string $iptc_data, string $filename, int $spool): string | bool {} |
|
834 | 834 | |
835 | 835 | /** |
836 | 836 | * Get the size of an image |
@@ -893,7 +893,7 @@ discard block |
||
893 | 893 | * On failure, false is returned. |
894 | 894 | * </p> |
895 | 895 | */ |
896 | -function getimagesize(string $filename, &$image_info): array|false {} |
|
896 | +function getimagesize(string $filename, &$image_info): array | false {} |
|
897 | 897 | |
898 | 898 | /** |
899 | 899 | * Get Mime-Type for image-type returned by getimagesize, exif_read_data, exif_thumbnail, exif_imagetype |
@@ -996,7 +996,7 @@ discard block |
||
996 | 996 | * @return string|false A string with the extension corresponding to the given image type. |
997 | 997 | */ |
998 | 998 | #[Pure] |
999 | -function image_type_to_extension(int $image_type, bool $include_dot = true): string|false {} |
|
999 | +function image_type_to_extension(int $image_type, bool $include_dot = true): string | false {} |
|
1000 | 1000 | |
1001 | 1001 | /** |
1002 | 1002 | * Outputs information about PHP's configuration |
@@ -1082,7 +1082,7 @@ discard block |
||
1082 | 1082 | * </p> |
1083 | 1083 | * @return bool true on success or false on failure. |
1084 | 1084 | */ |
1085 | -function phpinfo(#[ExpectedValues(flags: [INFO_GENERAL, INFO_CREDITS, INFO_CONFIGURATION, INFO_MODULES, INFO_ENVIRONMENT, INFO_VARIABLES, INFO_LICENSE, INFO_ALL])] int $flags = INFO_ALL): bool {} |
|
1085 | +function phpinfo(#[ExpectedValues(flags : [INFO_GENERAL, INFO_CREDITS, INFO_CONFIGURATION, INFO_MODULES, INFO_ENVIRONMENT, INFO_VARIABLES, INFO_LICENSE, INFO_ALL])] int $flags = INFO_ALL): bool {} |
|
1086 | 1086 | |
1087 | 1087 | /** |
1088 | 1088 | * Gets the current PHP version |
@@ -1096,7 +1096,7 @@ discard block |
||
1096 | 1096 | * the extension isn't enabled. |
1097 | 1097 | */ |
1098 | 1098 | #[Pure] |
1099 | -function phpversion(?string $extension): string|false {} |
|
1099 | +function phpversion(?string $extension): string | false {} |
|
1100 | 1100 | |
1101 | 1101 | /** |
1102 | 1102 | * Prints out the credits for PHP |
@@ -1208,7 +1208,7 @@ discard block |
||
1208 | 1208 | * </p> |
1209 | 1209 | */ |
1210 | 1210 | #[Pure] |
1211 | -function php_sapi_name(): string|false {} |
|
1211 | +function php_sapi_name(): string | false {} |
|
1212 | 1212 | |
1213 | 1213 | /** |
1214 | 1214 | * Returns information about the operating system PHP is running on |
@@ -1235,7 +1235,7 @@ discard block |
||
1235 | 1235 | * php_ini_scanned_files. |
1236 | 1236 | */ |
1237 | 1237 | #[Pure] |
1238 | -function php_ini_scanned_files(): string|false {} |
|
1238 | +function php_ini_scanned_files(): string | false {} |
|
1239 | 1239 | |
1240 | 1240 | /** |
1241 | 1241 | * Retrieve a path to the loaded php.ini file |
@@ -1244,7 +1244,7 @@ discard block |
||
1244 | 1244 | * @since 5.2.4 |
1245 | 1245 | */ |
1246 | 1246 | #[Pure] |
1247 | -function php_ini_loaded_file(): string|false {} |
|
1247 | +function php_ini_loaded_file(): string | false {} |
|
1248 | 1248 | |
1249 | 1249 | /** |
1250 | 1250 | * String comparisons using a "natural order" algorithm |
@@ -1391,4 +1391,4 @@ discard block |
||
1391 | 1391 | * </p> |
1392 | 1392 | * @return string|false A string token. |
1393 | 1393 | */ |
1394 | -function strtok(string $string, ?string $token): string|false {} |
|
1394 | +function strtok(string $string, ?string $token): string | false {} |
@@ -8,16 +8,14 @@ discard block |
||
8 | 8 | use JetBrains\PhpStorm\Internal\TentativeType; |
9 | 9 | use JetBrains\PhpStorm\Pure; |
10 | 10 | |
11 | -class __PHP_Incomplete_Class |
|
12 | -{ |
|
11 | +class __PHP_Incomplete_Class { |
|
13 | 12 | /** |
14 | 13 | * @var string |
15 | 14 | */ |
16 | 15 | public $__PHP_Incomplete_Class_Name; |
17 | 16 | } |
18 | 17 | |
19 | -class php_user_filter |
|
20 | -{ |
|
18 | +class php_user_filter { |
|
21 | 19 | #[LanguageLevelTypeAware(['8.1' => 'string'], default: '')] |
22 | 20 | public $filtername; |
23 | 21 | |
@@ -94,8 +92,7 @@ discard block |
||
94 | 92 | /** |
95 | 93 | * Instances of Directory are created by calling the dir() function, not by the new operator. |
96 | 94 | */ |
97 | -class Directory |
|
98 | -{ |
|
95 | +class Directory { |
|
99 | 96 | /** |
100 | 97 | * @var string The directory that was opened. |
101 | 98 | */ |
@@ -80,11 +80,11 @@ discard block |
||
80 | 80 | * interrupted by an incoming signal). |
81 | 81 | */ |
82 | 82 | function stream_select( |
83 | - ?array &$read, |
|
84 | - ?array &$write, |
|
85 | - ?array &$except, |
|
86 | - ?int $seconds, |
|
87 | - #[LanguageLevelTypeAware(['8.1' => 'int|null'], default: 'int')] $microseconds |
|
83 | + ?array &$read, |
|
84 | + ?array &$write, |
|
85 | + ?array &$except, |
|
86 | + ?int $seconds, |
|
87 | + #[LanguageLevelTypeAware(['8.1' => 'int|null'], default: 'int')] $microseconds |
|
88 | 88 | ): int|false {} |
89 | 89 | |
90 | 90 | /** |
@@ -647,12 +647,12 @@ discard block |
||
647 | 647 | * @return int|false the length of the written string or false on failure. |
648 | 648 | */ |
649 | 649 | function fputcsv( |
650 | - $stream, |
|
651 | - array $fields, |
|
652 | - string $separator = ",", |
|
653 | - string $enclosure = '"', |
|
654 | - string $escape = "\\", |
|
655 | - #[PhpStormStubsElementAvailable('8.1')] string $eol = PHP_EOL |
|
650 | + $stream, |
|
651 | + array $fields, |
|
652 | + string $separator = ",", |
|
653 | + string $enclosure = '"', |
|
654 | + string $escape = "\\", |
|
655 | + #[PhpStormStubsElementAvailable('8.1')] string $eol = PHP_EOL |
|
656 | 656 | ): int|false {} |
657 | 657 | |
658 | 658 | /** |
@@ -84,8 +84,8 @@ discard block |
||
84 | 84 | ?array &$write, |
85 | 85 | ?array &$except, |
86 | 86 | ?int $seconds, |
87 | - #[LanguageLevelTypeAware(['8.1' => 'int|null'], default: 'int')] $microseconds |
|
88 | -): int|false {} |
|
87 | + #[LanguageLevelTypeAware(['8.1' => 'int|null'], default : 'int')] $microseconds |
|
88 | +): int | false {} |
|
89 | 89 | |
90 | 90 | /** |
91 | 91 | * Create a stream context |
@@ -365,7 +365,7 @@ discard block |
||
365 | 365 | * </p> |
366 | 366 | * @return resource|false the created stream, or false on error. |
367 | 367 | */ |
368 | -function stream_socket_server(string $address, &$error_code, &$error_message, int $flags = STREAM_SERVER_BIND|STREAM_SERVER_LISTEN, $context) {} |
|
368 | +function stream_socket_server(string $address, &$error_code, &$error_message, int $flags = STREAM_SERVER_BIND | STREAM_SERVER_LISTEN, $context) {} |
|
369 | 369 | |
370 | 370 | /** |
371 | 371 | * Accept a connection on a socket created by {@see stream_socket_server} |
@@ -399,7 +399,7 @@ discard block |
||
399 | 399 | * </p> |
400 | 400 | * @return string|false The name of the socket or false on error. |
401 | 401 | */ |
402 | -function stream_socket_get_name($socket, bool $remote): string|false {} |
|
402 | +function stream_socket_get_name($socket, bool $remote): string | false {} |
|
403 | 403 | |
404 | 404 | /** |
405 | 405 | * Receives data from a socket, connected or not |
@@ -438,7 +438,7 @@ discard block |
||
438 | 438 | * </p> |
439 | 439 | * @return string|false the read data, as a string, or false on error |
440 | 440 | */ |
441 | -function stream_socket_recvfrom($socket, int $length, int $flags, &$address): string|false {} |
|
441 | +function stream_socket_recvfrom($socket, int $length, int $flags, &$address): string | false {} |
|
442 | 442 | |
443 | 443 | /** |
444 | 444 | * Sends a message to a socket, whether it is connected or not |
@@ -471,7 +471,7 @@ discard block |
||
471 | 471 | * </p> |
472 | 472 | * @return int|false a result code, as an integer. |
473 | 473 | */ |
474 | -function stream_socket_sendto($socket, string $data, int $flags, string $address): int|false {} |
|
474 | +function stream_socket_sendto($socket, string $data, int $flags, string $address): int | false {} |
|
475 | 475 | |
476 | 476 | /** |
477 | 477 | * Turns encryption on/off on an already connected socket |
@@ -493,7 +493,7 @@ discard block |
||
493 | 493 | * 0 if there isn't enough data and you should try again |
494 | 494 | * (only for non-blocking sockets). |
495 | 495 | */ |
496 | -function stream_socket_enable_crypto($stream, bool $enable, ?int $crypto_method, $session_stream): int|bool {} |
|
496 | +function stream_socket_enable_crypto($stream, bool $enable, ?int $crypto_method, $session_stream): int | bool {} |
|
497 | 497 | |
498 | 498 | /** |
499 | 499 | * Shutdown a full-duplex connection |
@@ -540,7 +540,7 @@ discard block |
||
540 | 540 | * @return array|false an array with the two socket resources on success, or |
541 | 541 | * false on failure. |
542 | 542 | */ |
543 | -function stream_socket_pair(int $domain, int $type, int $protocol): array|false {} |
|
543 | +function stream_socket_pair(int $domain, int $type, int $protocol): array | false {} |
|
544 | 544 | |
545 | 545 | /** |
546 | 546 | * Copies data from one stream to another |
@@ -559,7 +559,7 @@ discard block |
||
559 | 559 | * </p> |
560 | 560 | * @return int|false the total count of bytes copied, or false on failure. |
561 | 561 | */ |
562 | -function stream_copy_to_stream($from, $to, ?int $length, int $offset): int|false {} |
|
562 | +function stream_copy_to_stream($from, $to, ?int $length, int $offset): int | false {} |
|
563 | 563 | |
564 | 564 | /** |
565 | 565 | * Reads remainder of a stream into a string |
@@ -576,7 +576,7 @@ discard block |
||
576 | 576 | * </p> |
577 | 577 | * @return string|false a string or false on failure. |
578 | 578 | */ |
579 | -function stream_get_contents($stream, ?int $length = -1, int $offset = -1): string|false {} |
|
579 | +function stream_get_contents($stream, ?int $length = -1, int $offset = -1): string | false {} |
|
580 | 580 | |
581 | 581 | /** |
582 | 582 | * Tells whether the stream supports locking. |
@@ -624,7 +624,7 @@ discard block |
||
624 | 624 | * including end of file. |
625 | 625 | * </p> |
626 | 626 | */ |
627 | -function fgetcsv($stream, ?int $length = 0, string $separator = ',', string $enclosure = '"', string $escape = '\\'): array|false {} |
|
627 | +function fgetcsv($stream, ?int $length = 0, string $separator = ',', string $enclosure = '"', string $escape = '\\'): array | false {} |
|
628 | 628 | |
629 | 629 | /** |
630 | 630 | * Format line as CSV and write to file pointer |
@@ -653,7 +653,7 @@ discard block |
||
653 | 653 | string $enclosure = '"', |
654 | 654 | string $escape = "\\", |
655 | 655 | #[PhpStormStubsElementAvailable('8.1')] string $eol = PHP_EOL |
656 | -): int|false {} |
|
656 | +): int | false {} |
|
657 | 657 | |
658 | 658 | /** |
659 | 659 | * Portable advisory file locking |
@@ -710,7 +710,7 @@ discard block |
||
710 | 710 | * </p> |
711 | 711 | */ |
712 | 712 | #[Pure] |
713 | -function get_meta_tags(string $filename, bool $use_include_path = false): array|false {} |
|
713 | +function get_meta_tags(string $filename, bool $use_include_path = false): array | false {} |
|
714 | 714 | |
715 | 715 | /** |
716 | 716 | * Sets write file buffering on the given stream |
@@ -777,7 +777,7 @@ discard block |
||
777 | 777 | * @removed 7.0 |
778 | 778 | * @see stream_set_blocking() |
779 | 779 | */ |
780 | -#[Deprecated(replacement: "stream_set_blocking(%parametersList%)", since: 5.3)] |
|
780 | +#[Deprecated(replacement : "stream_set_blocking(%parametersList%)", since : 5.3)] |
|
781 | 781 | function set_socket_blocking($socket, bool $mode): bool {} |
782 | 782 | |
783 | 783 | /** |
@@ -904,7 +904,7 @@ discard block |
||
904 | 904 | * If an error occurs, returns false. |
905 | 905 | * </p> |
906 | 906 | */ |
907 | -function stream_get_line($stream, int $length, string $ending): string|false {} |
|
907 | +function stream_get_line($stream, int $length, string $ending): string | false {} |
|
908 | 908 | |
909 | 909 | /** |
910 | 910 | * Register a URL wrapper implemented as a PHP class |
@@ -959,7 +959,7 @@ discard block |
||
959 | 959 | * @return string|false containing the resolved absolute filename, or FALSE on failure. |
960 | 960 | * @since 5.3.2 |
961 | 961 | */ |
962 | -function stream_resolve_include_path(string $filename): string|false {} |
|
962 | +function stream_resolve_include_path(string $filename): string | false {} |
|
963 | 963 | |
964 | 964 | /** |
965 | 965 | * Unregister a URL wrapper |
@@ -1024,7 +1024,7 @@ discard block |
||
1024 | 1024 | * failure. |
1025 | 1025 | */ |
1026 | 1026 | #[Pure] |
1027 | -function get_headers(string $url, #[LanguageLevelTypeAware(['8.0' => 'bool'], default: 'int')] $associative = false, $context = null): array|false {} |
|
1027 | +function get_headers(string $url, #[LanguageLevelTypeAware(['8.0' => 'bool'], default : 'int')] $associative = false, $context = null): array | false {} |
|
1028 | 1028 | |
1029 | 1029 | /** |
1030 | 1030 | * Set timeout period on a stream |
@@ -1140,7 +1140,7 @@ discard block |
||
1140 | 1140 | * </p> |
1141 | 1141 | */ |
1142 | 1142 | #[Pure(true)] |
1143 | -function realpath(string $path): string|false {} |
|
1143 | +function realpath(string $path): string | false {} |
|
1144 | 1144 | |
1145 | 1145 | /** |
1146 | 1146 | * Match filename against a pattern |
@@ -14,7 +14,7 @@ discard block |
||
14 | 14 | * feeding to date. Returns false on error. |
15 | 15 | */ |
16 | 16 | #[Pure] |
17 | -function getlastmod(): int|false {} |
|
17 | +function getlastmod(): int | false {} |
|
18 | 18 | |
19 | 19 | /** |
20 | 20 | * Decodes data encoded with MIME base64 |
@@ -30,7 +30,7 @@ discard block |
||
30 | 30 | * binary. |
31 | 31 | */ |
32 | 32 | #[Pure] |
33 | -function base64_decode(string $string, bool $strict = false): string|false {} |
|
33 | +function base64_decode(string $string, bool $strict = false): string | false {} |
|
34 | 34 | |
35 | 35 | /** |
36 | 36 | * Encodes data with MIME base64 |
@@ -63,7 +63,7 @@ discard block |
||
63 | 63 | * @return string|false the decoded data as a string. |
64 | 64 | */ |
65 | 65 | #[Pure] |
66 | -function convert_uudecode(string $string): string|false {} |
|
66 | +function convert_uudecode(string $string): string | false {} |
|
67 | 67 | |
68 | 68 | /** |
69 | 69 | * Absolute value |
@@ -78,7 +78,7 @@ discard block |
||
78 | 78 | * bigger value range than integer). |
79 | 79 | */ |
80 | 80 | #[Pure] |
81 | -function abs(int|float $num): int|float {} |
|
81 | +function abs(int | float $num): int | float {} |
|
82 | 82 | |
83 | 83 | /** |
84 | 84 | * Round fractions up |
@@ -94,7 +94,7 @@ discard block |
||
94 | 94 | */ |
95 | 95 | #[Pure] |
96 | 96 | #[LanguageLevelTypeAware(["8.0" => "float"], default: "float|false")] |
97 | -function ceil(int|float $num) {} |
|
97 | +function ceil(int | float $num) {} |
|
98 | 98 | /** |
99 | 99 | * Round fractions down |
100 | 100 | * @link https://php.net/manual/en/function.floor.php |
@@ -108,7 +108,7 @@ discard block |
||
108 | 108 | */ |
109 | 109 | #[Pure] |
110 | 110 | #[LanguageLevelTypeAware(["8.0" => "float"], default: "float|false")] |
111 | -function floor(int|float $num) {} |
|
111 | +function floor(int | float $num) {} |
|
112 | 112 | |
113 | 113 | /** |
114 | 114 | * Returns the rounded value of val to specified precision (number of digits after the decimal point). |
@@ -130,7 +130,7 @@ discard block |
||
130 | 130 | * @return float The rounded value |
131 | 131 | */ |
132 | 132 | #[Pure] |
133 | -function round(int|float $num, int $precision = 0, int $mode = PHP_ROUND_HALF_UP): float {} |
|
133 | +function round(int | float $num, int $precision = 0, int $mode = PHP_ROUND_HALF_UP): float {} |
|
134 | 134 | |
135 | 135 | /** |
136 | 136 | * Sine |
@@ -375,7 +375,7 @@ discard block |
||
375 | 375 | * If the power cannot be computed false will be returned instead. |
376 | 376 | */ |
377 | 377 | #[Pure] |
378 | -function pow(mixed $num, mixed $exponent): object|int|float {} |
|
378 | +function pow(mixed $num, mixed $exponent): object | int | float {} |
|
379 | 379 | |
380 | 380 | /** |
381 | 381 | * Calculates the exponent of <constant>e</constant> |
@@ -473,7 +473,7 @@ discard block |
||
473 | 473 | * @return int|float The decimal value of binary_string |
474 | 474 | */ |
475 | 475 | #[Pure] |
476 | -function bindec(string $binary_string): int|float {} |
|
476 | +function bindec(string $binary_string): int | float {} |
|
477 | 477 | |
478 | 478 | /** |
479 | 479 | * Hexadecimal to decimal |
@@ -484,7 +484,7 @@ discard block |
||
484 | 484 | * @return int|float The decimal representation of hex_string |
485 | 485 | */ |
486 | 486 | #[Pure] |
487 | -function hexdec(string $hex_string): int|float {} |
|
487 | +function hexdec(string $hex_string): int | float {} |
|
488 | 488 | |
489 | 489 | /** |
490 | 490 | * Octal to decimal |
@@ -495,7 +495,7 @@ discard block |
||
495 | 495 | * @return int|float The decimal representation of octal_string |
496 | 496 | */ |
497 | 497 | #[Pure] |
498 | -function octdec(string $octal_string): int|float {} |
|
498 | +function octdec(string $octal_string): int | float {} |
|
499 | 499 | |
500 | 500 | /** |
501 | 501 | * Decimal to binary |
@@ -708,7 +708,7 @@ discard block |
||
708 | 708 | * @return string|false a string representation of the address or false on failure. |
709 | 709 | */ |
710 | 710 | #[Pure] |
711 | -function inet_ntop(string $ip): string|false {} |
|
711 | +function inet_ntop(string $ip): string | false {} |
|
712 | 712 | |
713 | 713 | /** |
714 | 714 | * Converts a human readable IP address to its packed in_addr representation |
@@ -720,7 +720,7 @@ discard block |
||
720 | 720 | * address |
721 | 721 | */ |
722 | 722 | #[Pure] |
723 | -function inet_pton(string $ip): string|false {} |
|
723 | +function inet_pton(string $ip): string | false {} |
|
724 | 724 | |
725 | 725 | /** |
726 | 726 | * Converts a string containing an (IPv4) Internet Protocol dotted address into a long integer |
@@ -732,7 +732,7 @@ discard block |
||
732 | 732 | * is invalid. |
733 | 733 | */ |
734 | 734 | #[Pure] |
735 | -function ip2long(string $ip): int|false {} |
|
735 | +function ip2long(string $ip): int | false {} |
|
736 | 736 | |
737 | 737 | /** |
738 | 738 | * Converts an long integer address into a string in (IPv4) internet standard dotted format |
@@ -743,7 +743,7 @@ discard block |
||
743 | 743 | * @return string|false the Internet IP address as a string. |
744 | 744 | */ |
745 | 745 | #[Pure] |
746 | -function long2ip(int $ip): string|false {} |
|
746 | +function long2ip(int $ip): string | false {} |
|
747 | 747 | |
748 | 748 | /** |
749 | 749 | * Gets the value of an environment variable |
@@ -759,7 +759,7 @@ discard block |
||
759 | 759 | * is provided, or false on an error. |
760 | 760 | */ |
761 | 761 | #[Pure] |
762 | -function getenv(?string $name, bool $local_only = false): array|string|false {} |
|
762 | +function getenv(?string $name, bool $local_only = false): array | string | false {} |
|
763 | 763 | |
764 | 764 | /** |
765 | 765 | * Sets the value of an environment variable |
@@ -790,7 +790,7 @@ discard block |
||
790 | 790 | * @return string[]|false[]|false This function will return an array of option / argument pairs or false on |
791 | 791 | * failure. |
792 | 792 | */ |
793 | -function getopt(string $short_options, array $long_options, &$rest_index): array|false {} |
|
793 | +function getopt(string $short_options, array $long_options, &$rest_index): array | false {} |
|
794 | 794 | |
795 | 795 | /** |
796 | 796 | * Gets system load average |
@@ -800,7 +800,7 @@ discard block |
||
800 | 800 | * @since 5.1.3 |
801 | 801 | */ |
802 | 802 | #[Pure] |
803 | -function sys_getloadavg(): array|false {} |
|
803 | +function sys_getloadavg(): array | false {} |
|
804 | 804 | |
805 | 805 | /** |
806 | 806 | * Return current Unix timestamp with microseconds |
@@ -819,7 +819,7 @@ discard block |
||
819 | 819 | * @return string|float |
820 | 820 | */ |
821 | 821 | #[Pure(true)] |
822 | -function microtime(#[TypeContract(true: "float", false: "string")] bool $as_float = false): string|float {} |
|
822 | +function microtime(#[TypeContract(true : "float", false : "string")] bool $as_float = false): string | float {} |
|
823 | 823 | |
824 | 824 | /** |
825 | 825 | * Get current time |
@@ -839,7 +839,7 @@ discard block |
||
839 | 839 | */ |
840 | 840 | #[Pure] |
841 | 841 | #[ArrayShape(["sec" => "int", "usec" => "int", "minuteswest" => "int", "dsttime" => "int"])] |
842 | -function gettimeofday(#[TypeContract(true: "float", false: "int[]")] bool $as_float = false): array|float {} |
|
842 | +function gettimeofday(#[TypeContract(true : "float", false : "int[]")] bool $as_float = false): array | float {} |
|
843 | 843 | |
844 | 844 | /** |
845 | 845 | * Gets the current resource usages |
@@ -852,7 +852,7 @@ discard block |
||
852 | 852 | * call. All entries are accessible by using their documented field names. |
853 | 853 | */ |
854 | 854 | #[Pure] |
855 | -function getrusage(int $mode): array|false {} |
|
855 | +function getrusage(int $mode): array | false {} |
|
856 | 856 | |
857 | 857 | /** |
858 | 858 | * Generate a unique ID |
@@ -918,7 +918,7 @@ discard block |
||
918 | 918 | * @see UConverter |
919 | 919 | */ |
920 | 920 | #[Pure] |
921 | -#[Deprecated(since: '7.4', reason: 'Us mb_convert_string(), iconv() or UConverter instead.')] |
|
921 | +#[Deprecated(since : '7.4', reason : 'Us mb_convert_string(), iconv() or UConverter instead.')] |
|
922 | 922 | function convert_cyr_string(string $str, string $from, string $to): string {} |
923 | 923 | |
924 | 924 | /** |
@@ -950,7 +950,7 @@ discard block |
||
950 | 950 | * option, or false if an error occurs. |
951 | 951 | */ |
952 | 952 | #[Pure] |
953 | -function get_cfg_var(string $option): array|string|false {} |
|
953 | +function get_cfg_var(string $option): array | string | false {} |
|
954 | 954 | |
955 | 955 | /** |
956 | 956 | * Alias: |
@@ -959,7 +959,7 @@ discard block |
||
959 | 959 | * @param bool $new_setting |
960 | 960 | * @removed 7.0 |
961 | 961 | */ |
962 | -#[Deprecated(since: '5.3')] |
|
962 | +#[Deprecated(since : '5.3')] |
|
963 | 963 | function magic_quotes_runtime(bool $new_setting) {} |
964 | 964 | |
965 | 965 | /** |
@@ -971,7 +971,7 @@ discard block |
||
971 | 971 | * @return bool true on success or false on failure. |
972 | 972 | * @removed 7.0 |
973 | 973 | */ |
974 | -#[Deprecated(reason: "This function has been DEPRECATED as of PHP 5.4.0. Raises an E_CORE_ERROR", since: "5.3")] |
|
974 | +#[Deprecated(reason : "This function has been DEPRECATED as of PHP 5.4.0. Raises an E_CORE_ERROR", since : "5.3")] |
|
975 | 975 | function set_magic_quotes_runtime(bool $new_setting): bool {} |
976 | 976 | |
977 | 977 | /** |
@@ -980,7 +980,7 @@ discard block |
||
980 | 980 | * @return int 0 if magic quotes gpc are off, 1 otherwise. |
981 | 981 | * @removed 8.0 |
982 | 982 | */ |
983 | -#[Deprecated(since: '7.4')] |
|
983 | +#[Deprecated(since : '7.4')] |
|
984 | 984 | function get_magic_quotes_gpc(): int {} |
985 | 985 | |
986 | 986 | /** |
@@ -988,7 +988,7 @@ discard block |
||
988 | 988 | * @link https://php.net/manual/en/function.get-magic-quotes-runtime.php |
989 | 989 | * @return int 0 if magic quotes runtime is off, 1 otherwise. |
990 | 990 | */ |
991 | -#[Deprecated(since: '7.4')] |
|
991 | +#[Deprecated(since : '7.4')] |
|
992 | 992 | function get_magic_quotes_runtime(): int {} |
993 | 993 | |
994 | 994 | /** |
@@ -1024,7 +1024,7 @@ discard block |
||
1024 | 1024 | * @return bool true on success or false on failure. |
1025 | 1025 | * @removed 5.4 |
1026 | 1026 | */ |
1027 | -#[Deprecated(reason: "This function has been DEPRECATED as of PHP 5.3.0", since: "5.3")] |
|
1027 | +#[Deprecated(reason : "This function has been DEPRECATED as of PHP 5.3.0", since : "5.3")] |
|
1028 | 1028 | function import_request_variables(string $types, $prefix = null): bool {} |
1029 | 1029 | |
1030 | 1030 | /** |
@@ -215,9 +215,9 @@ discard block |
||
215 | 215 | * @return void |
216 | 216 | */ |
217 | 217 | function debug_zval_dump( |
218 | - #[PhpStormStubsElementAvailable(from: '8.0')] mixed $value, |
|
219 | - #[PhpStormStubsElementAvailable(from: '5.3', to: '7.4')] $values, |
|
220 | - mixed ...$values |
|
218 | + #[PhpStormStubsElementAvailable(from: '8.0')] mixed $value, |
|
219 | + #[PhpStormStubsElementAvailable(from: '5.3', to: '7.4')] $values, |
|
220 | + mixed ...$values |
|
221 | 221 | ): void {} |
222 | 222 | |
223 | 223 | /** |
@@ -366,8 +366,8 @@ discard block |
||
366 | 366 | */ |
367 | 367 | #[Pure] |
368 | 368 | function hrtime( |
369 | - #[PhpStormStubsElementAvailable(from: '7.3', to: '7.4')] bool $as_number, |
|
370 | - #[PhpStormStubsElementAvailable(from: '8.0')] bool $as_number = false |
|
369 | + #[PhpStormStubsElementAvailable(from: '7.3', to: '7.4')] bool $as_number, |
|
370 | + #[PhpStormStubsElementAvailable(from: '8.0')] bool $as_number = false |
|
371 | 371 | ): array|int|float|false {} |
372 | 372 | |
373 | 373 | /** |
@@ -62,7 +62,7 @@ discard block |
||
62 | 62 | * @removed 7.0 |
63 | 63 | * @see call_user_func() |
64 | 64 | */ |
65 | -#[Deprecated(reason: "use call_user_func() instead", since: "5.3")] |
|
65 | +#[Deprecated(reason : "use call_user_func() instead", since : "5.3")] |
|
66 | 66 | function call_user_method(string $method_name, object &$obj, ...$parameter): mixed {} |
67 | 67 | |
68 | 68 | /** |
@@ -75,7 +75,7 @@ discard block |
||
75 | 75 | * @removed 7.0 |
76 | 76 | * @see call_user_func() |
77 | 77 | */ |
78 | -#[Deprecated(reason: "use call_user_func() instead", since: "5.3")] |
|
78 | +#[Deprecated(reason : "use call_user_func() instead", since : "5.3")] |
|
79 | 79 | function call_user_method_array(string $method_name, object &$obj, array $params): mixed {} |
80 | 80 | |
81 | 81 | /** |
@@ -187,7 +187,7 @@ discard block |
||
187 | 187 | * @param mixed ...$values [optional] |
188 | 188 | * @return void |
189 | 189 | */ |
190 | -function var_dump(mixed $value, #[PhpStormStubsElementAvailable(from: '8.0')] mixed ...$values): void {} |
|
190 | +function var_dump(mixed $value, #[PhpStormStubsElementAvailable(from : '8.0')] mixed ...$values): void {} |
|
191 | 191 | |
192 | 192 | /** |
193 | 193 | * Outputs or returns a parsable string representation of a variable |
@@ -215,8 +215,8 @@ discard block |
||
215 | 215 | * @return void |
216 | 216 | */ |
217 | 217 | function debug_zval_dump( |
218 | - #[PhpStormStubsElementAvailable(from: '8.0')] mixed $value, |
|
219 | - #[PhpStormStubsElementAvailable(from: '5.3', to: '7.4')] $values, |
|
218 | + #[PhpStormStubsElementAvailable(from : '8.0')] mixed $value, |
|
219 | + #[PhpStormStubsElementAvailable(from : '5.3', to : '7.4')] $values, |
|
220 | 220 | mixed ...$values |
221 | 221 | ): void {} |
222 | 222 | |
@@ -237,7 +237,7 @@ discard block |
||
237 | 237 | * will be presented in a format that shows keys and elements. Similar |
238 | 238 | * notation is used for objects. |
239 | 239 | */ |
240 | -function print_r(mixed $value, bool $return = false): string|bool {} |
|
240 | +function print_r(mixed $value, bool $return = false): string | bool {} |
|
241 | 241 | |
242 | 242 | /** |
243 | 243 | * Returns the amount of memory allocated to PHP |
@@ -328,7 +328,7 @@ discard block |
||
328 | 328 | * code as a string instead of printing it out. Otherwise, it will return |
329 | 329 | * true on success, false on failure. |
330 | 330 | */ |
331 | -function highlight_file(string $filename, bool $return = false): string|bool {} |
|
331 | +function highlight_file(string $filename, bool $return = false): string | bool {} |
|
332 | 332 | |
333 | 333 | /** |
334 | 334 | * Alias: |
@@ -338,7 +338,7 @@ discard block |
||
338 | 338 | * @param bool $return [optional] |
339 | 339 | * @return string|bool |
340 | 340 | */ |
341 | -function show_source(string $filename, bool $return = false): string|bool {} |
|
341 | +function show_source(string $filename, bool $return = false): string | bool {} |
|
342 | 342 | |
343 | 343 | /** |
344 | 344 | * Syntax highlighting of a string |
@@ -354,7 +354,7 @@ discard block |
||
354 | 354 | * code as a string instead of printing it out. Otherwise, it will return |
355 | 355 | * true on success, false on failure. |
356 | 356 | */ |
357 | -function highlight_string(string $string, bool $return = false): string|bool {} |
|
357 | +function highlight_string(string $string, bool $return = false): string | bool {} |
|
358 | 358 | |
359 | 359 | /** |
360 | 360 | * Get the system's high resolution time |
@@ -366,9 +366,9 @@ discard block |
||
366 | 366 | */ |
367 | 367 | #[Pure] |
368 | 368 | function hrtime( |
369 | - #[PhpStormStubsElementAvailable(from: '7.3', to: '7.4')] bool $as_number, |
|
370 | - #[PhpStormStubsElementAvailable(from: '8.0')] bool $as_number = false |
|
371 | -): array|int|float|false {} |
|
369 | + #[PhpStormStubsElementAvailable(from : '7.3', to : '7.4')] bool $as_number, |
|
370 | + #[PhpStormStubsElementAvailable(from : '8.0')] bool $as_number = false |
|
371 | +): array | int | float | false {} |
|
372 | 372 | |
373 | 373 | /** |
374 | 374 | * Return source with stripped comments and whitespace |
@@ -399,7 +399,7 @@ discard block |
||
399 | 399 | * an empty string on failure or for null values. |
400 | 400 | */ |
401 | 401 | #[Pure] |
402 | -function ini_get(string $option): string|false {} |
|
402 | +function ini_get(string $option): string | false {} |
|
403 | 403 | |
404 | 404 | /** |
405 | 405 | * Gets all configuration options |
@@ -435,7 +435,7 @@ discard block |
||
435 | 435 | * </p> |
436 | 436 | */ |
437 | 437 | #[Pure] |
438 | -function ini_get_all(?string $extension, bool $details = true): array|false {} |
|
438 | +function ini_get_all(?string $extension, bool $details = true): array | false {} |
|
439 | 439 | |
440 | 440 | /** |
441 | 441 | * Sets the value of a configuration option |
@@ -453,7 +453,7 @@ discard block |
||
453 | 453 | * </p> |
454 | 454 | * @return string|false the old value on success, false on failure. |
455 | 455 | */ |
456 | -function ini_set(string $option, #[LanguageLevelTypeAware(['8.1' => 'string|int|float|bool|null'], default: 'string')] $value): string|false {} |
|
456 | +function ini_set(string $option, #[LanguageLevelTypeAware(['8.1' => 'string|int|float|bool|null'], default : 'string')] $value): string | false {} |
|
457 | 457 | |
458 | 458 | /** |
459 | 459 | * Alias: |
@@ -464,7 +464,7 @@ discard block |
||
464 | 464 | * @param string $value |
465 | 465 | * @return string|false |
466 | 466 | */ |
467 | -function ini_alter(string $option, #[LanguageLevelTypeAware(['8.1' => 'string|int|float|bool|null'], default: 'string')] $value): string|false {} |
|
467 | +function ini_alter(string $option, #[LanguageLevelTypeAware(['8.1' => 'string|int|float|bool|null'], default : 'string')] $value): string | false {} |
|
468 | 468 | |
469 | 469 | /** |
470 | 470 | * Restores the value of a configuration option |
@@ -483,7 +483,7 @@ discard block |
||
483 | 483 | * @return string|false the path, as a string. |
484 | 484 | */ |
485 | 485 | #[Pure] |
486 | -function get_include_path(): string|false {} |
|
486 | +function get_include_path(): string | false {} |
|
487 | 487 | |
488 | 488 | /** |
489 | 489 | * Sets the include_path configuration option |
@@ -494,7 +494,7 @@ discard block |
||
494 | 494 | * @return string|false the old include_path on |
495 | 495 | * success or false on failure. |
496 | 496 | */ |
497 | -function set_include_path(string $include_path): string|false {} |
|
497 | +function set_include_path(string $include_path): string | false {} |
|
498 | 498 | |
499 | 499 | /** |
500 | 500 | * Restores the value of the include_path configuration option |
@@ -502,7 +502,7 @@ discard block |
||
502 | 502 | * @return void |
503 | 503 | * @removed 8.0 |
504 | 504 | */ |
505 | -#[Deprecated(since: '7.4')] |
|
505 | +#[Deprecated(since : '7.4')] |
|
506 | 506 | function restore_include_path() {} |
507 | 507 | |
508 | 508 | /** |
@@ -721,7 +721,7 @@ discard block |
||
721 | 721 | * @return array|false An associative array of all the HTTP headers in the current request, or <b>FALSE</b> on failure. |
722 | 722 | */ |
723 | 723 | #[Pure] |
724 | -function apache_request_headers(): false|array {} |
|
724 | +function apache_request_headers(): false | array {} |
|
725 | 725 | |
726 | 726 | /** |
727 | 727 | * Fetches all HTTP headers from the current request. |
@@ -730,7 +730,7 @@ discard block |
||
730 | 730 | * @return array|false An associative array of all the HTTP headers in the current request, or <b>FALSE</b> on failure. |
731 | 731 | */ |
732 | 732 | #[Pure] |
733 | -function getallheaders(): false|array {} |
|
733 | +function getallheaders(): false | array {} |
|
734 | 734 | |
735 | 735 | /** |
736 | 736 | * Check whether client disconnected |
@@ -791,7 +791,7 @@ discard block |
||
791 | 791 | * and false on failure. |
792 | 792 | */ |
793 | 793 | #[Pure(true)] |
794 | -function parse_ini_file(string $filename, bool $process_sections = false, int $scanner_mode = INI_SCANNER_NORMAL): array|false {} |
|
794 | +function parse_ini_file(string $filename, bool $process_sections = false, int $scanner_mode = INI_SCANNER_NORMAL): array | false {} |
|
795 | 795 | |
796 | 796 | /** |
797 | 797 | * Parse a configuration string |
@@ -814,7 +814,7 @@ discard block |
||
814 | 814 | * and false on failure. |
815 | 815 | */ |
816 | 816 | #[Pure] |
817 | -function parse_ini_string(string $ini_string, bool $process_sections = false, int $scanner_mode = INI_SCANNER_NORMAL): array|false {} |
|
817 | +function parse_ini_string(string $ini_string, bool $process_sections = false, int $scanner_mode = INI_SCANNER_NORMAL): array | false {} |
|
818 | 818 | |
819 | 819 | /** |
820 | 820 | * Tells whether the file was uploaded via HTTP POST |
@@ -854,7 +854,7 @@ discard block |
||
854 | 854 | * @since 7.3 |
855 | 855 | */ |
856 | 856 | #[Pure] |
857 | -function net_get_interfaces(): array|false {} |
|
857 | +function net_get_interfaces(): array | false {} |
|
858 | 858 | |
859 | 859 | /** |
860 | 860 | * Get the Internet host name corresponding to a given IP address |
@@ -866,7 +866,7 @@ discard block |
||
866 | 866 | * on failure. |
867 | 867 | */ |
868 | 868 | #[Pure] |
869 | -function gethostbyaddr(string $ip): string|false {} |
|
869 | +function gethostbyaddr(string $ip): string | false {} |
|
870 | 870 | |
871 | 871 | /** |
872 | 872 | * Get the IPv4 address corresponding to a given Internet host name |
@@ -891,7 +891,7 @@ discard block |
||
891 | 891 | * hostname could not be resolved. |
892 | 892 | */ |
893 | 893 | #[Pure] |
894 | -function gethostbynamel(string $hostname): array|false {} |
|
894 | +function gethostbynamel(string $hostname): array | false {} |
|
895 | 895 | |
896 | 896 | /** |
897 | 897 | * Gets the host name |
@@ -900,7 +900,7 @@ discard block |
||
900 | 900 | * returned. |
901 | 901 | */ |
902 | 902 | #[Pure] |
903 | -function gethostname(): string|false {} |
|
903 | +function gethostname(): string | false {} |
|
904 | 904 | |
905 | 905 | /** |
906 | 906 | * Alias: |
@@ -1172,4 +1172,4 @@ discard block |
||
1172 | 1172 | * </tr> |
1173 | 1173 | * </table> |
1174 | 1174 | */ |
1175 | -function dns_get_record(string $hostname, int $type = DNS_ANY, &$authoritative_name_servers, &$additional_records, bool $raw = false): array|false {} |
|
1175 | +function dns_get_record(string $hostname, int $type = DNS_ANY, &$authoritative_name_servers, &$additional_records, bool $raw = false): array | false {} |
@@ -231,9 +231,9 @@ |
||
231 | 231 | * @return void |
232 | 232 | */ |
233 | 233 | function parse_str( |
234 | - string $string, |
|
235 | - #[PhpStormStubsElementAvailable(from: '5.3', to: '7.4')] &$result = [], |
|
236 | - #[PhpStormStubsElementAvailable(from: '8.0')] &$result |
|
234 | + string $string, |
|
235 | + #[PhpStormStubsElementAvailable(from: '5.3', to: '7.4')] &$result = [], |
|
236 | + #[PhpStormStubsElementAvailable(from: '8.0')] &$result |
|
237 | 237 | ): void {} |
238 | 238 | |
239 | 239 | /** |
@@ -152,7 +152,7 @@ discard block |
||
152 | 152 | * is not valid. |
153 | 153 | */ |
154 | 154 | #[Pure] |
155 | -function nl_langinfo(int $item): string|false {} |
|
155 | +function nl_langinfo(int $item): string | false {} |
|
156 | 156 | |
157 | 157 | /** |
158 | 158 | * Calculate the soundex key of a string |
@@ -232,8 +232,8 @@ discard block |
||
232 | 232 | */ |
233 | 233 | function parse_str( |
234 | 234 | string $string, |
235 | - #[PhpStormStubsElementAvailable(from: '5.3', to: '7.4')] &$result = [], |
|
236 | - #[PhpStormStubsElementAvailable(from: '8.0')] &$result |
|
235 | + #[PhpStormStubsElementAvailable(from: '5.3', to: '7.4')] & $result = [], |
|
236 | + #[PhpStormStubsElementAvailable(from: '8.0')] & $result |
|
237 | 237 | ): void {} |
238 | 238 | |
239 | 239 | /** |
@@ -311,7 +311,7 @@ discard block |
||
311 | 311 | * @return string|false Returns the portion of string, or FALSE if needle is not found. |
312 | 312 | */ |
313 | 313 | #[Pure] |
314 | -function strchr(string $haystack, string $needle, bool $before_needle = false): string|false {} |
|
314 | +function strchr(string $haystack, string $needle, bool $before_needle = false): string | false {} |
|
315 | 315 | |
316 | 316 | /** |
317 | 317 | * Return a formatted string |
@@ -435,7 +435,7 @@ discard block |
||
435 | 435 | * the function will return the number of assigned values. The optional |
436 | 436 | * parameters must be passed by reference. |
437 | 437 | */ |
438 | -function sscanf(string $string, string $format, #[TypeContract(exists: "int|null", notExists: "array|null")] mixed &...$vars): array|int|null {} |
|
438 | +function sscanf(string $string, string $format, #[TypeContract(exists: "int|null", notExists: "array|null")] mixed &...$vars): array | int | null {} |
|
439 | 439 | |
440 | 440 | /** |
441 | 441 | * Parses input from a file according to a format |
@@ -451,7 +451,7 @@ discard block |
||
451 | 451 | * function will return the number of assigned values. The optional |
452 | 452 | * parameters must be passed by reference. |
453 | 453 | */ |
454 | -function fscanf($stream, string $format, #[TypeContract(exists: "int|false|null", notExists: "array|false|null")] mixed &...$vars): array|int|false|null {} |
|
454 | +function fscanf($stream, string $format, #[TypeContract(exists: "int|false|null", notExists: "array|false|null")] mixed &...$vars): array | int | false | null {} |
|
455 | 455 | |
456 | 456 | /** |
457 | 457 | * Parse a URL and return its components |
@@ -486,7 +486,7 @@ discard block |
||
486 | 486 | */ |
487 | 487 | #[ArrayShape(["scheme" => "string", "host" => "string", "port" => "int", "user" => "string", "pass" => "string", "query" => "string", "path" => "string", "fragment" => "string"])] |
488 | 488 | #[Pure] |
489 | -function parse_url(string $url, int $component = -1): array|string|int|false|null {} |
|
489 | +function parse_url(string $url, int $component = -1): array | string | int | false | null {} |
|
490 | 490 | |
491 | 491 | /** |
492 | 492 | * URL-encodes string |
@@ -580,7 +580,7 @@ discard block |
||
580 | 580 | * @return string a URL-encoded string. |
581 | 581 | */ |
582 | 582 | #[Pure] |
583 | -function http_build_query(object|array $data, string $numeric_prefix = "", ?string $arg_separator = "&", int $encoding_type = PHP_QUERY_RFC1738): string {} |
|
583 | +function http_build_query(object | array $data, string $numeric_prefix = "", ?string $arg_separator = "&", int $encoding_type = PHP_QUERY_RFC1738): string {} |
|
584 | 584 | |
585 | 585 | /** |
586 | 586 | * Returns the target of a symbolic link |
@@ -591,7 +591,7 @@ discard block |
||
591 | 591 | * @return string|false the contents of the symbolic link path or false on error. |
592 | 592 | */ |
593 | 593 | #[Pure(true)] |
594 | -function readlink(string $path): string|false {} |
|
594 | +function readlink(string $path): string | false {} |
|
595 | 595 | |
596 | 596 | /** |
597 | 597 | * Gets information about a link |
@@ -604,7 +604,7 @@ discard block |
||
604 | 604 | * system call. Returns 0 or false in case of error. |
605 | 605 | */ |
606 | 606 | #[Pure(true)] |
607 | -function linkinfo(string $path): int|false {} |
|
607 | +function linkinfo(string $path): int | false {} |
|
608 | 608 | |
609 | 609 | /** |
610 | 610 | * Creates a symbolic link |
@@ -669,7 +669,7 @@ discard block |
||
669 | 669 | * To get the output of the executed command, be sure to set and use the |
670 | 670 | * output parameter. |
671 | 671 | */ |
672 | -function exec(string $command, &$output, &$result_code): string|false {} |
|
672 | +function exec(string $command, &$output, &$result_code): string | false {} |
|
673 | 673 | |
674 | 674 | /** |
675 | 675 | * Execute an external program and display the output |
@@ -685,7 +685,7 @@ discard block |
||
685 | 685 | * @return string|false the last line of the command output on success, and false |
686 | 686 | * on failure. |
687 | 687 | */ |
688 | -function system(string $command, &$result_code): string|false {} |
|
688 | +function system(string $command, &$result_code): string | false {} |
|
689 | 689 | |
690 | 690 | /** |
691 | 691 | * Escape shell metacharacters |
@@ -731,7 +731,7 @@ discard block |
||
731 | 731 | * </p> |
732 | 732 | * @return string|false|null The output from the executed command or NULL if an error occurred or the command produces no output. |
733 | 733 | */ |
734 | -function shell_exec(string $command): string|false|null {} |
|
734 | +function shell_exec(string $command): string | false | null {} |
|
735 | 735 | |
736 | 736 | /** |
737 | 737 | * Execute a command and open file pointers for input/output |
@@ -803,7 +803,7 @@ discard block |
||
803 | 803 | * proc_close when you are finished with it. On failure |
804 | 804 | * returns false. |
805 | 805 | */ |
806 | -function proc_open(array|string $command, array $descriptor_spec, &$pipes, ?string $cwd, ?array $env_vars, ?array $options) {} |
|
806 | +function proc_open(array | string $command, array $descriptor_spec, &$pipes, ?string $cwd, ?array $env_vars, ?array $options) {} |
|
807 | 807 | |
808 | 808 | /** |
809 | 809 | * Close a process opened by {@see proc_open} and return the exit code of that process |
@@ -909,7 +909,7 @@ discard block |
||
909 | 909 | * </tr> |
910 | 910 | */ |
911 | 911 | #[ArrayShape(["command" => "string", "pid" => "int", "running" => "bool", "signaled" => "bool", "stopped" => "bool", "exitcode" => "int", "termsig" => "int", "stopsig" => "int"])] |
912 | -#[LanguageLevelTypeAware(["8.0" => "array"], default: "array|false")] |
|
912 | +#[LanguageLevelTypeAware(["8.0" => "array"], default : "array|false")] |
|
913 | 913 | function proc_get_status($process) {} |
914 | 914 | |
915 | 915 | /** |
@@ -1008,7 +1008,7 @@ discard block |
||
1008 | 1008 | * protocol is not found. |
1009 | 1009 | */ |
1010 | 1010 | #[Pure] |
1011 | -function getservbyname(string $service, string $protocol): int|false {} |
|
1011 | +function getservbyname(string $service, string $protocol): int | false {} |
|
1012 | 1012 | |
1013 | 1013 | /** |
1014 | 1014 | * Get Internet service which corresponds to port and protocol |
@@ -1023,7 +1023,7 @@ discard block |
||
1023 | 1023 | * @return string|false the Internet service name as a string. |
1024 | 1024 | */ |
1025 | 1025 | #[Pure] |
1026 | -function getservbyport(int $port, string $protocol): string|false {} |
|
1026 | +function getservbyport(int $port, string $protocol): string | false {} |
|
1027 | 1027 | |
1028 | 1028 | /** |
1029 | 1029 | * Get protocol number associated with protocol name |
@@ -1034,7 +1034,7 @@ discard block |
||
1034 | 1034 | * @return int|false the protocol number or -1 if the protocol is not found. |
1035 | 1035 | */ |
1036 | 1036 | #[Pure] |
1037 | -function getprotobyname(string $protocol): int|false {} |
|
1037 | +function getprotobyname(string $protocol): int | false {} |
|
1038 | 1038 | |
1039 | 1039 | /** |
1040 | 1040 | * Get protocol name associated with protocol number |
@@ -1045,7 +1045,7 @@ discard block |
||
1045 | 1045 | * @return string|false the protocol name as a string. |
1046 | 1046 | */ |
1047 | 1047 | #[Pure] |
1048 | -function getprotobynumber(int $protocol): string|false {} |
|
1048 | +function getprotobynumber(int $protocol): string | false {} |
|
1049 | 1049 | |
1050 | 1050 | /** |
1051 | 1051 | * Gets PHP script owner's UID |
@@ -1053,7 +1053,7 @@ discard block |
||
1053 | 1053 | * @return int|false the user ID of the current script, or false on error. |
1054 | 1054 | */ |
1055 | 1055 | #[Pure] |
1056 | -function getmyuid(): int|false {} |
|
1056 | +function getmyuid(): int | false {} |
|
1057 | 1057 | |
1058 | 1058 | /** |
1059 | 1059 | * Get PHP script owner's GID |
@@ -1061,7 +1061,7 @@ discard block |
||
1061 | 1061 | * @return int|false the group ID of the current script, or false on error. |
1062 | 1062 | */ |
1063 | 1063 | #[Pure] |
1064 | -function getmygid(): int|false {} |
|
1064 | +function getmygid(): int | false {} |
|
1065 | 1065 | |
1066 | 1066 | /** |
1067 | 1067 | * Gets PHP's process ID |
@@ -1069,7 +1069,7 @@ discard block |
||
1069 | 1069 | * @return int|false the current PHP process ID, or false on error. |
1070 | 1070 | */ |
1071 | 1071 | #[Pure] |
1072 | -function getmypid(): int|false {} |
|
1072 | +function getmypid(): int | false {} |
|
1073 | 1073 | |
1074 | 1074 | /** |
1075 | 1075 | * Gets the inode of the current script |
@@ -1077,4 +1077,4 @@ discard block |
||
1077 | 1077 | * @return int|false the current script's inode as an integer, or false on error. |
1078 | 1078 | */ |
1079 | 1079 | #[Pure] |
1080 | -function getmyinode(): int|false {} |
|
1080 | +function getmyinode(): int | false {} |
@@ -125,7 +125,7 @@ |
||
125 | 125 | * @return string |
126 | 126 | * @since 7.1 |
127 | 127 | */ |
128 | -function sapi_windows_cp_conv(int|string $in_codepage, int|string $out_codepage, string $subject): string {} |
|
128 | +function sapi_windows_cp_conv(int | string $in_codepage, int | string $out_codepage, string $subject): string {} |
|
129 | 129 | |
130 | 130 | /** |
131 | 131 | * Indicates whether the codepage is utf-8 compatible |