-
Notifications
You must be signed in to change notification settings - Fork 626
/
Extension.php
1111 lines (1006 loc) · 40.7 KB
/
Extension.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
/**
* @link https://craftcms.com/
* @copyright Copyright (c) Pixel & Tonic, Inc.
* @license https://craftcms.github.io/license/
*/
namespace craft\web\twig;
use Craft;
use craft\base\MissingComponentInterface;
use craft\base\PluginInterface;
use craft\elements\Asset;
use craft\elements\db\ElementQuery;
use craft\helpers\ArrayHelper;
use craft\helpers\DateTimeHelper;
use craft\helpers\Db;
use craft\helpers\FileHelper;
use craft\helpers\Json;
use craft\helpers\Sequence;
use craft\helpers\StringHelper;
use craft\helpers\Template as TemplateHelper;
use craft\helpers\UrlHelper;
use craft\i18n\Locale;
use craft\web\twig\nodevisitors\EventTagAdder;
use craft\web\twig\nodevisitors\EventTagFinder;
use craft\web\twig\nodevisitors\GetAttrAdjuster;
use craft\web\twig\tokenparsers\CacheTokenParser;
use craft\web\twig\tokenparsers\ExitTokenParser;
use craft\web\twig\tokenparsers\HeaderTokenParser;
use craft\web\twig\tokenparsers\HookTokenParser;
use craft\web\twig\tokenparsers\NamespaceTokenParser;
use craft\web\twig\tokenparsers\NavTokenParser;
use craft\web\twig\tokenparsers\PaginateTokenParser;
use craft\web\twig\tokenparsers\RedirectTokenParser;
use craft\web\twig\tokenparsers\RegisterResourceTokenParser;
use craft\web\twig\tokenparsers\RequireAdminTokenParser;
use craft\web\twig\tokenparsers\RequireEditionTokenParser;
use craft\web\twig\tokenparsers\RequireLoginTokenParser;
use craft\web\twig\tokenparsers\RequirePermissionTokenParser;
use craft\web\twig\tokenparsers\SwitchTokenParser;
use craft\web\twig\variables\CraftVariable;
use craft\web\View;
use DateInterval;
use DateTime;
use DateTimeInterface;
use DateTimeZone;
use enshrined\svgSanitize\Sanitizer;
use Twig\Environment as TwigEnvironment;
use Twig\Error\RuntimeError;
use Twig\Extension\AbstractExtension;
use Twig\Extension\GlobalsInterface;
use Twig\Markup;
use Twig\TwigFilter;
use Twig\TwigFunction;
use Twig\TwigTest;
use yii\base\InvalidArgumentException;
use yii\base\InvalidConfigException;
use yii\db\Expression;
use yii\helpers\Markdown;
/**
* Class Extension
*
* @author Pixel & Tonic, Inc. <support@pixelandtonic.com>
* @since 3.0
*/
class Extension extends AbstractExtension implements GlobalsInterface
{
// Properties
// =========================================================================
/**
* @var View|null
*/
protected $view;
/**
* @var TwigEnvironment|null
*/
protected $environment;
// Public Methods
// =========================================================================
/**
* Constructor
*
* @param View $view
* @param TwigEnvironment $environment
*/
public function __construct(View $view, TwigEnvironment $environment)
{
$this->view = $view;
$this->environment = $environment;
}
/**
* @inheritdoc
*/
public function getNodeVisitors()
{
return [
new GetAttrAdjuster(),
new EventTagFinder(),
new EventTagAdder(),
];
}
/**
* @inheritdoc
*/
public function getTokenParsers(): array
{
return [
new CacheTokenParser(),
new ExitTokenParser(),
new HeaderTokenParser(),
new HookTokenParser(),
new RegisterResourceTokenParser('css', 'registerCss', [
'allowTagPair' => true,
'allowOptions' => true,
]),
new RegisterResourceTokenParser('js', 'registerJs', [
'allowTagPair' => true,
'allowPosition' => true,
'allowRuntimePosition' => true,
]),
new NamespaceTokenParser(),
new NavTokenParser(),
new PaginateTokenParser(),
new RedirectTokenParser(),
new RequireAdminTokenParser(),
new RequireEditionTokenParser(),
new RequireLoginTokenParser(),
new RequirePermissionTokenParser(),
new SwitchTokenParser(),
// Deprecated tags
new RegisterResourceTokenParser('includeCss', 'registerCss', [
'allowTagPair' => true,
'allowOptions' => true,
'newCode' => '{% css %}',
]),
new RegisterResourceTokenParser('includeHiResCss', 'registerHiResCss', [
'allowTagPair' => true,
'allowOptions' => true,
'newCode' => '{% css %}',
]),
new RegisterResourceTokenParser('includeCssFile', 'registerCssFile', [
'allowOptions' => true,
'newCode' => '{% do view.registerCssFile("/url/to/file.css") %}',
]),
new RegisterResourceTokenParser('includeJs', 'registerJs', [
'allowTagPair' => true,
'allowPosition' => true,
'allowRuntimePosition' => true,
'newCode' => '{% js %}',
]),
new RegisterResourceTokenParser('includeJsFile', 'registerJsFile', [
'allowPosition' => true,
'allowOptions' => true,
'newCode' => '{% do view.registerJsFile("/url/to/file.js") %}',
]),
new RegisterResourceTokenParser('includecss', 'registerCss', [
'allowTagPair' => true,
'allowOptions' => true,
'newCode' => '{% css %}',
]),
new RegisterResourceTokenParser('includehirescss', 'registerHiResCss', [
'allowTagPair' => true,
'allowOptions' => true,
'newCode' => '{% css %}',
]),
new RegisterResourceTokenParser('includecssfile', 'registerCssFile', [
'allowOptions' => true,
'newCode' => '{% do view.registerCssFile("/url/to/file.css") %}',
]),
new RegisterResourceTokenParser('includejs', 'registerJs', [
'allowTagPair' => true,
'allowPosition' => true,
'allowRuntimePosition' => true,
'newCode' => '{% js %}',
]),
new RegisterResourceTokenParser('includejsfile', 'registerJsFile', [
'allowPosition' => true,
'allowOptions' => true,
'newCode' => '{% do view.registerJsFile("/url/to/file.js") %}',
]),
];
}
/**
* @inheritdoc
*/
public function getFilters(): array
{
$formatter = Craft::$app->getFormatter();
$security = Craft::$app->getSecurity();
return [
new TwigFilter('ascii', [StringHelper::class, 'toAscii']),
new TwigFilter('atom', [$this, 'atomFilter'], ['needs_environment' => true]),
new TwigFilter('camel', [$this, 'camelFilter']),
new TwigFilter('column', [ArrayHelper::class, 'getColumn']),
new TwigFilter('currency', [$formatter, 'asCurrency']),
new TwigFilter('date', [$this, 'dateFilter'], ['needs_environment' => true]),
new TwigFilter('datetime', [$this, 'datetimeFilter'], ['needs_environment' => true]),
new TwigFilter('duration', [DateTimeHelper::class, 'humanDurationFromInterval']),
new TwigFilter('encenc', [$this, 'encencFilter']),
new TwigFilter('filesize', [$formatter, 'asShortSize']),
new TwigFilter('filter', [$this, 'filterFilter']),
new TwigFilter('filterByValue', [ArrayHelper::class, 'filterByValue']),
new TwigFilter('group', [$this, 'groupFilter']),
new TwigFilter('hash', [$security, 'hashData']),
new TwigFilter('id', [$this->view, 'formatInputId']),
new TwigFilter('index', [ArrayHelper::class, 'index']),
new TwigFilter('indexOf', [$this, 'indexOfFilter']),
new TwigFilter('intersect', 'array_intersect'),
new TwigFilter('json_encode', [$this, 'jsonEncodeFilter']),
new TwigFilter('json_decode', [Json::class, 'decode']),
new TwigFilter('kebab', [$this, 'kebabFilter']),
new TwigFilter('lcfirst', [$this, 'lcfirstFilter']),
new TwigFilter('literal', [$this, 'literalFilter']),
new TwigFilter('markdown', [$this, 'markdownFilter']),
new TwigFilter('md', [$this, 'markdownFilter']),
new TwigFilter('multisort', [$this, 'multisortFilter']),
new TwigFilter('namespace', [$this->view, 'namespaceInputs']),
new TwigFilter('ns', [$this->view, 'namespaceInputs']),
new TwigFilter('namespaceInputName', [$this->view, 'namespaceInputName']),
new TwigFilter('namespaceInputId', [$this->view, 'namespaceInputId']),
new TwigFilter('number', [$formatter, 'asDecimal']),
new TwigFilter('parseRefs', [$this, 'parseRefsFilter']),
new TwigFilter('pascal', [$this, 'pascalFilter']),
new TwigFilter('percentage', [$formatter, 'asPercent']),
new TwigFilter('replace', [$this, 'replaceFilter']),
new TwigFilter('rss', [$this, 'rssFilter'], ['needs_environment' => true]),
new TwigFilter('snake', [$this, 'snakeFilter']),
new TwigFilter('time', [$this, 'timeFilter'], ['needs_environment' => true]),
new TwigFilter('timestamp', [$formatter, 'asTimestamp']),
new TwigFilter('translate', [$this, 'translateFilter']),
new TwigFilter('t', [$this, 'translateFilter']),
new TwigFilter('ucfirst', [$this, 'ucfirstFilter']),
new TwigFilter('ucwords', 'ucwords'),
new TwigFilter('unique', 'array_unique'),
new TwigFilter('values', 'array_values'),
new TwigFilter('without', [$this, 'withoutFilter']),
];
}
/**
* {@inheritdoc}
*/
public function getTests()
{
return [
new TwigTest('instance of', function($obj, $class) {
return $obj instanceof $class;
}),
new TwigTest('missing', function($obj) {
return $obj instanceof MissingComponentInterface;
}),
];
}
/**
* Translates the given message.
*
* @param mixed $message The message to be translated.
* @param string|null $category the message category.
* @param array|null $params The parameters that will be used to replace the corresponding placeholders in the message.
* @param string|null $language The language code (e.g. `en-US`, `en`). If this is null, the current
* [[\yii\base\Application::language|application language]] will be used.
* @return string the translated message.
*/
public function translateFilter($message, $category = null, $params = null, $language = null): string
{
// The front end site doesn't need to specify the category
/** @noinspection CallableParameterUseCaseInTypeContextInspection */
if (is_array($category)) {
/** @noinspection CallableParameterUseCaseInTypeContextInspection */
$language = $params;
/** @noinspection CallableParameterUseCaseInTypeContextInspection */
$params = $category;
$category = 'site';
} else if ($category === null) {
$category = 'site';
}
if ($params === null) {
$params = [];
}
try {
return Craft::t($category, (string)$message, $params, $language);
} catch (InvalidConfigException $e) {
return $message;
}
}
/**
* Uppercases the first character of a multibyte string.
*
* @param mixed $string The multibyte string.
* @return string The string with the first character converted to upercase.
*/
public function ucfirstFilter($string): string
{
return StringHelper::upperCaseFirst((string)$string);
}
/**
* Lowercases the first character of a multibyte string.
*
* @param mixed $string The multibyte string.
* @return string The string with the first character converted to lowercase.
*/
public function lcfirstFilter($string): string
{
return StringHelper::lowercaseFirst((string)$string);
}
/**
* kebab-cases a string.
*
* @param mixed $string The string
* @param string $glue The string used to glue the words together (default is a hyphen)
* @param bool $lower Whether the string should be lowercased (default is true)
* @param bool $removePunctuation Whether punctuation marks should be removed (default is true)
* @return string The kebab-cased string
*/
public function kebabFilter($string, string $glue = '-', bool $lower = true, bool $removePunctuation = true): string
{
return StringHelper::toKebabCase((string)$string, $glue, $lower, $removePunctuation);
}
/**
* camelCases a string.
*
* @param mixed $string The string
* @return string
*/
public function camelFilter($string): string
{
return StringHelper::toCamelCase((string)$string);
}
/**
* PascalCases a string.
*
* @param mixed $string The string
* @return string
*/
public function pascalFilter($string): string
{
return StringHelper::toPascalCase((string)$string);
}
/**
* snake_cases a string.
*
* @param mixed $string The string
* @return string
*/
public function snakeFilter($string): string
{
return StringHelper::toSnakeCase((string)$string);
}
/**
* This method will JSON encode a variable. We're overriding Twig's default implementation to set some stricter
* encoding options on text/html/xml requests.
*
* @param mixed $value The value to JSON encode.
* @param int|null $options Either null or a bitmask consisting of JSON_HEX_QUOT, JSON_HEX_TAG, JSON_HEX_AMP,
* JSON_HEX_APOS, JSON_NUMERIC_CHECK, JSON_PRETTY_PRINT, JSON_UNESCAPED_SLASHES,
* JSON_FORCE_OBJECT
* @param int $depth The maximum depth
* @return mixed The JSON encoded value.
*/
public function jsonEncodeFilter($value, int $options = null, int $depth = 512)
{
if ($options === null) {
if (in_array(Craft::$app->getResponse()->getContentType(), ['text/html', 'application/xhtml+xml'], true)) {
$options = JSON_HEX_TAG | JSON_HEX_AMP | JSON_HEX_QUOT;
} else {
$options = 0;
}
}
return json_encode($value, $options, $depth);
}
/**
* Returns an array without certain values.
*
* @param mixed $arr
* @param mixed $exclude
* @return array
*/
public function withoutFilter($arr, $exclude): array
{
$arr = (array)$arr;
if (!is_array($exclude)) {
$exclude = [$exclude];
}
foreach ($exclude as $value) {
ArrayHelper::removeValue($arr, $value);
}
return $arr;
}
/**
* Parses a string for reference tags.
*
* @param mixed $str
* @param int|null $siteId
* @return Markup
*/
public function parseRefsFilter($str, int $siteId = null): Markup
{
$str = Craft::$app->getElements()->parseRefs((string)$str, $siteId);
return TemplateHelper::raw($str);
}
/**
* Replaces Twig's |replace filter, adding support for passing in separate
* search and replace arrays.
*
* @param mixed $str
* @param mixed $search
* @param mixed $replace
* @return mixed
*/
public function replaceFilter($str, $search, $replace = null)
{
// Are they using the standard Twig syntax?
if (is_array($search) && $replace === null) {
return strtr($str, $search);
}
// Is this a regular expression?
if (preg_match('/^\/.+\/[a-zA-Z]*$/', $search)) {
return preg_replace($search, $replace, $str);
}
// Otherwise use str_replace
return str_replace($search, $replace, $str);
}
/**
* Extending Twig's |date filter so we can run any translations on the output.
*
* @param TwigEnvironment $env
* @param DateTimeInterface|DateInterval|string $date A date
* @param string|null $format The target format, null to use the default
* @param DateTimeZone|string|false|null $timezone The target timezone, null to use the default, false to leave unchanged
* @param string|null $locale The target locale the date should be formatted for. By default the current systme locale will be used.
* @return mixed|string
*/
public function dateFilter(TwigEnvironment $env, $date, string $format = null, $timezone = null, string $locale = null)
{
if ($date instanceof \DateInterval) {
return \twig_date_format_filter($env, $date, $format, $timezone);
}
// Is this a custom PHP date format?
if ($format !== null && !in_array($format, [Locale::LENGTH_SHORT, Locale::LENGTH_MEDIUM, Locale::LENGTH_LONG, Locale::LENGTH_FULL], true)) {
if (strpos($format, 'icu:') === 0) {
$format = substr($format, 4);
} else {
$format = StringHelper::ensureLeft($format, 'php:');
}
}
$date = \twig_date_converter($env, $date, $timezone);
$formatter = $locale ? (new Locale($locale))->getFormatter() : Craft::$app->getFormatter();
$fmtTimeZone = $formatter->timeZone;
$formatter->timeZone = $timezone !== null ? $date->getTimezone()->getName() : $formatter->timeZone;
$formatted = $formatter->asDate($date, $format);
$formatter->timeZone = $fmtTimeZone;
return $formatted;
}
/**
* Converts a date to the Atom format.
*
* @param TwigEnvironment $env
* @param DateTime|DateTimeInterface|string $date A date
* @param DateTimeZone|string|false|null $timezone The target timezone, null to use the default, false to leave unchanged
* @return string The formatted date
*/
public function atomFilter(TwigEnvironment $env, $date, $timezone = null): string
{
return \twig_date_format_filter($env, $date, \DateTime::ATOM, $timezone);
}
/**
* Converts a date to the RSS format.
*
* @param TwigEnvironment $env
* @param DateTime|DateTimeInterface|string $date A date
* @param DateTimeZone|string|false|null $timezone The target timezone, null to use the default, false to leave unchanged
* @return string The formatted date
*/
public function rssFilter(TwigEnvironment $env, $date, $timezone = null): string
{
return \twig_date_format_filter($env, $date, \DateTime::RSS, $timezone);
}
/**
* Formats the value as a time.
*
* @param TwigEnvironment $env
* @param DateTimeInterface|string $date A date
* @param string|null $format The target format, null to use the default
* @param DateTimeZone|string|false|null $timezone The target timezone, null to use the default, false to leave unchanged
* @param string|null $locale The target locale the date should be formatted for. By default the current systme locale will be used.
* @return mixed|string
*/
public function timeFilter(TwigEnvironment $env, $date, string $format = null, $timezone = null, string $locale = null)
{
// Is this a custom PHP date format?
if ($format !== null && !in_array($format, [Locale::LENGTH_SHORT, Locale::LENGTH_MEDIUM, Locale::LENGTH_LONG, Locale::LENGTH_FULL], true)) {
if (strpos($format, 'icu:') === 0) {
$format = substr($format, 4);
} else {
$format = StringHelper::ensureLeft($format, 'php:');
}
}
$date = \twig_date_converter($env, $date, $timezone);
$formatter = $locale ? (new Locale($locale))->getFormatter() : Craft::$app->getFormatter();
$fmtTimeZone = $formatter->timeZone;
$formatter->timeZone = $timezone !== null ? $date->getTimezone()->getName() : $formatter->timeZone;
$formatted = $formatter->asTime($date, $format);
$formatter->timeZone = $fmtTimeZone;
return $formatted;
}
/**
* Formats the value as a date+time.
*
* @param TwigEnvironment $env
* @param DateTimeInterface|string $date A date
* @param string|null $format The target format, null to use the default
* @param DateTimeZone|string|false|null $timezone The target timezone, null to use the default, false to leave unchanged
* @param string|null $locale The target locale the date should be formatted for. By default the current systme locale will be used.
* @return mixed|string
*/
public function datetimeFilter(TwigEnvironment $env, $date, string $format = null, $timezone = null, string $locale = null)
{
// Is this a custom PHP date format?
if ($format !== null && !in_array($format, [Locale::LENGTH_SHORT, Locale::LENGTH_MEDIUM, Locale::LENGTH_LONG, Locale::LENGTH_FULL], true)) {
if (strpos($format, 'icu:') === 0) {
$format = substr($format, 4);
} else {
$format = StringHelper::ensureLeft($format, 'php:');
}
}
$date = \twig_date_converter($env, $date, $timezone);
$formatter = $locale ? (new Locale($locale))->getFormatter() : Craft::$app->getFormatter();
$fmtTimeZone = $formatter->timeZone;
$formatter->timeZone = $timezone !== null ? $date->getTimezone()->getName() : $formatter->timeZone;
$formatted = $formatter->asDatetime($date, $format);
$formatter->timeZone = $fmtTimeZone;
return $formatted;
}
/**
* Encrypts and base64-encodes a string.
*
* @param mixed $str the string
* @return string
*/
public function encencFilter($str): string
{
return StringHelper::encenc((string)$str);
}
/**
* Filters an array.
*
* @param array|\Traversable $arr
* @param callable|null $arrow
* @return array|\Traversable
*/
public function filterFilter($arr, $arrow = null)
{
if ($arrow === null) {
return array_filter($arr);
}
return iterator_to_array(twig_array_filter($arr, $arrow));
}
/**
* Groups an array or element query's results by a common property.
*
* @param array|\Traversable $arr
* @param string $item
* @return array
* @throws RuntimeError if $arr is not of type array or Traversable
*/
public function groupFilter($arr, string $item): array
{
if ($arr instanceof ElementQuery) {
Craft::$app->getDeprecator()->log('ElementQuery::getIterator()', 'Looping through element queries directly has been deprecated. Use the all() function to fetch the query results before looping over them.');
$arr = $arr->all();
}
if (!is_array($arr) && !$arr instanceof \Traversable) {
throw new RuntimeError('Values passed to the |group filter must be of type array or Traversable.');
}
$groups = [];
$template = '{' . $item . '}';
foreach ($arr as $key => $object) {
$value = Craft::$app->getView()->renderObjectTemplate($template, $object);
$groups[$value][] = $object;
}
return $groups;
}
/**
* Returns the index of an item in a string or array, or -1 if it cannot be found.
*
* @param mixed $haystack
* @param mixed $needle
* @return int
*/
public function indexOfFilter($haystack, $needle): int
{
if (is_string($haystack)) {
$index = strpos($haystack, $needle);
} else if (is_array($haystack)) {
$index = array_search($needle, $haystack, false);
} else if (is_object($haystack) && $haystack instanceof \IteratorAggregate) {
$index = false;
foreach ($haystack as $i => $item) {
if ($item == $needle) {
$index = $i;
break;
}
}
}
/** @noinspection UnSafeIsSetOverArrayInspection - FP */
if (isset($index) && $index !== false) {
return $index;
}
return -1;
}
/**
* Escapes commas and asterisks in a string so they are not treated as special characters in
* [[Db::parseParam()]].
*
* @param mixed $value The param value.
* @return string The escaped param value.
*/
public function literalFilter($value): string
{
return Db::escapeParam((string)$value);
}
/**
* Parses text through Markdown.
*
* @param mixed $markdown The markdown text to parse
* @param string|null $flavor The markdown flavor to use. Can be 'original', 'gfm' (GitHub-Flavored Markdown),
* 'gfm-comment' (GFM with newlines converted to `<br>`s),
* or 'extra' (Markdown Extra). Default is 'original'.
* @param bool $inlineOnly Whether to only parse inline elements, omitting any `<p>` tags.
* @return Markup
*/
public function markdownFilter($markdown, string $flavor = null, bool $inlineOnly = false): Markup
{
if ($inlineOnly) {
$html = Markdown::processParagraph((string)$markdown, $flavor);
} else {
$html = Markdown::process((string)$markdown, $flavor);
}
return TemplateHelper::raw($html);
}
/**
* Duplicates an array and sorts it with [[\craft\helpers\ArrayHelper::multisort()]].
*
* @param mixed $array the array to be sorted. The array will be modified after calling this method.
* @param string|\Closure|array $key the key(s) to be sorted by. This refers to a key name of the sub-array
* elements, a property name of the objects, or an anonymous function returning the values for comparison
* purpose. The anonymous function signature should be: `function($item)`.
* To sort by multiple keys, provide an array of keys here.
* @param int|array $direction the sorting direction. It can be either `SORT_ASC` or `SORT_DESC`.
* When sorting by multiple keys with different sorting directions, use an array of sorting directions.
* @param int|array $sortFlag the PHP sort flag. Valid values include
* `SORT_REGULAR`, `SORT_NUMERIC`, `SORT_STRING`, `SORT_LOCALE_STRING`, `SORT_NATURAL` and `SORT_FLAG_CASE`.
* Please refer to [PHP manual](http://php.net/manual/en/function.sort.php)
* for more details. When sorting by multiple keys with different sort flags, use an array of sort flags.
* @return array the sorted array
* @throws InvalidArgumentException if the $direction or $sortFlag parameters do not have
* correct number of elements as that of $key.
*/
public function multisortFilter($array, $key, $direction = SORT_ASC, $sortFlag = SORT_REGULAR): array
{
// Prevent multisort() from modifying the original array
$array = array_merge($array);
ArrayHelper::multisort($array, $key, $direction, $sortFlag);
return $array;
}
/**
* @inheritdoc
*/
public function getFunctions(): array
{
return [
new TwigFunction('alias', [Craft::class, 'getAlias']),
new TwigFunction('actionInput', [$this, 'actionInputFunction']),
new TwigFunction('actionUrl', [UrlHelper::class, 'actionUrl']),
new TwigFunction('cpUrl', [UrlHelper::class, 'cpUrl']),
new TwigFunction('ceil', 'ceil'),
new TwigFunction('className', 'get_class'),
new TwigFunction('clone', [$this, 'cloneFunction']),
new TwigFunction('create', [Craft::class, 'createObject']),
new TwigFunction('csrfInput', [$this, 'csrfInputFunction']),
new TwigFunction('expression', [$this, 'expressionFunction']),
new TwigFunction('floor', 'floor'),
new TwigFunction('getenv', 'getenv'),
new TwigFunction('parseEnv', [Craft::class, 'parseEnv']),
new TwigFunction('plugin', [$this, 'pluginFunction']),
new TwigFunction('redirectInput', [$this, 'redirectInputFunction']),
new TwigFunction('renderObjectTemplate', [$this, 'renderObjectTemplate']),
new TwigFunction('round', [$this, 'roundFunction']),
new TwigFunction('seq', [$this, 'seqFunction']),
new TwigFunction('shuffle', [$this, 'shuffleFunction']),
new TwigFunction('siteUrl', [UrlHelper::class, 'siteUrl']),
new TwigFunction('svg', [$this, 'svgFunction']),
new TwigFunction('url', [UrlHelper::class, 'url']),
// DOM event functions
new TwigFunction('head', [$this->view, 'head']),
new TwigFunction('beginBody', [$this->view, 'beginBody']),
new TwigFunction('endBody', [$this->view, 'endBody']),
// Deprecated functions
new TwigFunction('getCsrfInput', [$this, 'getCsrfInput']),
new TwigFunction('getHeadHtml', [$this, 'getHeadHtml']),
new TwigFunction('getFootHtml', [$this, 'getFootHtml']),
];
}
/**
* Returns a CSRF input wrapped in a \Twig\Markup object.
*
* @return Markup|null
*/
public function csrfInputFunction()
{
$generalConfig = Craft::$app->getConfig()->getGeneral();
if ($generalConfig->enableCsrfProtection === true) {
return TemplateHelper::raw('<input type="hidden" name="' . $generalConfig->csrfTokenName . '" value="' . Craft::$app->getRequest()->getCsrfToken() . '">');
}
return null;
}
/**
* Returns a clone of the given variable.
*
* @param mixed $var
* @return mixed
*/
public function cloneFunction($var)
{
return clone $var;
}
/**
* @param mixed $expression
* @param mixed $params
* @param mixed $config
* @return Expression
*/
public function expressionFunction($expression, $params = [], $config = []): Expression
{
return new Expression($expression, $params, $config);
}
/**
* Returns a plugin instance by its handle.
*
* @param string $handle The plugin handle
* @return PluginInterface|null The plugin, or `null` if it's not installed
*/
public function pluginFunction(string $handle)
{
return Craft::$app->getPlugins()->getPlugin($handle);
}
/**
* Returns a redirect input wrapped in a \Twig\Markup object.
*
* @param string $url The URL to redirect to.
* @return Markup
*/
public function redirectInputFunction(string $url): Markup
{
return TemplateHelper::raw('<input type="hidden" name="redirect" value="' . Craft::$app->getSecurity()->hashData($url) . '">');
}
/**
* Returns an action input wrapped in a \Twig\Markup object, suitable for use in a front-end form.
*
* @param string $actionPath
* @return Markup
*/
public function actionInputFunction(string $actionPath): Markup
{
return TemplateHelper::raw('<input type="hidden" name="action" value="' . $actionPath . '">');
}
/**
* Rounds the given value.
*
* @param int|float $value
* @param int $precision
* @param int $mode
* @return int|float
* @deprecated in 3.0. Use Twig's |round filter instead.
*/
public function roundFunction($value, int $precision = 0, int $mode = PHP_ROUND_HALF_UP)
{
Craft::$app->getDeprecator()->log('round()', 'The round() function has been deprecated. Use Twig’s |round filter instead.');
return round($value, $precision, $mode);
}
/**
* Returns the next number in a given sequence, or the current number in the sequence.
*
* @param string $name The sequence name.
* @param int|null $length The minimum string length that should be returned. (Numbers that are too short will be left-padded with `0`s.)
* @param bool $next Whether the next number in the sequence should be returned (and the sequence should be incremented).
* If set to `false`, the current number in the sequence will be returned instead.
* @return integer|string
* @throws \Throwable if reasons
* @throws \yii\db\Exception
*/
public function seqFunction(string $name, int $length = null, bool $next = true)
{
if ($next) {
return Sequence::next($name, $length);
}
return Sequence::current($name, $length);
}
/**
* @param string $template
* @param mixed $object
* @return string
*/
public function renderObjectTemplate(string $template, $object): string
{
return Craft::$app->getView()->renderObjectTemplate($template, $object);
}
/**
* Shuffles an array.
*
* @param mixed $arr
* @return mixed
*/
public function shuffleFunction($arr)
{
if ($arr instanceof \Traversable) {
$arr = iterator_to_array($arr, false);
} else {
$arr = array_merge($arr);
}
shuffle($arr);
return $arr;
}
/**
* Returns the contents of a given SVG file.
*
* @param string|Asset $svg An SVG asset, a file path, or raw SVG markup
* @param bool|null $sanitize Whether the SVG should be sanitized of potentially
* malicious scripts. By default the SVG will only be sanitized if an asset
* or markup is passed in. (File paths are assumed to be safe.)
* @param bool|null $namespace Whether class names and IDs within the SVG
* should be namespaced to avoid conflicts with other elements in the DOM.
* By default the SVG will only be namespaced if an asset or markup is passed in.
* @param string|null $class A CSS class name that should be added to the `<svg>` element.
* @return Markup|string
*/
public function svgFunction($svg, bool $sanitize = null, bool $namespace = null, string $class = null)
{
if ($svg instanceof Asset) {
try {
$svg = $svg->getContents();
} catch (\Throwable $e) {
Craft::error("Could not get the contents of {$svg->getPath()}: {$e->getMessage()}", __METHOD__);
Craft::$app->getErrorHandler()->logException($e);
return '';
}
} else if (stripos($svg, '<svg') === false) {
// No <svg> tag, so it's probably a file path
$svg = Craft::getAlias($svg);
if (!is_file($svg) || !FileHelper::isSvg($svg)) {
Craft::warning("Could not get the contents of {$svg}: The file doesn't exist", __METHOD__);
return '';
}
$svg = file_get_contents($svg);
// This came from a file path, so pretty good chance that the SVG can be trusted.
$sanitize = $sanitize ?? false;
$namespace = $namespace ?? false;
}
// Sanitize and namespace the SVG by default
$sanitize = $sanitize ?? true;
$namespace = $namespace ?? true;
// Sanitize?
if ($sanitize) {
$svg = (new Sanitizer())->sanitize($svg);
// Remove comments, title & desc
$svg = preg_replace('/<!--.*?-->\s*/s', '', $svg);
$svg = preg_replace('/<title>.*?<\/title>\s*/is', '', $svg);
$svg = preg_replace('/<desc>.*?<\/desc>\s*/is', '', $svg);
}
// Remove the XML declaration
$svg = preg_replace('/<\?xml.*?\?>/', '', $svg);
// Namespace class names and IDs
if (
$namespace && (
strpos($svg, 'id=') !== false || strpos($svg, 'class=') !== false)
) {
$ns = StringHelper::randomStringWithChars('abcdefghijklmnopqrstuvwxyz', 10) . '-';
$ids = [];
$classes = [];
$svg = preg_replace_callback('/\bid=([\'"])([^\'"]+)\\1/i', function($matches) use ($ns, &$ids) {
$ids[] = $matches[2];
return "id={$matches[1]}{$ns}{$matches[2]}{$matches[1]}";
}, $svg);
$svg = preg_replace_callback('/\bclass=([\'"])([^\'"]+)\\1/i', function($matches) use ($ns, &$classes) {
$newClasses = [];
foreach (preg_split('/\s+/', $matches[2]) as $c) {
$classes[] = $c;
$newClasses[] = $ns . $c;
}
return 'class=' . $matches[1] . implode(' ', $newClasses) . $matches[1];
}, $svg);
foreach ($ids as $id) {
$quotedId = preg_quote($id, '/');
$svg = preg_replace("/#{$quotedId}\b(?!\-)/", "#{$ns}{$id}", $svg);
}
foreach ($classes as $c) {
$quotedClass = preg_quote($c, '/');
$svg = preg_replace("/\.{$quotedClass}\b(?!\-)/", ".{$ns}{$c}", $svg);
}
}
if ($class !== null) {
$svg = preg_replace('/(<svg\b[^>]+\bclass=([\'"])[^\'"]+)(\\2)/i', "$1 {$class}$3", $svg, 1, $count);
if ($count === 0) {
$svg = preg_replace('/<svg\b/i', "$0 class=\"{$class}\"", $svg, 1);
}
}
return TemplateHelper::raw($svg);
}
/**
* @inheritdoc
*/
public function getGlobals(): array
{
$isInstalled = Craft::$app->getIsInstalled();
$request = Craft::$app->getRequest();
$generalConfig = Craft::$app->getConfig()->getGeneral();