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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
mod functions;
mod helpers;
pub mod types;
use crate::type_map::PhpMapper;
use ahash::AHashSet;
use alef_codegen::builder::RustFileBuilder;
use alef_codegen::conversions::ConversionConfig;
use alef_codegen::generators::RustBindingConfig;
use alef_codegen::generators::{self, AsyncPattern};
use alef_codegen::naming::to_php_name;
use alef_codegen::shared::binding_fields;
use alef_core::backend::{Backend, BuildConfig, BuildDependency, Capabilities, GeneratedFile};
use alef_core::config::{Language, ResolvedCrateConfig, detect_serde_available, resolve_output_dir};
use alef_core::hash::{self, CommentStyle};
use alef_core::ir::ApiSurface;
use alef_core::ir::{PrimitiveType, TypeRef};
use heck::{ToLowerCamelCase, ToPascalCase};
use minijinja::context;
use std::collections::HashMap;
use std::path::PathBuf;
use crate::naming::php_autoload_namespace;
use functions::{gen_async_function_as_static_method, gen_function_as_static_method};
/// PHP 8.1 enum cases cannot use case-insensitive `class` (reserved for
/// `EnumName::class` syntax). Append a trailing underscore for those cases.
fn sanitize_php_enum_case(name: &str) -> String {
if name.eq_ignore_ascii_case("class") {
format!("{name}_")
} else {
name.to_string()
}
}
use helpers::{gen_enum_tainted_from_binding_to_core, gen_tokio_runtime, has_enum_named_field, references_named_type};
use types::{
gen_enum_constants, gen_flat_data_enum, gen_flat_data_enum_from_impls, gen_flat_data_enum_methods, gen_php_struct,
is_tagged_data_enum, is_untagged_data_enum,
};
pub struct PhpBackend;
impl PhpBackend {
fn binding_config(core_import: &str, has_serde: bool) -> RustBindingConfig<'_> {
RustBindingConfig {
struct_attrs: &["php_class"],
field_attrs: &[],
struct_derives: &["Clone"],
method_block_attr: Some("php_impl"),
constructor_attr: "",
static_attr: None,
function_attr: "#[php_function]",
enum_attrs: &[],
enum_derives: &[],
needs_signature: false,
signature_prefix: "",
signature_suffix: "",
core_import,
async_pattern: AsyncPattern::TokioBlockOn,
has_serde,
type_name_prefix: "",
option_duration_on_defaults: true,
opaque_type_names: &[],
skip_impl_constructor: false,
cast_uints_to_i32: false,
cast_large_ints_to_f64: false,
named_non_opaque_params_by_ref: false,
lossy_skip_types: &[],
serializable_opaque_type_names: &[],
never_skip_cfg_field_names: &[],
}
}
}
impl Backend for PhpBackend {
fn name(&self) -> &str {
"php"
}
fn language(&self) -> Language {
Language::Php
}
fn capabilities(&self) -> Capabilities {
Capabilities {
supports_async: false,
supports_classes: true,
supports_enums: true,
supports_option: true,
supports_result: true,
..Capabilities::default()
}
}
fn generate_bindings(&self, api: &ApiSurface, config: &ResolvedCrateConfig) -> anyhow::Result<Vec<GeneratedFile>> {
// Separate unit-variant enums (→ String), tagged data enums (→ flat PHP class),
// and untagged data enums (→ serde_json::Value, converted via from_value at binding↔core boundary).
let data_enum_names: AHashSet<String> = api
.enums
.iter()
.filter(|e| is_tagged_data_enum(e))
.map(|e| e.name.clone())
.collect();
let untagged_data_enum_names: AHashSet<String> = api
.enums
.iter()
.filter(|e| is_untagged_data_enum(e))
.map(|e| e.name.clone())
.collect();
// String-mapped enums: everything that is NOT a tagged-data enum AND NOT an untagged-data enum.
// Includes unit-variant enums (FilePurpose, ToolType, …) which are exposed as PHP string constants.
let enum_names: AHashSet<String> = api
.enums
.iter()
.filter(|e| !is_tagged_data_enum(e) && !is_untagged_data_enum(e))
.map(|e| e.name.clone())
.collect();
let mapper = PhpMapper {
enum_names: enum_names.clone(),
data_enum_names: data_enum_names.clone(),
untagged_data_enum_names: untagged_data_enum_names.clone(),
};
let core_import = config.core_import_name();
let lang_rename_all = config.serde_rename_all_for_language(Language::Php);
// Get exclusion lists from PHP config
let php_config = config.php.as_ref();
let exclude_functions = php_config.map(|c| c.exclude_functions.clone()).unwrap_or_default();
let exclude_types = php_config.map(|c| c.exclude_types.clone()).unwrap_or_default();
let output_dir = resolve_output_dir(config.output_paths.get("php"), &config.name, "crates/{name}-php/src/");
let has_serde = detect_serde_available(&output_dir);
// Build the opaque type names list: IR opaque types + bridge type aliases.
// Bridge type aliases (e.g. `VisitorHandle`) wrap Rc-based handles and cannot
// implement serde::Serialize/Deserialize. Including them ensures gen_php_struct
// emits #[serde(skip)] for fields of those types so derives on the enclosing
// struct (e.g. ConversionOptions) still compile.
let bridge_type_aliases_php: Vec<String> = config
.trait_bridges
.iter()
.filter_map(|b| b.type_alias.clone())
.collect();
let bridge_type_aliases_set: AHashSet<String> = bridge_type_aliases_php.iter().cloned().collect();
let mut opaque_names_vec_php: Vec<String> = api
.types
.iter()
.filter(|t| t.is_opaque)
.map(|t| t.name.clone())
.collect();
opaque_names_vec_php.extend(bridge_type_aliases_php);
let mut cfg = Self::binding_config(&core_import, has_serde);
cfg.opaque_type_names = &opaque_names_vec_php;
let never_skip_cfg_field_names: Vec<String> = config
.trait_bridges
.iter()
.filter_map(|b| {
if b.bind_via == alef_core::config::BridgeBinding::OptionsField {
b.resolved_options_field().map(|s| s.to_string())
} else {
None
}
})
.collect();
cfg.never_skip_cfg_field_names = &never_skip_cfg_field_names;
// Build the inner module content (types, methods, conversions)
let mut builder = RustFileBuilder::new().with_generated_header();
builder.add_inner_attribute("allow(dead_code, unused_imports, unused_variables)");
builder.add_inner_attribute("allow(unsafe_code)");
// PHP parameter names are lowerCamelCase; Rust complains about non-snake_case variables.
builder.add_inner_attribute("allow(non_snake_case)");
builder.add_inner_attribute("allow(clippy::too_many_arguments, clippy::let_unit_value, clippy::needless_borrow, clippy::map_identity, clippy::just_underscores_and_digits, clippy::unnecessary_cast, clippy::unused_unit, clippy::unwrap_or_default, clippy::derivable_impls, clippy::needless_borrows_for_generic_args, clippy::unnecessary_fallible_conversions, clippy::arc_with_non_send_sync, clippy::collapsible_if, clippy::clone_on_copy, clippy::should_implement_trait, clippy::useless_conversion)");
builder.add_import("ext_php_rs::prelude::*");
// Import serde_json when available (needed for serde-based param conversion)
if has_serde {
builder.add_import("serde_json");
}
// Import traits needed for trait method dispatch
for trait_path in generators::collect_trait_imports(api) {
builder.add_import(&trait_path);
}
// Only import HashMap when Map-typed fields or returns are present
let has_maps = api.types.iter().any(|t| {
t.fields
.iter()
.any(|f| matches!(&f.ty, alef_core::ir::TypeRef::Map(_, _)))
}) || api
.functions
.iter()
.any(|f| matches!(&f.return_type, alef_core::ir::TypeRef::Map(_, _)));
if has_maps {
builder.add_import("std::collections::HashMap");
}
// PhpBytes wrapper: accepts PHP binary strings without UTF-8 validation.
// ext-php-rs's String FromZval rejects non-UTF-8 strings, so binary content
// (PDFs, images, etc.) gets "Invalid value given for argument" errors. This
// wrapper reads the raw bytes via `zend_str()` and exposes them as Vec<u8>.
builder.add_item(
"#[derive(Debug, Clone, Default)]\n\
pub struct PhpBytes(pub Vec<u8>);\n\
\n\
impl<'a> ext_php_rs::convert::FromZval<'a> for PhpBytes {\n \
const TYPE: ext_php_rs::flags::DataType = ext_php_rs::flags::DataType::String;\n \
fn from_zval(zval: &'a ext_php_rs::types::Zval) -> Option<Self> {\n \
zval.zend_str().map(|zs| PhpBytes(zs.as_bytes().to_vec()))\n \
}\n\
}\n\
\n\
impl From<PhpBytes> for Vec<u8> {\n \
fn from(b: PhpBytes) -> Self { b.0 }\n\
}\n\
\n\
impl From<Vec<u8>> for PhpBytes {\n \
fn from(v: Vec<u8>) -> Self { PhpBytes(v) }\n\
}\n",
);
// Custom module declarations
let custom_mods = config.custom_modules.for_language(Language::Php);
for module in custom_mods {
builder.add_item(&format!("pub mod {module};"));
}
// Check if any function or method is async
let has_async =
api.functions.iter().any(|f| f.is_async) || api.types.iter().any(|t| t.methods.iter().any(|m| m.is_async));
if has_async {
builder.add_item(&gen_tokio_runtime());
}
// Check if we have opaque types and add Arc import if needed
let opaque_types: AHashSet<String> = api
.types
.iter()
.filter(|t| t.is_opaque)
.map(|t| t.name.clone())
.collect();
if !opaque_types.is_empty() {
builder.add_import("std::sync::Arc");
}
// Compute mutex types: opaque types with &mut self methods
let mutex_types: AHashSet<String> = api
.types
.iter()
.filter(|t| t.is_opaque && alef_codegen::generators::type_needs_mutex(t))
.map(|t| t.name.clone())
.collect();
if !mutex_types.is_empty() {
builder.add_import("std::sync::Mutex");
}
// Compute the PHP namespace for namespaced class registration.
// Delegates to config so [php].namespace overrides are respected.
let extension_name = config.php_extension_name();
let php_namespace = php_autoload_namespace(config);
// Build adapter body map before type iteration so bodies are available for method generation.
let adapter_bodies = alef_adapters::build_adapter_bodies(config, Language::Php)?;
// Streaming-adapter method keys ("Owner.method_name") — these methods are emitted
// as a triple of standalone functions (start/next/free) from the adapter struct hook, so the
// regular method-iteration loop must skip them to avoid double-emitting a function
// with the same name.
let streaming_method_keys: AHashSet<String> = config
.adapters
.iter()
.filter(|a| matches!(a.pattern, alef_core::config::AdapterPattern::Streaming))
.filter_map(|a| a.owner_type.as_deref().map(|owner| format!("{owner}.{}", a.name)))
.collect();
// Emit adapter-generated standalone items (streaming iterators, callback bridges).
for adapter in &config.adapters {
match adapter.pattern {
alef_core::config::AdapterPattern::Streaming => {
let key = alef_adapters::stream_struct_key(adapter);
if let Some(struct_code) = adapter_bodies.get(&key) {
builder.add_item(struct_code);
}
}
alef_core::config::AdapterPattern::CallbackBridge => {
let struct_key = format!("{}.__bridge_struct__", adapter.name);
let impl_key = format!("{}.__bridge_impl__", adapter.name);
if let Some(struct_code) = adapter_bodies.get(&struct_key) {
builder.add_item(struct_code);
}
if let Some(impl_code) = adapter_bodies.get(&impl_key) {
builder.add_item(impl_code);
}
}
_ => {}
}
}
for typ in api
.types
.iter()
.filter(|typ| !typ.is_trait && !exclude_types.contains(&typ.name))
{
if typ.is_opaque {
// Generate the opaque struct with separate #[php_class] and
// #[php(name = "Ns\\Type")] attributes (ext-php-rs 0.15+ syntax).
// Escape '\' in the namespace so the generated Rust string literal is valid.
let ns_escaped = php_namespace.replace('\\', "\\\\");
let php_name_attr = format!("php(name = \"{}\\\\{}\")", ns_escaped, typ.name);
let opaque_attr_arr = ["php_class", php_name_attr.as_str()];
let opaque_cfg = RustBindingConfig {
struct_attrs: &opaque_attr_arr,
..cfg
};
builder.add_item(&generators::gen_opaque_struct(typ, &opaque_cfg));
builder.add_item(&types::gen_opaque_struct_methods_with_exclude(
typ,
&mapper,
&opaque_types,
&core_import,
&adapter_bodies,
&mutex_types,
&streaming_method_keys,
));
// Client constructor — emit a #[php_method] impl
if let Some(ctor) = config.client_constructors.get(&typ.name) {
let ctor_body = generators::gen_opaque_constructor(ctor, &typ.name, &core_import, "#[php_method]");
let ctor_impl = format!("#[php_impl]\nimpl {} {{\n{}}}", typ.name, ctor_body);
builder.add_item(&ctor_impl);
}
} else {
// gen_struct adds #[derive(Default)] when typ.has_default is true,
// so no separate Default impl is needed.
builder.add_item(&gen_php_struct(
typ,
&mapper,
&cfg,
Some(&php_namespace),
&enum_names,
&lang_rename_all,
));
builder.add_item(&types::gen_struct_methods_with_exclude(
typ,
&mapper,
has_serde,
&core_import,
&opaque_types,
&enum_names,
&api.enums,
&exclude_functions,
&bridge_type_aliases_set,
&never_skip_cfg_field_names,
&mutex_types,
));
}
}
for enum_def in &api.enums {
if is_tagged_data_enum(enum_def) {
// Tagged data enums (struct variants) are lowered to a flat PHP class.
builder.add_item(&gen_flat_data_enum(enum_def, &mapper, Some(&php_namespace)));
builder.add_item(&gen_flat_data_enum_methods(enum_def, &mapper));
} else {
builder.add_item(&gen_enum_constants(enum_def));
}
}
// Generate free functions as static methods on a facade class rather than standalone
// `#[php_function]` items. Standalone functions rely on the `inventory` crate for
// auto-registration, which does not work in cdylib builds on macOS. Classes registered
// via `.class::<T>()` in the module builder DO work on all platforms.
let included_functions: Vec<_> = api
.functions
.iter()
.filter(|f| !exclude_functions.contains(&f.name))
.collect();
if !included_functions.is_empty() {
let facade_class_name = extension_name.to_pascal_case();
// Build each static method body (no #[php_function] attribute — they live inside
// a #[php_impl] block which handles registration via the class machinery).
let mut method_items: Vec<String> = Vec::new();
for func in included_functions {
let bridge_param = crate::trait_bridge::find_bridge_param(func, &config.trait_bridges);
if let Some((param_idx, bridge_cfg)) = bridge_param {
let bridge_handle_path = bridge_handle_path(api, bridge_cfg, &core_import);
method_items.push(crate::trait_bridge::gen_bridge_function(
func,
param_idx,
bridge_cfg,
&mapper,
&opaque_types,
&core_import,
&bridge_handle_path,
));
} else if func.is_async {
method_items.push(gen_async_function_as_static_method(
func,
&mapper,
&opaque_types,
&core_import,
&config.trait_bridges,
&mutex_types,
));
} else {
method_items.push(gen_function_as_static_method(
func,
&mapper,
&opaque_types,
&core_import,
&config.trait_bridges,
has_serde,
&mutex_types,
));
}
}
// Emit trait-bridge registration functions as static methods
for bridge_cfg in &config.trait_bridges {
if let Some(register_fn) = bridge_cfg.register_fn.as_deref() {
method_items.push(format!(
"pub fn {}(backend: &mut ext_php_rs::types::ZendObject) -> ext_php_rs::prelude::PhpResult<()> {{\n \
crate::{}(backend)\n}}",
register_fn,
register_fn
));
}
if let Some(unregister_fn) = bridge_cfg.unregister_fn.as_deref() {
method_items.push(format!(
"pub fn {}(name: String) -> ext_php_rs::prelude::PhpResult<()> {{\n \
crate::{}(name)\n}}",
unregister_fn, unregister_fn
));
}
if let Some(clear_fn) = bridge_cfg.clear_fn.as_deref() {
method_items.push(format!(
"pub fn {}() -> ext_php_rs::prelude::PhpResult<()> {{\n \
crate::{}()\n}}",
clear_fn, clear_fn
));
}
}
let methods_joined = method_items
.iter()
.map(|m| {
// Indent each line of each method by 4 spaces
m.lines()
.map(|l| {
if l.is_empty() {
String::new()
} else {
format!(" {l}")
}
})
.collect::<Vec<_>>()
.join("\n")
})
.collect::<Vec<_>>()
.join("\n\n");
// The PHP-visible class name gets an "Api" suffix to avoid collision with the
// PHP facade class (e.g. `Kreuzcrawl\Kreuzcrawl`) that Composer autoloads.
let php_api_class_name = format!("{facade_class_name}Api");
// Escape '\' so the generated Rust string literal is valid (e.g. "Ns\\ClassName").
let ns_escaped_facade = php_namespace.replace('\\', "\\\\");
let php_name_attr = format!("php(name = \"{}\\\\{}\")", ns_escaped_facade, php_api_class_name);
let facade_struct = format!(
"#[php_class]\n#[{php_name_attr}]\npub struct {facade_class_name}Api;\n\n#[php_impl]\nimpl {facade_class_name}Api {{\n{methods_joined}\n}}"
);
builder.add_item(&facade_struct);
// Trait bridge structs — top-level items (outside the facade class)
for bridge_cfg in &config.trait_bridges {
if let Some(trait_type) = api.types.iter().find(|t| t.is_trait && t.name == bridge_cfg.trait_name) {
let bridge = crate::trait_bridge::gen_trait_bridge(
trait_type,
bridge_cfg,
&core_import,
&config.error_type_name(),
&config.error_constructor_expr(),
api,
);
for imp in &bridge.imports {
builder.add_import(imp);
}
builder.add_item(&bridge.code);
}
}
}
let convertible = alef_codegen::conversions::convertible_types(api);
let core_to_binding = alef_codegen::conversions::core_to_binding_convertible_types(api);
let input_types = alef_codegen::conversions::input_type_names(api);
// From/Into conversions with PHP-specific i64 casts.
// Types with enum Named fields (or that reference such types transitively) can't
// have binding->core From impls because PHP maps enums to String and there's no
// From<String> for the core enum type. Core->binding is always safe.
let enum_names_ref = &mapper.enum_names;
let bridge_skip_types: Vec<String> = config
.trait_bridges
.iter()
.filter(|b| !matches!(b.bind_via, alef_core::config::BridgeBinding::OptionsField))
.filter_map(|b| b.type_alias.clone())
.collect();
// Trait-bridge fields whose binding-side wrapper holds `inner: Arc<core::T>`
// (every OptionsField-style bridge in alef follows this convention). Used by
// `binding_to_core` to emit `val.{f}.map(|v| (*v.inner).clone())` instead of
// `Default::default()` so the visitor handle survives the `.into()` call.
let trait_bridge_arc_wrapper_field_names: Vec<String> = config
.trait_bridges
.iter()
.filter(|b| b.bind_via == alef_core::config::BridgeBinding::OptionsField)
.filter_map(|b| b.resolved_options_field().map(String::from))
.collect();
// Set of opaque type names for ConversionConfig. Combines Rust `#[opaque]`
// types in the API with trait-bridge type aliases (e.g. VisitorHandle) so the
// `is_opaque_no_wrapper_field` branch in binding_to_core fires for those
// fields and emits the Arc-wrapper forwarding pattern.
let mut conv_opaque_types: AHashSet<String> = opaque_types.clone();
for bridge in &config.trait_bridges {
if let Some(alias) = &bridge.type_alias {
conv_opaque_types.insert(alias.clone());
}
}
let php_conv_config = ConversionConfig {
cast_large_ints_to_i64: true,
enum_string_names: Some(enum_names_ref),
untagged_data_enum_names: Some(&mapper.untagged_data_enum_names),
// PHP keeps `serde_json::Value` as-is in the binding struct (matches PhpMapper::json).
// `json_to_string` was previously enabled but caused `from_json` to fail when a JSON
// object/array landed in a `String`-typed field (e.g. tool `parameters` schema).
json_as_value: true,
include_cfg_metadata: false,
option_duration_on_defaults: true,
from_binding_skip_types: &bridge_skip_types,
never_skip_cfg_field_names: &never_skip_cfg_field_names,
opaque_types: Some(&conv_opaque_types),
trait_bridge_arc_wrapper_field_names: &trait_bridge_arc_wrapper_field_names,
..Default::default()
};
// Build transitive set of types that can't have binding->core From
let mut enum_tainted: AHashSet<String> = AHashSet::new();
for typ in api.types.iter().filter(|typ| !typ.is_trait) {
if has_enum_named_field(typ, enum_names_ref) {
enum_tainted.insert(typ.name.clone());
}
}
// Transitively mark types that reference enum-tainted types
let mut changed = true;
while changed {
changed = false;
for typ in api.types.iter().filter(|typ| !typ.is_trait) {
if !enum_tainted.contains(&typ.name)
&& binding_fields(&typ.fields).any(|f| references_named_type(&f.ty, &enum_tainted))
{
enum_tainted.insert(typ.name.clone());
changed = true;
}
}
}
for typ in api.types.iter().filter(|typ| !typ.is_trait) {
// binding->core: only when not enum-tainted and type is used as input
if input_types.contains(&typ.name)
&& !enum_tainted.contains(&typ.name)
&& alef_codegen::conversions::can_generate_conversion(typ, &convertible)
{
builder.add_item(&alef_codegen::conversions::gen_from_binding_to_core_cfg(
typ,
&core_import,
&php_conv_config,
));
} else if input_types.contains(&typ.name) && enum_tainted.contains(&typ.name) {
// Enum-tainted types: generate From with string->enum parsing for enum-Named
// fields, using first variant as fallback. Data-variant enum fields fill
// data fields with Default::default().
// Note: JSON roundtrip was previously used when has_serde=true, but that
// breaks on non-optional Duration fields (null != u64) and empty-string enum
// fields ("" is not a valid variant). Field-by-field conversion handles both.
builder.add_item(&gen_enum_tainted_from_binding_to_core(
typ,
&core_import,
enum_names_ref,
&enum_tainted,
&php_conv_config,
&api.enums,
&bridge_type_aliases_set,
));
}
// core->binding: always (enum->String via format, sanitized fields via format)
if alef_codegen::conversions::can_generate_conversion(typ, &core_to_binding) {
builder.add_item(&alef_codegen::conversions::gen_from_core_to_binding_cfg(
typ,
&core_import,
&opaque_types,
&php_conv_config,
));
}
}
// From impls for tagged data enums lowered to flat PHP classes.
// Track types whose `From<binding> for core` impl has already been emitted by
// the main loop above (or by a prior variant in this loop) to avoid duplicate
// impls when the same DTO appears both as a top-level input type and as a
// variant payload of a tagged enum (e.g. `CrawlPageResult` used directly and
// inside `CrawlEvent::Page { result: Box<CrawlPageResult> }`).
// The main loop above emits a `From<binding> for core` impl for any type
// that is `input_types.contains(&typ.name)` (either via the plain branch
// or the enum-tainted branch). Pre-seed the dedup set with those.
let mut emitted_binding_to_core: AHashSet<String> = api
.types
.iter()
.filter(|typ| !typ.is_trait && input_types.contains(&typ.name))
.filter(|typ| {
(enum_tainted.contains(&typ.name))
|| alef_codegen::conversions::can_generate_conversion(typ, &convertible)
})
.map(|typ| typ.name.clone())
.collect();
for enum_def in api.enums.iter().filter(|e| is_tagged_data_enum(e)) {
builder.add_item(&gen_flat_data_enum_from_impls(enum_def, &core_import));
// Also generate From impls for variant data types (e.g., ArchiveMetadata from FormatMetadata::Archive).
// These are needed when flat enum binding→core conversion calls `.into()` on variant fields.
for variant in &enum_def.variants {
for field in &variant.fields {
if let TypeRef::Named(type_name) = &field.ty {
if let Some(typ) = api.types.iter().find(|t| &t.name == type_name) {
if emitted_binding_to_core.contains(&typ.name) {
continue;
}
if enum_tainted.contains(&typ.name) {
builder.add_item(&gen_enum_tainted_from_binding_to_core(
typ,
&core_import,
enum_names_ref,
&enum_tainted,
&php_conv_config,
&api.enums,
&bridge_type_aliases_set,
));
emitted_binding_to_core.insert(typ.name.clone());
} else if alef_codegen::conversions::can_generate_conversion(typ, &convertible) {
builder.add_item(&alef_codegen::conversions::gen_from_binding_to_core_cfg(
typ,
&core_import,
&php_conv_config,
));
emitted_binding_to_core.insert(typ.name.clone());
}
}
}
}
}
}
// Emit From impls for all remaining DTO types that are convertible but haven't been
// emitted yet. This handles nested types that appear as fields in output structures
// but are not direct input types or enum variant payloads.
for typ in api.types.iter().filter(|t| !t.is_trait) {
if !emitted_binding_to_core.contains(&typ.name) {
if enum_tainted.contains(&typ.name) {
builder.add_item(&gen_enum_tainted_from_binding_to_core(
typ,
&core_import,
enum_names_ref,
&enum_tainted,
&php_conv_config,
&api.enums,
&bridge_type_aliases_set,
));
emitted_binding_to_core.insert(typ.name.clone());
} else if alef_codegen::conversions::can_generate_conversion(typ, &convertible) {
builder.add_item(&alef_codegen::conversions::gen_from_binding_to_core_cfg(
typ,
&core_import,
&php_conv_config,
));
emitted_binding_to_core.insert(typ.name.clone());
}
}
}
// Error converter functions + optional introspection method impl structs
for error in &api.errors {
builder.add_item(&alef_codegen::error_gen::gen_php_error_converter(error, &core_import));
// Emit #[php_class] + #[php_impl] block for errors with introspection methods.
let methods_impl = alef_codegen::error_gen::gen_php_error_methods_impl(error, &core_import);
if !methods_impl.is_empty() {
builder.add_item(&methods_impl);
}
}
// Serde default helpers for bool fields whose core default is `true`,
// and for SecurityLimits fields which use struct-level defaults.
// Referenced by #[serde(default = "crate::serde_defaults::...")] on struct fields.
if has_serde {
let serde_module = "mod serde_defaults {\n pub fn bool_true() -> bool { true }\n\
pub fn max_archive_size() -> i64 { 500 * 1024 * 1024 }\n\
pub fn max_compression_ratio() -> i64 { 100 }\n\
pub fn max_files_in_archive() -> i64 { 10_000 }\n\
pub fn max_nesting_depth() -> i64 { 1024 }\n\
pub fn max_entity_length() -> i64 { 1024 * 1024 }\n\
pub fn max_content_size() -> i64 { 100 * 1024 * 1024 }\n\
pub fn max_iterations() -> i64 { 10_000_000 }\n\
pub fn max_xml_depth() -> i64 { 1024 }\n\
pub fn max_table_cells() -> i64 { 100_000 }\n\
}";
builder.add_item(serde_module);
}
// Always enable abi_vectorcall on Windows — ext-php-rs requires the
// `vectorcall` calling convention for PHP entry points there. The feature
// is unstable on stable Rust; consumers either build with nightly or set
// RUSTC_BOOTSTRAP=1 (the upstream-recommended workaround). This cfg_attr
// is a no-op on non-windows so it costs nothing on Linux/macOS builds.
let php_config = config.php.as_ref();
builder.add_inner_attribute("cfg_attr(windows, feature(abi_vectorcall))");
// Optional feature gate — when [php].feature_gate is set, the entire crate
// is conditionally compiled. Use this for parity with PyO3's `extension-module`
// pattern; most PHP bindings don't need it.
if let Some(feature_name) = php_config.and_then(|c| c.feature_gate.as_deref()) {
builder.add_inner_attribute(&format!("cfg(feature = \"{feature_name}\")"));
}
// PHP module entry point — explicit class registration required because
// `inventory` crate auto-registration doesn't work in cdylib on macOS.
let mut class_registrations = String::new();
for typ in api
.types
.iter()
.filter(|typ| !typ.is_trait && !exclude_types.contains(&typ.name))
{
class_registrations.push_str(&crate::template_env::render(
"php_class_registration.jinja",
context! { class_name => &typ.name },
));
}
// Register the facade class that wraps free functions as static methods.
if !api.functions.is_empty() {
let facade_class_name = extension_name.to_pascal_case();
class_registrations.push_str(&crate::template_env::render(
"php_class_registration.jinja",
context! { class_name => &format!("{facade_class_name}Api") },
));
}
// Tagged data enums are lowered to flat PHP classes — register them like other classes.
// Unit-variant enums remain as string constants and don't need .class::<T>() registration.
for enum_def in api.enums.iter().filter(|e| is_tagged_data_enum(e)) {
class_registrations.push_str(&crate::template_env::render(
"php_class_registration.jinja",
context! { class_name => &enum_def.name },
));
}
// Register error info classes for errors that expose introspection methods.
for error in api.errors.iter().filter(|e| !e.methods.is_empty()) {
let info_class = format!("{}Info", error.name);
class_registrations.push_str(&crate::template_env::render(
"php_class_registration.jinja",
context! { class_name => &info_class },
));
}
builder.add_item(&format!(
"#[php_module]\npub fn get_module(module: ModuleBuilder) -> ModuleBuilder {{\n module{class_registrations}\n}}"
));
let mut content = builder.build();
// Post-process generated code to replace the bridge builder method.
// The generated code produces `visitor(Option<&VisitorHandle>)` which is
// unreachable from PHP. Replace the entire method — signature and body —
// with one that accepts a ZendObject and builds the proper bridge handle.
for bridge in &config.trait_bridges {
if let Some(field_name) = bridge.resolved_options_field() {
let param_name = bridge.param_name.as_deref().unwrap_or(field_name);
let type_alias = bridge.type_alias.as_deref().unwrap_or("VisitorHandle");
let options_type = bridge.options_type.as_deref().unwrap_or("ConversionOptions");
let builder_type = format!("{}Builder", options_type);
let bridge_struct = format!("Php{}Bridge", bridge.trait_name);
let bridge_handle_path = bridge_handle_path(api, bridge, &core_import);
// Match the verbatim pre-rustfmt output from codegen.
// gen_instance_method produces 4-space-indented lines (signature + body),
// then ImplBuilder.build() adds 4 more spaces to every line → 8/8/4 indent.
// The body is a single-line Self { inner: Arc::new(...) } expression.
// rustfmt later reformats this to the 4/8/8/4 multi-line style on disk.
let old_method = format!(
" pub fn {field_name}(&self, {param_name}: Option<&{type_alias}>) -> {builder_type} {{\n Self {{ inner: Arc::new((*self.inner).clone().{field_name}({param_name}.as_ref().map(|v| &v.inner))) }}\n }}"
);
let new_method = format!(
" pub fn {field_name}(&self, {param_name}: &mut ext_php_rs::types::ZendObject) -> {builder_type} {{\n let bridge = {bridge_struct}::new({param_name});\n let handle: {bridge_handle_path} = std::sync::Arc::new(std::sync::Mutex::new(bridge));\n Self {{ inner: Arc::new((*self.inner).clone().{field_name}(Some(handle))) }}\n }}"
);
content = content.replace(&old_method, &new_method);
}
}
// Generate PHP interface files for visitor-style bridges.
// Use PHP stubs output path if configured, otherwise fall back to packages/php/src/.
let php_stubs_dir = config
.php
.as_ref()
.and_then(|p| p.stubs.as_ref())
.map(|s| s.output.to_string_lossy().to_string())
.unwrap_or_else(|| "packages/php/src/".to_string());
let php_namespace = php_autoload_namespace(config);
let mut generated_files = vec![GeneratedFile {
path: PathBuf::from(&output_dir).join("lib.rs"),
content,
generated_header: false,
}];
// Emit PHP interface files for visitor bridges
for bridge_cfg in &config.trait_bridges {
if let Some(trait_type) = api.types.iter().find(|t| t.is_trait && t.name == bridge_cfg.trait_name) {
// Check if this is a visitor-style bridge (has type_alias, no register_fn, all methods have defaults)
let is_visitor_bridge = bridge_cfg.type_alias.is_some()
&& bridge_cfg.register_fn.is_none()
&& bridge_cfg.super_trait.is_none()
&& trait_type.methods.iter().all(|m| m.has_default_impl);
if is_visitor_bridge {
let interface_content = crate::trait_bridge::gen_visitor_interface(
trait_type,
bridge_cfg,
&php_namespace,
&HashMap::new(), // type_paths not needed for the interface file itself
);
let interface_filename = format!("{}Interface.php", bridge_cfg.trait_name);
generated_files.push(GeneratedFile {
path: PathBuf::from(&php_stubs_dir).join(&interface_filename),
content: interface_content,
generated_header: false,
});
}
}
}
Ok(generated_files)
}
fn generate_public_api(
&self,
api: &ApiSurface,
config: &ResolvedCrateConfig,
) -> anyhow::Result<Vec<GeneratedFile>> {
let extension_name = config.php_extension_name();
let class_name = extension_name.to_pascal_case();
// Generate PHP wrapper class
let mut content = String::new();
content.push_str(&crate::template_env::render(
"php_file_header.jinja",
minijinja::Value::default(),
));
content.push_str(&hash::header(CommentStyle::DoubleSlash));
content.push_str(&crate::template_env::render(
"php_declare_strict_types.jinja",
minijinja::Value::default(),
));
// PSR-12: blank line between `declare(strict_types=1);` and `namespace`.
content.push('\n');
// Determine namespace — delegates to config so [php].namespace overrides are respected.
let namespace = php_autoload_namespace(config);
content.push_str(&crate::template_env::render(
"php_namespace.jinja",
context! { namespace => &namespace },
));
// PSR-12: blank line between `namespace` and class declaration.
content.push('\n');
content.push_str(&crate::template_env::render(
"php_facade_class_declaration.jinja",
context! { class_name => &class_name },
));
// Build the set of bridge param names so they are excluded from public PHP signatures.
let bridge_param_names_pub: ahash::AHashSet<&str> = config
.trait_bridges
.iter()
.filter_map(|b| b.param_name.as_deref())
.collect();
// Config types whose PHP constructors can be called with zero arguments.
// Only qualifies when ALL fields are optional (PHP constructor needs no required args).
// `has_default` (Rust Default impl) is NOT sufficient — the PHP constructor is
// generated from struct fields and still requires non-optional ones.
let no_arg_constructor_types: AHashSet<String> = api
.types
.iter()
.filter(|t| t.fields.iter().all(|f| f.optional))
.map(|t| t.name.clone())
.collect();
// Generate wrapper methods for functions
for func in &api.functions {
// PHP method names are based on the Rust source name (camelCased).
// Async functions do not get a suffix because PHP blocks on async internally
// via `block_on`, presenting a synchronous API to callers.
// For example: `scrape` (async in Rust) → `scrape()` (sync from PHP perspective).
let method_name = func.name.to_lower_camel_case();
let return_php_type = php_type(&func.return_type);
// Visible params exclude bridge params (not surfaced to PHP callers).
let visible_params: Vec<_> = func
.params
.iter()
.filter(|p| !bridge_param_names_pub.contains(p.name.as_str()))
.collect();
// PHPDoc block
content.push_str(&crate::template_env::render(
"php_phpdoc_block_start.jinja",
minijinja::Value::default(),
));
if func.doc.is_empty() {
content.push_str(&crate::template_env::render(
"php_phpdoc_text_line.jinja",
context! { text => &format!("{}.", method_name) },
));
} else {
content.push_str(&crate::template_env::render(
"php_phpdoc_lines.jinja",
context! {
doc_lines => func.doc.lines().collect::<Vec<_>>(),
indent => " ",
},
));
}
content.push_str(&crate::template_env::render(
"php_phpdoc_empty_line.jinja",
minijinja::Value::default(),
));
for p in &visible_params {
let ptype = php_phpdoc_type(&p.ty);
let nullable_prefix = if p.optional { "?" } else { "" };
content.push_str(&crate::template_env::render(
"php_phpdoc_param_line.jinja",
context! {
nullable_prefix => nullable_prefix,
param_type => &ptype,
param_name => &p.name,
},
));
}
let return_phpdoc = php_phpdoc_type(&func.return_type);
content.push_str(&crate::template_env::render(
"php_phpdoc_return_line.jinja",
context! { return_type => &return_phpdoc },
));
if func.error_type.is_some() {
content.push_str(&crate::template_env::render(
"php_phpdoc_throws_line.jinja",
context! {
namespace => namespace.as_str(),
class_name => &class_name,
},
));
}
content.push_str(&crate::template_env::render(
"php_phpdoc_block_end.jinja",
minijinja::Value::default(),
));
// Method signature with type hints.
// Keep parameters in their original Rust order.
// Since PHP doesn't allow optional params before required ones, and some Rust
// functions have optional params in the middle, we must make all params after
// the first optional one also optional (nullable with null default).
// This ensures e2e generated test code (which uses Rust param order) will work.
// Additionally, config-like parameters (Named types ending in "Config") should
// be treated as optional for PHP even if not explicitly marked as such in the IR.
// Helper: a config param is only treated as optional when its type can be
// constructed with zero arguments (all fields are optional in the IR).
let is_optional_config_param = |p: &alef_core::ir::ParamDef| -> bool {
if let TypeRef::Named(name) = &p.ty {
(name.ends_with("Config") || name.as_str() == "config")
&& no_arg_constructor_types.contains(name.as_str())
} else {
false
}
};
let mut first_optional_idx = None;
for (idx, p) in visible_params.iter().enumerate() {
if p.optional || is_optional_config_param(p) {
first_optional_idx = Some(idx);
break;
}
}
content.push_str(&crate::template_env::render(
"php_method_signature_start.jinja",
context! { method_name => &method_name },
));
let params: Vec<String> = visible_params
.iter()
.enumerate()
.map(|(idx, p)| {
let ptype = php_type(&p.ty);
// Make param optional if:
// 1. It's explicitly optional OR
// 2. It's a config parameter with a no-arg constructor OR
// 3. It comes after the first optional/config param
let should_be_optional = p.optional
|| is_optional_config_param(p)
|| first_optional_idx.is_some_and(|first| idx >= first);
if should_be_optional {
format!("?{} ${} = null", ptype, p.name)
} else {
format!("{} ${}", ptype, p.name)
}
})
.collect();
content.push_str(¶ms.join(", "));
content.push_str(&crate::template_env::render(
"php_method_signature_end.jinja",
context! { return_type => &return_php_type },
));
// Delegate to the native extension class (registered as `{namespace}\{class_name}Api`).
// ext-php-rs auto-converts Rust snake_case to PHP camelCase.
// PHP does not expose async — async behaviour is handled internally via Tokio
// block_on, so the Rust function name matches the PHP method name exactly.
let ext_method_name = func.name.to_lower_camel_case();
let is_void = matches!(&func.return_type, TypeRef::Unit);
// Pass parameters to the native function in their ORIGINAL order (not sorted).
// The native extension expects parameters in the order defined in the Rust function.
// The PHP facade reorders them only in its own signature for PHP syntax compliance,
// but must pass them in the original order when calling the native method.
// Config-type params that were made optional (nullable) in the facade must be
// coerced to their default constructor when null, since the native ext requires
// non-nullable objects.
let call_params = visible_params
.iter()
.enumerate()
.map(|(idx, p)| {
let should_be_optional = p.optional
|| is_optional_config_param(p)
|| first_optional_idx.is_some_and(|first| idx >= first);
if should_be_optional && is_optional_config_param(p) {
if let TypeRef::Named(type_name) = &p.ty {
return format!("${} ?? new {}()", p.name, type_name);
}
}
format!("${}", p.name)
})
.collect::<Vec<_>>()
.join(", ");
let call_expr = format!("\\{namespace}\\{class_name}Api::{ext_method_name}({call_params})");
if is_void {
content.push_str(&crate::template_env::render(
"php_method_call_statement.jinja",
context! { call_expr => &call_expr },
));
} else {
content.push_str(&crate::template_env::render(
"php_method_call_return.jinja",
context! { call_expr => &call_expr },
));
}
content.push_str(&crate::template_env::render(
"php_method_end.jinja",
minijinja::Value::default(),
));
}
// Emit trait-bridge registration methods in the PHP facade
for bridge_cfg in &config.trait_bridges {
if let Some(register_fn) = bridge_cfg.register_fn.as_deref() {
let method_name = register_fn.to_lower_camel_case();
content.push_str(&crate::template_env::render(
"php_phpdoc_block_start.jinja",
minijinja::Value::default(),
));
content.push_str(&crate::template_env::render(
"php_phpdoc_text_line.jinja",
context! { text => &format!("{}.", method_name) },
));
content.push_str(&crate::template_env::render(
"php_phpdoc_empty_line.jinja",
minijinja::Value::default(),
));
let interface_name = &bridge_cfg.trait_name;
content.push_str(&crate::template_env::render(
"php_phpdoc_param_line.jinja",
context! {
nullable_prefix => "",
param_type => interface_name,
param_name => "backend",
},
));
content.push_str(&crate::template_env::render(
"php_phpdoc_return_line.jinja",
context! { return_type => "void" },
));
content.push_str(&crate::template_env::render(
"php_phpdoc_block_end.jinja",
minijinja::Value::default(),
));
content.push_str(&crate::template_env::render(
"php_method_signature_start.jinja",
context! { method_name => &method_name },
));
content.push_str(&format!("{} $backend = null) : void", interface_name));
let call_expr = format!("\\{namespace}\\{class_name}Api::{register_fn}($backend)");
content.push_str(&crate::template_env::render(
"php_method_call_statement.jinja",
context! { call_expr => &call_expr },
));
content.push_str(&crate::template_env::render(
"php_method_end.jinja",
minijinja::Value::default(),
));
}
if let Some(unregister_fn) = bridge_cfg.unregister_fn.as_deref() {
let method_name = unregister_fn.to_lower_camel_case();
content.push_str(&crate::template_env::render(
"php_phpdoc_block_start.jinja",
minijinja::Value::default(),
));
content.push_str(&crate::template_env::render(
"php_phpdoc_text_line.jinja",
context! { text => &format!("{}.", method_name) },
));
content.push_str(&crate::template_env::render(
"php_phpdoc_empty_line.jinja",
minijinja::Value::default(),
));
content.push_str(&crate::template_env::render(
"php_phpdoc_param_line.jinja",
context! {
nullable_prefix => "",
param_type => "string",
param_name => "name",
},
));
content.push_str(&crate::template_env::render(
"php_phpdoc_return_line.jinja",
context! { return_type => "void" },
));
content.push_str(&crate::template_env::render(
"php_phpdoc_block_end.jinja",
minijinja::Value::default(),
));
content.push_str(&crate::template_env::render(
"php_method_signature_start.jinja",
context! { method_name => &method_name },
));
content.push_str("string $name) : void");
let call_expr = format!("\\{namespace}\\{class_name}Api::{unregister_fn}($name)");
content.push_str(&crate::template_env::render(
"php_method_call_statement.jinja",
context! { call_expr => &call_expr },
));
content.push_str(&crate::template_env::render(
"php_method_end.jinja",
minijinja::Value::default(),
));
}
if let Some(clear_fn) = bridge_cfg.clear_fn.as_deref() {
let method_name = clear_fn.to_lower_camel_case();
content.push_str(&crate::template_env::render(
"php_phpdoc_block_start.jinja",
minijinja::Value::default(),
));
content.push_str(&crate::template_env::render(
"php_phpdoc_text_line.jinja",
context! { text => &format!("{}.", method_name) },
));
content.push_str(&crate::template_env::render(
"php_phpdoc_empty_line.jinja",
minijinja::Value::default(),
));
content.push_str(&crate::template_env::render(
"php_phpdoc_return_line.jinja",
context! { return_type => "void" },
));
content.push_str(&crate::template_env::render(
"php_phpdoc_block_end.jinja",
minijinja::Value::default(),
));
content.push_str(&crate::template_env::render(
"php_method_signature_start.jinja",
context! { method_name => &method_name },
));
content.push_str(") : void");
let call_expr = format!("\\{namespace}\\{class_name}Api::{clear_fn}()");
content.push_str(&crate::template_env::render(
"php_method_call_statement.jinja",
context! { call_expr => &call_expr },
));
content.push_str(&crate::template_env::render(
"php_method_end.jinja",
minijinja::Value::default(),
));
}
}
content.push_str(&crate::template_env::render(
"php_class_end.jinja",
minijinja::Value::default(),
));
// Use PHP stubs output path if configured, otherwise fall back to packages/php/src/.
// This is intentionally separate from config.output.php, which controls the Rust binding
// crate output directory (e.g., crates/kreuzcrawl-php/src/).
let output_dir = config
.php
.as_ref()
.and_then(|p| p.stubs.as_ref())
.map(|s| s.output.to_string_lossy().to_string())
.unwrap_or_else(|| "packages/php/src/".to_string());
let mut files: Vec<GeneratedFile> = Vec::new();
files.push(GeneratedFile {
path: PathBuf::from(&output_dir).join(format!("{}.php", class_name)),
content,
generated_header: false,
});
// Emit a per-opaque-type PHP class file alongside the facade. These provide
// method declarations for static analysis (PHPStan) and IDE autocomplete.
// The native PHP extension registers the same class names at module load
// (before Composer autoload runs), so these userland files are never
// included at runtime — the native class always wins.
for typ in api.types.iter().filter(|t| t.is_opaque && !t.is_trait) {
let streaming_adapters: Vec<&alef_core::config::AdapterConfig> = config
.adapters
.iter()
.filter(|a| {
matches!(a.pattern, alef_core::config::AdapterPattern::Streaming)
&& a.owner_type.as_deref() == Some(&typ.name)
&& !a.skip_languages.iter().any(|l| l == "php")
})
.collect();
let streaming_method_names: AHashSet<String> = streaming_adapters.iter().map(|a| a.name.clone()).collect();
let opaque_file = gen_php_opaque_class_file(typ, &namespace, &streaming_adapters, &streaming_method_names);
files.push(GeneratedFile {
path: PathBuf::from(&output_dir).join(format!("{}.php", typ.name)),
content: opaque_file,
generated_header: false,
});
}
Ok(files)
}
fn generate_type_stubs(
&self,
api: &ApiSurface,
config: &ResolvedCrateConfig,
) -> anyhow::Result<Vec<GeneratedFile>> {
let extension_name = config.php_extension_name();
let class_name = extension_name.to_pascal_case();
// Determine namespace — delegates to config so [php].namespace overrides are respected.
let namespace = php_autoload_namespace(config);
// PSR-12 requires a blank line after the opening `<?php` tag.
// php-cs-fixer enforces this and would insert it post-write,
// making `alef verify` see content that differs from what was
// freshly generated. Emit it here so generated == on-disk.
let mut content = String::new();
content.push_str(&crate::template_env::render(
"php_file_header.jinja",
minijinja::Value::default(),
));
content.push_str(&hash::header(CommentStyle::DoubleSlash));
content.push_str("// Type stubs for the native PHP extension — declares classes\n");
content.push_str("// provided at runtime by the compiled Rust extension (.so/.dll).\n");
content.push_str("// Include this in phpstan.neon scanFiles for static analysis.\n\n");
content.push_str(&crate::template_env::render(
"php_declare_strict_types.jinja",
minijinja::Value::default(),
));
// PSR-12: blank line between `declare(strict_types=1);` and `namespace`.
content.push('\n');
// Use bracketed namespace syntax so we can add global-namespace function stubs later.
content.push_str(&crate::template_env::render(
"php_namespace_block_begin.jinja",
context! { namespace => &namespace },
));
// Exception class
content.push_str(&crate::template_env::render(
"php_exception_class_declaration.jinja",
context! { class_name => &class_name },
));
content.push_str(
" public function getErrorCode(): int { throw new \\RuntimeException('Not implemented.'); }\n",
);
// Emit introspection method stubs for errors that expose them.
// These are backed by #[php_method] impls in the generated native extension.
let has_status_code = api
.errors
.iter()
.any(|e| e.methods.iter().any(|m| m.name == "status_code"));
let has_is_transient = api
.errors
.iter()
.any(|e| e.methods.iter().any(|m| m.name == "is_transient"));
let has_error_type = api
.errors
.iter()
.any(|e| e.methods.iter().any(|m| m.name == "error_type"));
if has_status_code {
content.push_str(
" /** HTTP status code for this error (0 means no associated status). */\n \
public function statusCode(): int { throw new \\RuntimeException('Not implemented.'); }\n",
);
}
if has_is_transient {
content.push_str(
" /** Returns true if the error is transient and a retry may succeed. */\n \
public function isTransient(): bool { throw new \\RuntimeException('Not implemented.'); }\n",
);
}
if has_error_type {
content.push_str(
" /** Machine-readable error category string for matching and logging. */\n \
public function errorType(): string { throw new \\RuntimeException('Not implemented.'); }\n",
);
}
content.push_str("}\n\n");
// Opaque handle classes are declared as per-type PHP files in
// `packages/php/src/{TypeName}.php` (see `generate_public_api`). They
// are intentionally omitted from this aggregate extension stub so PHPStan
// does not see two class declarations for the same fully-qualified name.
// Record / struct types (non-opaque with fields)
for typ in api.types.iter().filter(|typ| !typ.is_trait) {
if typ.is_opaque || typ.fields.is_empty() {
continue;
}
if !typ.doc.is_empty() {
content.push_str("/**\n");
content.push_str(&crate::template_env::render(
"php_phpdoc_lines.jinja",
context! {
doc_lines => typ.doc.lines().collect::<Vec<_>>(),
indent => "",
},
));
content.push_str(" */\n");
}
content.push_str(&crate::template_env::render(
"php_record_class_stub_declaration.jinja",
context! { class_name => &typ.name },
));
// PHP 8.3+ constructor property promotion with `public readonly`.
// Required parameters come before optional ones (PHP syntax requirement).
let mut sorted_fields: Vec<&alef_core::ir::FieldDef> = binding_fields(&typ.fields).collect();
sorted_fields.sort_by_key(|f| f.optional);
// Promoted readonly parameters replace both separate property declarations
// and redundant getter methods — direct property access is the PHP 8.3+ idiom.
// Each promoted parameter gets an inline /** @var T [description] */ block so that
// phpdoc-lint (phpstan level max) and IDEs see the precise generic type and field docs.
let params: Vec<String> = sorted_fields
.iter()
.map(|f| {
let ptype = php_type(&f.ty);
let nullable = if f.optional && !ptype.starts_with('?') {
format!("?{ptype}")
} else {
ptype
};
let default = if f.optional { " = null" } else { "" };
let php_name = to_php_name(&f.name);
let phpdoc_type = php_phpdoc_type(&f.ty);
let var_type = if f.optional && !phpdoc_type.starts_with('?') {
format!("?{phpdoc_type}")
} else {
phpdoc_type
};
let phpdoc = php_property_phpdoc(&var_type, &f.doc, " ");
format!("{phpdoc} public readonly {nullable} ${php_name}{default}",)
})
.collect();
content.push_str(&crate::template_env::render(
"php_constructor_method.jinja",
context! { params => ¶ms.join(",\n") },
));
// Emit method stubs for impl methods declared on this DTO type.
// PHPStan can only see methods that appear in the stub; without these,
// static preset factories (e.g. `all()`, `minimal()`) and withers
// (e.g. `withChunking()`) are flagged as "Call to undefined method".
let non_excluded_methods: Vec<&alef_core::ir::MethodDef> = typ
.methods
.iter()
.filter(|m| !m.binding_excluded && !m.sanitized)
.collect();
for method in non_excluded_methods {
let method_name = method.name.to_lower_camel_case();
let is_static = method.receiver.is_none();
let return_type = php_type(&method.return_type);
let first_optional_idx = method.params.iter().position(|p| p.optional);
let params: Vec<String> = method
.params
.iter()
.enumerate()
.map(|(idx, p)| {
let ptype = php_type(&p.ty);
if p.optional || first_optional_idx.is_some_and(|first| idx >= first) {
let nullable = if ptype.starts_with('?') { "" } else { "?" };
format!("{nullable}{ptype} ${} = null", p.name)
} else {
format!("{} ${}", ptype, p.name)
}
})
.collect();
let static_kw = if is_static { "static " } else { "" };
let is_void = matches!(&method.return_type, TypeRef::Unit);
let stub_body = if is_void {
"{ }".to_string()
} else {
"{ throw new \\RuntimeException('Not implemented — provided by the native extension.'); }"
.to_string()
};
content.push_str(&format!(
" public {static_kw}function {method_name}({}): {return_type}\n {stub_body}\n",
params.join(", ")
));
}
content.push_str("}\n\n");
}
// Emit tagged data enums as classes (they're lowered to flat PHP classes in the binding).
// Unit-variant enums → PHP 8.1+ enum constants.
for enum_def in &api.enums {
if is_tagged_data_enum(enum_def) {
// Tagged data enums are lowered to flat classes; emit class stubs.
if !enum_def.doc.is_empty() {
content.push_str("/**\n");
content.push_str(&crate::template_env::render(
"php_phpdoc_lines.jinja",
context! {
doc_lines => enum_def.doc.lines().collect::<Vec<_>>(),
indent => "",
},
));
content.push_str(" */\n");
}
content.push_str(&crate::template_env::render(
"php_record_class_stub_declaration.jinja",
context! { class_name => &enum_def.name },
));
content.push_str("}\n\n");
} else {
// Unit-variant enums → PHP 8.1+ enum constants.
content.push_str(&crate::template_env::render(
"php_tagged_enum_declaration.jinja",
context! { enum_name => &enum_def.name },
));
for variant in &enum_def.variants {
let case_name = sanitize_php_enum_case(&variant.name);
content.push_str(&crate::template_env::render(
"php_enum_variant_stub.jinja",
context! {
variant_name => case_name,
value => &variant.name,
},
));
}
content.push_str("}\n\n");
}
}
// Extension function stubs — generated as a native `{ClassName}Api` class with static
// methods. The PHP facade (`{ClassName}`) delegates to `{ClassName}Api::method()`.
// Using a class instead of global functions avoids the `inventory` crate registration
// issue on macOS (cdylib builds do not collect `#[php_function]` entries there).
if !api.functions.is_empty() {
// Bridge params are hidden from the PHP-visible API in stubs too.
let bridge_param_names_stubs: ahash::AHashSet<&str> = config
.trait_bridges
.iter()
.filter_map(|b| b.param_name.as_deref())
.collect();
content.push_str(&crate::template_env::render(
"php_api_class_declaration.jinja",
context! { class_name => &class_name },
));
for func in &api.functions {
let return_type = php_type_fq(&func.return_type, &namespace);
let return_phpdoc = php_phpdoc_type_fq(&func.return_type, &namespace);
// Visible params exclude bridge params.
let visible_params: Vec<_> = func
.params
.iter()
.filter(|p| !bridge_param_names_stubs.contains(p.name.as_str()))
.collect();
// Stubs declare the ACTUAL native interface, which has parameters in their original order
// (ext-php-rs doesn't reorder them). DO NOT sort them here.
// The PHP facade may reorder them for syntax compliance, but the stub must match
// the actual native extension signature.
// Emit PHPDoc when any param or the return type is an array, so PHPStan
// understands generic element types (e.g. array<string> vs bare array).
let has_array_params = visible_params
.iter()
.any(|p| matches!(&p.ty, TypeRef::Vec(_) | TypeRef::Map(_, _)));
let has_array_return = matches!(&func.return_type, TypeRef::Vec(_) | TypeRef::Map(_, _))
|| matches!(&func.return_type, TypeRef::Optional(inner) if matches!(inner.as_ref(), TypeRef::Vec(_) | TypeRef::Map(_, _)));
let first_optional_idx = visible_params.iter().position(|p| p.optional);
if has_array_params || has_array_return {
content.push_str(" /**\n");
for (idx, p) in visible_params.iter().enumerate() {
let ptype = php_phpdoc_type_fq(&p.ty, &namespace);
let nullable_prefix = if p.optional || first_optional_idx.is_some_and(|first| idx >= first) {
"?"
} else {
""
};
content.push_str(&crate::template_env::render(
"php_phpdoc_static_param.jinja",
context! {
nullable_prefix => nullable_prefix,
ptype => &ptype,
param_name => &p.name,
},
));
}
content.push_str(&crate::template_env::render(
"php_phpdoc_static_return.jinja",
context! { return_phpdoc => &return_phpdoc },
));
content.push_str(" */\n");
}
let params: Vec<String> = visible_params
.iter()
.enumerate()
.map(|(idx, p)| {
let ptype = php_type_fq(&p.ty, &namespace);
if p.optional || first_optional_idx.is_some_and(|first| idx >= first) {
let nullable_ptype = if ptype.starts_with('?') {
ptype
} else {
format!("?{ptype}")
};
format!("{} ${} = null", nullable_ptype, p.name)
} else {
format!("{} ${}", ptype, p.name)
}
})
.collect();
// ext-php-rs auto-converts Rust snake_case to PHP camelCase.
// PHP does not expose async — async behaviour is handled internally via
// Tokio block_on, so the stub method name matches the Rust function name.
let stub_method_name = func.name.to_lower_camel_case();
let is_void_stub = return_type == "void";
let stub_body = if is_void_stub {
"{ }".to_string()
} else {
"{ throw new \\RuntimeException('Not implemented.'); }".to_string()
};
content.push_str(&crate::template_env::render(
"php_static_method_stub.jinja",
context! {
method_name => &stub_method_name,
params => ¶ms.join(", "),
return_type => &return_type,
stub_body => &stub_body,
},
));
}
content.push_str("}\n\n");
}
// Close the namespaced block
content.push_str(&crate::template_env::render(
"php_namespace_block_end.jinja",
minijinja::Value::default(),
));
// Use stubs output path if configured, otherwise packages/php/stubs/
let output_dir = config
.php
.as_ref()
.and_then(|p| p.stubs.as_ref())
.map(|s| s.output.to_string_lossy().to_string())
.unwrap_or_else(|| "packages/php/stubs/".to_string());
Ok(vec![GeneratedFile {
path: PathBuf::from(&output_dir).join(format!("{}_extension.php", extension_name)),
content,
generated_header: false,
}])
}
fn build_config(&self) -> Option<BuildConfig> {
Some(BuildConfig {
tool: "cargo",
crate_suffix: "-php",
build_dep: BuildDependency::None,
post_build: vec![],
})
}
}
fn bridge_handle_path(api: &ApiSurface, bridge: &alef_core::config::TraitBridgeConfig, core_import: &str) -> String {
let alias = bridge.type_alias.as_deref().unwrap_or("VisitorHandle");
api.types
.iter()
.find(|t| t.name == alias && !t.rust_path.is_empty())
.map(|t| t.rust_path.replace('-', "_"))
.or_else(|| api.excluded_type_paths.get(alias).map(|path| path.replace('-', "_")))
.unwrap_or_else(|| format!("{core_import}::visitor::{alias}"))
}
/// Map an IR [`TypeRef`] to a PHPDoc type string with generic parameters (e.g., `array<string>`).
/// PHPStan at level `max` requires iterable value types in PHPDoc annotations.
fn php_phpdoc_type(ty: &TypeRef) -> String {
match ty {
TypeRef::Vec(inner) => format!("array<{}>", php_phpdoc_type(inner)),
TypeRef::Map(k, v) => format!("array<{}, {}>", php_phpdoc_type(k), php_phpdoc_type(v)),
TypeRef::Optional(inner) => format!("?{}", php_phpdoc_type(inner)),
_ => php_type(ty),
}
}
/// Map an IR [`TypeRef`] to a fully-qualified PHPDoc type string with generics (e.g., `array<\Ns\T>`).
fn php_phpdoc_type_fq(ty: &TypeRef, namespace: &str) -> String {
match ty {
TypeRef::Vec(inner) => format!("array<{}>", php_phpdoc_type_fq(inner, namespace)),
TypeRef::Map(k, v) => format!(
"array<{}, {}>",
php_phpdoc_type_fq(k, namespace),
php_phpdoc_type_fq(v, namespace)
),
TypeRef::Named(name) => format!("\\{}\\{}", namespace, name),
TypeRef::Optional(inner) => format!("?{}", php_phpdoc_type_fq(inner, namespace)),
_ => php_type(ty),
}
}
/// Map an IR [`TypeRef`] to a fully-qualified PHP type-hint string for use outside the namespace.
fn php_type_fq(ty: &TypeRef, namespace: &str) -> String {
match ty {
TypeRef::Named(name) => format!("\\{}\\{}", namespace, name),
TypeRef::Optional(inner) => {
let inner_type = php_type_fq(inner, namespace);
if inner_type.starts_with('?') {
inner_type
} else {
format!("?{inner_type}")
}
}
_ => php_type(ty),
}
}
/// Generate a per-opaque-type PHP class file for `packages/php/src/{TypeName}.php`.
///
/// The native ext-php-rs extension registers the same class at module load time
/// (before Composer autoload runs), so this userland file is never included at
/// runtime — the native class always wins. The file is consumed by PHPStan and
/// IDEs as the authoritative declaration of the type's public API surface.
fn gen_php_opaque_class_file(
typ: &alef_core::ir::TypeDef,
namespace: &str,
streaming_adapters: &[&alef_core::config::AdapterConfig],
streaming_method_names: &AHashSet<String>,
) -> String {
let mut content = String::new();
content.push_str(&crate::template_env::render(
"php_file_header.jinja",
minijinja::Value::default(),
));
content.push_str(&hash::header(CommentStyle::DoubleSlash));
content.push_str(&crate::template_env::render(
"php_declare_strict_types.jinja",
minijinja::Value::default(),
));
// PSR-12: blank line between `declare(strict_types=1);` and `namespace`.
content.push('\n');
content.push_str(&crate::template_env::render(
"php_namespace.jinja",
context! { namespace => namespace },
));
// PSR-12: blank line between `namespace` and class declaration.
content.push('\n');
// Type-level docblock.
if !typ.doc.is_empty() {
content.push_str("/**\n");
content.push_str(&crate::template_env::render(
"php_phpdoc_lines.jinja",
context! {
doc_lines => typ.doc.lines().collect::<Vec<_>>(),
indent => "",
},
));
content.push_str(" */\n");
}
content.push_str(&format!("final class {}\n{{\n", typ.name));
// Instance methods first, static methods second — skip streaming methods
// (they'll be emitted as Generator wrappers after regular methods).
let mut method_order: Vec<&alef_core::ir::MethodDef> = Vec::new();
method_order.extend(
typ.methods
.iter()
.filter(|m| m.receiver.is_some() && !streaming_method_names.contains(&m.name)),
);
method_order.extend(
typ.methods
.iter()
.filter(|m| m.receiver.is_none() && !streaming_method_names.contains(&m.name)),
);
for method in method_order {
let method_name = method.name.to_lower_camel_case();
let return_type = php_type(&method.return_type);
let is_void = matches!(&method.return_type, TypeRef::Unit);
let is_static = method.receiver.is_none();
// PHPDoc block — keep it short to avoid line-width issues.
let mut doc_lines: Vec<String> = vec![];
let doc_line = method.doc.lines().next().unwrap_or("").trim();
if !doc_line.is_empty() {
doc_lines.push(doc_line.to_string());
}
// Add @param PHPDoc for array parameters so PHPStan knows the element type
let mut phpdoc_params: Vec<String> = vec![];
for param in &method.params {
if matches!(¶m.ty, TypeRef::Vec(_) | TypeRef::Map(_, _)) {
let phpdoc_type = php_phpdoc_type(¶m.ty);
phpdoc_params.push(format!("@param {} ${}", phpdoc_type, param.name));
}
}
doc_lines.extend(phpdoc_params);
// Add @return PHPDoc for array types so PHPStan knows the element type
let needs_return_phpdoc = matches!(&method.return_type, TypeRef::Vec(_) | TypeRef::Map(_, _));
if needs_return_phpdoc {
let phpdoc_type = php_phpdoc_type(&method.return_type);
doc_lines.push(format!("@return {phpdoc_type}"));
}
// Emit PHPDoc if needed
if !doc_lines.is_empty() {
content.push_str(" /**\n");
for line in doc_lines {
content.push_str(&format!(" * {}\n", line));
}
content.push_str(" */\n");
}
// Method signature.
let static_kw = if is_static { "static " } else { "" };
let first_optional_idx = method.params.iter().position(|p| p.optional);
let params: Vec<String> = method
.params
.iter()
.enumerate()
.map(|(idx, p)| {
let ptype = php_type(&p.ty);
if p.optional || first_optional_idx.is_some_and(|first| idx >= first) {
let nullable = if ptype.starts_with('?') { "" } else { "?" };
format!("{nullable}{ptype} ${} = null", p.name)
} else {
format!("{} ${}", ptype, p.name)
}
})
.collect();
content.push_str(&format!(
" public {static_kw}function {method_name}({}): {return_type}\n",
params.join(", ")
));
let body = if is_void {
" {\n }\n"
} else {
" {\n throw new \\RuntimeException('Not implemented — provided by the native extension.');\n }\n"
};
content.push_str(body);
}
// Streaming wrapper methods: convert _start/_next/_free Rust functions to PHP Generators.
for adapter in streaming_adapters {
let item_type = adapter.item_type.as_deref().unwrap_or("array");
content.push_str(&gen_php_streaming_method_wrapper(adapter, item_type));
content.push('\n');
}
content.push_str("}\n");
content
}
/// Generate a PHP streaming method wrapper for an adapter.
///
/// For PHP, we generate a Generator method that calls the Rust streaming methods directly.
/// Since PHP can't easily pass opaque types as function parameters, we skip the _start/_next/_free
/// pattern and instead keep the streaming logic on the class.
fn gen_php_streaming_method_wrapper(adapter: &alef_core::config::AdapterConfig, _item_type: &str) -> String {
let method_name = adapter.name.to_lower_camel_case();
// Build parameter list.
let mut params_vec: Vec<String> = Vec::new();
for p in &adapter.params {
let ptype = php_type(&alef_core::ir::TypeRef::Named(p.ty.clone()));
let nullable = if p.optional { "?" } else { "" };
let default = if p.optional { " = null" } else { "" };
params_vec.push(format!("{nullable}{ptype} ${}{default}", p.name));
}
let params_sig = params_vec.join(", ");
// Generate a stub method that indicates it's provided by the native extension.
// The actual streaming implementation is on the Rust side; this PHP method
// is a placeholder for IDE/PHPStan. At runtime, the native extension
// provides the actual Generator-yielding implementation.
format!(
" public function {method_name}({params_sig}): \\Generator\n {{\n \
throw new \\RuntimeException('Not implemented — provided by the native extension.');\n \
}}\n",
method_name = method_name,
)
}
/// Map an IR [`TypeRef`] to a PHP type-hint string.
fn php_type(ty: &TypeRef) -> String {
match ty {
TypeRef::String | TypeRef::Char | TypeRef::Json | TypeRef::Bytes | TypeRef::Path => "string".to_string(),
TypeRef::Primitive(p) => match p {
PrimitiveType::Bool => "bool".to_string(),
PrimitiveType::F32 | PrimitiveType::F64 => "float".to_string(),
PrimitiveType::U8
| PrimitiveType::U16
| PrimitiveType::U32
| PrimitiveType::U64
| PrimitiveType::I8
| PrimitiveType::I16
| PrimitiveType::I32
| PrimitiveType::I64
| PrimitiveType::Usize
| PrimitiveType::Isize => "int".to_string(),
},
TypeRef::Optional(inner) => {
// Flatten nested Option<Option<T>> to a single nullable type.
// PHP has no double-nullable concept; ?T already covers null.
let inner_type = php_type(inner);
if inner_type.starts_with('?') {
inner_type
} else {
format!("?{inner_type}")
}
}
TypeRef::Vec(_) | TypeRef::Map(_, _) => "array".to_string(),
TypeRef::Named(name) => name.clone(),
TypeRef::Unit => "void".to_string(),
TypeRef::Duration => "float".to_string(),
}
}
/// Build an inline PHPDoc block for a class property or constructor-promoted parameter.
///
/// - When `doc` is non-empty and multi-line, emits a multi-line block with description lines
/// followed by an `@var` tag.
/// - When `doc` is non-empty and single-line, emits a compact `/** @var T Description. */` form.
/// - When `doc` is empty, emits the type-only compact form `/** @var T */`.
///
/// `indent` is prepended to every line of the output (typically 4 or 8 spaces).
fn php_property_phpdoc(var_type: &str, doc: &str, indent: &str) -> String {
let doc = doc.trim();
if doc.is_empty() {
return format!("{indent}/** @var {var_type} */\n");
}
let lines: Vec<&str> = doc.lines().collect();
if lines.len() == 1 {
let line = lines[0].trim();
return format!("{indent}/** @var {var_type} {line} */\n");
}
// Multi-line: description block + @var tag.
let mut out = format!("{indent}/**\n");
for line in &lines {
let trimmed = line.trim();
if trimmed.is_empty() {
out.push_str(&format!("{indent} *\n"));
} else {
out.push_str(&format!("{indent} * {trimmed}\n"));
}
}
out.push_str(&format!("{indent} *\n"));
out.push_str(&format!("{indent} * @var {var_type}\n"));
out.push_str(&format!("{indent} */\n"));
out
}