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
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
|
<?php
/**
* Elgg entities.
* Functions to manage all elgg entities (sites, collections, objects and users).
*
* @package Elgg
* @subpackage Core
* @author Curverider Ltd <info@elgg.com>
* @link http://elgg.org/
*/
/// Cache objects in order to minimise database access.
$ENTITY_CACHE = NULL;
/// Cache subtype searches
$SUBTYPE_CACHE = NULL;
/// Require the locatable interface TODO: Move this into start.php?
require_once('location.php');
/**
* ElggEntity The elgg entity superclass
* This class holds methods for accessing the main entities table.
*
* @author Curverider Ltd <info@elgg.com>
* @package Elgg
* @subpackage Core
*/
abstract class ElggEntity implements
Notable, // Calendar interface
Locatable, // Geocoding interface
Exportable, // Allow export of data
Importable, // Allow import of data
Loggable, // Can events related to this object class be logged
Iterator, // Override foreach behaviour
ArrayAccess // Override for array access
{
/**
* The main attributes of an entity.
* Blank entries for all database fields should be created by the constructor.
* Subclasses should add to this in their constructors.
* Any field not appearing in this will be viewed as a
*/
protected $attributes;
/**
* If set, overrides the value of getURL()
*/
protected $url_override;
/**
* Icon override, overrides the value of getIcon().
*/
protected $icon_override;
/**
* Temporary cache for metadata, permitting meta data access before a guid has obtained.
*/
protected $temp_metadata;
/**
* Temporary cache for annotations, permitting meta data access before a guid has obtained.
*/
protected $temp_annotations;
/**
* Volatile data structure for this object, allows for storage of data
* in-memory that isn't sync'd back to the metadata table.
*/
protected $volatile;
/**
* Initialise the attributes array.
* This is vital to distinguish between metadata and base parameters.
*
* Place your base parameters here.
*
* @return void
*/
protected function initialise_attributes() {
initialise_entity_cache();
// Create attributes array if not already created
if (!is_array($this->attributes)) {
$this->attributes = array();
}
if (!is_array($this->temp_metadata)) {
$this->temp_metadata = array();
}
if (!is_array($this->temp_annotations)) {
$this->temp_annotations = array();
}
if (!is_array($this->volatile)) {
$this->volatile = array();
}
$this->attributes['guid'] = "";
$this->attributes['type'] = "";
$this->attributes['subtype'] = "";
$this->attributes['owner_guid'] = get_loggedin_userid();
$this->attributes['container_guid'] = get_loggedin_userid();
$this->attributes['site_guid'] = 0;
$this->attributes['access_id'] = ACCESS_PRIVATE;
$this->attributes['time_created'] = "";
$this->attributes['time_updated'] = "";
$this->attributes['enabled'] = "yes";
// There now follows a bit of a hack
/* Problem: To speed things up, some objects are split over several tables, this means that it requires
* n number of database reads to fully populate an entity. This causes problems for caching and create events
* since it is not possible to tell whether a subclassed entity is complete.
* Solution: We have two counters, one 'tables_split' which tells whatever is interested how many tables
* are going to need to be searched in order to fully populate this object, and 'tables_loaded' which is how
* many have been loaded thus far.
* If the two are the same then this object is complete.
*
* Use: isFullyLoaded() to check
*/
$this->attributes['tables_split'] = 1;
$this->attributes['tables_loaded'] = 0;
}
/**
* Clone an entity
*
* Resets the guid so that the entity can be saved as a distinct entity from
* the original. Creation time will be set when this new entity is saved.
* The owner and container guids come from the original entity. The clone
* method copies metadata but does not copy over annotations, or private settings.
*
* Note: metadata will have its owner and access id set when the entity is saved
* and it will be the same as that off the entity.
*/
public function __clone() {
$orig_entity = get_entity($this->guid);
if (!$orig_entity) {
elgg_log("Failed to clone entity with GUID $this->guid", "ERROR");
return;
}
$metadata_array = get_metadata_for_entity($this->guid);
$this->attributes['guid'] = "";
// copy metadata over to new entity - slightly convoluted due to
// handling of metadata arrays
if (is_array($metadata_array)) {
// create list of metadata names
$metadata_names = array();
foreach ($metadata_array as $metadata) {
$metadata_names[] = $metadata['name'];
}
// arrays are stored with multiple enties per name
$metadata_names = array_unique($metadata_names);
// move the metadata over
foreach ($metadata_names as $name) {
$this->set($name, $orig_entity->$name);
}
}
}
/**
* Return the value of a given key.
* If $name is a key field (as defined in $this->attributes) that value is returned, otherwise it will
* then look to see if the value is in this object's metadata.
*
* Q: Why are we not using __get overload here?
* A: Because overload operators cause problems during subclassing, so we put the code here and
* create overloads in subclasses.
*
* subtype is returned as an id rather than the subtype string. Use getSubtype()
* to get the subtype string.
*
* @param string $name
* @return mixed Returns the value of a given value, or null.
*/
public function get($name) {
// See if its in our base attribute
if (isset($this->attributes[$name])) {
return $this->attributes[$name];
}
// No, so see if its in the meta data for this entity
$meta = $this->getMetaData($name);
// getMetaData returns NULL if $name is not found
return $meta;
}
/**
* Set the value of a given key, replacing it if necessary.
* If $name is a base attribute (as defined in $this->attributes) that value is set, otherwise it will
* set the appropriate item of metadata.
*
* Note: It is important that your class populates $this->attributes with keys for all base attributes, anything
* not in their gets set as METADATA.
*
* Q: Why are we not using __set overload here?
* A: Because overload operators cause problems during subclassing, so we put the code here and
* create overloads in subclasses.
*
* @todo Move "title" logic to applicable extending classes.
*
* @param string $name
* @param mixed $value
*/
public function set($name, $value) {
if (array_key_exists($name, $this->attributes)) {
// Check that we're not trying to change the guid!
if ((array_key_exists('guid', $this->attributes)) && ($name=='guid')) {
return false;
}
// strip out tags from title
if ($name == 'title') {
$value = strip_tags($value);
}
$this->attributes[$name] = $value;
}
else {
return $this->setMetaData($name, $value);
}
return true;
}
/**
* Get a given piece of metadata.
*
* @param string $name
*/
public function getMetaData($name) {
if ((int) ($this->guid) > 0) {
$md = get_metadata_byname($this->getGUID(), $name);
} else {
if (isset($this->temp_metadata[$name])) {
return $this->temp_metadata[$name];
}
}
if ($md && !is_array($md)) {
return $md->value;
} else if ($md && is_array($md)) {
return metadata_array_to_values($md);
}
return null;
}
/**
* Class member get overloading
*
* @param string $name
* @return mixed
*/
function __get($name) {
return $this->get($name);
}
/**
* Class member set overloading
*
* @param string $name
* @param mixed $value
* @return mixed
*/
function __set($name, $value) {
return $this->set($name, $value);
}
/**
* Supporting isset.
*
* @param string $name The name of the attribute or metadata.
* @return bool
*/
function __isset($name) {
if ($this->$name!="") {
return true;
}
else {
return false;
}
}
/**
* Supporting unsetting of magic attributes.
*
* @param string $name The name of the attribute or metadata.
*/
function __unset($name) {
if (array_key_exists($name, $this->attributes)) {
$this->attributes[$name] = "";
}
else {
$this->clearMetaData($name);
}
}
/**
* Set a piece of metadata.
*
* @param string $name Name of the metadata
* @param mixed $value Value of the metadata
* @param string $value_type Types supported: integer and string. Will auto-identify if not set
* @param bool $multiple
* @return bool
*/
public function setMetaData($name, $value, $value_type = "", $multiple = false) {
if (is_array($value)) {
unset($this->temp_metadata[$name]);
remove_metadata($this->getGUID(), $name);
foreach ($value as $v) {
if ((int) $this->guid > 0) {
$multiple = true;
if (!create_metadata($this->getGUID(), $name, $v, $value_type,
$this->getOwner(), $this->getAccessID(), $multiple)) {
return false;
}
} else {
if (($multiple) && (isset($this->temp_metadata[$name]))) {
if (!is_array($this->temp_metadata[$name])) {
$tmp = $this->temp_metadata[$name];
$this->temp_metadata[$name] = array();
$this->temp_metadata[$name][] = $tmp;
}
$this->temp_metadata[$name][] = $value;
}
else {
$this->temp_metadata[$name] = $value;
}
}
}
return true;
} else {
unset($this->temp_metadata[$name]);
if ((int) $this->guid > 0) {
return create_metadata($this->getGUID(), $name, $value, $value_type, $this->getOwner(), $this->getAccessID(), $multiple);
} else {
//$this->temp_metadata[$name] = $value;
if (($multiple) && (isset($this->temp_metadata[$name]))) {
if (!is_array($this->temp_metadata[$name])) {
$tmp = $this->temp_metadata[$name];
$this->temp_metadata[$name] = array();
$this->temp_metadata[$name][] = $tmp;
}
$this->temp_metadata[$name][] = $value;
}
else {
$this->temp_metadata[$name] = $value;
}
return true;
}
}
}
/**
* Clear metadata.
*/
public function clearMetaData($name = "") {
if (empty($name)) {
return clear_metadata($this->getGUID());
} else {
return remove_metadata($this->getGUID(),$name);
}
}
/**
* Get a piece of volatile (non-persisted) data on this entity
*/
public function getVolatileData($name) {
if (!is_array($this->volatile)) {
$this->volatile = array();
}
if (array_key_exists($name, $this->volatile)) {
return $this->volatile[$name];
} else {
return NULL;
}
}
/**
* Set a piece of volatile (non-persisted) data on this entity
*/
public function setVolatileData($name, $value) {
if (!is_array($this->volatile)) {
$this->volatile = array();
}
$this->volatile[$name] = $value;
}
/**
* Remove all entities associated with this entity
*
* @return true
*/
public function clearRelationships() {
remove_entity_relationships($this->getGUID());
remove_entity_relationships($this->getGUID(),"",true);
return true;
}
/**
* Add a relationship.
*
* @param int $guid Relationship to link to.
* @param string $relationship The type of relationship.
*/
public function addRelationship($guid, $relationship) {
return add_entity_relationship($this->getGUID(), $relationship, $guid);
}
/**
* Adds a private setting to this entity.
*
* @param $name
* @param $value
* @return unknown_type
*/
function setPrivateSetting($name, $value) {
return set_private_setting($this->getGUID(), $name, $value);
}
/**
* Gets private setting for this entity
*
* @param $name
* @return unknown_type
*/
function getPrivateSetting($name) {
return get_private_setting($this->getGUID(), $name);
}
/**
* Removes private setting for this entity.
*
* @param $name
* @return unknown_type
*/
function removePrivateSetting($name) {
return remove_private_setting($this->getGUID(), $name);
}
/**
* Adds an annotation to an entity. By default, the type is detected automatically; however,
* it can also be set. Note that by default, annotations are private.
*
* @param string $name
* @param mixed $value
* @param int $access_id
* @param int $owner_id
* @param string $vartype
*/
function annotate($name, $value, $access_id = ACCESS_PRIVATE, $owner_id = 0, $vartype = "") {
if ((int) $this->guid > 0) {
return create_annotation($this->getGUID(), $name, $value, $vartype, $owner_id, $access_id);
} else {
$this->temp_annotations[$name] = $value;
}
return true;
}
/**
* Get the annotations for an entity.
*
* @param string $name
* @param int $limit
* @param int $offset
* @param string $order
*/
function getAnnotations($name, $limit = 50, $offset = 0, $order="asc") {
if ((int) ($this->guid) > 0) {
return get_annotations($this->getGUID(), "", "", $name, "", 0, $limit, $offset, $order);
} else {
return $this->temp_annotations[$name];
}
}
/**
* Remove all annotations or all annotations for this entity.
*
* @param string $name
*/
function clearAnnotations($name = "") {
return clear_annotations($this->getGUID(), $name);
}
/**
* Return the annotations for the entity.
*
* @param string $name The type of annotation.
*/
function countAnnotations($name = "") {
return count_annotations($this->getGUID(), "", "", $name);
}
/**
* Get the average of an integer type annotation.
*
* @param string $name
*/
function getAnnotationsAvg($name) {
return get_annotations_avg($this->getGUID(), "", "", $name);
}
/**
* Get the sum of integer type annotations of a given name.
*
* @param string $name
*/
function getAnnotationsSum($name) {
return get_annotations_sum($this->getGUID(), "", "", $name);
}
/**
* Get the minimum of integer type annotations of given name.
*
* @param string $name
*/
function getAnnotationsMin($name) {
return get_annotations_min($this->getGUID(), "", "", $name);
}
/**
* Get the maximum of integer type annotations of a given name.
*
* @param string $name
*/
function getAnnotationsMax($name) {
return get_annotations_max($this->getGUID(), "", "", $name);
}
/**
* Gets an array of entities from a specific relationship type
*
* @param string $relationship Relationship type (eg "friends")
* @param true|false $inverse Is this an inverse relationship?
* @param int $limit Number of elements to return
* @param int $offset Indexing offset
* @return array|false An array of entities or false on failure
*/
function getEntitiesFromRelationship($relationship, $inverse = false, $limit = 50, $offset = 0) {
return get_entities_from_relationship($relationship, $this->getGUID(), $inverse,
"", "", "", "time_created desc", $limit, $offset);
}
/**
* Gets the number of of entities from a specific relationship type
*
* @param string $relationship Relationship type (eg "friends")
* @return int|false The number of entities or false on failure
*/
function countEntitiesFromRelationship($relationship) {
return get_entities_from_relationship($relationship, $this->getGUID(), false, "", "", "",
"time_created desc", null, null, true);
}
/**
* Determines whether or not the specified user (by default the current one) can edit the entity
*
* @param int $user_guid The user GUID, optionally (defaults to the currently logged in user)
* @return true|false
*/
function canEdit($user_guid = 0) {
return can_edit_entity($this->getGUID(), $user_guid);
}
/**
* Determines whether or not the specified user (by default the current one) can edit metadata on the entity
*
* @param ElggMetadata $metadata The piece of metadata to specifically check
* @param int $user_guid The user GUID, optionally (defaults to the currently logged in user)
* @return true|false
*/
function canEditMetadata($metadata = null, $user_guid = 0) {
return can_edit_entity_metadata($this->getGUID(), $user_guid, $metadata);
}
/**
* Returns whether the given user (or current user) has the ability to write to this container.
*
* @param int $user_guid The user.
* @return bool
*/
public function canWriteToContainer($user_guid = 0) {
return can_write_to_container($user_guid, $this->getGUID());
}
/**
* Obtain this entity's access ID
*
* @return int The access ID
*/
public function getAccessID() {
return $this->get('access_id');
}
/**
* Obtain this entity's GUID
*
* @return int GUID
*/
public function getGUID() {
return $this->get('guid');
}
/**
* Get the owner of this entity
*
* @return int The owner GUID
*/
public function getOwner() {
return $this->get('owner_guid');
}
/**
* Returns the actual entity of the user who owns this entity, if any
*
* @return ElggEntity The owning user
*/
public function getOwnerEntity() {
return get_entity($this->get('owner_guid'));
}
/**
* Gets the type of entity this is
*
* @return string Entity type
*/
public function getType() {
return $this->get('type');
}
/**
* Returns the subtype of this entity
*
* @return string The entity subtype
*/
public function getSubtype() {
// If this object hasn't been saved, then return the subtype string.
if (!((int) $this->guid > 0)) {
return $this->get('subtype');
}
return get_subtype_from_id($this->get('subtype'));
}
/**
* Gets the UNIX epoch time that this entity was created
*
* @return int UNIX epoch time
*/
public function getTimeCreated() {
return $this->get('time_created');
}
/**
* Gets the UNIX epoch time that this entity was last updated
*
* @return int UNIX epoch time
*/
public function getTimeUpdated() {
return $this->get('time_updated');
}
/**
* Gets the display URL for this entity
*
* @return string The URL
*/
public function getURL() {
if (!empty($this->url_override)) {
return $this->url_override;
}
return get_entity_url($this->getGUID());
}
/**
* Overrides the URL returned by getURL
*
* @param string $url The new item URL
* @return string The URL
*/
public function setURL($url) {
$this->url_override = $url;
return $url;
}
/**
* Return a url for the entity's icon, trying multiple alternatives.
*
* @param string $size Either 'large','medium','small' or 'tiny'
* @return string The url or false if no url could be worked out.
*/
public function getIcon($size = 'medium') {
if (isset($this->icon_override[$size])) {
return $this->icon_override[$size];
}
return get_entity_icon_url($this, $size);
}
/**
* Set an icon override for an icon and size.
*
* @param string $url The url of the icon.
* @param string $size The size its for.
* @return bool
*/
public function setIcon($url, $size = 'medium') {
$url = sanitise_string($url);
$size = sanitise_string($size);
if (!$this->icon_override) {
$this->icon_override = array();
}
$this->icon_override[$size] = $url;
return true;
}
/**
* Tests to see whether the object has been fully loaded.
*
* @return bool
*/
public function isFullyLoaded() {
return ! ($this->attributes['tables_loaded'] < $this->attributes['tables_split']);
}
/**
* Save generic attributes to the entities table.
*/
public function save() {
$guid = (int) $this->guid;
if ($guid > 0) {
cache_entity($this);
return update_entity(
$this->get('guid'),
$this->get('owner_guid'),
$this->get('access_id'),
$this->get('container_guid')
);
} else {
// Create a new entity (nb: using attribute array directly 'cos set function does something special!)
$this->attributes['guid'] = create_entity($this->attributes['type'], $this->attributes['subtype'], $this->attributes['owner_guid'], $this->attributes['access_id'], $this->attributes['site_guid'], $this->attributes['container_guid']);
if (!$this->attributes['guid']) {
throw new IOException(elgg_echo('IOException:BaseEntitySaveFailed'));
}
// Save any unsaved metadata TODO: How to capture extra information (access id etc)
if (sizeof($this->temp_metadata) > 0) {
foreach($this->temp_metadata as $name => $value) {
$this->$name = $value;
unset($this->temp_metadata[$name]);
}
}
// Save any unsaved annotations metadata. TODO: How to capture extra information (access id etc)
if (sizeof($this->temp_annotations) > 0) {
foreach($this->temp_annotations as $name => $value) {
$this->annotate($name, $value);
unset($this->temp_annotations[$name]);
}
}
// set the subtype to id now rather than a string
$this->attributes['subtype'] = get_subtype_id($this->attributes['type'], $this->attributes['subtype']);
// Cache object handle
if ($this->attributes['guid']) cache_entity($this);
return $this->attributes['guid'];
}
}
/**
* Load the basic entity information and populate base attributes array.
*
* @param int $guid
*/
protected function load($guid) {
$row = get_entity_as_row($guid);
if ($row) {
// Create the array if necessary - all subclasses should test before creating
if (!is_array($this->attributes)) {
$this->attributes = array();
}
// Now put these into the attributes array as core values
$objarray = (array) $row;
foreach($objarray as $key => $value) {
$this->attributes[$key] = $value;
}
// Increment the portion counter
if (!$this->isFullyLoaded()) {
$this->attributes['tables_loaded']++;
}
// Cache object handle
if ($this->attributes['guid']) {
cache_entity($this);
}
return true;
}
return false;
}
/**
* Disable this entity.
*
* @param string $reason Optional reason
* @param bool $recursive Recursively disable all contained entities?
*/
public function disable($reason = "", $recursive = true) {
return disable_entity($this->get('guid'), $reason, $recursive);
}
/**
* Re-enable this entity.
*/
public function enable() {
return enable_entity($this->get('guid'));
}
/**
* Is this entity enabled?
*
* @return boolean
*/
public function isEnabled() {
if ($this->enabled == 'yes') {
return true;
}
return false;
}
/**
* Delete this entity.
*/
public function delete() {
return delete_entity($this->get('guid'));
}
// LOCATABLE INTERFACE /////////////////////////////////////////////////////////////
/** Interface to set the location */
public function setLocation($location) {
$location = sanitise_string($location);
$this->location = $location;
return true;
}
/**
* Set latitude and longitude tags for a given entity.
*
* @param float $lat
* @param float $long
*/
public function setLatLong($lat, $long) {
$lat = sanitise_string($lat);
$long = sanitise_string($long);
$this->set('geo:lat', $lat);
$this->set('geo:long', $long);
return true;
}
/**
* Get the contents of the ->geo:lat field.
*
*/
public function getLatitude() {
return $this->get('geo:lat');
}
/**
* Get the contents of the ->geo:lat field.
*
*/
public function getLongitude() {
return $this->get('geo:long');
}
/**
* Get the ->location metadata.
*
*/
public function getLocation() {
return $this->get('location');
}
// NOTABLE INTERFACE ///////////////////////////////////////////////////////////////
/**
* Calendar functionality.
* This function sets the time of an object on a calendar listing.
*
* @param int $hour If ommitted, now is assumed.
* @param int $minute If ommitted, now is assumed.
* @param int $second If ommitted, now is assumed.
* @param int $day If ommitted, now is assumed.
* @param int $month If ommitted, now is assumed.
* @param int $year If ommitted, now is assumed.
* @param int $duration Duration of event, remainder of the day is assumed.
*/
public function setCalendarTimeAndDuration($hour = NULL, $minute = NULL, $second = NULL, $day = NULL, $month = NULL, $year = NULL, $duration = NULL) {
$start = mktime($hour, $minute, $second, $month, $day, $year);
$end = $start + abs($duration);
if (!$duration) {
$end = get_day_end($day,$month,$year);
}
$this->calendar_start = $start;
$this->calendar_end = $end;
return true;
}
/**
* Return the start timestamp.
*/
public function getCalendarStartTime() {
return (int)$this->calendar_start;
}
/**
* Return the end timestamp.
*/
public function getCalendarEndTime() {
return (int)$this->calendar_end;
}
// EXPORTABLE INTERFACE ////////////////////////////////////////////////////////////
/**
* Return an array of fields which can be exported.
*/
public function getExportableValues() {
return array(
'guid',
'type',
'subtype',
'time_created',
'container_guid',
'owner_guid',
);
}
/**
* Export this class into an array of ODD Elements containing all necessary fields.
* Override if you wish to return more information than can be found in $this->attributes (shouldn't happen)
*/
public function export() {
$tmp = array();
// Generate uuid
$uuid = guid_to_uuid($this->getGUID());
// Create entity
$odd = new ODDEntity(
$uuid,
$this->attributes['type'],
get_subtype_from_id($this->attributes['subtype'])
);
$tmp[] = $odd;
$exportable_values = $this->getExportableValues();
// Now add its attributes
foreach ($this->attributes as $k => $v) {
$meta = NULL;
if (in_array( $k, $exportable_values)) {
switch ($k) {
case 'guid' : // Dont use guid in OpenDD
case 'type' : // Type and subtype already taken care of
case 'subtype' :
break;
case 'time_created' : // Created = published
$odd->setAttribute('published', date("r", $v));
break;
case 'site_guid' : // Container
$k = 'site_uuid';
$v = guid_to_uuid($v);
$meta = new ODDMetaData($uuid . "attr/$k/", $uuid, $k, $v);
break;
case 'container_guid' : // Container
$k = 'container_uuid';
$v = guid_to_uuid($v);
$meta = new ODDMetaData($uuid . "attr/$k/", $uuid, $k, $v);
break;
case 'owner_guid' : // Convert owner guid to uuid, this will be stored in metadata
$k = 'owner_uuid';
$v = guid_to_uuid($v);
$meta = new ODDMetaData($uuid . "attr/$k/", $uuid, $k, $v);
break;
default :
$meta = new ODDMetaData($uuid . "attr/$k/", $uuid, $k, $v);
}
// set the time of any metadata created
if ($meta) {
$meta->setAttribute('published', date("r",$this->time_created));
$tmp[] = $meta;
}
}
}
// Now we do something a bit special.
/*
* This provides a rendered view of the entity to foreign sites.
*/
elgg_set_viewtype('default');
$view = elgg_view_entity($this, true);
elgg_set_viewtype();
$tmp[] = new ODDMetaData($uuid . "volatile/renderedentity/", $uuid, 'renderedentity', $view , 'volatile');
return $tmp;
}
// IMPORTABLE INTERFACE ////////////////////////////////////////////////////////////
/**
* Import data from an parsed xml data array.
*
* @param array $data
* @param int $version
*/
public function import(ODD $data) {
if (!($data instanceof ODDEntity)) {
throw new InvalidParameterException(elgg_echo('InvalidParameterException:UnexpectedODDClass'));
}
// Set type and subtype
$this->attributes['type'] = $data->getAttribute('class');
$this->attributes['subtype'] = $data->getAttribute('subclass');
// Set owner
$this->attributes['owner_guid'] = get_loggedin_userid(); // Import as belonging to importer.
// Set time
$this->attributes['time_created'] = strtotime($data->getAttribute('published'));
$this->attributes['time_updated'] = time();
return true;
}
// SYSTEM LOG INTERFACE ////////////////////////////////////////////////////////////
/**
* Return an identification for the object for storage in the system log.
* This id must be an integer.
*
* @return int
*/
public function getSystemLogID() {
return $this->getGUID();
}
/**
* Return the class name of the object.
*/
public function getClassName() {
return get_class($this);
}
/**
* For a given ID, return the object associated with it.
* This is used by the river functionality primarily.
* This is useful for checking access permissions etc on objects.
*/
public function getObjectFromID($id) {
return get_entity($id);
}
/**
* Return the GUID of the owner of this object.
*/
public function getObjectOwnerGUID() {
return $this->owner_guid;
}
// ITERATOR INTERFACE //////////////////////////////////////////////////////////////
/*
* This lets an entity's attributes be displayed using foreach as a normal array.
* Example: http://www.sitepoint.com/print/php5-standard-library
*/
private $valid = FALSE;
function rewind() {
$this->valid = (FALSE !== reset($this->attributes));
}
function current() {
return current($this->attributes);
}
function key() {
return key($this->attributes);
}
function next() {
$this->valid = (FALSE !== next($this->attributes));
}
function valid() {
return $this->valid;
}
// ARRAY ACCESS INTERFACE //////////////////////////////////////////////////////////
/*
* This lets an entity's attributes be accessed like an associative array.
* Example: http://www.sitepoint.com/print/php5-standard-library
*/
function offsetSet($key, $value) {
if ( array_key_exists($key, $this->attributes) ) {
$this->attributes[$key] = $value;
}
}
function offsetGet($key) {
if ( array_key_exists($key, $this->attributes) ) {
return $this->attributes[$key];
}
}
function offsetUnset($key) {
if ( array_key_exists($key, $this->attributes) ) {
$this->attributes[$key] = ""; // Full unsetting is dangerious for our objects
}
}
function offsetExists($offset) {
return array_key_exists($offset, $this->attributes);
}
}
/**
* Initialise the entity cache.
*/
function initialise_entity_cache() {
global $ENTITY_CACHE;
if (!$ENTITY_CACHE) {
//select_default_memcache('entity_cache'); // TODO: Replace with memcache?
$ENTITY_CACHE = array();
}
}
/**
* Invalidate this class' entry in the cache.
*
* @param int $guid The guid
*/
function invalidate_cache_for_entity($guid) {
global $ENTITY_CACHE;
$guid = (int)$guid;
unset($ENTITY_CACHE[$guid]);
//$ENTITY_CACHE->delete($guid);
}
/**
* Cache an entity.
*
* @param ElggEntity $entity Entity to cache
*/
function cache_entity(ElggEntity $entity) {
global $ENTITY_CACHE;
$ENTITY_CACHE[$entity->guid] = $entity;
}
/**
* Retrieve a entity from the cache.
*
* @param int $guid The guid
*/
function retrieve_cached_entity($guid) {
global $ENTITY_CACHE;
$guid = (int)$guid;
if (isset($ENTITY_CACHE[$guid])) {
if ($ENTITY_CACHE[$guid]->isFullyLoaded()) {
return $ENTITY_CACHE[$guid];
}
}
return false;
}
/**
* As retrieve_cached_entity, but returns the result as a stdClass (compatible with load functions that
* expect a database row.)
*
* @param int $guid The guid
*/
function retrieve_cached_entity_row($guid) {
$obj = retrieve_cached_entity($guid);
if ($obj) {
$tmp = new stdClass;
foreach ($obj as $k => $v) {
$tmp->$k = $v;
}
return $tmp;
}
return false;
}
/**
* Return the integer ID for a given subtype, or false.
*
* TODO: Move to a nicer place?
*
* @param string $type
* @param string $subtype
*/
function get_subtype_id($type, $subtype) {
global $CONFIG, $SUBTYPE_CACHE;
$type = sanitise_string($type);
$subtype = sanitise_string($subtype);
if ($subtype=="") {
//return $subtype;
return FALSE;
}
// Todo: cache here? Or is looping less efficient that going to the db each time?
$result = get_data_row("SELECT * from {$CONFIG->dbprefix}entity_subtypes
where type='$type' and subtype='$subtype'");
if ($result) {
if (!$SUBTYPE_CACHE) {
//select_default_memcache('subtype_cache');
$SUBTYPE_CACHE = array();
}
$SUBTYPE_CACHE[$result->id] = $result;
return $result->id;
}
return FALSE;
}
/**
* For a given subtype ID, return its identifier text.
*
* TODO: Move to a nicer place?
*
* @param int $subtype_id
*/
function get_subtype_from_id($subtype_id) {
global $CONFIG, $SUBTYPE_CACHE;
$subtype_id = (int)$subtype_id;
if (!$subtype_id) {
return false;
}
if (isset($SUBTYPE_CACHE[$subtype_id])) {
return $SUBTYPE_CACHE[$subtype_id]->subtype;
}
$result = get_data_row("SELECT * from {$CONFIG->dbprefix}entity_subtypes where id=$subtype_id");
if ($result) {
if (!$SUBTYPE_CACHE) {
//select_default_memcache('subtype_cache');
$SUBTYPE_CACHE = array();
}
$SUBTYPE_CACHE[$subtype_id] = $result;
return $result->subtype;
}
return false;
}
/**
* This function tests to see if a subtype has a registered class handler.
*
* @param string $type The type
* @param string $subtype The subtype
* @return a class name or null
*/
function get_subtype_class($type, $subtype) {
global $CONFIG, $SUBTYPE_CACHE;
$type = sanitise_string($type);
$subtype = sanitise_string($subtype);
// Todo: cache here? Or is looping less efficient that going to the db each time?
$result = get_data_row("SELECT * from {$CONFIG->dbprefix}entity_subtypes
where type='$type' and subtype='$subtype'");
if ($result) {
if (!$SUBTYPE_CACHE) {
//select_default_memcache('subtype_cache');
$SUBTYPE_CACHE = array();
}
$SUBTYPE_CACHE[$result->id] = $result;
return $result->class;
}
return NULL;
}
/**
* This function tests to see if a subtype has a registered class handler by its id.
*
* @param int $subtype_id The subtype
* @return a class name or null
*/
function get_subtype_class_from_id($subtype_id) {
global $CONFIG, $SUBTYPE_CACHE;
$subtype_id = (int)$subtype_id;
if (!$subtype_id) {
return false;
}
if (isset($SUBTYPE_CACHE[$subtype_id])) {
return $SUBTYPE_CACHE[$subtype_id]->class;
}
$result = get_data_row("SELECT * from {$CONFIG->dbprefix}entity_subtypes where id=$subtype_id");
if ($result) {
if (!$SUBTYPE_CACHE) {
//select_default_memcache('subtype_cache');
$SUBTYPE_CACHE = array();
}
$SUBTYPE_CACHE[$subtype_id] = $result;
return $result->class;
}
return NULL;
}
/**
* This function will register a new subtype, returning its ID as required.
*
* @param string $type The type you're subtyping
* @param string $subtype The subtype label
* @param string $class Optional class handler (if you don't want it handled by the generic elgg handler for the type)
*/
function add_subtype($type, $subtype, $class = "") {
global $CONFIG;
$type = sanitise_string($type);
$subtype = sanitise_string($subtype);
$class = sanitise_string($class);
// Short circuit if no subtype is given
if ($subtype == "") {
return 0;
}
$id = get_subtype_id($type, $subtype);
if ($id==0) {
return insert_data("insert into {$CONFIG->dbprefix}entity_subtypes (type, subtype, class) values ('$type','$subtype','$class')");
}
return $id;
}
/**
* Update an existing entity.
*
* @param int $guid
* @param int $owner_guid
* @param int $access_id
* @param int $container_guid
*/
function update_entity($guid, $owner_guid, $access_id, $container_guid = null) {
global $CONFIG, $ENTITY_CACHE;
$guid = (int)$guid;
$owner_guid = (int)$owner_guid;
$access_id = (int)$access_id;
$container_guid = (int) $container_guid;
if (is_null($container_guid)) {
$container_guid = $owner_guid;
}
$time = time();
$entity = get_entity($guid);
if ($entity->canEdit()) {
if (trigger_elgg_event('update',$entity->type,$entity)) {
$ret = update_data("UPDATE {$CONFIG->dbprefix}entities set owner_guid='$owner_guid', access_id='$access_id', container_guid='$container_guid', time_updated='$time' WHERE guid=$guid");
if ($entity instanceof ElggObject) {
update_river_access_by_object($guid,$access_id);
}
// If memcache is available then delete this entry from the cache
static $newentity_cache;
if ((!$newentity_cache) && (is_memcache_available())) {
$newentity_cache = new ElggMemcache('new_entity_cache');
}
if ($newentity_cache) {
$new_entity = $newentity_cache->delete($guid);
}
// Handle cases where there was no error BUT no rows were updated!
if ($ret===false) {
return false;
}
return true;
}
}
}
/**
* Determine whether a given user is able to write to a given container.
*
* @param int $user_guid The user guid, or 0 for get_loggedin_userid()
* @param int $container_guid The container, or 0 for the current page owner.
*/
function can_write_to_container($user_guid = 0, $container_guid = 0, $entity_type = 'all') {
global $CONFIG;
$user_guid = (int)$user_guid;
$user = get_entity($user_guid);
if (!$user) {
$user = get_loggedin_user();
}
$container_guid = (int)$container_guid;
if (!$container_guid) {
$container_guid = page_owner();
}
if (!$container_guid) {
return true;
}
$container = get_entity($container_guid);
if ($container) {
// If the user can edit the container, they can also write to it
if ($container->canEdit($user_guid)) {
return true;
}
// Basics, see if the user is a member of the group.
if ($user && $container instanceof ElggGroup) {
if (!$container->isMember($user)) {
return false;
} else {
return true;
}
}
// See if anyone else has anything to say
return trigger_plugin_hook('container_permissions_check', $entity_type,
array('container' => $container, 'user' => $user), false);
}
return false;
}
/**
* Create a new entity of a given type.
*
* @param string $type The type of the entity (site, user, object).
* @param string $subtype The subtype of the entity.
* @param int $owner_guid The GUID of the object's owner.
* @param int $access_id The access control group to create the entity with.
* @param int $site_guid The site to add this entity to. Leave as 0 (default) for the current site.
* @return mixed The new entity's GUID, or false on failure
*/
function create_entity($type, $subtype, $owner_guid, $access_id, $site_guid = 0, $container_guid = 0) {
global $CONFIG;
$type = sanitise_string($type);
$subtype = add_subtype($type, $subtype);
$owner_guid = (int)$owner_guid;
$access_id = (int)$access_id;
$time = time();
if ($site_guid == 0) {
$site_guid = $CONFIG->site_guid;
}
$site_guid = (int) $site_guid;
if ($container_guid == 0) {
$container_guid = $owner_guid;
}
$user = get_loggedin_user();
if (!can_write_to_container($user->guid, $owner_guid, $type)) {
return false;
}
if ($owner_guid != $container_guid) {
if (!can_write_to_container($user->guid, $container_guid, $type)) {
return false;
}
}
if ($type=="") {
throw new InvalidParameterException(elgg_echo('InvalidParameterException:EntityTypeNotSet'));
}
return insert_data("INSERT into {$CONFIG->dbprefix}entities
(type, subtype, owner_guid, site_guid, container_guid, access_id, time_created, time_updated) values
('$type',$subtype, $owner_guid, $site_guid, $container_guid, $access_id, $time, $time)");
}
/**
* Retrieve the entity details for a specific GUID, returning it as a stdClass db row.
*
* You will only get an object if a) it exists, b) you have access to it.
*
* @param int $guid The GUID of the object to extract
*/
function get_entity_as_row($guid) {
global $CONFIG;
if (!$guid) {
return false;
}
$guid = (int) $guid;
$access = get_access_sql_suffix();
return get_data_row("SELECT * from {$CONFIG->dbprefix}entities where guid=$guid and $access");
}
/**
* Create an Elgg* object from a given entity row.
*/
function entity_row_to_elggstar($row) {
if (!($row instanceof stdClass)) {
return $row;
}
if ((!isset($row->guid)) || (!isset($row->subtype))) {
return $row;
}
$new_entity = false;
// Create a memcache cache if we can
static $newentity_cache;
if ((!$newentity_cache) && (is_memcache_available())) {
$newentity_cache = new ElggMemcache('new_entity_cache');
}
if ($newentity_cache) {
$new_entity = $newentity_cache->load($row->guid);
}
if ($new_entity) {
return $new_entity;
}
$classname = get_subtype_class_from_id($row->subtype);
if ($classname!="") {
if (class_exists($classname)) {
$new_entity = new $classname($row);
if (!($new_entity instanceof ElggEntity)) {
throw new ClassException(sprintf(elgg_echo('ClassException:ClassnameNotClass'), $classname, 'ElggEntity'));
}
}
else {
error_log(sprintf(elgg_echo('ClassNotFoundException:MissingClass'), $classname));
}
}
else {
switch ($row->type) {
case 'object' :
$new_entity = new ElggObject($row); break;
case 'user' :
$new_entity = new ElggUser($row); break;
case 'group' :
$new_entity = new ElggGroup($row); break;
case 'site' :
$new_entity = new ElggSite($row); break;
default:
throw new InstallationException(sprintf(elgg_echo('InstallationException:TypeNotSupported'), $row->type));
}
}
// Cache entity if we have a cache available
if (($newentity_cache) && ($new_entity)) {
$newentity_cache->save($new_entity->guid, $new_entity);
}
return $new_entity;
}
/**
* Return the entity for a given guid as the correct object.
* @param int $guid The GUID of the entity
* @return a child of ElggEntity appropriate for the type.
*/
function get_entity($guid) {
static $newentity_cache;
$new_entity = false;
if ((!$newentity_cache) && (is_memcache_available())) {
$newentity_cache = new ElggMemcache('new_entity_cache');
}
if ($newentity_cache) {
$new_entity = $newentity_cache->load($guid);
}
if ($new_entity) {
return $new_entity;
}
return entity_row_to_elggstar(get_entity_as_row($guid));
}
/**
* Get all entities.
*
* @param array $options Array in format:
*
* types => NULL|STR entity type
*
* subtypes => NULL|STR entity subtype
*
* type_subtype_pairs => NULL|ARR (type = '$type' AND subtype = '$subtype') pairs
*
* owner_guids => NULL|INT entity guid
*
* container_guids => NULL|INT container_guid
*
* site_guids => NULL (current_site)|INT site_guid
*
* order_by => NULL (time_created desc)|STR SQL order by clause
*
* limit => NULL (10)|INT SQL limit clause
*
* offset => NULL (0)|INT SQL offset clause
*
* time_lower => NULL|INT Time lower boundary in epoch time
*
* time_upper => NULL|INT Time upper boundary in epoch time
*
* count => TRUE|FALSE return a count instead of entities
*
* wheres => array() Additional where clauses to AND together
*
* joins => array() Additional joins
*
* @return if count, int
* if not count, array or false if no entities
*/
function elgg_get_entities(array $options = array()) {
global $CONFIG;
//@todo allow use of singular types that rewrite to plural ones.
$defaults = array(
'type' => NULL,
'types' => NULL,
'subtypes' => NULL,
'subtype' => NULL,
'type_subtype_pairs' => NULL,
'owner_guids' => NULL,
'owner_guid' => NULL,
'container_guids' => NULL,
'container_guid' => NULL,
'site_guids' => $CONFIG->site_guid,
'site_guid' => NULL,
'modified_time_lower' => NULL,
'modified_time_upper' => NULL,
'created_time_lower' => NULL,
'created_time_upper' => NULL,
'order_by' => 'e.time_created desc',
'group_by' => NULL,
'limit' => 10,
'offset' => 0,
'count' => FALSE,
'selects' => array(),
'wheres' => array(),
'joins' => array()
);
$options = array_merge($defaults, $options);
$singulars = array('type', 'subtype', 'owner_guid', 'container_guid', 'site_guid');
$options = elgg_normalise_plural_options_array($options, $singulars);
// evaluate where clauses
if (!is_array($options['wheres'])) {
$options['wheres'] = array($options['wheres']);
}
$wheres = $options['wheres'];
$wheres[] = elgg_get_entity_type_subtype_where_sql('e', $options['types'], $options['subtypes'], $options['type_subtype_pairs']);
$wheres[] = elgg_get_entity_site_where_sql('e', $options['site_guids']);
$wheres[] = elgg_get_entity_owner_where_sql('e', $options['owner_guids']);
$wheres[] = elgg_get_entity_container_where_sql('e', $options['container_guids']);
$wheres[] = elgg_get_entity_time_where_sql('e', $options['created_time_upper'],
$options['created_time_lower'], $options['modified_time_upper'], $options['modified_time_lower']);
// remove identical where clauses
$wheres = array_unique($wheres);
// see if any functions failed
// remove empty strings on successful functions
foreach ($wheres as $i => $where) {
if ($where === FALSE) {
return FALSE;
} elseif (empty($where)) {
unset($wheres[$i]);
}
}
// evaluate join clauses
if (!is_array($options['joins'])) {
$options['joins'] = array($options['joins']);
}
// remove identical join clauses
$joins = array_unique($options['joins']);
foreach ($joins as $i => $join) {
if ($join === FALSE) {
return FALSE;
} elseif (empty($join)) {
unset($joins[$i]);
}
}
// evalutate selects
if ($options['selects']) {
$selects = '';
foreach ($options['selects'] as $select) {
$selects = ", $select";
}
} else {
$selects = '';
}
if (!$options['count']) {
$query = "SELECT DISTINCT e.*{$selects} FROM {$CONFIG->dbprefix}entities e ";
} else {
$query = "SELECT count(DISTINCT e.guid) as total FROM {$CONFIG->dbprefix}entities e ";
}
// add joins
foreach ($joins as $j) {
$query .= " $j ";
}
// add wheres
$query .= ' WHERE ';
foreach ($wheres as $w) {
$query .= " $w AND ";
}
// Add access controls
$query .= get_access_sql_suffix('e');
if (!$options['count']) {
if ($options['group_by'] = sanitise_string($options['group_by'])) {
$query .= " GROUP BY {$options['group_by']}";
}
if ($options['order_by'] = sanitise_string($options['order_by'])) {
$query .= " ORDER BY {$options['order_by']}";
}
if ($options['limit']) {
$limit = sanitise_int($options['limit']);
$offset = sanitise_int($options['offset']);
$query .= " LIMIT $offset, $limit";
}
$dt = get_data($query, "entity_row_to_elggstar");
//@todo normalize this to array()
return $dt;
} else {
$total = get_data_row($query);
return (int)$total->total;
}
}
/**
* @deprecated 1.7. Use elgg_get_entities().
* @param $type
* @param $subtype
* @param $owner_guid
* @param $order_by
* @param $limit
* @param $offset
* @param $count
* @param $site_guid
* @param $container_guid
* @param $timelower
* @param $timeupper
* @return unknown_type
*/
function get_entities($type = "", $subtype = "", $owner_guid = 0, $order_by = "", $limit = 10, $offset = 0,
$count = false, $site_guid = 0, $container_guid = null, $timelower = 0, $timeupper = 0) {
elgg_log('get_entities() was deprecated in 1.7 by elgg_get_entities()!', 'WARNING');
// rewrite owner_guid to container_guid to emulate old functionality
$container_guid = $owner_guid;
$owner_guid = NULL;
$options = array();
if ($type) {
if (is_array($type)) {
$options['types'] = $type;
} else {
$options['type'] = $type;
}
}
if ($subtype) {
if (is_array($subtype)) {
$options['subtypes'] = $subtype;
} else {
$options['subtype'] = $subtype;
}
}
if ($owner_guid) {
if (is_array($owner_guid)) {
$options['owner_guids'] = $owner_guid;
} else {
$options['owner_guid'] = $owner_guid;
}
}
if ($order_by) {
$options['order_by'] = $order_by;
}
if ($limit) {
$options['limit'] = $limit;
}
if ($offset) {
$options['offset'] = $offset;
}
if ($count) {
$options['count'] = $count;
}
if ($site_guid) {
$options['site_guids'] = $site_guid;
}
if ($container_guid) {
$options['container_guids'] = $container_guid;
}
if ($timeupper) {
$options['time_upper'] = $timeupper;
}
if ($timelower) {
$options['time_lower'] = $timelower;
}
$r = elgg_get_entities($options);
return $r;
}
/**
* Returns type and subtype SQL appropriate for inclusion in an IN clause.
*
* @param string $table entity table prefix.
* @param NULL|$types
* @param NULL|array $subtypes
* @param NULL|array $pairs
* @return FALSE|string
*/
function elgg_get_entity_type_subtype_where_sql($table, $types, $subtypes, $pairs) {
// subtype depends upon type.
if ($subtypes && !$types) {
elgg_log("Cannot set subtypes without type.", 'WARNING');
return FALSE;
}
// short circuit if nothing is requested
if (!$types && !$subtypes && !$pairs) {
return '';
}
// these are the only valid types for entities in elgg as defined in the DB.
$valid_types = array('object', 'user', 'group', 'site');
// pairs override
$wheres = array();
if (!is_array($pairs)) {
if (!is_array($types)) {
$types = array($types);
}
if ($subtypes && !is_array($subtypes)) {
$subtypes = array($subtypes);
}
// subtypes are based upon types, so we need to look at each
// type individually to get the right subtype id.
foreach ($types as $type) {
if (!in_array($type, $valid_types)) {
return FALSE;
}
$subtype_ids = array();
if ($subtypes) {
// if there is only one subtype and it is is not 0 and it invalid return false.
// if the type is 0 or null, let it through.
// if the type is set but the subtype is FALSE, return false.
if (count($subtypes) === 1) {
if ($subtypes[0] && !get_subtype_id($type, $subtypes[0])) {
return FALSE;
}
}
// subtypes can be NULL or '' or 0, which means "no subtype"
foreach ($subtypes as $subtype) {
// if a subtype is sent that doesn't exist
if (0 === $subtype || $subtype_id = get_subtype_id($type, $subtype)) {
$subtype_ids[] = (0 === $subtype) ? 0 : $subtype_id;
} else {
// @todo should return false.
//return FALSE;
elgg_log("Type-subtype $type:$subtype' does not exist!", 'WARNING');
continue;
}
}
}
}
//if ($subtype_ids_str = implode(',', $subtype_ids)) {
if (is_array($subtype_ids) && count($subtype_ids)) {
$subtype_ids_str = implode(',', $subtype_ids);
$wheres[] = "({$table}.type = '$type' AND {$table}.subtype IN ($subtype_ids_str))";
} else {
$wheres[] = "({$table}.type = '$type')";
}
} else {
// using type/subtype pairs
foreach ($pairs as $paired_type => $paired_subtypes) {
if ($paired_subtypes && !is_array($paired_subtypes)) {
$paired_subtypes = array($paired_subtypes);
}
if (is_array($paired_subtypes) && count($paired_subtypes)) {
$paired_subtype_ids = array();
foreach ($paired_subtypes as $paired_subtype) {
if ($paired_subtype && ($paired_subtype_id = get_subtype_id($paired_type, $paired_subtype))) {
$paired_subtype_ids[] = $paired_subtype_id;
} else {
// @todo should return false.
//return FALSE;
elgg_log("Paired type-subtype $paired_type:$paired_subtype' does not exist!", 'WARNING');
continue;
}
}
if ($paired_subtype_ids_str = implode(',', $paired_subtype_ids)) {
$wheres[] = "({$table}.type = '$paired_type' AND {$table}.subtype IN ($paired_subtype_ids_str))";
}
} else {
$wheres[] = "({$table}.type = '$paired_type')";
}
}
}
// pairs override the above. return false if they don't exist.
if (is_array($wheres) && count($wheres)) {
$where = implode(' OR ', $wheres);
return "($where)";
}
return '';
}
/**
* Returns SQL for owner and containers.
*
* @todo Probably DRY up once things are settled.
* @param str $table
* @param NULL|array $owner_guids
* @return FALSE|str
*/
function elgg_get_entity_owner_where_sql($table, $owner_guids) {
// short circuit if nothing requested
// 0 is a valid owner_guid.
if (!$owner_guids && $owner_guids !== 0) {
return '';
}
// normalize and sanitise owners
if (!is_array($owner_guids)) {
$owner_guids = array($owner_guids);
}
$owner_guids_sanitised = array();
foreach ($owner_guids as $owner_guid) {
if (($owner_guid != sanitise_int($owner_guid))) {
return FALSE;
}
$owner_guids_sanitised[] = $owner_guid;
}
$where = '';
// implode(',', 0) returns 0.
if (($owner_str = implode(',', $owner_guids_sanitised)) && ($owner_str !== FALSE) && ($owner_str !== '')) {
$where = "({$table}.owner_guid IN ($owner_str))";
}
return $where;
}
/**
* Returns SQL for containers.
*
* @param string $table entity table prefix
* @param NULL|array $container_guids
* @return FALSE|string
*/
function elgg_get_entity_container_where_sql($table, $container_guids) {
// short circuit if nothing is requested.
// 0 is a valid container_guid.
if (!$container_guids && $container_guids !== 0) {
return '';
}
// normalize and sanitise containers
if (!is_array($container_guids)) {
$container_guids = array($container_guids);
}
$container_guids_sanitised = array();
foreach ($container_guids as $container_guid) {
if (($container_guid != sanitise_int($container_guid))) {
return FALSE;
}
$container_guids_sanitised[] = $container_guid;
}
$where = '';
// implode(',', 0) returns 0.
if (FALSE !== $container_str = implode(',', $container_guids_sanitised)) {
$where = "({$table}.container_guid IN ($container_str))";
}
return $where;
}
/**
* Returns SQL where clause for entity time limits.
*
* @param string $table Prefix for entity table name.
* @param NULL|int $time_created_upper
* @param NULL|int $time_created_lower
* @param NULL|int $time_updated_upper
* @param NULL|int $time_updated_lower
*
* @return FALSE|str FALSE on fail, string on success.
*/
function elgg_get_entity_time_where_sql($table, $time_created_upper = NULL, $time_created_lower = NULL,
$time_updated_upper = NULL, $time_updated_lower = NULL) {
$wheres = array();
// exploit PHP's loose typing (quack) to check that they are INTs and not str cast to 0
if ($time_created_upper && $time_created_upper == sanitise_int($time_created_upper)) {
$wheres[] = "{$table}.time_created <= $time_created_upper";
}
if ($time_created_lower && $time_created_lower == sanitise_int($time_created_lower)) {
$wheres[] = "{$table}.time_created >= $time_created_lower";
}
if ($time_updated_upper && $time_updated_upper == sanitise_int($time_updated_upper)) {
$wheres[] = "{$table}.time_updated <= $time_updated_upper";
}
if ($time_updated_lower && $time_updated_lower == sanitise_int($time_updated_lower)) {
$wheres[] = "{$table}.time_updated >= $time_updated_lower";
}
if (is_array($wheres) && count($wheres) > 0) {
$where_str = implode(' AND ', $wheres);
return "($where_str)";
}
return '';
}
/**
* Gets SQL for site entities
*
* @param string $table entity table name
* @param NULL|array $site_guids
* @return FALSE|string
*/
function elgg_get_entity_site_where_sql($table, $site_guids) {
// short circuit if nothing requested
if (!$site_guids) {
return '';
}
if (!is_array($site_guids)) {
$site_guids = array($site_guids);
}
$site_guids_sanitised = array();
foreach ($site_guids as $site_guid) {
if (!$site_guid || ($site_guid != sanitise_int($site_guid))) {
return FALSE;
}
$site_guids_sanitised[] = $site_guid;
}
if ($site_guids_str = implode(',', $site_guids_sanitised)) {
return "({$table}.site_guid IN ($site_guids_str))";
}
return '';
}
/**
* Returns a viewable list of entities
*
* @see elgg_view_entity_list
*
* @param array $options Any elgg_get_entity() options plus:
*
* full_view => BOOL Display full view entities
*
* view_type_toggle => BOOL Display gallery / list switch
*
* pagination => BOOL Display pagination links
*
* @return str
*/
function elgg_list_entities($options) {
$defaults = array(
'offset' => 0,
'limit' => 10,
'full_view' => TRUE,
'view_type_toggle' => FALSE,
'pagination' => TRUE
);
$options = array_merge($defaults, $options);
$count = elgg_get_entities(array_merge(array('count' => TRUE), $options));
$entities = elgg_get_entities($options);
return elgg_view_entity_list($entities, $count, $options['offset'],
$options['limit'], $options['full_view'], $options['view_type_toggle'], $options['pagination']);
}
/**
* @deprecated 1.7. Use elgg_list_entities().
* @param $type
* @param $subtype
* @param $owner_guid
* @param $limit
* @param $fullview
* @param $viewtypetoggle
* @param $pagination
* @return unknown_type
*/
function list_entities($type= "", $subtype = "", $owner_guid = 0, $limit = 10, $fullview = true, $viewtypetoggle = false, $pagination = true) {
elgg_log('list_entities() was deprecated in 1.7. Use elgg_list_entities()!', 'WARNING');
$options = array();
// rewrite owner_guid to container_guid to emulate old functionality
if ($owner_guid) {
$options['container_guids'] = $owner_guid;
}
if ($type) {
$options['types'] = $type;
}
if ($subtype) {
$options['subtypes'] = $subtype;
}
if ($limit) {
$options['limit'] = $limit;
}
if ($offset = sanitise_int(get_input('offset', null))) {
$options['offset'] = $offset;
}
$options['full_view'] = $fullview;
$options['view_toggle_type'] = $viewtypetoggle;
$options['pagination'] = $pagination;
return elgg_list_entities($options);
}
/**
* Returns a viewable list of entities contained in a number of groups.
*
* @param string $subtype The arbitrary subtype of the entity
* @param int $owner_guid The GUID of the owning user
* @param int $container_guid The GUID of the containing group
* @param int $limit The number of entities to display per page (default: 10)
* @param true|false $fullview Whether or not to display the full view (default: true)
* @param true|false $viewtypetoggle Whether or not to allow gallery view (default: true)
* @param true|false $pagination Whether to display pagination (default: true)
* @return string A viewable list of entities
*/
function list_entities_groups($subtype = "", $owner_guid = 0, $container_guid = 0, $limit = 10, $fullview = true, $viewtypetoggle = true, $pagination = true) {
$offset = (int) get_input('offset');
$count = get_objects_in_group($container_guid, $subtype, $owner_guid, 0, "", $limit, $offset, true);
$entities = get_objects_in_group($container_guid, $subtype, $owner_guid, 0, "", $limit, $offset);
return elgg_view_entity_list($entities, $count, $offset, $limit, $fullview, $viewtypetoggle, $pagination);
}
/**
* Returns a list of months containing content specified by the parameters
*
* @param string $type The type of entity
* @param string $subtype The subtype of entity
* @param int $container_guid The container GUID that the entinties belong to
* @param int $site_guid The site GUID
* @return array|false Either an array of timestamps, or false on failure
*/
function get_entity_dates($type = '', $subtype = '', $container_guid = 0, $site_guid = 0) {
global $CONFIG;
$site_guid = (int) $site_guid;
if ($site_guid == 0) {
$site_guid = $CONFIG->site_guid;
}
$where = array();
if ($type != "") {
$type = sanitise_string($type);
$where[] = "type='$type'";
}
if (is_array($subtype)) {
$tempwhere = "";
if (sizeof($subtype)) {
foreach($subtype as $typekey => $subtypearray) {
foreach($subtypearray as $subtypeval) {
$typekey = sanitise_string($typekey);
if (!empty($subtypeval)) {
if (!$subtypeval = (int) get_subtype_id($typekey, $subtypeval))
return false;
} else {
$subtypeval = 0;
}
if (!empty($tempwhere)) $tempwhere .= " or ";
$tempwhere .= "(type = '{$typekey}' and subtype = {$subtypeval})";
}
}
}
if (!empty($tempwhere)) {
$where[] = "({$tempwhere})";
}
} else {
if ($subtype AND !$subtype = get_subtype_id($type, $subtype)) {
return false;
} else {
$where[] = "subtype=$subtype";
}
}
if ($container_guid !== 0) {
if (is_array($container_guid)) {
foreach($container_guid as $key => $val) {
$container_guid[$key] = (int) $val;
}
$where[] = "container_guid in (" . implode(",",$container_guid) . ")";
} else {
$container_guid = (int) $container_guid;
$where[] = "container_guid = {$container_guid}";
}
}
if ($site_guid > 0) {
$where[] = "site_guid = {$site_guid}";
}
$where[] = get_access_sql_suffix();
$sql = "SELECT DISTINCT EXTRACT(YEAR_MONTH FROM FROM_UNIXTIME(time_created)) AS yearmonth
FROM {$CONFIG->dbprefix}entities where ";
foreach ($where as $w) {
$sql .= " $w and ";
}
$sql .= "1=1";
if ($result = get_data($sql)) {
$endresult = array();
foreach($result as $res) {
$endresult[] = $res->yearmonth;
}
return $endresult;
}
return false;
}
/**
* Disable an entity but not delete it.
*
* @param int $guid The guid
* @param string $reason Optional reason
*/
function disable_entity($guid, $reason = "", $recursive = true) {
global $CONFIG;
$guid = (int)$guid;
$reason = sanitise_string($reason);
if ($entity = get_entity($guid)) {
if (trigger_elgg_event('disable',$entity->type,$entity)) {
if ($entity->canEdit()) {
if ($reason) {
create_metadata($guid, 'disable_reason', $reason,'', 0, ACCESS_PUBLIC);
}
if ($recursive) {
// Temporary token overriding access controls TODO: Do this better.
static $__RECURSIVE_DELETE_TOKEN;
// Make it slightly harder to guess
$__RECURSIVE_DELETE_TOKEN = md5(get_loggedin_userid());
$sub_entities = get_data("SELECT * from {$CONFIG->dbprefix}entities
WHERE container_guid=$guid
or owner_guid=$guid
or site_guid=$guid", 'entity_row_to_elggstar');
if ($sub_entities) {
foreach ($sub_entities as $e) {
$e->disable($reason);
}
}
$__RECURSIVE_DELETE_TOKEN = null;
}
$res = update_data("UPDATE {$CONFIG->dbprefix}entities
set enabled='no'
where guid={$guid}");
return $res;
}
}
}
return false;
}
/**
* Enable an entity again.
*
* @param int $guid
*/
function enable_entity($guid) {
global $CONFIG;
$guid = (int)$guid;
// Override access only visible entities
$access_status = access_get_show_hidden_status();
access_show_hidden_entities(true);
if ($entity = get_entity($guid)) {
if (trigger_elgg_event('enable',$entity->type,$entity)) {
if ($entity->canEdit()) {
access_show_hidden_entities($access_status);
$result = update_data("UPDATE {$CONFIG->dbprefix}entities
set enabled='yes'
where guid={$guid}");
$entity->clearMetaData('disable_reason');
return $result;
}
}
}
access_show_hidden_entities($access_status);
return false;
}
/**
* Delete a given entity.
*
* @param int $guid
* @param bool $recursive If true (default) then all entities which are owned or contained by $guid will also be deleted.
* Note: this bypasses ownership of sub items.
*/
function delete_entity($guid, $recursive = true) {
global $CONFIG, $ENTITY_CACHE;
$guid = (int)$guid;
if ($entity = get_entity($guid)) {
if (trigger_elgg_event('delete', $entity->type, $entity)) {
if ($entity->canEdit()) {
// delete cache
if (isset($ENTITY_CACHE[$guid])) {
invalidate_cache_for_entity($guid);
}
// Delete contained owned and otherwise releated objects (depth first)
if ($recursive) {
// Temporary token overriding access controls TODO: Do this better.
static $__RECURSIVE_DELETE_TOKEN;
// Make it slightly harder to guess
$__RECURSIVE_DELETE_TOKEN = md5(get_loggedin_userid());
$sub_entities = get_data("SELECT * from {$CONFIG->dbprefix}entities
WHERE container_guid=$guid
or owner_guid=$guid
or site_guid=$guid", 'entity_row_to_elggstar');
if ($sub_entities) {
foreach ($sub_entities as $e) {
$e->delete();
}
}
$__RECURSIVE_DELETE_TOKEN = null;
}
// Now delete the entity itself
$entity->clearMetadata();
$entity->clearAnnotations();
$entity->clearRelationships();
remove_from_river_by_subject($guid);
remove_from_river_by_object($guid);
remove_all_private_settings($guid);
$res = delete_data("DELETE from {$CONFIG->dbprefix}entities where guid={$guid}");
if ($res) {
$sub_table = "";
// Where appropriate delete the sub table
switch ($entity->type) {
case 'object' :
$sub_table = $CONFIG->dbprefix . 'objects_entity';
break;
case 'user' :
$sub_table = $CONFIG->dbprefix . 'users_entity';
break;
case 'group' :
$sub_table = $CONFIG->dbprefix . 'groups_entity';
break;
case 'site' :
$sub_table = $CONFIG->dbprefix . 'sites_entity';
break;
}
if ($sub_table) {
delete_data("DELETE from $sub_table where guid={$guid}");
}
}
return $res;
}
}
}
return false;
}
/**
* Delete multiple entities that match a given query.
* This function itterates through and calls delete_entity on each one, this is somewhat inefficient but lets
* the 'delete' even be called for each entity.
*
* @deprecated 1.7. This is a dangerous function as it defaults to deleting everything.
* @param string $type The type of entity (eg "user", "object" etc)
* @param string $subtype The arbitrary subtype of the entity
* @param int $owner_guid The GUID of the owning user
*/
function delete_entities($type = "", $subtype = "", $owner_guid = 0) {
elgg_log('delete_entities() was deprecated in 1.7 because no one should use it.');
return false;
}
/**
* A plugin hook to get certain volitile (generated on the fly) attributes about an entity in order to export them.
*
* @param unknown_type $hook
* @param unknown_type $entity_type
* @param unknown_type $returnvalue
* @param unknown_type $params The parameters, passed 'guid' and 'varname'
* @return unknown
*/
function volatile_data_export_plugin_hook($hook, $entity_type, $returnvalue, $params) {
$guid = (int)$params['guid'];
$variable_name = sanitise_string($params['varname']);
if (($hook == 'volatile') && ($entity_type == 'metadata')) {
if (($guid) && ($variable_name)) {
switch ($variable_name) {
case 'renderedentity' :
elgg_set_viewtype('default');
$view = elgg_view_entity(get_entity($guid));
elgg_set_viewtype();
$tmp = new ElggMetadata();
$tmp->type = 'volatile';
$tmp->name = 'renderedentity';
$tmp->value = $view;
$tmp->entity_guid = $guid;
return $tmp;
break;
}
}
}
}
/**
* Handler called by trigger_plugin_hook on the "export" event.
*/
function export_entity_plugin_hook($hook, $entity_type, $returnvalue, $params) {
// Sanity check values
if ((!is_array($params)) && (!isset($params['guid']))) {
throw new InvalidParameterException(elgg_echo('InvalidParameterException:GUIDNotForExport'));
}
if (!is_array($returnvalue)) {
throw new InvalidParameterException(elgg_echo('InvalidParameterException:NonArrayReturnValue'));
}
$guid = (int)$params['guid'];
// Get the entity
$entity = get_entity($guid);
if (!($entity instanceof ElggEntity)) {
throw new InvalidClassException(sprintf(elgg_echo('InvalidClassException:NotValidElggStar'), $guid, get_class()));
}
$export = $entity->export();
if (is_array($export)) {
foreach ($export as $e) {
$returnvalue[] = $e;
}
} else {
$returnvalue[] = $export;
}
return $returnvalue;
}
/**
* Utility function used by import_entity_plugin_hook() to process an ODDEntity into an unsaved ElggEntity.
*
* @param ODDEntity $element The OpenDD element
* @return ElggEntity the unsaved entity which should be populated by items.
*/
function oddentity_to_elggentity(ODDEntity $element) {
$class = $element->getAttribute('class');
$subclass = $element->getAttribute('subclass');
// See if we already have imported this uuid
$tmp = get_entity_from_uuid($element->getAttribute('uuid'));
if (!$tmp) {
// Construct new class with owner from session
$classname = get_subtype_class($class, $subclass);
if ($classname!="") {
if (class_exists($classname)) {
$tmp = new $classname();
if (!($tmp instanceof ElggEntity)) {
throw new ClassException(sprintf(elgg_echo('ClassException:ClassnameNotClass', $classname, get_class())));
}
}
else
error_log(sprintf(elgg_echo('ClassNotFoundException:MissingClass'), $classname));
}
else {
switch ($class) {
case 'object' :
$tmp = new ElggObject($row);
break;
case 'user' :
$tmp = new ElggUser($row);
break;
case 'group' :
$tmp = new ElggGroup($row);
break;
case 'site' :
$tmp = new ElggSite($row);
break;
default:
throw new InstallationException(sprintf(elgg_echo('InstallationException:TypeNotSupported'), $class));
}
}
}
if ($tmp) {
if (!$tmp->import($element)) {
throw new ImportException(sprintf(elgg_echo('ImportException:ImportFailed'), $element->getAttribute('uuid')));
}
return $tmp;
}
return NULL;
}
/**
* Import an entity.
* This function checks the passed XML doc (as array) to see if it is a user, if so it constructs a new
* elgg user and returns "true" to inform the importer that it's been handled.
*/
function import_entity_plugin_hook($hook, $entity_type, $returnvalue, $params) {
$element = $params['element'];
$tmp = NULL;
if ($element instanceof ODDEntity) {
$tmp = oddentity_to_elggentity($element);
if ($tmp) {
// Make sure its saved
if (!$tmp->save()) {
throw new ImportException(sprintf(elgg_echo('ImportException:ProblemSaving'), $element->getAttribute('uuid')));
}
// Belts and braces
if (!$tmp->guid) {
throw new ImportException(elgg_echo('ImportException:NoGUID'));
}
// We have saved, so now tag
add_uuid_to_guid($tmp->guid, $element->getAttribute('uuid'));
return $tmp;
}
}
}
/**
* Determines whether or not the specified user can edit the specified entity.
*
* This is extendible by registering a plugin hook taking in the parameters 'entity' and 'user',
* which are the entity and user entities respectively
*
* @see register_plugin_hook
*
* @param int $entity_guid The GUID of the entity
* @param int $user_guid The GUID of the user
* @return true|false Whether the specified user can edit the specified entity.
*/
function can_edit_entity($entity_guid, $user_guid = 0) {
global $CONFIG;
$user_guid = (int)$user_guid;
$user = get_entity($user_guid);
if (!$user) {
$user = get_loggedin_user();
}
if ($entity = get_entity($entity_guid)) {
$return = false;
// Test user if possible - should default to false unless a plugin hook says otherwise
if ($user) {
if ($entity->getOwner() == $user->getGUID()) {
$return = true;
}
if ($entity->container_guid == $user->getGUID()) {
$return = true;
}
if ($entity->type == "user" && $entity->getGUID() == $user->getGUID()) {
$return = true;
}
if ($container_entity = get_entity($entity->container_guid)) {
if ($container_entity->canEdit()) {
$return = true;
}
}
}
return trigger_plugin_hook('permissions_check', $entity->type,
array('entity' => $entity, 'user' => $user), $return);
} else {
return false;
}
}
/**
* Determines whether or not the specified user can edit metadata on the specified entity.
*
* This is extendible by registering a plugin hook taking in the parameters 'entity' and 'user',
* which are the entity and user entities respectively
*
* @see register_plugin_hook
*
* @param int $entity_guid The GUID of the entity
* @param int $user_guid The GUID of the user
* @param ElggMetadata $metadata The metadata to specifically check (if any; default null)
* @return true|false Whether the specified user can edit the specified entity.
*/
function can_edit_entity_metadata($entity_guid, $user_guid = 0, $metadata = null) {
if ($entity = get_entity($entity_guid)) {
$return = null;
if ($metadata->owner_guid == 0) {
$return = true;
}
if (is_null($return)) {
$return = can_edit_entity($entity_guid, $user_guid);
}
$user = get_entity($user_guid);
$return = trigger_plugin_hook('permissions_check:metadata',$entity->type,array('entity' => $entity, 'user' => $user, 'metadata' => $metadata),$return);
return $return;
} else {
return false;
}
}
/**
* Get the icon for an entity
*
* @param ElggEntity $entity The entity (passed an entity rather than a guid to handle non-created entities)
* @param string $size
*/
function get_entity_icon_url(ElggEntity $entity, $size = 'medium') {
global $CONFIG;
$size = sanitise_string($size);
switch (strtolower($size)) {
case 'master':
$size = 'master';
break;
case 'large' :
$size = 'large';
break;
case 'topbar' :
$size = 'topbar';
break;
case 'tiny' :
$size = 'tiny';
break;
case 'small' :
$size = 'small';
break;
case 'medium' :
default:
$size = 'medium';
}
$url = false;
$viewtype = elgg_get_viewtype();
// Step one, see if anyone knows how to render this in the current view
$url = trigger_plugin_hook('entity:icon:url', $entity->getType(), array('entity' => $entity, 'viewtype' => $viewtype, 'size' => $size), $url);
// Fail, so use default
if (!$url) {
$type = $entity->getType();
$subtype = $entity->getSubtype();
if (!empty($subtype)) {
$overrideurl = elgg_view("icon/{$type}/{$subtype}/{$size}",array('entity' => $entity));
if (!empty($overrideurl)) {
return $overrideurl;
}
}
$overrideurl = elgg_view("icon/{$type}/default/{$size}",array('entity' => $entity));
if (!empty($overrideurl)) {
return $overrideurl;
}
$url = $CONFIG->url . "_graphics/icons/default/$size.png";
}
return $url;
}
/**
* Gets the URL for an entity, given a particular GUID
*
* @param int $entity_guid The GUID of the entity
* @return string The URL of the entity
*/
function get_entity_url($entity_guid) {
global $CONFIG;
if ($entity = get_entity($entity_guid)) {
$url = "";
if (isset($CONFIG->entity_url_handler[$entity->getType()][$entity->getSubType()])) {
$function = $CONFIG->entity_url_handler[$entity->getType()][$entity->getSubType()];
if (is_callable($function)) {
$url = $function($entity);
}
} elseif (isset($CONFIG->entity_url_handler[$entity->getType()]['all'])) {
$function = $CONFIG->entity_url_handler[$entity->getType()]['all'];
if (is_callable($function)) {
$url = $function($entity);
}
} elseif (isset($CONFIG->entity_url_handler['all']['all'])) {
$function = $CONFIG->entity_url_handler['all']['all'];
if (is_callable($function)) {
$url = $function($entity);
}
}
if ($url == "") {
$url = $CONFIG->url . "pg/view/" . $entity_guid;
}
return $url;
}
return false;
}
/**
* Sets the URL handler for a particular entity type and subtype
*
* @param string $function_name The function to register
* @param string $entity_type The entity type
* @param string $entity_subtype The entity subtype
* @return true|false Depending on success
*/
function register_entity_url_handler($function_name, $entity_type = "all", $entity_subtype = "all") {
global $CONFIG;
if (!is_callable($function_name)) {
return false;
}
if (!isset($CONFIG->entity_url_handler)) {
$CONFIG->entity_url_handler = array();
}
if (!isset($CONFIG->entity_url_handler[$entity_type])) {
$CONFIG->entity_url_handler[$entity_type] = array();
}
$CONFIG->entity_url_handler[$entity_type][$entity_subtype] = $function_name;
return true;
}
/**
* Default Icon URL handler for entities.
* This will attempt to find a default entity for the current view and return a url. This is registered at
* a low priority so that other handlers will pick it up first.
*
* @param unknown_type $hook
* @param unknown_type $entity_type
* @param unknown_type $returnvalue
* @param unknown_type $params
*/
function default_entity_icon_hook($hook, $entity_type, $returnvalue, $params) {
global $CONFIG;
if ((!$returnvalue) && ($hook == 'entity:icon:url')) {
$entity = $params['entity'];
$type = $entity->type;
$subtype = get_subtype_from_id($entity->subtype);
$viewtype = $params['viewtype'];
$size = $params['size'];
$url = "views/$viewtype/graphics/icons/$type/$subtype/$size.png";
if (!@file_exists($CONFIG->path . $url)) {
$url = "views/$viewtype/graphics/icons/$type/default/$size.png";
}
if(!@file_exists($CONFIG->path . $url)) {
$url = "views/$viewtype/graphics/icons/default/$size.png";
}
if (@file_exists($CONFIG->path . $url)) {
return $CONFIG->url . $url;
}
}
}
/**
* Registers and entity type and subtype to return in search and other places.
* A description in the elgg_echo languages file of the form item:type:subtype
* is also expected.
*
* @param string $type The type of entity (object, site, user, group)
* @param string $subtype The subtype to register (may be blank)
* @return true|false Depending on success
*/
function register_entity_type($type, $subtype) {
global $CONFIG;
$type = strtolower($type);
if (!in_array($type, array('object','site','group','user'))) {
return false;
}
if (!isset($CONFIG->registered_entities)) {
$CONFIG->registered_entities = array();
}
if (!isset($CONFIG->registered_entities[$type])) {
$CONFIG->registered_entities[$type] = array();
}
if ($subtype) {
$CONFIG->registered_entities[$type][] = $subtype;
}
return true;
}
/**
* Returns registered entity types and subtypes
*
* @see register_entity_type
*
* @param string $type The type of entity (object, site, user, group) or blank for all
* @return array|false Depending on whether entities have been registered
*/
function get_registered_entity_types($type = '') {
global $CONFIG;
if (!isset($CONFIG->registered_entities)) {
return false;
}
if (!empty($type)) {
$type = strtolower($type);
}
if (!empty($type) && empty($CONFIG->registered_entities[$type])) {
return false;
}
if (empty($type)) {
return $CONFIG->registered_entities;
}
return $CONFIG->registered_entities[$type];
}
/**
* Determines whether or not the specified entity type and subtype have been registered in the system
*
* @param string $type The type of entity (object, site, user, group)
* @param string $subtype The subtype (may be blank)
* @return true|false Depending on whether or not the type has been registered
*/
function is_registered_entity_type($type, $subtype) {
global $CONFIG;
if (!isset($CONFIG->registered_entities)) {
return false;
}
$type = strtolower($type);
if (empty($CONFIG->registered_entities[$type])) {
return false;
}
if (in_array($subtype, $CONFIG->registered_entities[$type])) {
return true;
}
}
/**
* Page handler for generic entities view system
*
* @param array $page Page elements from pain page handler
*/
function entities_page_handler($page) {
if (isset($page[0])) {
global $CONFIG;
set_input('guid',$page[0]);
include($CONFIG->path . "entities/index.php");
}
}
/**
* @deprecated 1.7. Use elgg_list_registered_entities().
* @param $owner_guid
* @param $limit
* @param $fullview
* @param $viewtypetoggle
* @param $allowedtypes
* @return unknown_type
*/
function list_registered_entities($owner_guid = 0, $limit = 10, $fullview = true, $viewtypetoggle = false, $allowedtypes = true) {
elgg_log('list_registered_entities() was deprecated in 1.7 by elgg_list_registered_entities().', 'WARNING');
$options = array();
// don't want to send anything if not being used.
if ($owner_guid) {
$options['owner_guid'] = $owner_guid;
}
if ($limit) {
$options['limit'] = $limit;
}
if ($allowedtypes) {
$options['allowed_types'] = $allowedtypes;
}
// need to send because might be BOOL
$options['full_view'] = $fullview;
$options['view_type_toggle'] = $viewtypetoggle;
$options['offset'] = get_input('offset', 0);
return elgg_list_registered_entities($options);
}
/**
* Returns a viewable list of entities based on the registered types.
*
* @see elgg_view_entity_list
*
* @param array $options Any elgg_get_entity() options plus:
*
* full_view => BOOL Display full view entities
*
* view_type_toggle => BOOL Display gallery / list switch
*
* allowed_types => TRUE|ARRAY True to show all types or an array of valid types.
*
* pagination => BOOL Display pagination links
*
* @return string A viewable list of entities
*/
function elgg_list_registered_entities($options) {
$defaults = array(
'full_view' => TRUE,
'allowed_types' => TRUE,
'view_type_toggle' => FALSE,
'pagination' => TRUE,
'offset' => 0
);
$options = array_merge($defaults, $options);
$typearray = array();
if ($object_types = get_registered_entity_types()) {
foreach($object_types as $object_type => $subtype_array) {
if (in_array($object_type, $options['allowed_types']) || $options['allowed_types'] === TRUE) {
$typearray[$object_type] = array();
if (is_array($subtype_array) && count($subtype_array)) {
foreach ($subtype_array as $subtype) {
$typearray[$object_type][] = $subtype;
}
}
}
}
}
$options['type_subtype_pairs'] = $typearray;
$count = elgg_get_entities(array_merge(array('count' => TRUE), $options));
$entities = elgg_get_entities($options);
return elgg_view_entity_list($entities, $count, $options['offset'],
$options['limit'], $options['full_view'], $options['view_type_toggle'], $options['pagination']);
}
/**
* Get entities based on their private data, in a similar way to metadata.
*
* @param string $name The name of the setting
* @param string $value The value of the setting
* @param string $type The type of entity (eg "user", "object" etc)
* @param string $subtype The arbitrary subtype of the entity
* @param int $owner_guid The GUID of the owning user
* @param string $order_by The field to order by; by default, time_created desc
* @param int $limit The number of entities to return; 10 by default
* @param int $offset The indexing offset, 0 by default
* @param boolean $count Set to true to get a count rather than the entities themselves (limits and offsets don't apply in this context). Defaults to false.
* @param int $site_guid The site to get entities for. Leave as 0 (default) for the current site; -1 for all sites.
* @param int|array $container_guid The container or containers to get entities from (default: all containers).
* @return array A list of entities.
*/
function get_entities_from_private_setting($name = "", $value = "", $type = "", $subtype = "", $owner_guid = 0, $order_by = "", $limit = 10, $offset = 0, $count = false, $site_guid = 0, $container_guid = null) {
global $CONFIG;
if ($subtype === false || $subtype === null || $subtype === 0) {
return false;
}
$name = sanitise_string($name);
$value = sanitise_string($value);
if ($order_by == "") {
$order_by = "e.time_created desc";
}
$order_by = sanitise_string($order_by);
$limit = (int)$limit;
$offset = (int)$offset;
$site_guid = (int) $site_guid;
if ($site_guid == 0) {
$site_guid = $CONFIG->site_guid;
}
$where = array();
if (is_array($type)) {
$tempwhere = "";
if (sizeof($type)) {
foreach($type as $typekey => $subtypearray) {
foreach($subtypearray as $subtypeval) {
$typekey = sanitise_string($typekey);
if (!empty($subtypeval)) {
if (!$subtypeval = (int) get_subtype_id($typekey, $subtypeval)) {
return false;
}
} else {
$subtypeval = 0;
}
if (!empty($tempwhere)) $tempwhere .= " or ";
$tempwhere .= "(e.type = '{$typekey}' and e.subtype = {$subtypeval})";
}
}
}
if (!empty($tempwhere)) {
$where[] = "({$tempwhere})";
}
} else {
$type = sanitise_string($type);
if ($subtype AND !$subtype = get_subtype_id($type, $subtype)) {
return false;
}
if ($type != "") {
$where[] = "e.type='$type'";
}
if ($subtype!=="") {
$where[] = "e.subtype=$subtype";
}
}
if ($owner_guid != "") {
if (!is_array($owner_guid)) {
$owner_array = array($owner_guid);
$owner_guid = (int) $owner_guid;
// $where[] = "owner_guid = '$owner_guid'";
} else if (sizeof($owner_guid) > 0) {
$owner_array = array_map('sanitise_int', $owner_guid);
// Cast every element to the owner_guid array to int
// $owner_guid = array_map("sanitise_int", $owner_guid);
// $owner_guid = implode(",",$owner_guid);
// $where[] = "owner_guid in ({$owner_guid})";
}
if (is_null($container_guid)) {
$container_guid = $owner_array;
}
}
if ($site_guid > 0) {
$where[] = "e.site_guid = {$site_guid}";
}
if (!is_null($container_guid)) {
if (is_array($container_guid)) {
foreach($container_guid as $key => $val) $container_guid[$key] = (int) $val;
$where[] = "e.container_guid in (" . implode(",",$container_guid) . ")";
} else {
$container_guid = (int) $container_guid;
$where[] = "e.container_guid = {$container_guid}";
}
}
if ($name!="") {
$where[] = "s.name = '$name'";
}
if ($value!="") {
$where[] = "s.value='$value'";
}
if (!$count) {
$query = "SELECT distinct e.*
from {$CONFIG->dbprefix}entities e
JOIN {$CONFIG->dbprefix}private_settings s ON e.guid=s.entity_guid where ";
} else {
$query = "SELECT count(distinct e.guid) as total
from {$CONFIG->dbprefix}entities e JOIN {$CONFIG->dbprefix}private_settings s
ON e.guid=s.entity_guid where ";
}
foreach ($where as $w) {
$query .= " $w and ";
}
// Add access controls
$query .= get_access_sql_suffix('e');
if (!$count) {
$query .= " order by $order_by";
if ($limit) {
// Add order and limit
$query .= " limit $offset, $limit";
}
$dt = get_data($query, "entity_row_to_elggstar");
return $dt;
} else {
$total = get_data_row($query);
return $total->total;
}
}
/**
* Get entities based on their private data by multiple keys, in a similar way to metadata.
*
* @param string $name The name of the setting
* @param string $value The value of the setting
* @param string|array $type The type of entity (eg "user", "object" etc) or array(type1 => array('subtype1', ...'subtypeN'), ...)
* @param string $subtype The arbitrary subtype of the entity
* @param int $owner_guid The GUID of the owning user
* @param string $order_by The field to order by; by default, time_created desc
* @param int $limit The number of entities to return; 10 by default
* @param int $offset The indexing offset, 0 by default
* @param boolean $count Set to true to get a count rather than the entities themselves (limits and offsets don't apply in this context). Defaults to false.
* @param int $site_guid The site to get entities for. Leave as 0 (default) for the current site; -1 for all sites.
* @param int|array $container_guid The container or containers to get entities from (default: all containers).
* @return array A list of entities.
*/
function get_entities_from_private_setting_multi(array $name, $type = "", $subtype = "", $owner_guid = 0, $order_by = "", $limit = 10, $offset = 0, $count = false, $site_guid = 0, $container_guid = null) {
global $CONFIG;
if ($subtype === false || $subtype === null || $subtype === 0) {
return false;
}
if ($order_by == "") {
$order_by = "e.time_created desc";
}
$order_by = sanitise_string($order_by);
$limit = (int)$limit;
$offset = (int)$offset;
$site_guid = (int) $site_guid;
if ($site_guid == 0) {
$site_guid = $CONFIG->site_guid;
}
$where = array();
if (is_array($type)) {
$tempwhere = "";
if (sizeof($type)) {
foreach($type as $typekey => $subtypearray) {
foreach($subtypearray as $subtypeval) {
$typekey = sanitise_string($typekey);
if (!empty($subtypeval)) {
if (!$subtypeval = (int) get_subtype_id($typekey, $subtypeval)) {
return false;
}
} else {
$subtypeval = 0;
}
if (!empty($tempwhere)) $tempwhere .= " or ";
$tempwhere .= "(e.type = '{$typekey}' and e.subtype = {$subtypeval})";
}
}
}
if (!empty($tempwhere)) {
$where[] = "({$tempwhere})";
}
} else {
$type = sanitise_string($type);
if ($subtype AND !$subtype = get_subtype_id($type, $subtype)) {
return false;
}
if ($type != "") {
$where[] = "e.type='$type'";
}
if ($subtype!=="") {
$where[] = "e.subtype=$subtype";
}
}
if ($owner_guid != "") {
if (!is_array($owner_guid)) {
$owner_array = array($owner_guid);
$owner_guid = (int) $owner_guid;
// $where[] = "owner_guid = '$owner_guid'";
} else if (sizeof($owner_guid) > 0) {
$owner_array = array_map('sanitise_int', $owner_guid);
// Cast every element to the owner_guid array to int
// $owner_guid = array_map("sanitise_int", $owner_guid);
// $owner_guid = implode(",",$owner_guid);
// $where[] = "owner_guid in ({$owner_guid})";
}
if (is_null($container_guid)) {
$container_guid = $owner_array;
}
}
if ($site_guid > 0) {
$where[] = "e.site_guid = {$site_guid}";
}
if (!is_null($container_guid)) {
if (is_array($container_guid)) {
foreach($container_guid as $key => $val) $container_guid[$key] = (int) $val;
$where[] = "e.container_guid in (" . implode(",",$container_guid) . ")";
} else {
$container_guid = (int) $container_guid;
$where[] = "e.container_guid = {$container_guid}";
}
}
if ($name) {
$s_join = "";
$i = 1;
foreach ($name as $k => $n) {
$k = sanitise_string($k);
$s_join .= " JOIN {$CONFIG->dbprefix}private_settings s$i ON e.guid=s$i.entity_guid";
$where[] = "s$i.name = '$k'";
$where[] = "s$i.value = '$n'";
$i++;
}
}
if (!$count) {
$query = "SELECT distinct e.* from {$CONFIG->dbprefix}entities e $s_join where ";
} else {
$query = "SELECT count(distinct e.guid) as total
from {$CONFIG->dbprefix}entities e $s_join where ";
}
foreach ($where as $w) {
$query .= " $w and ";
}
// Add access controls
$query .= get_access_sql_suffix('e');
if (!$count) {
$query .= " order by $order_by";
// Add order and limit
if ($limit) {
$query .= " limit $offset, $limit";
}
$dt = get_data($query, "entity_row_to_elggstar");
return $dt;
} else {
$total = get_data_row($query);
return $total->total;
}
}
/**
* Gets a private setting for an entity.
*
* @param int $entity_guid The entity GUID
* @param string $name The name of the setting
* @return mixed The setting value, or false on failure
*/
function get_private_setting($entity_guid, $name) {
global $CONFIG;
$entity_guid = (int) $entity_guid;
$name = sanitise_string($name);
if ($setting = get_data_row("SELECT value from {$CONFIG->dbprefix}private_settings where name = '{$name}' and entity_guid = {$entity_guid}")) {
return $setting->value;
}
return false;
}
/**
* Return an array of all private settings for a given
*
* @param int $entity_guid The entity GUID
*/
function get_all_private_settings($entity_guid) {
global $CONFIG;
$entity_guid = (int) $entity_guid;
$result = get_data("SELECT * from {$CONFIG->dbprefix}private_settings where entity_guid = {$entity_guid}");
if ($result) {
$return = array();
foreach ($result as $r) {
$return[$r->name] = $r->value;
}
return $return;
}
return false;
}
/**
* Sets a private setting for an entity.
*
* @param int $entity_guid The entity GUID
* @param string $name The name of the setting
* @param string $value The value of the setting
* @return mixed The setting ID, or false on failure
*/
function set_private_setting($entity_guid, $name, $value) {
global $CONFIG;
$entity_guid = (int) $entity_guid;
$name = sanitise_string($name);
$value = sanitise_string($value);
$result = insert_data("INSERT into {$CONFIG->dbprefix}private_settings
(entity_guid, name, value) VALUES
($entity_guid, '{$name}', '{$value}')
ON DUPLICATE KEY UPDATE value='$value'");
if ($result === 0) {
return true;
}
return $result;
}
/**
* Deletes a private setting for an entity.
*
* @param int $entity_guid The Entity GUID
* @param string $name The name of the setting
* @return true|false depending on success
*
*/
function remove_private_setting($entity_guid, $name) {
global $CONFIG;
$entity_guid = (int) $entity_guid;
$name = sanitise_string($name);
return delete_data("DELETE from {$CONFIG->dbprefix}private_settings
where name = '{$name}'
and entity_guid = {$entity_guid}");
}
/**
* Deletes all private settings for an entity.
*
* @param int $entity_guid The Entity GUID
* @return true|false depending on success
*
*/
function remove_all_private_settings($entity_guid) {
global $CONFIG;
$entity_guid = (int) $entity_guid;
return delete_data("DELETE from {$CONFIG->dbprefix}private_settings
where entity_guid = {$entity_guid}");
}
/*
* Check the recurisve delete permissions token.
*
* @return bool
*/
function recursive_delete_permissions_check($hook, $entity_type, $returnvalue, $params) {
static $__RECURSIVE_DELETE_TOKEN;
$entity = $params['entity'];
if ((isloggedin()) && ($__RECURSIVE_DELETE_TOKEN) && (strcmp($__RECURSIVE_DELETE_TOKEN, md5(get_loggedin_userid())))) {
return true;
}
// consult next function
return NULL;
}
/**
* Garbage collect stub and fragments from any broken delete/create calls
*
* @param unknown_type $hook
* @param unknown_type $user
* @param unknown_type $returnvalue
* @param unknown_type $tag
*/
function entities_gc($hook, $user, $returnvalue, $tag) {
global $CONFIG;
$tables = array ('sites_entity', 'objects_entity', 'groups_entity', 'users_entity');
foreach ($tables as $table) {
delete_data("DELETE from {$CONFIG->dbprefix}{$table}
where guid NOT IN (SELECT guid from {$CONFIG->dbprefix}entities)");
}
}
/**
* Runs unit tests for the entities object.
*/
function entities_test($hook, $type, $value, $params) {
global $CONFIG;
$value[] = $CONFIG->path . 'engine/tests/objects/entities.php';
return $value;
}
/**
* Entities init function; establishes the page handler
*
*/
function entities_init() {
register_page_handler('view','entities_page_handler');
register_plugin_hook('unit_test', 'system', 'entities_test');
// Allow a permission override for recursive entity deletion
// TODO: Can this be done better?
register_plugin_hook('permissions_check','all','recursive_delete_permissions_check');
register_plugin_hook('permissions_check:metadata','all','recursive_delete_permissions_check');
register_plugin_hook('gc','system','entities_gc');
register_plugin_hook('search','all','search_list_entities_by_name');
}
/** Register the import hook */
register_plugin_hook("import", "all", "import_entity_plugin_hook", 0);
/** Register the hook, ensuring entities are serialised first */
register_plugin_hook("export", "all", "export_entity_plugin_hook", 0);
/** Hook to get certain named bits of volatile data about an entity */
register_plugin_hook('volatile', 'metadata', 'volatile_data_export_plugin_hook');
/** Hook for rendering a default icon for entities */
register_plugin_hook('entity:icon:url', 'all', 'default_entity_icon_hook', 1000);
/** Register init system event **/
register_elgg_event_handler('init','system','entities_init');
|