-
Notifications
You must be signed in to change notification settings - Fork 0
/
esdportal_api.module
2054 lines (1823 loc) · 75.1 KB
/
esdportal_api.module
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* @file
* esdportal_api.module
*/
use Tobscure\JsonApi\Document;
use Drupal\esdportal_api\Serializers\EcSerializer;
use Drupal\esdportal_api\Serializers\SchoolSerializer;
use Drupal\esdportal_api\EcDataUtils;
define("ESDPORTAL_API_DEFAULT_LIMIT", 100);
define("ESDPORTAL_API_MAX_LIMIT", 1000);
// Define any filter_special query_TAG_alters here:
define("ESDPORTAL_API_SPECIALTAGS_SCHOOLS", "school_profile_has_specialed, school_profile_has_arts, school_profile_has_sports, school_profile_has_transportation, school_profile_has_before_after_care, school_profile_application_required, school_profile_collegereadiness, esd_k8hs_2015_highscore");
define("ESDPORTAL_API_SPECIALTAGS_ECS", "ec_profile_is_free_or_reduced_cost, ec_profile_has_transportation, ec_profile_has_special_needs_experience, ec_profile_has_meals, has_esd_el_2014, has_esd_el_2015, esd_el_highscore");
// Do the same for special sorts:
// These sorts are defined as query tags with names "sort_tag_[asc|desc]".
define("ESDPORTAL_API_SPECIALSORTS_ECS", "ec_profile_changed, ec_total_pts");
define("ESDPORTAL_API_SPECIALSORTS_SCHOOLS", "school_profile_changed, school_combined_total_pts");
/**
* Implements hook_services_resources().
*
* Defines resources for special (non-standard) ESD Portal data.
*/
function esdportal_api_services_resources() {
$api = array(
'ecs' => array(
'operations' => array(
'retrieve' => array(
'help' => 'Retrieves Early Childhood Center',
'callback' => '_esdportal_api_retrieve_ec',
'access callback' => 'user_access',
'access arguments' => array('access content'),
'access arguments append' => FALSE,
'args' => array(
array(
'name' => 'id',
'type' => 'int',
'description' => 'ec entity ID',
'source' => array('path' => '0'),
'optional' => FALSE,
'default value' => NULL,
),
array(
'name' => 'includes',
'type' => 'string',
'description' => 'Include other datasets, comma-separated (current options: ec_profile, most_recent_ec_state_rating, ' . implode(', ', _esdportal_api_get_ec_data_tables()) . ', all)',
'source' => array('param' => 'includes'),
'optional' => TRUE,
'default value' => NULL,
),
array(
'name' => 'flatten_fields',
'type' => 'int',
'description' => 'Remove localization structure from fields if true',
'source' => array('param' => 'flatten_fields'),
'optional' => TRUE,
'default value' => 0,
),
),
),
'index' => array(
'help' => 'Lists Early Childhood Centers',
'callback' => '_esdportal_api_index_ecs',
'access arguments' => array('access content'),
'args' => array(
array(
'name' => 'includes',
'type' => 'string',
'description' => 'Include other datasets, comma-separated (current options: ec_profile, most_recent_ec_state_rating, ' . implode(', ', _esdportal_api_get_ec_data_tables()) . ', all)',
'source' => array('param' => 'includes'),
'optional' => TRUE,
'default value' => NULL,
),
array(
'name' => 'flatten_fields',
'type' => 'int',
'description' => 'Remove localization structure from fields if true',
'source' => array('param' => 'flatten_fields'),
'optional' => TRUE,
'default value' => 0,
),
array(
'name' => 'filter',
'type' => 'array',
'description' => 'An array of field or property names from early childhood center entities paired with values to use to filter the result set.',
'optional' => TRUE,
'source' => array('param' => 'filter'),
'default value' => array(),
'commerce_services_field_populate' => 'taxonomy_term',
),
array(
'name' => 'filter_op',
'type' => 'array',
'description' => 'An array of field or property names from early childhood center entities paired with the operator to use when filtering the result set. If operator is IN, the query builder will attempt to explode the value of filter by commas (e.g. `filter[field_school_type]=10,922&filter_op[field_school_type]=IN` will be transformed into a `WHERE ... IN (..., ...)` query.',
'optional' => TRUE,
'source' => array('param' => 'filter_op'),
'default value' => array(),
'commerce_services_match_keys' => array(
'arg' => 'filter',
'default value' => '=',
),
),
array(
'name' => 'filter_special',
'type' => 'array',
'description' => 'A comma-separated list of custom filters to apply. Options: ' . ESDPORTAL_API_SPECIALTAGS_ECS,
'optional' => TRUE,
'source' => array('param' => 'filter_special'),
'default value' => array(),
'commerce_services_explode' => ',',
),
array(
'name' => 'sort_by',
'type' => 'string',
'description' => 'A comma separated list of field or property names from early childhood center entities by which to sort the result set.',
'optional' => TRUE,
'source' => array('param' => 'sort_by'),
'default value' => 'name',
'commerce_services_explode' => ',',
),
array(
'name' => 'sort_order',
'type' => 'string',
'description' => 'A comma separated list of order specifiers (DESC or ASC) indicating the direction the sort_by values should be applied to the result set.',
'optional' => TRUE,
'source' => array('param' => 'sort_order'),
'default value' => 'DESC',
'commerce_services_explode' => ',',
),
array(
'name' => 'sort_by_special',
'type' => 'string',
'description' => 'A comma separated list of special sorts to apply. Options: ' . ESDPORTAL_API_SPECIALSORTS_ECS,
'optional' => TRUE,
'source' => array('param' => 'sort_by_special'),
'default value' => 'name',
'commerce_services_explode' => ',',
),
array(
'name' => 'sort_order_special',
'type' => 'string',
'description' => 'A comma separated list of order specifiers (DESC or ASC) indicating the direction the sort_by_special values should be applied to the result set.',
'optional' => TRUE,
'source' => array('param' => 'sort_order_special'),
'default value' => 'DESC',
'commerce_services_explode' => ',',
),
array(
'name' => 'near_latlon',
'type' => 'string',
'description' => 'A comma separated pair of decimal latitude and longitude to use as a geo-spatial filter, along with near_miles.',
'optional' => TRUE,
'source' => array('param' => 'near_latlon'),
'default value' => NULL,
'commerce_services_explode' => ',',
),
array(
'name' => 'near_miles',
'type' => 'string',
'description' => 'Radius in miles to include in a geo-spatial query originating at coordinates specified in near_latlon.',
'optional' => TRUE,
'source' => array('param' => 'near_miles'),
'default value' => NULL,
),
array(
'name' => 'limit',
'type' => 'int',
'description' => 'Limit response count (default ' . ESDPORTAL_API_DEFAULT_LIMIT . ')',
'source' => array('param' => 'limit'),
'optional' => TRUE,
'default value' => ESDPORTAL_API_DEFAULT_LIMIT,
),
array(
'name' => 'offset',
'type' => 'int',
'description' => 'Offset starting record',
'source' => array('param' => 'offset'),
'optional' => TRUE,
'default value' => 0,
),
),
),
),
),
'ec_state_ratings' => array(
'operations' => array(
'retrieve' => array(
'help' => 'Retrieves state ratings for an Early Childhood Center',
'callback' => '_esdportal_api_retrieve_ec_state_rating',
'access callback' => 'user_access',
'access arguments' => array('access content'),
'access arguments append' => FALSE,
'args' => array(
array(
'name' => 'esd_ec_id',
'type' => 'int',
'description' => 'ESD-universe early childhood center ID',
'source' => array('path' => '0'),
'optional' => FALSE,
'default value' => NULL,
),
array(
'name' => 'batch_timestamp',
'type' => 'int',
'description' => 'UNIX timestamp of a specific batch (if not provided, returns most recent rating)',
'source' => array('param' => 'batch_timestamp'),
'optional' => TRUE,
'default value' => NULL,
),
),
),
'index' => array(
'help' => 'Lists most recent Early Childhood Center state ratings',
'callback' => '_esdportal_api_index_ec_state_ratings',
'access arguments' => array('access content'),
'args' => array(
array(
'name' => 'batch_timestamp',
'type' => 'int',
'description' => 'UNIX timestamp of a specific batch (if not provided, returns most recent ratings)',
'source' => array('path' => '1'),
'optional' => TRUE,
'default value' => NULL,
),
),
),
),
),
'schools' => array(
'operations' => array(
'retrieve' => array(
'help' => 'Retrieves School',
'callback' => '_esdportal_api_retrieve_school',
'access callback' => 'user_access',
'access arguments' => array('access content'),
'access arguments append' => FALSE,
'args' => array(
array(
'name' => 'id',
'type' => 'int',
'description' => 'school entity ID',
'source' => array('path' => '0'),
'optional' => FALSE,
'default value' => NULL,
),
array(
'name' => 'includes',
'type' => 'string',
'description' => 'Include other datasets, comma-separated (current options: school_profile, ' . implode(', ', _esdportal_api_get_school_data_tables()) . ', all)',
'source' => array('param' => 'includes'),
'optional' => TRUE,
'default value' => NULL,
),
array(
'name' => 'flatten_fields',
'type' => 'int',
'description' => 'Remove localization structure from fields if true',
'source' => array('param' => 'flatten_fields'),
'optional' => TRUE,
'default value' => 0,
),
),
),
'index' => array(
'help' => 'Lists Schools',
'callback' => '_esdportal_api_index_schools',
'access arguments' => array('access content'),
'args' => array(
array(
'name' => 'includes',
'type' => 'string',
'description' => 'Include other datasets, comma-separated (current options: school_profile, ' . implode(', ', _esdportal_api_get_school_data_tables()) . ', all)',
'source' => array('param' => 'includes'),
'optional' => TRUE,
'default value' => NULL,
),
array(
'name' => 'flatten_fields',
'type' => 'int',
'description' => 'Remove localization structure from fields if true',
'source' => array('param' => 'flatten_fields'),
'optional' => TRUE,
'default value' => 0,
),
array(
'name' => 'filter',
'type' => 'array',
'description' => 'An array of field or property names from school entities paired with values to use to filter the result set.',
'optional' => TRUE,
'source' => array('param' => 'filter'),
'default value' => array(),
'commerce_services_field_populate' => 'taxonomy_term',
),
array(
'name' => 'filter_op',
'type' => 'array',
'description' => 'An array of field or property names from school entities paired with the operator to use when filtering the result set. If operator is IN, the query builder will attempt to explode the value of filter by commas (e.g. `filter[field_school_type]=10,922&filter_op[field_school_type]=IN` will be transformed into a `WHERE ... IN (..., ...)` query.',
'optional' => TRUE,
'source' => array('param' => 'filter_op'),
'default value' => array(),
'commerce_services_match_keys' => array(
'arg' => 'filter',
'default value' => '=',
),
),
array(
'name' => 'filter_special',
'type' => 'array',
'description' => 'A comma-separated list of custom filters to apply. Options: ' . ESDPORTAL_API_SPECIALTAGS_SCHOOLS,
'optional' => TRUE,
'source' => array('param' => 'filter_special'),
'default value' => array(),
'commerce_services_explode' => ',',
),
array(
'name' => 'sort_by',
'type' => 'string',
'description' => 'A comma separated list of field or property names from school entities by which to sort the result set.',
'optional' => TRUE,
'source' => array('param' => 'sort_by'),
'default value' => 'name',
'commerce_services_explode' => ',',
),
array(
'name' => 'sort_order',
'type' => 'string',
'description' => 'A comma separated list of order specifiers (DESC or ASC) indicating the direction the sort_by values should be applied to the result set.',
'optional' => TRUE,
'source' => array('param' => 'sort_order'),
'default value' => 'DESC',
'commerce_services_explode' => ',',
),
array(
'name' => 'sort_by_special',
'type' => 'string',
'description' => 'A comma separated list of special sorts to apply. Options: ' . ESDPORTAL_API_SPECIALSORTS_SCHOOLS,
'optional' => TRUE,
'source' => array('param' => 'sort_by_special'),
'default value' => 'name',
'commerce_services_explode' => ',',
),
array(
'name' => 'sort_order_special',
'type' => 'string',
'description' => 'A comma separated list of order specifiers (DESC or ASC) indicating the direction the sort_by_special values should be applied to the result set.',
'optional' => TRUE,
'source' => array('param' => 'sort_order_special'),
'default value' => 'DESC',
'commerce_services_explode' => ',',
),
array(
'name' => 'near_latlon',
'type' => 'string',
'description' => 'A comma separated pair of decimal latitude and longitude to use as a geo-spatial filter, along with near_miles.',
'optional' => TRUE,
'source' => array('param' => 'near_latlon'),
'default value' => NULL,
'commerce_services_explode' => ',',
),
array(
'name' => 'near_miles',
'type' => 'string',
'description' => 'Radius in miles to include in a geo-spatial query originating at coordinates specified in near_latlon.',
'optional' => TRUE,
'source' => array('param' => 'near_miles'),
'default value' => NULL,
),
array(
'name' => 'filter_values',
'type' => 'array',
'description' => 'An array of special fields paired with comma-separated values to use to filter the result set. Allowed values for schools: field_special_ed_level (basic,intensive,moderate,none), field_special_ed_programs (autism,blindness,cognitive,deafness,developmental_delay,emotional,ld,multiple,orthopedic,other,speech). Filter values are added to the query using an IN clause (OR).',
'optional' => TRUE,
'source' => array('param' => 'filter_values'),
'default value' => array(),
'commerce_services_explode' => ',',
),
array(
'name' => 'limit',
'type' => 'int',
'description' => 'Limit response count (default ' . ESDPORTAL_API_DEFAULT_LIMIT . ')',
'source' => array('param' => 'limit'),
'optional' => TRUE,
'default value' => ESDPORTAL_API_DEFAULT_LIMIT,
),
array(
'name' => 'offset',
'type' => 'int',
'description' => 'Offset starting record',
'source' => array('param' => 'offset'),
'optional' => TRUE,
'default value' => 0,
),
),
),
),
),
);
return $api;
}
/**
* Retrieves a single early childhood center.
*
* @param int $id
* ESD internal ec id.
* @param string $includes
* Related datasets to include, comma-separated. 'all' will include all.
* @param bool $flatten_fields
* If true, remove l10n structure & other drupal crap from response.
*
* @return array
* Nested array of the ec data.
*/
function _esdportal_api_retrieve_ec($id, $includes, $flatten_fields = FALSE) {
$document = new Document();
$ec = taxonomy_term_load($id);
if (!$ec || $ec->vid != 19) {
return services_error(t('early childhood center @id does not exist.', array('@id' => $id)), 404);
}
$all_includes = array_merge(['ec_profile', 'most_recent_ec_state_rating'], _esdportal_api_get_ec_data_tables());
$includes = (strlen($includes) > 0) ? explode(',', $includes) : NULL;
// Add ec_profile and most_recent_ec_state_rating by default if no other
// includes are specified.
if (!count($includes)) {
$includes[] = 'ec_profile';
$includes[] = 'most_recent_ec_state_rating';
}
// Include all the includes.
if (in_array('all', $includes)) {
$includes = $all_includes;
}
$serializer = ($includes) ? new EcSerializer($includes) : new EcSerializer([]);
$ecs = [$ec];
_esdportal_api_load_includes_for_ecs($ecs, $includes, $flatten_fields);
$resource = $serializer->resource($ecs[0]);
$document->setData($resource);
return $document->toArray();
}
/**
* Helper function to flatten an entity's fields.
*
* @param string $entity_type
* Drupal entity type.
* @param object &$entity
* An entity object.
*/
function _esdportal_api_flatten_entity_fields($entity_type, &$entity) {
if (isset($entity->vocabulary_machine_name)) {
$entity->machine_name = $entity->vocabulary_machine_name;
}
\Drupal\esdportal_api\EcDataUtils::flattenFields($entity_type, $entity);
}
/**
* Given a taxonomy term, find the first node related to it & return its nid.
*
* @param string $bundle
* Content type.
* @param object $term
* Taxonomy term.
*
* @return int
* node id
*/
function _esdportal_api_get_related_nid($bundle, $term) {
$nid = db_query("SELECT ti.nid FROM taxonomy_index AS ti INNER JOIN node AS n ON n.nid=ti.nid WHERE ti.tid=:tid AND n.type=:bundle", array(':tid' => $term->tid, ':bundle' => $bundle))->fetchField();
return $nid;
}
/**
* Retrieves list of all early childhood centers.
*
* @param string $includes
* Related datasets to include, comma-separated. 'all' will include all.
* @param bool $flatten_fields
* If true, remove l10n structure & other drupal structures from response.
* @param array|bool $filter
* An associative array of property names, single column field names, or
* multi-column field column names with their values to use to filter the
* result set of the index request.
* @param array|bool $filter_op
* An associative array of field and property names with the operators to use
* when applying their filter conditions to the index request query.
* @param array|bool $filter_special
* An array of names of special filters to apply.
* @param array|bool $sort_by
* An array of database fields to sort the query by, with sort fields being
* valid properties, single column field names, or multi-column field column
* names for the matching entity type.
* @param array|bool $sort_order
* The corresponding sort orders for the fields specified in the $sort_by
* array; one of either 'DESC' or 'ASC'.
* @param array|bool $sort_by_special
* A comma separated list of special sorts to apply.
* @param array|bool $sort_order_special
* The corresponding sort orders for the fields specified in the
* $sort_by_special array; one of either 'DESC' or 'ASC'.
* @param array|bool $near_latlon
* A pair of latitude & longitude coordinates to use in a geoquery along with
* the following param.
* @param float|bool $near_miles
* Distance in miles to include in a geospatial query.
* @param int $limit
* If null, return all results.
* @param int $offset
* Offset starting record.
*
* @return array
* JSON-API data.
*/
function _esdportal_api_index_ecs($includes = NULL, $flatten_fields = FALSE, $filter = FALSE, $filter_op = FALSE, $filter_special = FALSE, $sort_by = FALSE, $sort_order = FALSE, $sort_by_special = FALSE, $sort_order_special = FALSE, $near_latlon = FALSE, $near_miles = FALSE, $limit = NULL, $offset = 0) {
$document = new Document();
list($ecs, $total) = _esdportal_api_taxonomy_get_tree(19, $filter, $filter_op, $filter_special, $sort_by, $sort_order, $sort_by_special, $sort_order_special, $near_latlon, $near_miles, [], $limit, $offset);
$link_to_self = $_SERVER['REQUEST_URI'];
// All the potential includes aside from data tables.
$special_includes = [
'ec_profile',
'most_recent_ec_state_rating'
];
$all_includes = array_merge($special_includes, _esdportal_api_get_ec_data_tables());
$includes = (strlen($includes) > 0) ? explode(',', $includes) : [];
// Include all the includes.
if (in_array('all', $includes)) {
$includes = $all_includes;
}
$serializer = ($includes) ? new EcSerializer($includes) : new EcSerializer([]);
_esdportal_api_load_includes_for_ecs($ecs, $includes, $flatten_fields);
$collection = $serializer->collection($ecs);
$document->setData($collection);
$document->addMeta('total', $total);
$document->addLink('self', $link_to_self);
return $document->toArray();
}
/**
* Retrieves an ec_state_rating.
*
* Retrieves a single EC Center's rating with given timestamp or most recent
* timestamp if none is given.
*
* @param int $esd_ec_id
* Early childhood center ID.
* @param int $batch_timestamp
* The specific timestamp to grab. If null, return most recent one.
*
* @return array
* State rating data.
*/
function _esdportal_api_retrieve_ec_state_rating($esd_ec_id, $batch_timestamp = NULL) {
if (isset($batch_timestamp) && $batch_timestamp > 0) {
$rating = db_query('SELECT * FROM {ec_state_ratings} WHERE timestamp=:batch_timestamp AND esd_ec_id=:esd_ec_id', array(':esd_ec_id' => $esd_ec_id, ':batch_timestamp' => $batch_timestamp))->fetchAssoc();
}
else {
$rating = db_query('SELECT * FROM {ec_state_ratings} WHERE timestamp=(SELECT MAX(timestamp) FROM {ec_state_ratings}) AND esd_ec_id=:esd_ec_id', array(':esd_ec_id' => $esd_ec_id))->fetchAssoc();
}
return $rating;
}
/**
* Lists all batch timestamps.
*
* Not offered via api yet.
*/
function _esdportal_api_index_ec_state_ratings_batches() {
return db_query('SELECT DISTINCT(timestamp) FROM {ec_state_ratings} ORDER BY timestamp DESC')->fetchAssoc();
}
/**
* Lists ec_state_ratings.
*
* Lists set of EC state ratings with given timestamp or most recent timestamp,
* if none is given.
*
* @param int $batch_timestamp
* The specific batch timestamp to retrieve. If null, retrieve most recent
* batch.
*
* @return array
* Array of ec state rating data.
*/
function _esdportal_api_index_ec_state_ratings($batch_timestamp = NULL) {
if (isset($batch_timestamp) && $batch_timestamp > 0) {
$ratings = db_query('SELECT * FROM {ec_state_ratings} WHERE timestamp=:batch_timestamp', array(':batch_timestamp' => $batch_timestamp))->fetchAssoc();
}
else {
$ratings = db_query('SELECT * FROM {ec_state_ratings} WHERE timestamp=(SELECT MAX(timestamp) FROM {ec_state_ratings})')->fetchAll();
}
return array('ec_state_ratings' => $ratings);
}
/**
* Retrieves a single school.
*
* @param int $id
* ESD internal school id.
* @param string $includes
* Related datasets to include, comma-separated. 'all' will include all.
* @param bool $flatten_fields
* If true, remove l10n structure & other drupal structures from response.
*
* @return array
* JSON-API data
*/
function _esdportal_api_retrieve_school($id, $includes, $flatten_fields = FALSE) {
$document = new Document();
$school = taxonomy_term_load($id);
if (!$school || ($school->vid != 4)) {
return services_error(t('school @id does not exist.', array('@id' => $id)), 404);
}
$all_includes = array_merge(['school_profile'], _esdportal_api_get_school_data_tables());
$includes = (strlen($includes) > 0) ? explode(',', $includes) : NULL;
// Add school_profile by default if no other includes are specified.
if (!count($includes)) {
$includes[] = 'school_profile';
}
// Include all the includes.
if (in_array('all', $includes)) {
$includes = $all_includes;
}
$serializer = ($includes) ? new SchoolSerializer($includes) : new SchoolSerializer([]);
$schools = [$school];
_esdportal_api_load_includes_for_schools($schools, $includes, $flatten_fields);
$resource = $serializer->resource($schools[0]);
$document->setData($resource);
return $document->toArray();
}
/**
* Retrieves list of all schools.
*
* @param string $includes
* Related datasets to include, comma-separated. 'all' will include all.
* @param bool $flatten_fields
* If true, remove l10n structure & other drupal structures from response.
* @param array|bool $filter
* An associative array of property names, single column field names, or
* multi-column field column names with their values to use to filter the
* result set of the index request.
* @param array|bool $filter_op
* An associative array of field and property names with the operators to use
* when applying their filter conditions to the index request query.
* @param array|bool $filter_special
* An array of names of special filters to apply.
* @param array|bool $sort_by
* An array of database fields to sort the query by, with sort fields being
* valid properties, single column field names, or multi-column field column
* names for the matching entity type.
* @param array|bool $sort_order
* The corresponding sort orders for the fields specified in the $sort_by.
* @param array|bool $sort_by_special
* A comma separated list of special sorts to apply.
* @param array|bool $sort_order_special
* The corresponding sort orders for the fields specified in the
* array; one of either 'DESC' or 'ASC'.
* @param array|bool $near_latlon
* A pair of latitude & longitude coordinates to use in a geoquery along with
* the following param.
* @param float|bool $near_miles
* Distance in miles to include in a geospatial query.
* @param array|bool $filter_values
* Filter with acceptable values. Associative array.
* @param int $limit
* If null, return all results.
* @param int $offset
* Offset starting record.
*
* @return array
* JSON-API data.
*/
function _esdportal_api_index_schools($includes = NULL, $flatten_fields = FALSE, $filter = FALSE, $filter_op = FALSE, $filter_special = FALSE, $sort_by = FALSE, $sort_order = FALSE, $sort_by_special = FALSE, $sort_order_special = FALSE, $near_latlon = FALSE, $near_miles = FALSE, $filter_values = FALSE, $limit = NULL, $offset = 0) {
$document = new Document();
list($schools, $total) = _esdportal_api_taxonomy_get_tree(4, $filter, $filter_op, $filter_special, $sort_by, $sort_order, $sort_by_special, $sort_order_special, $near_latlon, $near_miles, $filter_values, $limit, $offset);
$link_to_self = $_SERVER['REQUEST_URI'];
$all_includes = array_merge(['school_profile'], _esdportal_api_get_school_data_tables());
$includes = (strlen($includes) > 0) ? explode(',', $includes) : [];
// Include all the includes.
if (in_array('all', $includes)) {
$includes = $all_includes;
}
$serializer = ($includes) ? new SchoolSerializer($includes) : new SchoolSerializer([]);
_esdportal_api_load_includes_for_schools($schools, $includes, $flatten_fields);
$collection = $serializer->collection($schools);
$document->setData($collection);
$document->addMeta('total', $total);
$document->addLink('self', $link_to_self);
return $document->toArray();
}
/**
* Lists all school data tables.
*
* @return array
* Data table names.
*/
function _esdportal_api_get_school_data_tables() {
$potential_data_tables = \Drupal\esdportal_api\EcDataUtils::getDataTablesWithBcodes();
return \Drupal\esdportal_api\EcDataUtils::extractDataTableNames($potential_data_tables);
}
/**
* List all Early Childhood data tables.
*
* @return array
* Data table names.
*/
function _esdportal_api_get_ec_data_tables() {
$potential_data_tables = \Drupal\esdportal_api\EcDataUtils::getDataTablesWithProgramIds();
return \Drupal\esdportal_api\EcDataUtils::extractDataTableNames($potential_data_tables);
}
/**
* Loads all includes for a set of schools.
*
* First, load BCODE-related data tables (not as positive of a match as schid)
* and then try loading schid-related tables.
*
* @param array &$schools
* School entities.
* @param array $includes
* Datasets to include.
* @param bool $flatten_fields
* Whether or not to flattenFields.
*/
function _esdportal_api_load_includes_for_schools(array &$schools, array $includes = [], $flatten_fields = NULL) {
$potential_bcode_data_tables = \Drupal\esdportal_api\EcDataUtils::getDataTablesWithBcodes();
$potential_bcode_data_table_names = \Drupal\esdportal_api\EcDataUtils::extractDataTableNames($potential_bcode_data_tables);
$bcode_tables_to_include = array_intersect($potential_bcode_data_table_names, $includes);
$potential_schid_data_tables = \Drupal\esdportal_api\EcDataUtils::getDataTablesWithEsdSchids();
$potential_schid_data_table_names = \Drupal\esdportal_api\EcDataUtils::extractDataTableNames($potential_schid_data_tables);
$schid_tables_to_include = array_intersect($potential_schid_data_table_names, $includes);
foreach ($schools as &$school) {
// Some schools don't have BCODEs.
if (!isset($school->field_bcode[LANGUAGE_NONE])) {
$school->bcode = NULL;
}
else {
$school->bcode = $school->field_bcode[LANGUAGE_NONE][0]['value'];
}
// Some schools don't have ESD internal school IDs.
if (!isset($school->field_esd_schid[LANGUAGE_NONE])) {
$school->esd_schid = NULL;
}
else {
$school->esd_schid = $school->field_esd_schid[LANGUAGE_NONE][0]['value'];
}
if ($flatten_fields) {
_esdportal_api_flatten_entity_fields('taxonomy_term', $school);
}
$school->school_profile_id = _esdportal_api_get_related_nid('school_profile', $school);
}
unset($school);
if (in_array('school_profile', $includes)) {
foreach ($schools as &$school) {
if ($school->school_profile_id) {
$school->school_profile = node_load($school->school_profile_id);
if ($flatten_fields) {
_esdportal_api_flatten_entity_fields('node', $school->school_profile);
}
}
}
}
unset($school);
// First, load BCODE-joined tables...
if (count($bcode_tables_to_include) > 0) {
// we've got some data tables to include!
foreach ($schools as &$school) {
if ($school->bcode !== NULL) {
foreach ($bcode_tables_to_include as $table) {
$table_info = $potential_bcode_data_tables[$table];
$data_table_identifier = $table_info->name;
$q = db_select($table_info->name)
->fields($table_info->name)
->condition($table_info->table_schema['primary key'][0], $school->bcode);
try {
$res = $q->execute();
}
catch (Exception $e) {
// No table?
if ($e->getCode() == '42') {
// Do nothing for now...
}
else {
watchdog_exception('_esdportal_api_load_includes_for_schools', $e);
}
}
$data = $res->fetchObject();
$school->{$data_table_identifier} = ($data) ? $data : FALSE;
}
}
}
unset($school);
}
// And then overwrite (if necessary) or add internal-ID-joined tables.
if (count($schid_tables_to_include) > 0) {
foreach ($schools as &$school) {
if ($school->esd_schid !== NULL) {
foreach ($schid_tables_to_include as $table) {
$table_info = $potential_schid_data_tables[$table];
$data_table_identifier = $table_info->name;
$q = db_select($table_info->name)
->fields($table_info->name)
->condition($table_info->meta['join']['field_data_field_esd_schid']['field'], $school->esd_schid);
try {
$res = $q->execute();
}
catch (Exception $e) {
// No table?
if ($e->getCode() == '42') {
// Do nothing for now...
}
else {
watchdog_exception('_esdportal_api_load_includes_for_schools', $e);
}
}
$data = $res->fetchObject();
// Keep BCODE data if it's there already.
$school->{$data_table_identifier} = ($data) ? $data : $school->{$data_table_identifier};
}
}
}
unset($school);
}
}
/**
* Loads all includes for a set of early childhood centers.
*
* @param array &$ecs
* Early childhood center entities.
* @param array $includes
* Datasets to include.
* @param bool $flatten_fields
* Whether or not to flattenFields.
*/
function _esdportal_api_load_includes_for_ecs(array &$ecs, array $includes = [], $flatten_fields = NULL) {
$potential_data_tables = \Drupal\esdportal_api\EcDataUtils::getDataTablesWithProgramIds();
$potential_data_table_names = \Drupal\esdportal_api\EcDataUtils::extractDataTableNames($potential_data_tables);
$tables_to_include = array_intersect($potential_data_table_names, $includes);
foreach ($ecs as &$ec) {
// Some ecs don't have program_ids.
if (!isset($ec->field_esd_ec_id[LANGUAGE_NONE])) {
$ec->program_id = NULL;
}
else {
$ec->program_id = $ec->field_esd_ec_id[LANGUAGE_NONE][0]['value'];
}
if ($flatten_fields) {
_esdportal_api_flatten_entity_fields('taxonomy_term', $ec);
}
$ec->ec_profile_id = _esdportal_api_get_related_nid('ec_profile', $ec);
}
unset($ec);
if (in_array('ec_profile', $includes)) {
foreach ($ecs as $ec) {
if ($ec->ec_profile_id) {
$ec->ec_profile = node_load($ec->ec_profile_id);
if ($flatten_fields) {
_esdportal_api_flatten_entity_fields('node', $ec->ec_profile);
}
}
}
}
unset($ec);
if (in_array('most_recent_ec_state_rating', $includes)) {
foreach ($ecs as $ec) {
$ec->most_recent_ec_state_rating = (object) _esdportal_api_retrieve_ec_state_rating(\Drupal\esdportal_api\EcDataUtils::getEcId($ec));
$ec->most_recent_ec_state_rating_id = $ec->most_recent_ec_state_rating->rating_id;
}
}
if (count($tables_to_include) > 0) {
// we've got some data tables to include!
foreach ($ecs as &$ec) {
if ($ec->program_id !== NULL) {
foreach ($tables_to_include as $table) {
$table_info = $potential_data_tables[$table];
$data_table_identifier = $table_info->name;
$q = db_select($table_info->name)
->fields($table_info->name)
->condition($table_info->table_schema['primary key'][0], $ec->program_id);
try {
$res = $q->execute();
}
catch (Exception $e) {
// No table?
if ($e->getCode() == '42') {
// Do nothing for now...
}
else {
watchdog_exception('_esdportal_api_load_includes_for_schools', $e);
}
}
$data = $res->fetchObject();
$ec->{$data_table_identifier} = ($data) ? $data : FALSE;
}
}
}
unset($ec);
}
}
/**
* Load vocabulary terms.
*
* Loads a whole taxonomy vocabulary, with sort and filter options akin to
* commerce_services.
*
* Function signature cribbed from commerce_services module.
*
* @param int $vid
* Taxonomy vocabulary id.