-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathphpmapscript.html
More file actions
3755 lines (3684 loc) · 155 KB
/
phpmapscript.html
File metadata and controls
3755 lines (3684 loc) · 155 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="ja" data-content_root="../../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>PHP MapScript API — MapServer 8.6.2 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="../../_static/sphinx.css?v=48f05237" />
<link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="../../_static/sphinx_collapse.css?v=226d88b4" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css?v=dd298242" />
<link rel="stylesheet" type="text/css" href="../../_static/ribbon.css?v=ea091bf4" />
<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=0377e500"></script>
<script src="../../_static/doctools.js?v=fd6eb6e6"></script>
<script src="../../_static/sphinx_highlight.js?v=6ffebe34"></script>
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../../_static/copybutton.js?v=f281be69"></script>
<script src="../../_static/translations.js?v=4755f45a"></script>
<link rel="icon" href="../../_static/mapserver.ico"/>
<link rel="author" title="このドキュメントについて" href="../../about.html" />
<link rel="index" title="索引" href="../../genindex.html" />
<link rel="search" title="検索" href="../../search.html" />
<link rel="copyright" title="著作権" href="../../copyright.html" />
<link rel="next" title="PHP MapScript Migration Guide" href="migration_guide.html" />
<link rel="prev" title="PHP MapScript" href="php_intro.html" />
</head><body>
<!-- for main branch only, do not backport this -->
<table width="100%" style="width: 100%; background-color: white;">
<tr>
<td rowspan="2" style="padding: 10px 0px 10px 10px;">
<a href="../../index.html" title="Home"><img src="../../_static/banner.png" alt="MapServer banner" border="0" /></a>
</td>
<td style="padding: 10px 10px 0px 0px; text-align: right; vertical-align: top;">
<a href="../../index.html" title="Home">Home</a> |
<a href="../../products.html" title="Products (MapServer core, MapCache, TinyOWS">Products</a> |
<a href="https://github.com/mapserver/mapserver/issues/" title="Issue Tracker (MapServer core)">Issue Tracker</a> |
<a href="../../community/service_providers.html" title="Professional Service Providers">Service Providers</a> |
<a href="../../faq.html" title="Frequently Asked Questions">FAQ</a> |
<a href="https://fosstodon.org/@mapserver" title="Mastodon" target="_blank">Mastodon</a> |
<a href="../../download.html" title="Download Source or Binaries">Download </a> |
<a class="badge" href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=KRJ2X44N3HA6U&source=url" target="_blank">
<img src="https://img.shields.io/badge/donate-%E2%9D%A4%C2%A0-ff69b4.svg?style=flat" alt="Donate to MapServer">
</a>
</td>
</tr>
<tr>
<td style="padding: 0px 10px 0px 0px; text-align: right; vertical-align: bottom;">
<a href="../../../mapscript/php/phpmapscript.html"><img src="../../_static/flagicons/en.png" alt="en" title="en" border="0" /></a>
<a href="../../../ar/mapscript/php/phpmapscript.html"><img src="../../_static/flagicons/ar.png" alt="ar" title="ar" border="0" /></a>
<a href="../../../de/mapscript/php/phpmapscript.html"><img src="../../_static/flagicons/de.png" alt="de" title="de" border="0" /></a>
<a href="../../../el/mapscript/php/phpmapscript.html"><img src="../../_static/flagicons/el.png" alt="el" title="el" border="0" /></a>
<a href="../../../es/mapscript/php/phpmapscript.html"><img src="../../_static/flagicons/es.png" alt="es" title="es" border="0" /></a>
<a href="../../../fr/mapscript/php/phpmapscript.html"><img src="../../_static/flagicons/fr.png" alt="fr" title="fr" border="0" /></a>
<a href="../../../id/mapscript/php/phpmapscript.html"><img src="../../_static/flagicons/id.png" alt="id" title="id" border="0" /></a>
<a href="../../../it/mapscript/php/phpmapscript.html"><img src="../../_static/flagicons/it.png" alt="it" title="it" border="0" /></a>
<img src="../../_static/flagicons/ja.png" alt="ja" title="ja" border="0" width="18px" height="13px"/>
<a href="../../../nl_NL/mapscript/php/phpmapscript.html"><img src="../../_static/flagicons/nl_NL.png" alt="nl_NL" title="nl_NL" border="0" /></a>
<a href="../../../pl/mapscript/php/phpmapscript.html"><img src="../../_static/flagicons/pl.png" alt="pl" title="pl" border="0" /></a>
<a href="../../../ru/mapscript/php/phpmapscript.html"><img src="../../_static/flagicons/ru.png" alt="ru" title="ru" border="0" /></a>
<a href="../../../sq/mapscript/php/phpmapscript.html"><img src="../../_static/flagicons/sq.png" alt="sq" title="sq" border="0" /></a>
<a href="../../../tr/mapscript/php/phpmapscript.html"><img src="../../_static/flagicons/tr.png" alt="tr" title="tr" border="0" /></a>
</td>
</tr>
</table>
<div class="related" role="navigation" aria-label="Related">
<h3>ナビゲーション</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="総合索引"
accesskey="I">索引</a></li>
<li class="right" >
<a href="migration_guide.html" title="PHP MapScript Migration Guide"
accesskey="N">次へ</a> |</li>
<li class="right" >
<a href="php_intro.html" title="PHP MapScript"
accesskey="P">前へ</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">Home</a> »</li>
<li class="nav-item nav-item-1"><a href="../../documentation.html" >MapServer 8.6.2 Documentation</a> »</li>
<li class="nav-item nav-item-2"><a href="../index.html" >MapScript</a> »</li>
<li class="nav-item nav-item-3"><a href="index.html" accesskey="U">PHP MapScript</a> »</li>
<li class="nav-item nav-item-this"><a href="">PHP MapScript API</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="php-mapscript-api">
<span id="phpmapscriptapi"></span><h1><a class="toc-backref" href="#id1" role="doc-backlink">PHP MapScript API</a><a class="headerlink" href="#php-mapscript-api" title="Link to this heading">¶</a></h1>
<dl class="field-list">
<dt class="field-odd">Author<span class="colon">:</span></dt>
<dd class="field-odd"><p>Daniel Morissette</p>
</dd>
<dt class="field-even">Contact<span class="colon">:</span></dt>
<dd class="field-even"><p>dmorissette at mapgears.com</p>
</dd>
<dt class="field-odd">Author<span class="colon">:</span></dt>
<dd class="field-odd"><p>Yewondwossen Assefa</p>
</dd>
<dt class="field-even">Author<span class="colon">:</span></dt>
<dd class="field-even"><p>Alan Boudreault</p>
</dd>
<dt class="field-odd">Contact<span class="colon">:</span></dt>
<dd class="field-odd"><p>aboudreault at mapgears.com</p>
</dd>
<dt class="field-even">Author<span class="colon">:</span></dt>
<dd class="field-even"><p>Jeff McKenna</p>
</dd>
<dt class="field-odd">Contact<span class="colon">:</span></dt>
<dd class="field-odd"><p>jmckenna at gatewaygeomatics.com</p>
<div class="admonition warning">
<p class="admonition-title">警告</p>
<p>Since the MapServer 8.0.0 release PHP support is only available through
MapServer's <a class="reference internal" href="../mapscript-api/index.html#swig"><span class="std std-ref">SWIG API</span></a>. The unmaintained <cite>native</cite> PHP MapScript
support (referred to in this section of the documentation) was removed.</p>
</div>
<div class="admonition note">
<p class="admonition-title">注釈</p>
<p>If you are using MapServer 5.6 and older, please refer
to the <a class="reference internal" href="index-5.6.html#php5-6"><span class="std std-ref">PHP MapScript 5.6 documentation</span></a> instead.</p>
</div>
</dd>
</dl>
<nav class="contents" id="id1">
<p class="topic-title">目次</p>
<ul class="simple">
<li><p><a class="reference internal" href="#php-mapscript-api" id="id76">PHP MapScript API</a></p>
<ul>
<li><p><a class="reference internal" href="#important-note" id="id77">Important Note</a></p></li>
<li><p><a class="reference internal" href="#constants" id="id78">Constants</a></p></li>
<li><p><a class="reference internal" href="#functions" id="id79">Functions</a></p></li>
<li><p><a class="reference internal" href="#classes" id="id80">Classes</a></p>
<ul>
<li><p><a class="reference internal" href="#classobj" id="id81">classObj</a></p></li>
<li><p><a class="reference internal" href="#clusterobj" id="id82">clusterObj</a></p></li>
<li><p><a class="reference internal" href="#colorobj" id="id83">colorObj</a></p></li>
<li><p><a class="reference internal" href="#errorobj" id="id84">errorObj</a></p></li>
<li><p><a class="reference internal" href="#gridobj" id="id85">gridObj</a></p></li>
<li><p><a class="reference internal" href="#hashtableobj" id="id86">hashTableObj</a></p></li>
<li><p><a class="reference internal" href="#imageobj" id="id87">imageObj</a></p></li>
<li><p><a class="reference internal" href="#labelcachememberobj" id="id88">labelcacheMemberObj</a></p></li>
<li><p><a class="reference internal" href="#labelcacheobj" id="id89">labelcacheObj</a></p></li>
<li><p><a class="reference internal" href="#labelobj" id="id90">labelObj</a></p></li>
<li><p><a class="reference internal" href="#layerobj" id="id91">layerObj</a></p></li>
<li><p><a class="reference internal" href="#legendobj" id="id92">legendObj</a></p></li>
<li><p><a class="reference internal" href="#lineobj" id="id93">lineObj</a></p></li>
<li><p><a class="reference internal" href="#mapobj" id="id94">mapObj</a></p></li>
<li><p><a class="reference internal" href="#outputformatobj" id="id95">outputformatObj</a></p></li>
<li><p><a class="reference internal" href="#owsrequestobj" id="id96">OwsrequestObj</a></p></li>
<li><p><a class="reference internal" href="#pointobj" id="id97">pointObj</a></p></li>
<li><p><a class="reference internal" href="#projectionobj" id="id98">projectionObj</a></p></li>
<li><p><a class="reference internal" href="#querymapobj" id="id99">querymapObj</a></p></li>
<li><p><a class="reference internal" href="#rectobj" id="id100">rectObj</a></p></li>
<li><p><a class="reference internal" href="#referencemapobj" id="id101">referenceMapObj</a></p></li>
<li><p><a class="reference internal" href="#resultobj" id="id102">resultObj</a></p></li>
<li><p><a class="reference internal" href="#scalebarobj" id="id103">scalebarObj</a></p></li>
<li><p><a class="reference internal" href="#shapefileobj" id="id104">shapefileObj</a></p></li>
<li><p><a class="reference internal" href="#shapeobj" id="id105">shapeObj</a></p></li>
<li><p><a class="reference internal" href="#styleobj" id="id106">styleObj</a></p></li>
<li><p><a class="reference internal" href="#symbolobj" id="id107">symbolObj</a></p></li>
<li><p><a class="reference internal" href="#webobj" id="id108">webObj</a></p></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
<section id="important-note">
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Important Note</a><a class="headerlink" href="#important-note" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p>Constant names and class member variable names are case-sensitive in
PHP.</p></li>
</ul>
</section>
<section id="constants">
<span id="index-0"></span><h2><a class="toc-backref" href="#id1" role="doc-backlink">Constants</a><a class="headerlink" href="#constants" title="Link to this heading">¶</a></h2>
<p>The following MapServer constants are available:</p>
<dl class="simple">
<dt>Boolean values</dt><dd><p>MS_TRUE, MS_FALSE, MS_ON, MS_OFF, MS_YES, MS_NO</p>
</dd>
<dt>Map units</dt><dd><p>MS_INCHES, MS_FEET, MS_MILES, MS_METERS,
MS_KILOMETERS, MS_DD, MS_PIXELS, MS_NAUTICALMILES</p>
</dd>
<dt>Layer types</dt><dd><p>MS_LAYER_POINT, MS_LAYER_LINE, MS_LAYER_POLYGON, MS_LAYER_RASTER,
MS_LAYER_ANNOTATION (deprecated since 6.2), MS_LAYER_QUERY,
MS_LAYER_CIRCLE, MS_LAYER_TILEINDEX, MS_LAYER_CHART</p>
</dd>
<dt>Layer/Legend/Scalebar/Class Status</dt><dd><p>MS_ON, MS_OFF, MS_DEFAULT, MS_EMBED, MS_DELETE</p>
</dd>
<dt>Layer alpha transparency</dt><dd><p>allows alpha transparent pixmaps to be used with RGB map images
MS_GD_ALPHA</p>
</dd>
<dt>Label positions</dt><dd><p>MS_UL, MS_LR, MS_UR, MS_LL, MS_CR, MS_CL, MS_UC, MS_LC,
MS_CC, MS_XY, MS_AUTO, MS_AUTO2, MS_FOLLOW, MS_NONE</p>
</dd>
<dt>Bitmap font styles</dt><dd><p>MS_TINY , MS_SMALL, MS_MEDIUM, MS_LARGE, MS_GIANT</p>
</dd>
<dt>Shape types</dt><dd><p>MS_SHAPE_POINT, MS_SHAPE_LINE, MS_SHAPE_POLYGON, MS_SHAPE_NULL</p>
</dd>
<dt>Shapefile types</dt><dd><p>MS_SHP_POINT, MS_SHP_ARC, MS_SHP_POLYGON, MS_SHP_MULTIPOINT</p>
</dd>
<dt>Query/join types</dt><dd><p>MS_SINGLE, MS_MULTIPLE</p>
</dd>
<dt>Querymap styles</dt><dd><p>MS_NORMAL, MS_HILITE, MS_SELECTED</p>
</dd>
<dt>Connection Types</dt><dd><p>MS_INLINE, MS_SHAPEFILE, MS_TILED_SHAPEFILE, MS_SDE, MS_OGR,
MS_TILED_OGR, MS_POSTGIS, MS_WMS, MS_ORACLESPATIAL, MS_WFS,
MS_GRATICULE, MS_RASTER, MS_PLUGIN, MS_UNION</p>
</dd>
<dt>Error codes</dt><dd><p>MS_NOERR, MS_IOERR, MS_MEMERR, MS_TYPEERR, MS_SYMERR,
MS_REGEXERR, MS_TTFERR, MS_DBFERR, MS_GDERR, MS_IDENTERR,
MS_EOFERR, MS_PROJERR, MS_MISCERR, MS_CGIERR, MS_WEBERR,
MS_IMGERR, MS_HASHERR, MS_JOINERR, MS_NOTFOUND, MS_SHPERR,
MS_PARSEERR, MS_SDEERR, MS_OGRERR, MS_QUERYERR, MS_WMSERR,
MS_WMSCONNERR, MS_ORACLESPATIALERR, MS_WFSERR, MS_WFSCONNERR,
MS_MAPCONTEXTERR, MS_HTTPERR, MS_WCSERR</p>
</dd>
<dt>Symbol types</dt><dd><p>MS_SYMBOL_SIMPLE, MS_SYMBOL_VECTOR, MS_SYMBOL_ELLIPSE,
MS_SYMBOL_PIXMAP, MS_SYMBOL_TRUETYPE</p>
</dd>
<dt>Image Mode types (<a class="reference internal" href="../../mapfile/outputformat.html#outputformat"><span class="std std-ref">outputFormatObj</span></a>)</dt><dd><p>MS_IMAGEMODE_PC256, MS_IMAGEMODE_RGB, MS_IMAGEMODE_RGBA,
MS_IMAGEMODE_INT16, MS_IMAGEMODE_FLOAT32, MS_IMAGEMODE_BYTE,
MS_IMAGEMODE_FEATURE, MS_IMAGEMODE_NULL</p>
</dd>
<dt>Style/Attribue binding</dt><dd><p>MS_STYLE_BINDING_SIZE, MS_STYLE_BINDING_ANGLE,
MS_STYLE_BINDING_COLOR, MS_STYLE_BINDING_OUTLINECOLOR,
MS_STYLE_BINDING_SYMBOL, MS_STYLE_BINDING_WIDTH</p>
</dd>
<dt>Label/Attribute binding</dt><dd><p>MS_LABEL_BINDING_SIZE, MS_LABEL_BINDING_ANGLE,
MS_LABEL_BINDING_COLOR, MS_LABEL_BINDING_OUTLINECOLOR,
MS_LABEL_BINDING_FONT, MS_LABEL_BINDING_PRIORITY,
MS_LABEL_BINDING_POSITION, MS_LABEL_BINDING_SHADOWSIZEX,
MS_LABEL_BINDING_SHADOWSIZEY</p>
</dd>
<dt>Alignment</dt><dd><p>MS_ALIGN_LEFT, MS_ALIGN_CENTER, MS_ALIGN_RIGHT</p>
</dd>
<dt>OwsRequest</dt><dd><p>MS_GET_REQUEST, MS_POST_REQUEST</p>
</dd>
</dl>
</section>
<section id="functions">
<span id="index-1"></span><h2><a class="toc-backref" href="#id1" role="doc-backlink">Functions</a><a class="headerlink" href="#functions" title="Link to this heading">¶</a></h2>
<dl class="simple">
<dt>string ms_GetVersion()</dt><dd><p>Returns the MapServer version and options in a string. This
string can be parsed to find out which modules were compiled in,
etc.</p>
</dd>
<dt>int ms_GetVersionInt()</dt><dd><p>Returns the MapServer version number (x.y.z) as an integer
(x*10000 + y*100 + z). (New in v5.0) e.g. V5.4.3 would return
50403.</p>
</dd>
<dt>int ms_iogetStdoutBufferBytes()</dt><dd><p>Writes the current buffer to stdout. The PHP header() function
should be used to set the documents's content-type prior to
calling the function. Returns the number of bytes written if
output is sent to stdout. See <a class="reference internal" href="../../ogc/mapscript.html#mapscript-ows"><span class="std std-ref">MapScript Wrappers for WxS Services</span></a> for more info.</p>
</dd>
<dt>void ms_iogetstdoutbufferstring()</dt><dd><p>Fetch the current stdout buffer contents as a string. This method
does not clear the buffer.</p>
</dd>
<dt>void ms_ioinstallstdinfrombuffer()</dt><dd><p>Installs a mapserver IO handler directing future stdin reading
(ie. post request capture) to come from a buffer.</p>
</dd>
<dt>void ms_ioinstallstdouttobuffer()</dt><dd><p>Installs a mapserver IO handler directing future stdout output
to a memory buffer.</p>
</dd>
<dt>void ms_ioresethandlers()</dt><dd><p>Resets the default stdin and stdout handlers in place of "buffer"
based handlers.</p>
</dd>
<dt>string ms_iostripstdoutbuffercontenttype()</dt><dd><p>Strip the Content-type header off the stdout buffer if it has one,
and if a content type is found it is return. Otherwise return
false.</p>
</dd>
<dt>void ms_iostripstdoutbuffercontentheaders()</dt><dd><p>Strip all the Content-* headers off the stdout buffer if it has
some.</p>
</dd>
<dt>array ms_TokenizeMap(string map_file_name)</dt><dd><p>Preparses a mapfile through the MapServer parser and return an
array with one item for each token from the mapfile. Strings,
logical expressions, regex expressions and comments are returned
as individual tokens.</p>
</dd>
<dt>errorObj ms_GetErrorObj()</dt><dd><p>Returns a reference to the head of the list of errorObj.</p>
</dd>
<dt>void ms_ResetErrorList()</dt><dd><p>Clear the current error list.
Note that clearing the list invalidates any errorObj handles obtained
via the $error->next() method.</p>
</dd>
</dl>
</section>
<section id="classes">
<span id="index-2"></span><h2><a class="toc-backref" href="#id1" role="doc-backlink">Classes</a><a class="headerlink" href="#classes" title="Link to this heading">¶</a></h2>
<p>The following class objects are available through PHP MapScript.</p>
<section id="classobj">
<span id="index-3"></span><h3><a class="toc-backref" href="#id1" role="doc-backlink">classObj</a><a class="headerlink" href="#classobj" title="Link to this heading">¶</a></h3>
<section id="constructor">
<h4>Constructor<a class="headerlink" href="#constructor" title="Link to this heading">¶</a></h4>
<p>Class Objects can be returned by the <a class="reference internal" href="#layerobj">layerObj</a> class, or can be
created using:</p>
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="x">new classObj(layerObj layer [, classObj class])</span>
</pre></div>
</div>
<p>or using the old constructor</p>
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="x">classObj ms_newClassObj(layerObj layer [, classObj class])</span>
</pre></div>
</div>
<p>The second argument class is optional. If given, the new class
created will be a copy of this class.</p>
</section>
<section id="members">
<h4>Members<a class="headerlink" href="#members" title="Link to this heading">¶</a></h4>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Type</p></th>
<th class="head"><p>Name</p></th>
<th class="head"><p>Note</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>string</p></td>
<td><p>group</p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p>string</p></td>
<td><p>keyimage</p></td>
<td></td>
</tr>
<tr class="row-even"><td><p>labelObj</p></td>
<td><p>label</p></td>
<td><p>Removed (6.2) - use addLabel, getLabel, ...</p></td>
</tr>
<tr class="row-odd"><td><p>double</p></td>
<td><p>maxscaledenom</p></td>
<td></td>
</tr>
<tr class="row-even"><td><p>hashTableObj</p></td>
<td><p>metadata</p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p>double</p></td>
<td><p>minscaledenom</p></td>
<td></td>
</tr>
<tr class="row-even"><td><p>string</p></td>
<td><p>name</p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p>int</p></td>
<td><p>numlabels</p></td>
<td><p>read-only (since 6.2)</p></td>
</tr>
<tr class="row-even"><td><p>int</p></td>
<td><p>numstyles</p></td>
<td><p>read-only</p></td>
</tr>
<tr class="row-odd"><td><p>int</p></td>
<td><p>status</p></td>
<td><p>MS_ON, MS_OFF or MS_DELETE</p></td>
</tr>
<tr class="row-even"><td><p>string</p></td>
<td><p>template</p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p>string</p></td>
<td><p>title</p></td>
<td></td>
</tr>
<tr class="row-even"><td><p>int</p></td>
<td><p>type</p></td>
<td></td>
</tr>
</tbody>
</table>
</section>
<section id="methods">
<h4>Methods<a class="headerlink" href="#methods" title="Link to this heading">¶</a></h4>
<dl>
<dt>int addLabel( labelObj label)</dt><dd><div class="versionadded">
<p><span class="versionmodified added">Added in version 6.2.</span></p>
</div>
<p>Add a labelObj to the classObj and return its index in the labels
array.</p>
</dd>
<dt>string convertToString()</dt><dd><p>Saves the object to a string. Provides the inverse option for
updateFromString.</p>
</dd>
<dt>imageObj createLegendIcon(int width, int height)</dt><dd><p>Draw the legend icon and return a new imageObj.</p>
</dd>
<dt>int deletestyle(int index)</dt><dd><p>Delete the style specified by the style index. If there are any
style that follow the deleted style, their index will decrease by 1.</p>
</dd>
<dt>int drawLegendIcon(int width, int height, imageObj im, int dstX, int dstY)</dt><dd><p>Draw the legend icon on im object at dstX, dstY.
Returns MS_SUCCESS/MS_FAILURE.</p>
</dd>
<dt>void free()</dt><dd><p>Free the object properties and break the internal references.
Note that you have to unset the php variable to free totally the
resources.</p>
</dd>
<dt>string getExpressionString()</dt><dd><p>Returns the <a class="reference internal" href="../../mapfile/expressions.html#expressions"><span class="std std-ref">expression</span></a> string for the class
object.</p>
</dd>
<dt>labelObj getLabel(int index)</dt><dd><div class="versionadded">
<p><span class="versionmodified added">Added in version 6.2.</span></p>
</div>
<p>Return a reference to the labelObj at <em>index</em> in the labels array.</p>
<p>See the <a class="reference internal" href="#labelobj">labelObj</a> section for more details on multiple class
labels.</p>
</dd>
<dt>int getMetaData(string name)</dt><dd><p>Fetch class metadata entry by name. Returns "" if no entry
matches the name. Note that the search is case sensitive.</p>
<div class="admonition note">
<p class="admonition-title">注釈</p>
<p>getMetaData's query is case sensitive.</p>
</div>
</dd>
<dt>styleObj getStyle(int index)</dt><dd><p>Return the style object using an index. index >= 0 &&
index < class->numstyles.</p>
</dd>
<dt>string getTextString()</dt><dd><p>Returns the text string for the class object.</p>
</dd>
<dt>int insertStyle( <a class="reference internal" href="#styleobj">styleObj</a> style [, int index=-1 ] )</dt><dd><p>Insert a <em>copy</em> of <em>style</em> into the styles array at index <em>index</em>.
Default is -1, or the end of the array. Returns the index at which the
style was inserted.</p>
</dd>
<dt>int movestyledown(int index)</dt><dd><p>The style specified by the style index will be moved down into
the array of classes. Returns MS_SUCCESS or MS_FAILURE.
ex class->movestyledown(0) will have the effect of moving style 0
up to position 1, and the style at position 1 will be moved
to position 0.</p>
</dd>
<dt>int movestyleup(int index)</dt><dd><p>The style specified by the style index will be moved up into
the array of classes. Returns MS_SUCCESS or MS_FAILURE.
ex class->movestyleup(1) will have the effect of moving style 1
up to position 0, and the style at position 0 will be moved
to position 1.</p>
</dd>
<dt>labelObj removeLabel(int index)</dt><dd><div class="versionadded">
<p><span class="versionmodified added">Added in version 6.2.</span></p>
</div>
<p>Remove the labelObj at <em>index</em> from the labels array and return a
reference to the labelObj. numlabels is decremented, and the
array is updated.</p>
</dd>
<dt>int removeMetaData(string name)</dt><dd><p>Remove a metadata entry for the class. Returns MS_SUCCESS/MS_FAILURE.</p>
</dd>
<dt>int set(string property_name, new_value)</dt><dd><p>Set object property to a new value.</p>
</dd>
<dt>int setExpression(string expression)</dt><dd><p>Set the <a class="reference internal" href="../../mapfile/expressions.html#expressions"><span class="std std-ref">expression</span></a> string for the class
object.</p>
</dd>
<dt>int setMetaData(string name, string value)</dt><dd><p>Set a metadata entry for the class. Returns MS_SUCCESS/MS_FAILURE.</p>
</dd>
<dt>int settext(string text)</dt><dd><p>Set the text string for the class object.</p>
</dd>
<dt>int updateFromString(string snippet)</dt><dd><p>Update a class from a string snippet. Returns MS_SUCCESS/MS_FAILURE.</p>
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="x">/*set the color */</span>
<span class="x">$oClass->updateFromString('CLASS STYLE COLOR 255 0 255 END END');</span>
</pre></div>
</div>
</dd>
</dl>
</section>
</section>
<section id="clusterobj">
<span id="index-4"></span><h3><a class="toc-backref" href="#id1" role="doc-backlink">clusterObj</a><a class="headerlink" href="#clusterobj" title="Link to this heading">¶</a></h3>
<section id="id2">
<h4>Constructor<a class="headerlink" href="#id2" title="Link to this heading">¶</a></h4>
<p>Instance of clusterObj is always embedded inside the <a class="reference internal" href="#layerobj">layerObj</a>.</p>
</section>
<section id="id3">
<h4>Members<a class="headerlink" href="#id3" title="Link to this heading">¶</a></h4>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Type</p></th>
<th class="head"><p>Name</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>double</p></td>
<td><p>buffer</p></td>
</tr>
<tr class="row-odd"><td><p>double</p></td>
<td><p>maxdistance</p></td>
</tr>
<tr class="row-even"><td><p>string</p></td>
<td><p>region</p></td>
</tr>
</tbody>
</table>
</section>
<section id="id4">
<h4>Methods<a class="headerlink" href="#id4" title="Link to this heading">¶</a></h4>
<dl class="simple">
<dt>string convertToString()</dt><dd><p>Saves the object to a string. Provides the inverse option for
updateFromString.</p>
</dd>
<dt>string getFilterString()</dt><dd><p>Returns the <a class="reference internal" href="../../mapfile/expressions.html#expressions"><span class="std std-ref">expression</span></a> for this cluster
filter or NULL on error.</p>
</dd>
<dt>string getGroupString()</dt><dd><p>Returns the <a class="reference internal" href="../../mapfile/expressions.html#expressions"><span class="std std-ref">expression</span></a> for this cluster group
or NULL on error.</p>
</dd>
<dt>int setFilter(string expression)</dt><dd><p>Set layer filter <a class="reference internal" href="../../mapfile/expressions.html#expressions"><span class="std std-ref">expression</span></a>.</p>
</dd>
<dt>int setGroup(string expression)</dt><dd><p>Set layer group <a class="reference internal" href="../../mapfile/expressions.html#expressions"><span class="std std-ref">expression</span></a>.</p>
</dd>
</dl>
</section>
</section>
<section id="colorobj">
<span id="index-5"></span><h3><a class="toc-backref" href="#id1" role="doc-backlink">colorObj</a><a class="headerlink" href="#colorobj" title="Link to this heading">¶</a></h3>
<section id="id5">
<h4>Constructor<a class="headerlink" href="#id5" title="Link to this heading">¶</a></h4>
<p>Instances of colorObj are always embedded inside other classes.</p>
</section>
<section id="id6">
<h4>Members<a class="headerlink" href="#id6" title="Link to this heading">¶</a></h4>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Type</p></th>
<th class="head"><p>Name</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>int</p></td>
<td><p>red</p></td>
</tr>
<tr class="row-odd"><td><p>int</p></td>
<td><p>green</p></td>
</tr>
<tr class="row-even"><td><p>int</p></td>
<td><p>blue</p></td>
</tr>
<tr class="row-odd"><td><p>int</p></td>
<td><p>alpha</p></td>
</tr>
</tbody>
</table>
</section>
<section id="id7">
<h4>Methods<a class="headerlink" href="#id7" title="Link to this heading">¶</a></h4>
<dl>
<dt>int setRGB(int red, int green, int blue, int alpha = 255)</dt><dd><p>Set red, green, blue and alpha values. Returns MS_SUCCESS.</p>
</dd>
<dt>string toHex()</dt><dd><div class="versionadded">
<p><span class="versionmodified added">Added in version 7.0.0.</span></p>
</div>
<p>Get the color as a hex string "#rrggbb" or (if alpha is not 255)
"#rrggbbaa".</p>
</dd>
<dt>int setHex(string hex)</dt><dd><div class="versionadded">
<p><span class="versionmodified added">Added in version 7.0.0.</span></p>
</div>
<p>Set red, green, blue and alpha values. The hex string should have the form
"#rrggbb" (alpha will be set to 255) or "#rrggbbaa". Returns MS_SUCCESS.</p>
</dd>
</dl>
</section>
</section>
<section id="errorobj">
<span id="index-6"></span><h3><a class="toc-backref" href="#id1" role="doc-backlink">errorObj</a><a class="headerlink" href="#errorobj" title="Link to this heading">¶</a></h3>
<p>Instances of errorObj are created internally by MapServer as errors
happen. Errors are managed as a chained list with the first item being
the most recent error. The head of the list can be fetched using
ms_GetErrorObj(), and the list can be cleared using ms_ResetErrorList()</p>
<section id="id8">
<h4>Members<a class="headerlink" href="#id8" title="Link to this heading">¶</a></h4>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Type</p></th>
<th class="head"><p>Name</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>int</p></td>
<td><p>code //See error code constants above</p></td>
</tr>
<tr class="row-odd"><td><p>string</p></td>
<td><p>message</p></td>
</tr>
<tr class="row-even"><td><p>string</p></td>
<td><p>routine</p></td>
</tr>
</tbody>
</table>
</section>
<section id="method">
<h4>Method<a class="headerlink" href="#method" title="Link to this heading">¶</a></h4>
<dl class="simple">
<dt>errorObj next()</dt><dd><p>Returns the next errorObj in the list, or NULL if we reached the end
of the list.</p>
</dd>
</dl>
</section>
<section id="example">
<h4>Example<a class="headerlink" href="#example" title="Link to this heading">¶</a></h4>
<p>This example draws a map and reports all errors generated during
the draw() call, errors can potentially come from multiple layers.</p>
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="x">ms_ResetErrorList();</span>
<span class="x">$img = $map->draw();</span>
<span class="x">$error = ms_GetErrorObj();</span>
<span class="x">while($error && $error->code != MS_NOERR)</span>
<span class="x">{</span>
<span class="x"> printf("Error in %s: %s<br>\n", $error->routine, $error->message);</span>
<span class="x"> $error = $error->next();</span>
<span class="x">}</span>
</pre></div>
</div>
</section>
</section>
<section id="gridobj">
<span id="index-7"></span><h3><a class="toc-backref" href="#id1" role="doc-backlink">gridObj</a><a class="headerlink" href="#gridobj" title="Link to this heading">¶</a></h3>
<section id="id9">
<h4>Constructor<a class="headerlink" href="#id9" title="Link to this heading">¶</a></h4>
<p>The grid is always embedded inside a layer object defined as
a grid (layer->connectiontype = MS_GRATICULE)
(for more docs : <a class="reference external" href="https://github.com/MapServer/MapServer/wiki/MapServerGrid">https://github.com/MapServer/MapServer/wiki/MapServerGrid</a>)</p>
<p>A layer can become a grid layer by adding a grid object to it using :
ms_newGridObj(layerObj layer)</p>
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="x">$oLayer = ms_newlayerobj($oMap);</span>
<span class="x">$oLayer->set("name", "GRID");</span>
<span class="x">ms_newgridobj($oLayer);</span>
<span class="x">$oLayer->grid->set("labelformat", "DDMMSS");</span>
</pre></div>
</div>
</section>
<section id="id10">
<h4>Members<a class="headerlink" href="#id10" title="Link to this heading">¶</a></h4>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Type</p></th>
<th class="head"><p>Name</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>string</p></td>
<td><p>labelformat</p></td>
</tr>
<tr class="row-odd"><td><p>double</p></td>
<td><p>maxacrs</p></td>
</tr>
<tr class="row-even"><td><p>double</p></td>
<td><p>maxinterval</p></td>
</tr>
<tr class="row-odd"><td><p>double</p></td>
<td><p>maxsubdivide</p></td>
</tr>
<tr class="row-even"><td><p>double</p></td>
<td><p>minarcs</p></td>
</tr>
<tr class="row-odd"><td><p>double</p></td>
<td><p>mininterval</p></td>
</tr>
<tr class="row-even"><td><p>double</p></td>
<td><p>minsubdivide</p></td>
</tr>
</tbody>
</table>
</section>
<section id="id11">
<h4>Methods<a class="headerlink" href="#id11" title="Link to this heading">¶</a></h4>
<dl class="simple">
<dt>int set(string property_name, new_value)</dt><dd><p>Set object property to a new value.</p>
</dd>
</dl>
</section>
</section>
<section id="hashtableobj">
<span id="index-8"></span><h3><a class="toc-backref" href="#id1" role="doc-backlink">hashTableObj</a><a class="headerlink" href="#hashtableobj" title="Link to this heading">¶</a></h3>
<section id="id12">
<h4>Constructor<a class="headerlink" href="#id12" title="Link to this heading">¶</a></h4>
<p>Instance of hashTableObj is always embedded inside the <a class="reference internal" href="#classobj">classObj</a>,
<a class="reference internal" href="#layerobj">layerObj</a>, <a class="reference internal" href="#mapobj">mapObj</a> and <a class="reference internal" href="#webobj">webObj</a>. It is uses a read only.</p>
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="x">$hashTable = $oLayer->metadata;</span>
<span class="x">$key = null;</span>
<span class="x">while ($key = $hashTable->nextkey($key))</span>
<span class="x"> echo "Key: ".$key." value: ".$hashTable->get($key)."<br/>";</span>
</pre></div>
</div>
</section>
<section id="id13">
<h4>Methods<a class="headerlink" href="#id13" title="Link to this heading">¶</a></h4>
<dl class="simple">
<dt>void clear()</dt><dd><p>Clear all items in the hashTable (To NULL).</p>
</dd>
<dt>string get(string key)</dt><dd><p>Fetch class metadata entry by name. Returns "" if no entry
matches the name. Note that the search is case sensitive.</p>
</dd>
<dt>string nextkey(string previousKey)</dt><dd><p>Return the next key or first key if previousKey = NULL.
Return NULL if no item is in the hashTable or end of hashTable is
reached</p>
</dd>
<dt>int remove(string key)</dt><dd><p>Remove a metadata entry in the hashTable. Returns MS_SUCCESS/MS_FAILURE.</p>
</dd>
<dt>int set(string key, string value)</dt><dd><p>Set a metadata entry in the hashTable. Returns MS_SUCCESS/MS_FAILURE.</p>
</dd>
</dl>
</section>
</section>
<section id="imageobj">
<span id="index-9"></span><h3><a class="toc-backref" href="#id1" role="doc-backlink">imageObj</a><a class="headerlink" href="#imageobj" title="Link to this heading">¶</a></h3>
<section id="id14">
<h4>Constructor<a class="headerlink" href="#id14" title="Link to this heading">¶</a></h4>
<p>Instances of imageObj are always created by the <a class="reference internal" href="#mapobj">mapObj</a> class methods.</p>
</section>
<section id="id15">
<h4>Members<a class="headerlink" href="#id15" title="Link to this heading">¶</a></h4>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Type</p></th>
<th class="head"><p>Name</p></th>
<th class="head"><p>Note</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>int</p></td>
<td><p>width</p></td>
<td><p>read-only</p></td>
</tr>
<tr class="row-odd"><td><p>int</p></td>
<td><p>height</p></td>
<td><p>read-only</p></td>
</tr>
<tr class="row-even"><td><p>int</p></td>
<td><p>resolution</p></td>
<td><p>read-only</p></td>
</tr>
<tr class="row-odd"><td><p>int</p></td>
<td><p>resolutionfactor</p></td>
<td><p>read-only</p></td>
</tr>
<tr class="row-even"><td><p>string</p></td>
<td><p>imagepath</p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p>string</p></td>
<td><p>imageurl</p></td>
<td></td>
</tr>
</tbody>
</table>
</section>
<section id="id16">
<h4>Methods<a class="headerlink" href="#id16" title="Link to this heading">¶</a></h4>
<dl class="simple">
<dt>void pasteImage(imageObj srcImg, int transparentColorHex [[, int dstX, int dstY], int angle])</dt><dd><p>Copy srcImg on top of the current imageObj.
transparentColorHex is the color (in 0xrrggbb format) from srcImg
that should be considered transparent (i.e. those pixels won't
be copied). Pass -1 if you don't want any transparent color.
If optional dstx,dsty are provided then it defines the position
where the image should be copied (dstx,dsty = top-left corner
position).
The optional angle is a value between 0 and 360 degrees to rotate
the source image counterclockwise. Note that if an angle is specified
(even if its value is zero) then the dstx and dsty coordinates
specify the CENTER of the destination area.
Note: this function works only with 8 bits GD images (PNG or GIF).</p>
</dd>
<dt>int saveImage([string filename, MapObj oMap])</dt><dd><p>Writes image object to specified filename.
Passing no filename or an empty filename sends output to stdout. In
this case, the PHP header() function should be used to set the
document's content-type prior to calling saveImage(). The output
format is the one that is currently selected in the map file. The
second argument oMap is not manadatory. It is usful when saving to
formats like GTIFF that needs georeference information contained in
the map file. On success, it returns either MS_SUCCESS if writing to an
external file, or the number of bytes written if output is sent to
stdout.</p>
</dd>
<dt>string saveWebImage()</dt><dd><p>Writes image to temp directory. Returns image URL.
The output format is the one that is currently selected in the
map file.</p>
</dd>
</dl>
</section>
</section>
<section id="labelcachememberobj">
<span id="index-10"></span><h3><a class="toc-backref" href="#id1" role="doc-backlink">labelcacheMemberObj</a><a class="headerlink" href="#labelcachememberobj" title="Link to this heading">¶</a></h3>
<p>Accessible only through the <a class="reference internal" href="#mapobj">mapObj</a> (map->getLabel()).</p>
<section id="id17">
<h4>Members<a class="headerlink" href="#id17" title="Link to this heading">¶</a></h4>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Type</p></th>
<th class="head"><p>Name</p></th>
<th class="head"><p>Note</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>int</p></td>
<td><p>classindex</p></td>
<td><p>read-only</p></td>
</tr>
<tr class="row-odd"><td><p>int</p></td>
<td><p>featuresize</p></td>
<td><p>read-only</p></td>
</tr>
<tr class="row-even"><td><p>int</p></td>
<td><p>layerindex</p></td>
<td><p>read-only</p></td>
</tr>
<tr class="row-odd"><td><p>int</p></td>
<td><p>markerid</p></td>
<td><p>read-only</p></td>
</tr>
<tr class="row-even"><td><p>int</p></td>
<td><p>numstyles</p></td>
<td><p>read-only</p></td>
</tr>
<tr class="row-odd"><td><p>int</p></td>
<td><p>shapeindex</p></td>
<td><p>read-only</p></td>
</tr>
<tr class="row-even"><td><p>int</p></td>
<td><p>status</p></td>
<td><p>read-only</p></td>
</tr>
<tr class="row-odd"><td><p>string</p></td>
<td><p>text</p></td>
<td><p>read-only</p></td>
</tr>
<tr class="row-even"><td><p>int</p></td>
<td><p>tileindex</p></td>
<td><p>read-only</p></td>
</tr>
</tbody>
</table>
</section>
<section id="id18">
<h4>Method<a class="headerlink" href="#id18" title="Link to this heading">¶</a></h4>
<p>None</p>
</section>
</section>
<section id="labelcacheobj">
<span id="index-11"></span><h3><a class="toc-backref" href="#id1" role="doc-backlink">labelcacheObj</a><a class="headerlink" href="#labelcacheobj" title="Link to this heading">¶</a></h3>
<p>Accessible only through the <a class="reference internal" href="#mapobj">mapObj</a> (map->labelcache). This object
is only used to give the possibility to free the label cache
(map->labelcache->freeCache())</p>
<section id="id19">
<h4>Methods<a class="headerlink" href="#id19" title="Link to this heading">¶</a></h4>
<dl class="simple">
<dt>boolean freeCache()</dt><dd><p>Free the label cache. Always returns MS_SUCCESS.
Ex : map->labelcache->freeCache();</p>
</dd>
</dl>
</section>
</section>
<section id="labelobj">
<span id="index-12"></span><h3><a class="toc-backref" href="#id1" role="doc-backlink">labelObj</a><a class="headerlink" href="#labelobj" title="Link to this heading">¶</a></h3>
<section id="id20">
<h4>Constructor<a class="headerlink" href="#id20" title="Link to this heading">¶</a></h4>
<p>labelObj are always embedded inside other classes.</p>
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="x">new labelObj()</span>
</pre></div>
</div>
</section>
<section id="id21">
<h4>Members<a class="headerlink" href="#id21" title="Link to this heading">¶</a></h4>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Type</p></th>
<th class="head"><p>Name</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>int</p></td>
<td><p>align</p></td>
</tr>
<tr class="row-odd"><td><p>double</p></td>
<td><p>angle</p></td>
</tr>
<tr class="row-even"><td><p>int</p></td>
<td><p>anglemode</p></td>
</tr>
<tr class="row-odd"><td><p>int</p></td>
<td><p>antialias</p></td>
</tr>
<tr class="row-even"><td><p>int</p></td>
<td><p>autominfeaturesize</p></td>
</tr>
<tr class="row-odd"><td><p>colorObj</p></td>
<td><p>backgroundcolor (deprecated since 6.0)</p></td>
</tr>
<tr class="row-even"><td><p>colorObj</p></td>
<td><p>backgroundshadowcolor (deprecated since 6.0)</p></td>
</tr>
<tr class="row-odd"><td><p>int</p></td>
<td><p>backgroundshadowsizex (deprecated since 6.0)</p></td>
</tr>
<tr class="row-even"><td><p>int</p></td>
<td><p>backgroundshadowsizey (deprecated since 6.0)</p></td>
</tr>
<tr class="row-odd"><td><p>int</p></td>
<td><p>buffer</p></td>
</tr>
<tr class="row-even"><td><p>colorObj</p></td>
<td><p>color</p></td>
</tr>
<tr class="row-odd"><td><p>string</p></td>
<td><p>encoding</p></td>
</tr>
<tr class="row-even"><td><p>string</p></td>
<td><p>font</p></td>
</tr>
<tr class="row-odd"><td><p>int</p></td>
<td><p>force</p></td>
</tr>
<tr class="row-even"><td><p>int</p></td>
<td><p>maxlength</p></td>
</tr>
<tr class="row-odd"><td><p>int</p></td>
<td><p>maxsize</p></td>
</tr>
<tr class="row-even"><td><p>int</p></td>
<td><p>mindistance</p></td>
</tr>
<tr class="row-odd"><td><p>int</p></td>
<td><p>minfeaturesize</p></td>
</tr>
<tr class="row-even"><td><p>int</p></td>
<td><p>minlength</p></td>
</tr>
<tr class="row-odd"><td><p>int</p></td>
<td><p>minsize</p></td>
</tr>
<tr class="row-even"><td><p>int</p></td>
<td><p>numstyles</p></td>
</tr>
<tr class="row-odd"><td><p>int</p></td>
<td><p>offsetx</p></td>
</tr>
<tr class="row-even"><td><p>int</p></td>
<td><p>offsety</p></td>
</tr>
<tr class="row-odd"><td><p>colorObj</p></td>