/
document.php
1120 lines (997 loc) · 21.3 KB
/
document.php
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
/**
* @package Joomla.Platform
* @subpackage Document
*
* @copyright Copyright (C) 2005 - 2016 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Document class, provides an easy interface to parse and display a document
*
* @since 11.1
*/
class JDocument
{
/**
* Document title
*
* @var string
* @since 11.1
*/
public $title = '';
/**
* Document description
*
* @var string
* @since 11.1
*/
public $description = '';
/**
* Document full URL
*
* @var string
* @since 11.1
*/
public $link = '';
/**
* Document base URL
*
* @var string
* @since 11.1
*/
public $base = '';
/**
* Contains the document language setting
*
* @var string
* @since 11.1
*/
public $language = 'en-gb';
/**
* Contains the document direction setting
*
* @var string
* @since 11.1
*/
public $direction = 'ltr';
/**
* Document generator
*
* @var string
*/
public $_generator = 'Joomla! - Open Source Content Management';
/**
* Document modified date
*
* @var string
* @since 11.1
*/
public $_mdate = '';
/**
* Tab string
*
* @var string
* @since 11.1
*/
public $_tab = "\11";
/**
* Contains the line end string
*
* @var string
* @since 11.1
*/
public $_lineEnd = "\12";
/**
* Contains the character encoding string
*
* @var string
* @since 11.1
*/
public $_charset = 'utf-8';
/**
* Document mime type
*
* @var string
* @since 11.1
*/
public $_mime = '';
/**
* Document namespace
*
* @var string
* @since 11.1
*/
public $_namespace = '';
/**
* Document profile
*
* @var string
* @since 11.1
*/
public $_profile = '';
/**
* Array of linked scripts
*
* @var array
* @since 11.1
*/
public $_scripts = array();
/**
* Array of scripts placed in the header
*
* @var array
* @since 11.1
*/
public $_script = array();
/**
* Array of scripts options
*
* @var array
*/
protected $scriptOptions = array();
/**
* Array of linked style sheets
*
* @var array
* @since 11.1
*/
public $_styleSheets = array();
/**
* Array of included style declarations
*
* @var array
* @since 11.1
*/
public $_style = array();
/**
* Array of meta tags
*
* @var array
* @since 11.1
*/
public $_metaTags = array();
/**
* The rendering engine
*
* @var object
* @since 11.1
*/
public $_engine = null;
/**
* The document type
*
* @var string
* @since 11.1
*/
public $_type = null;
/**
* Array of buffered output
*
* @var mixed (depends on the renderer)
* @since 11.1
*/
public static $_buffer = null;
/**
* JDocument instances container.
*
* @var array
* @since 11.3
*/
protected static $instances = array();
/**
* Media version added to assets
*
* @var string
* @since 3.2
*/
protected $mediaVersion = null;
/**
* Class constructor.
*
* @param array $options Associative array of options
*
* @since 11.1
*/
public function __construct($options = array())
{
if (array_key_exists('lineend', $options))
{
$this->setLineEnd($options['lineend']);
}
if (array_key_exists('charset', $options))
{
$this->setCharset($options['charset']);
}
if (array_key_exists('language', $options))
{
$this->setLanguage($options['language']);
}
if (array_key_exists('direction', $options))
{
$this->setDirection($options['direction']);
}
if (array_key_exists('tab', $options))
{
$this->setTab($options['tab']);
}
if (array_key_exists('link', $options))
{
$this->setLink($options['link']);
}
if (array_key_exists('base', $options))
{
$this->setBase($options['base']);
}
if (array_key_exists('mediaversion', $options))
{
$this->setMediaVersion($options['mediaversion']);
}
}
/**
* Returns the global JDocument object, only creating it
* if it doesn't already exist.
*
* @param string $type The document type to instantiate
* @param array $attributes Array of attributes
*
* @return object The document object.
*
* @since 11.1
*/
public static function getInstance($type = 'html', $attributes = array())
{
$signature = serialize(array($type, $attributes));
if (empty(self::$instances[$signature]))
{
$type = preg_replace('/[^A-Z0-9_\.-]/i', '', $type);
$ntype = null;
// Determine the path and class
$class = 'JDocument' . ucfirst($type);
if (!class_exists($class))
{
// @deprecated 4.0 - JDocument objects should be autoloaded instead
$path = __DIR__ . '/' . $type . '/' . $type . '.php';
if (file_exists($path))
{
JLog::add('Non-autoloadable JDocument subclasses are deprecated, support will be removed in 4.0.', JLog::WARNING, 'deprecated');
require_once $path;
}
// Default to the raw format
else
{
$ntype = $type;
$class = 'JDocumentRaw';
}
}
$instance = new $class($attributes);
self::$instances[$signature] = $instance;
if (!is_null($ntype))
{
// Set the type to the Document type originally requested
$instance->setType($ntype);
}
}
return self::$instances[$signature];
}
/**
* Set the document type
*
* @param string $type Type document is to set to
*
* @return JDocument instance of $this to allow chaining
*
* @since 11.1
*/
public function setType($type)
{
$this->_type = $type;
return $this;
}
/**
* Returns the document type
*
* @return string
*
* @since 11.1
*/
public function getType()
{
return $this->_type;
}
/**
* Get the contents of the document buffer
*
* @return The contents of the document buffer
*
* @since 11.1
*/
public function getBuffer()
{
return self::$_buffer;
}
/**
* Set the contents of the document buffer
*
* @param string $content The content to be set in the buffer.
* @param array $options Array of optional elements.
*
* @return JDocument instance of $this to allow chaining
*
* @since 11.1
*/
public function setBuffer($content, $options = array())
{
self::$_buffer = $content;
return $this;
}
/**
* Gets a meta tag.
*
* @param string $name Name of the meta HTML tag
* @param string $attribute Attribute to use in the meta HTML tag
*
* @return string
*
* @since 11.1
*/
public function getMetaData($name, $attribute = 'name')
{
// B/C old http_equiv parameter.
if (!is_string($attribute))
{
$attribute = $attribute == true ? 'http-equiv' : 'name';
}
if ($name == 'generator')
{
$result = $this->getGenerator();
}
elseif ($name == 'description')
{
$result = $this->getDescription();
}
else
{
$result = isset($this->_metaTags[$attribute]) && isset($this->_metaTags[$attribute][$name]) ? $this->_metaTags[$attribute][$name] : '';
}
return $result;
}
/**
* Sets or alters a meta tag.
*
* @param string $name Name of the meta HTML tag
* @param string $content Value of the meta HTML tag
* @param string $attribute Attribute to use in the meta HTML tag
*
* @return JDocument instance of $this to allow chaining
*
* @since 11.1
*/
public function setMetaData($name, $content, $attribute = 'name')
{
// B/C old http_equiv parameter.
if (!is_string($attribute))
{
$attribute = $attribute == true ? 'http-equiv' : 'name';
}
if ($name == 'generator')
{
$this->setGenerator($content);
}
elseif ($name == 'description')
{
$this->setDescription($content);
}
else
{
$this->_metaTags[$attribute][$name] = $content;
}
return $this;
}
/**
* Adds a linked script to the page
*
* @param string $url URL to the linked script
* @param string $type Type of script. Defaults to 'text/javascript'
* @param boolean $defer Adds the defer attribute.
* @param boolean $async Adds the async attribute.
*
* @return JDocument instance of $this to allow chaining
*
* @since 11.1
*/
public function addScript($url, $type = "text/javascript", $defer = false, $async = false)
{
$this->_scripts[$url]['mime'] = $type;
$this->_scripts[$url]['defer'] = $defer;
$this->_scripts[$url]['async'] = $async;
return $this;
}
/**
* Adds a linked script to the page with a version to allow to flush it. Ex: myscript.js54771616b5bceae9df03c6173babf11d
* If not specified Joomla! automatically handles versioning
*
* @param string $url URL to the linked script
* @param string $version Version of the script
* @param string $type Type of script. Defaults to 'text/javascript'
* @param boolean $defer Adds the defer attribute.
* @param boolean $async [description]
*
* @return JDocument instance of $this to allow chaining
*
* @since 3.2
*/
public function addScriptVersion($url, $version = null, $type = "text/javascript", $defer = false, $async = false)
{
// Automatic version
if ($version === null)
{
$version = $this->getMediaVersion();
}
if (!empty($version) && strpos($url, '?') === false)
{
$url .= '?' . $version;
}
return $this->addScript($url, $type, $defer, $async);
}
/**
* Adds a script to the page
*
* @param string $content Script
* @param string $type Scripting mime (defaults to 'text/javascript')
*
* @return JDocument instance of $this to allow chaining
*
* @since 11.1
*/
public function addScriptDeclaration($content, $type = 'text/javascript')
{
if (!isset($this->_script[strtolower($type)]))
{
$this->_script[strtolower($type)] = $content;
}
else
{
$this->_script[strtolower($type)] .= chr(13) . $content;
}
return $this;
}
/**
* Add option for script
*
* @param string $key Name in Storage
* @param mixed $options Scrip options as array or string
* @param bool $merge Whether merge with existing (true) or replace (false)
*
* @return JDocument instance of $this to allow chaining
*
* @since 3.5
*/
public function addScriptOptions($key, $options, $merge = true)
{
if (empty($this->scriptOptions[$key]))
{
$this->scriptOptions[$key] = array();
}
if ($merge && is_array($options))
{
$this->scriptOptions[$key] = array_merge($this->scriptOptions[$key], $options);
}
else
{
$this->scriptOptions[$key] = $options;
}
return $this;
}
/**
* Get script(s) options
*
* @param string $key Name in Storage
*
* @return array Options for given $key, or all script options
*
* @since 3.5
*/
public function getScriptOptions($key = null)
{
if ($key)
{
return (empty($this->scriptOptions[$key])) ? array() : $this->scriptOptions[$key];
}
else
{
return $this->scriptOptions;
}
}
/**
* Adds a linked stylesheet to the page
*
* @param string $url URL to the linked style sheet
* @param string $type Mime encoding type
* @param string $media Media type that this stylesheet applies to
* @param array $attribs Array of attributes
*
* @return JDocument instance of $this to allow chaining
*
* @since 11.1
*/
public function addStyleSheet($url, $type = 'text/css', $media = null, $attribs = array())
{
$this->_styleSheets[$url]['mime'] = $type;
$this->_styleSheets[$url]['media'] = $media;
$this->_styleSheets[$url]['attribs'] = $attribs;
return $this;
}
/**
* Adds a linked stylesheet version to the page. Ex: template.css?54771616b5bceae9df03c6173babf11d
* If not specified Joomla! automatically handles versioning
*
* @param string $url URL to the linked style sheet
* @param string $version Version of the stylesheet
* @param string $type Mime encoding type
* @param string $media Media type that this stylesheet applies to
* @param array $attribs Array of attributes
*
* @return JDocument instance of $this to allow chaining
*
* @since 3.2
*/
public function addStyleSheetVersion($url, $version = null, $type = "text/css", $media = null, $attribs = array())
{
// Automatic version
if ($version === null)
{
$version = $this->getMediaVersion();
}
if (!empty($version) && strpos($url, '?') === false)
{
$url .= '?' . $version;
}
return $this->addStyleSheet($url, $type, $media, $attribs);
}
/**
* Adds a stylesheet declaration to the page
*
* @param string $content Style declarations
* @param string $type Type of stylesheet (defaults to 'text/css')
*
* @return JDocument instance of $this to allow chaining
*
* @since 11.1
*/
public function addStyleDeclaration($content, $type = 'text/css')
{
if (!isset($this->_style[strtolower($type)]))
{
$this->_style[strtolower($type)] = $content;
}
else
{
$this->_style[strtolower($type)] .= chr(13) . $content;
}
return $this;
}
/**
* Sets the document charset
*
* @param string $type Charset encoding string
*
* @return JDocument instance of $this to allow chaining
*
* @since 11.1
*/
public function setCharset($type = 'utf-8')
{
$this->_charset = $type;
return $this;
}
/**
* Returns the document charset encoding.
*
* @return string
*
* @since 11.1
*/
public function getCharset()
{
return $this->_charset;
}
/**
* Sets the global document language declaration. Default is English (en-gb).
*
* @param string $lang The language to be set
*
* @return JDocument instance of $this to allow chaining
*
* @since 11.1
*/
public function setLanguage($lang = "en-gb")
{
$this->language = strtolower($lang);
return $this;
}
/**
* Returns the document language.
*
* @return string
*
* @since 11.1
*/
public function getLanguage()
{
return $this->language;
}
/**
* Sets the global document direction declaration. Default is left-to-right (ltr).
*
* @param string $dir The language direction to be set
*
* @return JDocument instance of $this to allow chaining
*
* @since 11.1
*/
public function setDirection($dir = "ltr")
{
$this->direction = strtolower($dir);
return $this;
}
/**
* Returns the document direction declaration.
*
* @return string
*
* @since 11.1
*/
public function getDirection()
{
return $this->direction;
}
/**
* Sets the title of the document
*
* @param string $title The title to be set
*
* @return JDocument instance of $this to allow chaining
*
* @since 11.1
*/
public function setTitle($title)
{
$this->title = $title;
return $this;
}
/**
* Return the title of the document.
*
* @return string
*
* @since 11.1
*/
public function getTitle()
{
return $this->title;
}
/**
* Set the assets version
*
* @param string $mediaVersion Media version to use
*
* @return JDocument instance of $this to allow chaining
*
* @since 3.2
*/
public function setMediaVersion($mediaVersion)
{
$this->mediaVersion = strtolower($mediaVersion);
return $this;
}
/**
* Return the media version
*
* @return string
*
* @since 3.2
*/
public function getMediaVersion()
{
return $this->mediaVersion;
}
/**
* Sets the base URI of the document
*
* @param string $base The base URI to be set
*
* @return JDocument instance of $this to allow chaining
*
* @since 11.1
*/
public function setBase($base)
{
$this->base = $base;
return $this;
}
/**
* Return the base URI of the document.
*
* @return string
*
* @since 11.1
*/
public function getBase()
{
return $this->base;
}
/**
* Sets the description of the document
*
* @param string $description The description to set
*
* @return JDocument instance of $this to allow chaining
*
* @since 11.1
*/
public function setDescription($description)
{
$this->description = $description;
return $this;
}
/**
* Return the title of the page.
*
* @return string
*
* @since 11.1
*/
public function getDescription()
{
return $this->description;
}
/**
* Sets the document link
*
* @param string $url A url
*
* @return JDocument instance of $this to allow chaining
*
* @since 11.1
*/
public function setLink($url)
{
$this->link = $url;
return $this;
}
/**
* Returns the document base url
*
* @return string
*
* @since 11.1
*/
public function getLink()
{
return $this->link;
}
/**
* Sets the document generator
*
* @param string $generator The generator to be set
*
* @return JDocument instance of $this to allow chaining
*
* @since 11.1
*/
public function setGenerator($generator)
{
$this->_generator = $generator;
return $this;
}
/**
* Returns the document generator
*
* @return string
*
* @since 11.1
*/
public function getGenerator()
{
return $this->_generator;
}
/**
* Sets the document modified date
*
* @param string $date The date to be set
*
* @return JDocument instance of $this to allow chaining
*
* @since 11.1
*/
public function setModifiedDate($date)
{
$this->_mdate = $date;
return $this;
}
/**
* Returns the document modified date
*
* @return string
*
* @since 11.1
*/
public function getModifiedDate()
{
return $this->_mdate;
}
/**
* Sets the document MIME encoding that is sent to the browser.
*
* This usually will be text/html because most browsers cannot yet
* accept the proper mime settings for XHTML: application/xhtml+xml
* and to a lesser extent application/xml and text/xml. See the W3C note
* ({@link http://www.w3.org/TR/xhtml-media-types/
* http://www.w3.org/TR/xhtml-media-types/}) for more details.
*
* @param string $type The document type to be sent
* @param boolean $sync Should the type be synced with HTML?
*
* @return JDocument instance of $this to allow chaining
*
* @since 11.1
*
* @link http://www.w3.org/TR/xhtml-media-types
*/
public function setMimeEncoding($type = 'text/html', $sync = true)
{
$this->_mime = strtolower($type);
// Syncing with meta-data
if ($sync)
{
$this->setMetaData('content-type', $type . '; charset=' . $this->_charset, true);
}
return $this;
}
/**
* Return the document MIME encoding that is sent to the browser.
*
* @return string
*
* @since 11.1
*/
public function getMimeEncoding()
{
return $this->_mime;
}
/**
* Sets the line end style to Windows, Mac, Unix or a custom string.
*
* @param string $style "win", "mac", "unix" or custom string.
*
* @return JDocument instance of $this to allow chaining
*
* @since 11.1
*/
public function setLineEnd($style)
{
switch ($style)
{
case 'win':
$this->_lineEnd = "\15\12";
break;
case 'unix':
$this->_lineEnd = "\12";
break;
case 'mac':
$this->_lineEnd = "\15";
break;
default:
$this->_lineEnd = $style;
}
return $this;
}
/**