FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
processing-docs/generate/domit/xml_domit_lite_parser.php at master · processing/processing-docs · GitHub
processing
processing-docs
Repository navigation
Code
Issues
3
(3)
Pull requests
Actions
Projects
Wiki
Security and quality
Insights
Expand file tree
Breadcrumbs
processing-docs
/
generate
/
domit
/
xml_domit_lite_parser.php
Copy path
More file actions
More file actions
Latest commit
History
History
History
1876 lines (1618 loc) · 56.6 KB
Breadcrumbs
processing-docs
/
generate
/
domit
/
xml_domit_lite_parser.php
Copy path
File metadata and controls
1876 lines (1618 loc) · 56.6 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
<?php
/**
* DOMIT! Lite is a non-validating, but lightweight and fast DOM parser for PHP
* @package domit-xmlparser
* @subpackage domit-xmlparser-lite
* @version 1.01
* @copyright (C) 2004 John Heinstein. All rights reserved
* @license http://www.gnu.org/copyleft/lesser.html LGPL License
* @author John Heinstein <johnkarl@nbnet.nb.ca>
* @link http://www.engageinteractive.com/domit/ DOMIT! Home Page
* DOMIT! is Free Software
**/
if
(!
defined
(
'
DOMIT_INCLUDE_PATH
'
)) {
define
(
'
DOMIT_INCLUDE_PATH
'
, (
dirname
(
__FILE__
) .
"
/
"
));
}
/** current version of DOMIT! Lite */
define
(
'
DOMIT_LITE_VERSION
'
,
'
1.01
'
);
/**
*@global array Flipped version of $definedEntities array, to allow two-way conversion of entities
*
* Made global so that Attr nodes, which have no ownerDocument property, can access the array
*/
$
GLOBALS
[
'
DOMIT_defined_entities_flip
'
] =
array
();
require_once
(
DOMIT_INCLUDE_PATH
.
'
xml_domit_shared.php
'
);
/**
* The base class of all DOMIT node types
*
* @package domit-xmlparser
* @subpackage domit-xmlparser-lite
* @author John Heinstein <johnkarl@nbnet.nb.ca>
*/
class
DOMIT_Lite_Node {
/** @var string The name of the node, varies according to node type */
var
$
nodeName
=
null
;
/** @var string The value of the node, varies according to node type */
var
$
nodeValue
=
null
;
/** @var int The type of node, e.g. CDataSection */
var
$
nodeType
=
null
;
/** @var Object A reference to the parent of the current node */
var
$
parentNode
=
null
;
/** @var Array An array of child node references */
var
$
childNodes
=
null
;
/** @var Object A reference to the first node in the childNodes list */
var
$
firstChild
=
null
;
/** @var Object A reference to the last node in the childNodes list */
var
$
lastChild
=
null
;
/** @var Object A reference to the node prior to the current node in its parents childNodes list */
var
$
previousSibling
=
null
;
/** @var Object A reference to the node after the current node in its parents childNodes list */
var
$
nextSibling
=
null
;
/** @var Array An array of attribute key / value pairs */
var
$
attributes
=
null
;
/** @var Object A reference to the Document node */
var
$
ownerDocument
=
null
;
/** @var string The unique node id */
var
$
uid
;
/** @var int The number of children of the current node */
var
$
childCount
=
0
;
/**
* Raises error if abstract class is directly instantiated
*/
function
DOMIT_Lite_Node
() {
DOMIT_DOMException::
raiseException
(
DOMIT_ABSTRACT_CLASS_INSTANTIATION_ERR
,
'
Cannot instantiate abstract class DOMIT_Lite_Node
'
);
}
//DOMIT_Lite_Node
/**
* DOMIT_Lite_Node constructor, assigns a uid
*/
function
_constructor
() {
global
$
uidFactory
;
$
this
->
uid
=
$
uidFactory
->
generateUID
();
}
//_constructor
/**
* Appends a node to the childNodes list of the current node
* @abstract
* @param Object The node to be appended
* @return Object The appended node
*/
function
&
appendChild
(&
$
child
) {
DOMIT_DOMException::
raiseException
(
DOMIT_HIERARCHY_REQUEST_ERR
,
(
'
Method appendChild cannot be called by class
'
.
get_class
(
$
this
)));
}
//appendChild
/**
* Inserts a node to the childNodes list of the current node
* @abstract
* @param Object The node to be inserted
* @param Object The node before which the insertion is to occur
* @return Object The inserted node
*/
function
&
insertBefore
(&
$
newChild
, &
$
refChild
) {
DOMIT_DOMException::
raiseException
(
DOMIT_HIERARCHY_REQUEST_ERR
,
(
'
Method insertBefore cannot be called by class
'
.
get_class
(
$
this
)));
}
//insertBefore
/**
* Replaces a node with another
* @abstract
* @param Object The new node
* @param Object The old node
* @return Object The new node
*/
function
&
replaceChild
(&
$
newChild
, &
$
oldChild
) {
DOMIT_DOMException::
raiseException
(
DOMIT_HIERARCHY_REQUEST_ERR
,
(
'
Method replaceChild cannot be called by class
'
.
get_class
(
$
this
)));
}
//replaceChild
/**
* Removes a node from the childNodes list of the current node
* @abstract
* @param Object The node to be removed
* @return Object The removed node
*/
function
&
removeChild
(&
$
oldChild
) {
DOMIT_DOMException::
raiseException
(
DOMIT_HIERARCHY_REQUEST_ERR
,
(
'
Method removeChild cannot be called by class
'
.
get_class
(
$
this
)));
}
//removeChild
/**
* Returns the index of the specified node in a childNodes list
* @param Array The childNodes array to be searched
* @param Object The node targeted by the search
* @return int The index of the target node, or -1 if not found
*/
function
getChildNodeIndex
(&
$
arr
, &
$
child
) {
$
index
= -
1
;
$
total
=
count
(
$
arr
);
for
(
$
i
=
0
;
$
i
<
$
total
;
$
i
++) {
if
(
$
child
->
uid
==
$
arr
[
$
i
]->
uid
) {
$
index
=
$
i
;
break
;
}
}
return
$
index
;
}
//getChildNodeIndex
/**
* Determines whether a node has any children
* @return boolean True if any child nodes are present
*/
function
hasChildNodes
() {
return
(
$
this
->
childCount
>
0
);
}
//hasChildNodes
/**
* Copies a node and/or its children
* @abstract
* @param boolean True if all child nodes are also to be cloned
* @return Object A copy of the node and/or its children
*/
function
&
cloneNode
(
$
deep
=
false
) {
DOMIT_DOMException::
raiseException
(
DOMIT_ABSTRACT_METHOD_INVOCATION_ERR
,
'
Cannot invoke abstract method DOMIT_Lite_Node->cloneNode($deep). Must provide an overridden method in your subclass.
'
);
}
//cloneNode
/**
* Adds elements with the specified tag name to a NodeList collection
* @param Object The NodeList collection
* @param string The tag name of matching elements
*/
function
getNamedElements
(&
$
nodeList
,
$
tagName
) {
//Implemented in DOMIT_Lite_Element.
//Needs to be here though! This is called against all nodes in the document.
}
//getNamedElements
/**
* Sets the ownerDocument property of a node to the containing DOMIT_Document
* @param Object A reference to the document element of the DOMIT_Document
*/
function
setOwnerDocument
(&
$
rootNode
) {
if
(
$
rootNode
->
ownerDocument
==
null
) {
unset(
$
this
->
ownerDocument
);
$
this
->
ownerDocument
=
null
;
}
else
{
$
this
->
ownerDocument
=&
$
rootNode
->
ownerDocument
;
}
$
total
=
$
this
->
childCount
;
for
(
$
i
=
0
;
$
i
<
$
total
;
$
i
++) {
$
this
->
childNodes
[
$
i
]->
setOwnerDocument
(
$
rootNode
);
}
}
//setOwnerDocument
/**
* Tests whether a value is null, and if so, returns a default value
* @param mixed The value to be tested
* @param mixed The default value
* @return mixed The specified value, or the default value if null
*/
function
&
nvl
(&
$
value
,
$
default
) {
if
(
is_null
(
$
value
))
return
$
default
;
return
$
value
;
}
//nvl
/**
* Retrieves an element or DOMIT_NodeList of elements corresponding to an Xpath-like expression.
* @abstract
* @param string The query pattern
* @param int If a single node is to be returned (rather than the entire NodeList) the index of that node
* @return mixed A NodeList or single node that matches the pattern
*/
function
&
getElementsByPath
(
$
pattern
,
$
nodeIndex
=
0
) {
DOMIT_DOMException::
raiseException
(
DOMIT_HIERARCHY_REQUEST_ERR
,
(
'
Method getElementsByPath cannot be called by class
'
.
get_class
(
$
this
)));
}
//getElementsByPath
/**
* Returns the concatented text of the current node and its children
* @return string The concatented text of the current node and its children
*/
function
getText
() {
return
$
this
->
nodeValue
;
}
//getText
/**
* Formats a string for presentation as HTML
* @param string The string to be formatted
* @param boolean True if the string is to be sent directly to output
* @return string The HTML formatted string
*/
function
forHTML
(
$
str
,
$
doPrint
=
false
) {
require_once
(
DOMIT_INCLUDE_PATH
.
'
xml_domit_utilities.php
'
);
return
DOMIT_Utilities::
forHTML
(
$
str
,
$
doPrint
);
}
//forHTML
/**
* Generates an array representation of the node and its children
* @abstract
* @return Array A representation of the node and its children
*/
function
toArray
() {
DOMIT_DOMException::
raiseException
(
DOMIT_HIERARCHY_REQUEST_ERR
,
(
'
Method toArray cannot be called by class
'
.
get_class
(
$
this
)));
}
//toArray
/**
* A node event that can be set to fire upon document loading, used for node initialization
* @abstract
*/
function
onLoad
() {
//you can override this method if you subclass any of the
//DOMIT_Lite_Nodes. It's a way of performing
//initialization of your subclass as soon as the document
//has been loaded (as opposed to as soon as the current node
//has been instantiated).
}
//onLoad
/**
* Clears previousSibling, nextSibling, and parentNode references from a node that has been removed
*/
function
clearReferences
() {
if
(
$
this
->
previousSibling
!=
null
) {
unset(
$
this
->
previousSibling
);
$
this
->
previousSibling
=
null
;
}
if
(
$
this
->
nextSibling
!=
null
) {
unset(
$
this
->
nextSibling
);
$
this
->
nextSibling
=
null
;
}
if
(
$
this
->
parentNode
!=
null
) {
unset(
$
this
->
parentNode
);
$
this
->
parentNode
=
null
;
}
}
//clearReferences
/**
* Generates a normalized (formatted for readability) representation of the node and its children
* @param boolean True if HTML readable output is desired
* @param boolean True if illegal xml characters in text nodes and attributes should be converted to entities
* @return string The formatted string representation
*/
function
toNormalizedString
(
$
htmlSafe
=
false
,
$
subEntities
=
false
) {
//require this file for generating a normalized (readable) xml string representation
require_once
(
DOMIT_INCLUDE_PATH
.
'
xml_domit_utilities.php
'
);
global
$
DOMIT_defined_entities_flip
;
$
result
= DOMIT_Utilities::
toNormalizedString
(
$
this
,
$
subEntities
,
$
DOMIT_defined_entities_flip
);
if
(
$
htmlSafe
)
$
result
=
$
this
->
forHTML
(
$
result
);
return
$
result
;
}
//toNormalizedString
}
//DOMIT_Lite_Node
/**
* A parent class for nodes which possess child nodes
*
* @package domit-xmlparser
* @subpackage domit-xmlparser-lite
* @author John Heinstein <johnkarl@nbnet.nb.ca>
*/
class
DOMIT_Lite_ChildNodes_Interface
extends
DOMIT_Lite_Node {
/**
* Raises error if abstract class is directly instantiated
*/
function
DOMIT_Lite_ChildNodes_Interface
() {
DOMIT_DOMException::
raiseException
(
DOMIT_ABSTRACT_CLASS_INSTANTIATION_ERR
,
'
Cannot instantiate abstract class DOMIT_Lite_ChildNodes_Interface
'
);
}
//DOMIT_Lite_ChildNodes_Interface
/**
* Appends a node to the childNodes list of the current node
* @param Object The node to be appended
* @return Object The appended node
*/
function
&
appendChild
(&
$
child
) {
if
(!(
$
this
->
hasChildNodes
())) {
$
this
->
childNodes
[
0
] =&
$
child
;
$
this
->
firstChild
=&
$
child
;
}
else
{
//remove $child if it already exists
$
index
=
$
this
->
getChildNodeIndex
(
$
this
->
childNodes
,
$
child
);
if
(
$
index
!= -
1
) {
$
this
->
removeChild
(
$
child
);
}
//append child
$
numNodes
=
$
this
->
childCount
;
$
prevSibling
=&
$
this
->
childNodes
[(
$
numNodes
-
1
)];
$
this
->
childNodes
[
$
numNodes
] =&
$
child
;
//set next and previous relationships
$
child
->
previousSibling
=&
$
prevSibling
;
$
prevSibling
->
nextSibling
=&
$
child
;
}
$
this
->
lastChild
=&
$
child
;
$
child
->
parentNode
=&
$
this
;
unset(
$
child
->
nextSibling
);
$
child
->
nextSibling
=
null
;
$
child
->
setOwnerDocument
(
$
this
);
$
this
->
childCount
++;
return
$
child
;
}
//appendChild
/**
* Inserts a node to the childNodes list of the current node
* @param Object The node to be inserted
* @param Object The node before which the insertion is to occur
* @return Object The inserted node
*/
function
&
insertBefore
(&
$
newChild
, &
$
refChild
) {
if
((
$
refChild
->
nodeType
==
DOMIT_DOCUMENT_NODE
) ||
(
$
refChild
->
parentNode
==
null
)) {
DOMIT_DOMException::
raiseException
(
DOMIT_NOT_FOUND_ERR
,
'
Reference child not present in the child nodes list.
'
);
}
//if reference child is also the node to be inserted
//leave the document as is and don't raise an exception
if
(
$
refChild
->
uid
==
$
newChild
->
uid
) {
return
$
newChild
;
}
//remove $newChild if it already exists
$
index
=
$
this
->
getChildNodeIndex
(
$
this
->
childNodes
,
$
newChild
);
if
(
$
index
!= -
1
) {
$
this
->
removeChild
(
$
newChild
);
}
//find index of $refChild in childNodes
$
index
=
$
this
->
getChildNodeIndex
(
$
this
->
childNodes
,
$
refChild
);
if
(
$
index
!= -
1
) {
//reset sibling chain
if
(
$
refChild
->
previousSibling
!=
null
) {
$
refChild
->
previousSibling
->
nextSibling
=&
$
newChild
;
$
newChild
->
previousSibling
=&
$
refChild
->
previousSibling
;
}
else
{
$
this
->
firstChild
=&
$
newChild
;
if
(
$
newChild
->
previousSibling
!=
null
) {
unset(
$
newChild
->
previousSibling
);
$
newChild
->
previousSibling
=
null
;
}
}
$
newChild
->
parentNode
=&
$
refChild
->
parentNode
;
$
newChild
->
nextSibling
=&
$
refChild
;
$
refChild
->
previousSibling
=&
$
newChild
;
//add node to childNodes
$
i
=
$
this
->
childCount
;
while
(
$
i
>=
0
) {
if
(
$
i
>
$
index
) {
$
this
->
childNodes
[
$
i
] =&
$
this
->
childNodes
[(
$
i
-
1
)];
}
else
if
(
$
i
==
$
index
) {
$
this
->
childNodes
[
$
i
] =&
$
newChild
;
}
$
i
--;
}
$
this
->
childCount
++;
}
else
{
$
this
->
appendChild
(
$
newChild
);
}
$
newChild
->
setOwnerDocument
(
$
this
);
return
$
newChild
;
}
//insertBefore
/**
* Replaces a node with another
* @param Object The new node
* @param Object The old node
* @return Object The new node
*/
function
&
replaceChild
(&
$
newChild
, &
$
oldChild
) {
if
(
$
this
->
hasChildNodes
()) {
//remove $newChild if it already exists
$
index
=
$
this
->
getChildNodeIndex
(
$
this
->
childNodes
,
$
newChild
);
if
(
$
index
!= -
1
) {
$
this
->
removeChild
(
$
newChild
);
}
//find index of $oldChild in childNodes
$
index
=
$
this
->
getChildNodeIndex
(
$
this
->
childNodes
,
$
oldChild
);
if
(
$
index
!= -
1
) {
$
newChild
->
ownerDocument
=&
$
oldChild
->
ownerDocument
;
$
newChild
->
parentNode
=&
$
oldChild
->
parentNode
;
//reset sibling chain
if
(
$
oldChild
->
previousSibling
==
null
) {
unset(
$
newChild
->
previousSibling
);
$
newChild
->
previousSibling
=
null
;
}
else
{
$
oldChild
->
previousSibling
->
nextSibling
=&
$
newChild
;
$
newChild
->
previousSibling
=&
$
oldChild
->
previousSibling
;
}
if
(
$
oldChild
->
nextSibling
==
null
) {
unset(
$
newChild
->
nextSibling
);
$
newChild
->
nextSibling
=
null
;
}
else
{
$
oldChild
->
nextSibling
->
previousSibling
=&
$
newChild
;
$
newChild
->
nextSibling
=&
$
oldChild
->
nextSibling
;
}
$
this
->
childNodes
[
$
index
] =&
$
newChild
;
if
(
$
index
==
0
)
$
this
->
firstChild
=&
$
newChild
;
if
(
$
index
== (
$
this
->
childCount
-
1
))
$
this
->
lastChild
=&
$
newChild
;
$
newChild
->
setOwnerDocument
(
$
this
);
return
$
newChild
;
}
}
DOMIT_DOMException::
raiseException
(
DOMIT_NOT_FOUND_ERR
,
(
'
Reference node for replaceChild not found.
'
));
}
//replaceChild
/**
* Removes a node from the childNodes list of the current node
* @param Object The node to be removed
* @return Object The removed node
*/
function
&
removeChild
(&
$
oldChild
) {
if
(
$
this
->
hasChildNodes
()) {
//find index of $oldChild in childNodes
$
index
=
$
this
->
getChildNodeIndex
(
$
this
->
childNodes
,
$
oldChild
);
if
(
$
index
!= -
1
) {
//reset sibling chain
if
((
$
oldChild
->
previousSibling
!=
null
) && (
$
oldChild
->
nextSibling
!=
null
)) {
$
oldChild
->
previousSibling
->
nextSibling
=&
$
oldChild
->
nextSibling
;
$
oldChild
->
nextSibling
->
previousSibling
=&
$
oldChild
->
previousSibling
;
}
else
if
((
$
oldChild
->
previousSibling
!=
null
) && (
$
oldChild
->
nextSibling
==
null
)) {
$
this
->
lastChild
=&
$
oldChild
->
previousSibling
;
unset(
$
oldChild
->
previousSibling
->
nextSibling
);
$
oldChild
->
previousSibling
->
nextSibling
=
null
;
}
else
if
((
$
oldChild
->
previousSibling
==
null
) && (
$
oldChild
->
nextSibling
!=
null
)) {
unset(
$
oldChild
->
nextSibling
->
previousSibling
);
$
oldChild
->
nextSibling
->
previousSibling
=
null
;
$
this
->
firstChild
=&
$
oldChild
->
nextSibling
;
}
else
if
((
$
oldChild
->
previousSibling
==
null
) && (
$
oldChild
->
nextSibling
==
null
)) {
unset(
$
this
->
firstChild
);
$
this
->
firstChild
=
null
;
unset(
$
this
->
lastChild
);
$
this
->
lastChild
=
null
;
}
$
total
=
$
this
->
childCount
;
//remove node from childNodes
for
(
$
i
=
0
;
$
i
<
$
total
;
$
i
++) {
if
(
$
i
== (
$
total
-
1
)) {
array_splice
(
$
this
->
childNodes
,
$
i
,
1
);
}
else
if
(
$
i
>=
$
index
) {
$
this
->
childNodes
[
$
i
] =&
$
this
->
childNodes
[(
$
i
+
1
)];
}
}
$
this
->
childCount
--;
$
oldChild
->
clearReferences
();
return
$
oldChild
;
}
}
DOMIT_DOMException::
raiseException
(
DOMIT_NOT_FOUND_ERR
,
(
'
Target node for removeChild not found.
'
));
}
//removeChild
/**
* Searches the element tree for an element with the specified attribute name and value.
* @param string The value of the attribute
* @param string The name of the attribute
* @param boolean True if the first found node is to be returned as a node instead of a nodelist
* @param boolean True if uid is to be considered an attribute
* @return object A NodeList of found elements, or null
*/
function
&
getElementsByAttribute
(
$
attrName
=
'
id
'
,
$
attrValue
=
''
,
$
returnFirstFoundNode
=
false
,
$
treatUIDAsAttribute
=
false
) {
require_once
(
DOMIT_INCLUDE_PATH
.
'
xml_domit_nodemaps.php
'
);
$
nodelist
=
new
DOMIT_NodeList
();
switch
(
$
this
->
nodeType
) {
case
DOMIT_ELEMENT_NODE
:
$
this
->
_getElementsByAttribute
(
$
nodelist
,
$
attrName
,
$
attrValue
,
$
returnFirstFoundNode
,
$
treatUIDAsAttribute
);
break
;
case
DOMIT_DOCUMENT_NODE
:
if
(
$
this
->
documentElement
!=
null
) {
$
this
->
documentElement
->
_getElementsByAttribute
(
$
nodelist
,
$
attrName
,
$
attrValue
,
$
returnFirstFoundNode
,
$
treatUIDAsAttribute
);
}
break
;
}
if
(
$
returnFirstFoundNode
) {
if
(
$
nodelist
->
getLength
() >
0
) {
return
$
nodelist
->
item
(
0
);
}
$
null
=
null
;
return
$
null
;
}
return
$
nodelist
;
}
//getElementsByAttribute
/**
* Searches the element tree for an element with the specified attribute name and value.
* @param object The node list of found elements
* @param string The value of the attribute
* @param string The name of the attribute
* @param boolean True if the first found node is to be returned as a node instead of a nodelist
* @param boolean True if uid is to be considered an attribute
* @param boolean True the node has been found
*/
function
_getElementsByAttribute
(&
$
nodelist
,
$
attrName
,
$
attrValue
,
$
returnFirstFoundNode
,
$
treatUIDAsAttribute
,
$
foundNode
=
false
) {
if
(!(
$
foundNode
&&
$
returnFirstFoundNode
)) {
if
((
$
this
->
getAttribute
(
$
attrName
) ==
$
attrValue
) ||
(
$
treatUIDAsAttribute
&& (
$
attrName
==
'
uid
'
) && (
$
this
->
uid
==
$
attrValue
))) {
$
nodelist
->
appendNode
(
$
this
);
$
foundNode
=
true
;
if
(
$
returnFirstFoundNode
)
return
;
}
$
total
=
$
this
->
childCount
;
for
(
$
i
=
0
;
$
i
<
$
total
;
$
i
++) {
$
currNode
=&
$
this
->
childNodes
[
$
i
];
if
(
$
currNode
->
nodeType
==
DOMIT_ELEMENT_NODE
) {
$
currNode
->
_getElementsByAttribute
(
$
nodelist
,
$
attrName
,
$
attrValue
,
$
returnFirstFoundNode
,
$
treatUIDAsAttribute
,
$
foundNode
);
}
}
}
}
//_getElementsByAttribute
}
//DOMIT_Lite_ChildNodes_Interface
/**
* A class representing the DOM Document
*
* @package domit-xmlparser
* @subpackage domit-xmlparser-lite
* @author John Heinstein <johnkarl@nbnet.nb.ca>
*/
class
DOMIT_Lite_Document
extends
DOMIT_Lite_ChildNodes_Interface {
/** @var string The xml declaration text */
var
$
xmlDeclaration
;
/** @var string The doctype text */
var
$
doctype
;
/** @var Object A reference to the root node of the DOM document */
var
$
documentElement
;
/** @var string The parser used to process the DOM document, either "EXPAT" or "SAXY_LITE" */
var
$
parser
;
/** @var Object A reference to the DOMIT_DOMImplementation object */
var
$
implementation
;
/** @var Array User defined translation table for XML entities */
var
$
definedEntities
=
array
();
/** @var boolean If true, loadXML or parseXML will attempt to detect and repair invalid xml */
var
$
doResolveErrors
=
false
;
/** @var boolean True if whitespace is to be preserved during parsing */
var
$
preserveWhitespace
=
false
;
/** @var boolean If true, elements tags will be rendered to string as <element></element> rather than <element/> */
var
$
doExpandEmptyElementTags
=
false
;
/** @var array A list of exceptions to the empty element expansion rule */
var
$
expandEmptyElementExceptions
=
array
();
/** @var int The error code returned by the SAX parser */
var
$
errorCode
=
0
;
/** @var string The error string returned by the SAX parser */
var
$
errorString
=
''
;
/** @var object A reference to a http connection or proxy server, if one is required */
var
$
httpConnection
=
null
;
/** @var boolean True if php_http_client_generic is to be used instead of PHP get_file_contents to retrieve xml data */
var
$
doUseHTTPClient
=
false
;
/**
* DOM Document constructor
*/
function
DOMIT_Lite_Document
() {
$
this
->
_constructor
();
$
this
->
xmlDeclaration
=
''
;
$
this
->
doctype
=
''
;
$
this
->
documentElement
=
null
;
$
this
->
nodeType
=
DOMIT_DOCUMENT_NODE
;
$
this
->
nodeName
=
'
#document
'
;
$
this
->
ownerDocument
=&
$
this
;
$
this
->
parser
=
''
;
$
this
->
implementation
=
new
DOMIT_DOMImplementation
();
}
//DOMIT_Lite_Document
/**
* Specifies whether DOMIT! Lite will try to fix invalid XML before parsing begins
* @param boolean True if errors are to be resolved
*/
function
resolveErrors
(
$
truthVal
) {
$
this
->
doResolveErrors
=
$
truthVal
;
}
//resolveErrors
/**
* Specifies the parameters of the http conection used to obtain the xml data
* @param string The ip address or domain name of the connection
* @param string The path of the connection
* @param int The port that the connection is listening on
* @param int The timeout value for the connection
* @param string The user name, if authentication is required
* @param string The password, if authentication is required
*/
function
setConnection
(
$
host
,
$
path
=
'
/
'
,
$
port
=
80
,
$
timeout
=
0
,
$
user
=
null
,
$
password
=
null
) {
require_once
(
DOMIT_INCLUDE_PATH
.
'
php_http_client_generic.php
'
);
$
this
->
httpConnection
=
new
php_http_client_generic
(
$
host
,
$
path
,
$
port
,
$
timeout
,
$
user
,
$
password
);
}
//setConnection
/**
* Specifies whether DOMIT! preserves whitespace when parsing
* @param boolean True if whitespace is to be preserved
*/
function
preserveWhitespace
(
$
truthVal
) {
$
this
->
preserveWhitespace
=
$
truthVal
;
}
//preserveWhitespace
/**
* Specifies basic authentication for an http connection
* @param string The user name
* @param string The password
*/
function
setAuthorization
(
$
user
,
$
password
) {
$
this
->
httpConnection
->
setAuthorization
(
$
user
,
$
password
);
}
//setAuthorization
/**
* Specifies that a proxy is to be used to obtain the xml data
* @param string The ip address or domain name of the proxy
* @param string The path to the proxy
* @param int The port that the proxy is listening on
* @param int The timeout value for the connection
* @param string The user name, if authentication is required
* @param string The password, if authentication is required
*/
function
setProxyConnection
(
$
host
,
$
path
=
'
/
'
,
$
port
=
80
,
$
timeout
=
0
,
$
user
=
null
,
$
password
=
null
) {
require_once
(
DOMIT_INCLUDE_PATH
.
'
php_http_proxy.php
'
);
$
this
->
httpConnection
=
new
php_http_proxy
(
$
host
,
$
path
,
$
port
,
$
timeout
,
$
user
,
$
password
);
}
//setProxyConnection
/**
* Specifies basic authentication for the proxy
* @param string The user name
* @param string The password
*/
function
setProxyAuthorization
(
$
user
,
$
password
) {
$
this
->
httpConnection
->
setProxyAuthorization
(
$
user
,
$
password
);
}
//setProxyAuthorization
/**
* Specifies whether an HTTP client should be used to establish a connection
* @param boolean True if an HTTP client is to be used to establish the connection
*/
function
useHTTPClient
(
$
truthVal
) {
$
this
->
doUseHTTPClient
=
$
truthVal
;
}
//useHTTPClient
/**
* Returns the error code from the underlying SAX parser
* @return int The error code
*/
function
getErrorCode
() {
return
$
this
->
errorCode
;
}
//getErrorCode
/**
* Returns the error string from the underlying SAX parser
* @return string The error string
*/
function
getErrorString
() {
return
$
this
->
errorString
;
}
//getErrorString
/**
* Specifies whether elements tags will be rendered to string as <element></element> rather than <element/>
* @param boolean True if the expanded form is to be used
* @param mixed An array of tag names that should be excepted from expandEmptyElements rule (optional)
*/
function
expandEmptyElementTags
(
$
truthVal
,
$
expandEmptyElementExceptions
=
false
) {
$
this
->
doExpandEmptyElementTags
=
$
truthVal
;
if
(
is_array
(
$
expandEmptyElementExceptions
)) {
$
this
->
expandEmptyElementExceptions
=
$
expandEmptyElementExceptions
;
}
}
//expandEmptyElementTags
/**
* Set the specified node as document element
* @param Object The node that is to become document element
* @return Object The new document element
*/
function
&
setDocumentElement
(&
$
node
) {
if
(
$
node
->
nodeType
==
DOMIT_ELEMENT_NODE
) {
if
(
$
this
->
documentElement
==
null
) {
parent
::
appendChild
(
$
node
);
}
else
{
parent
::
replaceChild
(
$
node
,
$
this
->
documentElement
);
}
$
this
->
documentElement
=&
$
node
;
}
else
{
DOMIT_DOMException::
raiseException
(
DOMIT_HIERARCHY_REQUEST_ERR
,
(
'
Cannot add a node of type
'
.
get_class
(
$
node
) .
'
as a Document Element.
'
));
}
return
$
node
;
}
//setDocumentElement
/**
* Appends a node to the childNodes list of the current node
* @param Object The node to be appended
* @return Object The appended node
*/
function
&
appendChild
(&
$
node
) {
if
(
$
node
->
nodeType
==
DOMIT_ELEMENT_NODE
) {
if
(
$
this
->
documentElement
==
null
) {
parent
::
appendChild
(
$
node
);
$
this
->
setDocumentElement
(
$
node
);
}
else
{
//error thrown if documentElement already exists!
DOMIT_DOMException::
raiseException
(
DOMIT_HIERARCHY_REQUEST_ERR
,
(
'
Cannot have more than one root node (documentElement) in a DOMIT_Document.
'
));
}
}
else
{
DOMIT_DOMException::
raiseException
(
DOMIT_HIERARCHY_REQUEST_ERR
,
(
'
Cannot add a node of type
'
.
get_class
(
$
node
) .
'
to a DOMIT_Document.
'
));
}
return
$
node
;
}
//appendChild
/**
* Replaces a node with another
* @param Object The new node
* @param Object The old node
* @return Object The new node
*/
function
&
replaceChild
(&
$
newChild
, &
$
oldChild
) {
if
((
$
this
->
documentElement
!=
null
) && (
$
oldChild
->
uid
==
$
this
->
documentElement
->
uid
)) {
if
(
$
node
->
nodeType
==
DOMIT_ELEMENT_NODE
) {
//replace documentElement with new node
$
this
->
setDocumentElement
(
$
newChild
);
}
else
{
DOMIT_DOMException::
raiseException
(
DOMIT_HIERARCHY_REQUEST_ERR
,
(
'
Cannot replace Document Element with a node of class
'
.
get_class
(
$
newChild
)));
}
}
else
{
if
(
$
node
->
nodeType
==
DOMIT_ELEMENT_NODE
) {
if
(
$
this
->
documentElement
!=
null
) {
DOMIT_DOMException::
raiseException
(
DOMIT_HIERARCHY_REQUEST_ERR
,
(
'
Cannot have more than one root node (documentElement) in a DOMIT_Document.
'
));
}
else
{
parent
::
replaceChild
(
$
newChild
,
$
oldChild
);
}
}
else
{
DOMIT_DOMException::
raiseException
(
DOMIT_HIERARCHY_REQUEST_ERR
,
(
'
Nodes of class
'
.
get_class
(
$
newChild
) .
'
cannot be children of a DOMIT_Document.
'
));
}
}
return
$
newChild
;
}
//replaceChild
/**
* Inserts a node to the childNodes list of the current node
* @param Object The node to be inserted
* @param Object The node before which the insertion is to occur
* @return Object The inserted node
*/
function
&
insertBefore
(&
$
newChild
, &
$
refChild
) {
$
type
=
$
newChild
->
nodeType
;
if
(
$
type
==
DOMIT_ELEMENT_NODE
) {
if
(
$
this
->
documentElement
==
null
) {
parent
::
insertBefore
(
$
newChild
,
$
refChild
);
$
this
->
setDocumentElement
(
$
newChild
);
}
else
{
//error thrown if documentElement already exists!
DOMIT_DOMException::
raiseException
(
DOMIT_HIERARCHY_REQUEST_ERR
,
(
'
Cannot have more than one root node (documentElement) in a DOMIT_Document.
'
));
}
}
else
{
DOMIT_DOMException::
raiseException
(
DOMIT_HIERARCHY_REQUEST_ERR
,
(
'
Cannot insert a node of type
'
.
get_class
(
$
newChild
) .
'
to a DOMIT_Document.
'
));
}
return
$
newChild
;
}
//insertBefore
/**
* Removes a node from the childNodes list of the current node
* @param Object The node to be removed
* @return Object The removed node
*/
function
&
removeChild
(&
$
oldChild
) {
if
((
$
this
->
documentElement
!=
null
) && (
$
oldChild
->
uid
==
$
this
->
documentElement
->
uid
)) {
parent
::
removeChild
(
$
oldChild
);
$
this
->
documentElement
=
null
;
}
else
{
parent
::
removeChild
(
$
oldChild
);
}
$
oldChild
->
clearReferences
();
return
$
oldChild
;
}
//removeChild
/**
* Creates a new DOMIT_Lite_Element node
* @param string The tag name of the element
* @return Object The new element
*/
function
&
createElement
(
$
tagName
) {
$
node
=
new
DOMIT_Lite_Element
(
$
tagName
);
$
node
->
ownerDocument
=&
$
this
;
return
$
node
;
}
//createElement
/**
* Creates a new DOMIT_Text node
* @param string The text of the node
* @return Object The new text node
*/
function
&
createTextNode
(
$
data
) {
$
node
=
new
DOMIT_Lite_TextNode
(
$
data
);
$
node
->
ownerDocument
=&
$
this
;
return
$
node
;
}
//createTextNode
/**
* Creates a new DOMIT_Lite_CDATASection node
* @param string The text of the CDATASection
* @return Object The new CDATASection node
*/
function
&
createCDATASection
(
$
data
) {
$
node
=
new
DOMIT_Lite_CDATASection
(
$
data
);
$
node
->
ownerDocument
=&
$
this
;
return
$
node
;
}
//createCDATASection
/**
* Retrieves a NodeList of child elements with the specified tag name
* @param string The matching element tag name
* @return Object A NodeList of found elements
*/
function
&
getElementsByTagName
(
$
tagName
) {
$
nodeList
=
new
DOMIT_NodeList
();
if
(
$
this
->
documentElement
!=
null
) {
$
this
->
documentElement
->
getNamedElements
(
$
nodeList
,
$
tagName
);
}
return
$
nodeList
;
}
//getElementsByTagName
/**
* Retrieves an element or DOMIT_NodeList of elements corresponding to an Xpath-like expression.
* @param string The query pattern
* @param int If a single node is to be returned (rather than the entire NodeList) the index of that node
* @return mixed A NodeList or single node that matches the pattern
*/
function
&
getElementsByPath
(
$
pattern
,
$
nodeIndex
=
0
) {
require_once
(
DOMIT_INCLUDE_PATH
.
'
xml_domit_getelementsbypath.php
'
);
$
gebp
=
new
DOMIT_GetElementsByPath
();
$
myResponse
=&
$
gebp
->
parsePattern
(
$
this
,
$
pattern
,
$
nodeIndex
);
return
$
myResponse
;
}
//getElementsByPath
/**
* Parses an xml string; first encodes string as UTF-8
* @param string The xml text to be parsed
* @param boolean True if SAXY is to be used instead of Expat
* @param boolean False if CDATA Section are to be generated as Text nodes
* @param boolean True if onLoad is to be called on each node after parsing
* @return boolean True if parsing is successful
*/
function
parseXML_utf8
(
$
xmlText
,
$
useSAXY
=
true
,
$
preserveCDATA
=
true
,
$
fireLoadEvent
=
false
) {
return
$
this
->
parseXML
(
utf8_encode
(
$
xmlText
),
$
useSAXY
,
$
preserveCDATA
,
$
fireLoadEvent
);
}
//parseXML_utf8
/**
* Parses an xml string
* @param string The xml text to be parsed
* @param boolean True if SAXY is to be used instead of Expat
* @param boolean False if CDATA Section are to be generated as Text nodes
* @param boolean True if onLoad is to be called on each node after parsing
* @return boolean True if parsing is successful
*/
function
parseXML
(
$
xmlText
,
$
useSAXY
=
true
,
$
preserveCDATA
=
true
,
$
fireLoadEvent
=
false
) {
require_once
(
DOMIT_INCLUDE_PATH
.
'
xml_domit_utilities.php
'
);
if
(
$
this
->
doResolveErrors
) {
require_once
(
DOMIT_INCLUDE_PATH
.
'
xml_domit_doctor.php
'
);
$
xmlText
= DOMIT_Doctor::
fixAmpersands
(
$
xmlText
);
}
if
(DOMIT_Utilities::
validateXML
(
$
xmlText
)) {
$
domParser
=
new
DOMIT_Lite_Parser
();
if
(
$
useSAXY
|| (!
function_exists
(
'
xml_parser_create
'
))) {
//use SAXY parser to populate xml tree
$
this
->
parser
=
'
SAXY_LITE
'
;
$
success
=
$
domParser
->
parseSAXY
(
$
this
,
$
xmlText
,
$
preserveCDATA
,
$
this
->
definedEntities
);
}
else
{
//use Expat parser to populate xml tree
$
this
->
parser
=
'
EXPAT
'
;
View remainder of file in raw view
Back
|
FazBrowse Home
|
New Git URL