1 (function(angular
, $, _
, undefined) {
4 var schema
= CRM
.vars
.api4
.schema
;
6 var links
= CRM
.vars
.api4
.links
;
7 // Cache list of entities
9 // Cache list of actions
12 var fieldOptions
= {};
17 angular
.module('api4Explorer').config(function($routeProvider
) {
18 $routeProvider
.when('/explorer/:api4entity?/:api4action?', {
19 controller
: 'Api4Explorer',
20 templateUrl
: '~/api4Explorer/Explorer.html',
25 angular
.module('api4Explorer').controller('Api4Explorer', function($scope
, $routeParams
, $location
, $timeout
, $http
, crmUiHelp
, crmApi4
, dialogService
) {
26 var ts
= $scope
.ts
= CRM
.ts(),
27 ctrl
= $scope
.$ctrl
= this;
28 $scope
.entities
= entities
;
29 $scope
.actions
= actions
;
31 $scope
.havingOptions
= [];
32 $scope
.fieldsAndJoins
= [];
33 $scope
.fieldsAndJoinsAndFunctions
= [];
34 $scope
.fieldsAndJoinsAndFunctionsWithSuffixes
= [];
35 $scope
.fieldsAndJoinsAndFunctionsAndWildcards
= [];
36 $scope
.availableParams
= {};
37 params
= $scope
.params
= {};
39 $scope
.selectedTab
= {result
: 'result', code
: 'php'};
41 accessDebugOutput
: CRM
.checkPerm('access debug output'),
42 editGroups
: CRM
.checkPerm('edit groups')
44 marked
.setOptions({highlight
: prettyPrintOne
});
45 var getMetaParams
= {},
46 objectParams
= {orderBy
: 'ASC', values
: '', defaults
: '', chain
: ['Entity', '', '{}']},
47 docs
= CRM
.vars
.api4
.docs
,
50 $scope
.helpTitle
= '';
51 $scope
.helpContent
= {};
52 $scope
.entity
= $routeParams
.api4entity
;
55 $scope
.status
= 'default';
56 $scope
.loading
= false;
58 $scope
.langs
= ['php', 'js', 'ang', 'cli'];
59 $scope
.joinTypes
= [{k
: false, v
: 'FALSE (LEFT JOIN)'}, {k
: true, v
: 'TRUE (INNER JOIN)'}];
60 $scope
.bridgeEntities
= _
.filter(schema
, {type
: 'BridgeEntity'});
63 {name
: 'oop', label
: ts('OOP Style'), code
: ''},
64 {name
: 'php', label
: ts('Traditional'), code
: ''}
67 {name
: 'js', label
: ts('Single Call'), code
: ''},
68 {name
: 'js2', label
: ts('Batch Calls'), code
: ''}
71 {name
: 'ang', label
: ts('Single Call'), code
: ''},
72 {name
: 'ang2', label
: ts('Batch Calls'), code
: ''}
75 {name
: 'short', label
: ts('CV (short)'), code
: ''},
76 {name
: 'long', label
: ts('CV (long)'), code
: ''},
77 {name
: 'pipe', label
: ts('CV (pipe)'), code
: ''}
81 if (!entities
.length
) {
82 formatForSelect2(schema
, entities
, 'name', ['description', 'icon']);
91 function ucfirst(str
) {
92 return str
[0].toUpperCase() + str
.slice(1);
95 function lcfirst(str
) {
96 return str
[0].toLowerCase() + str
.slice(1);
99 function pluralize(str
) {
100 var lastLetter
= str
[str
.length
- 1],
101 lastTwo
= str
[str
.length
- 2] + lastLetter
;
102 if (lastLetter
=== 's' || lastLetter
=== 'x' || lastTwo
=== 'ch') {
105 if (lastLetter
=== 'y' && lastTwo
!== 'ey') {
106 return str
.slice(0, -1) + 'ies';
111 // Reformat an existing array of objects for compatibility with select2
112 function formatForSelect2(input
, container
, key
, extra
, prefix
) {
113 _
.each(input
, function(item
) {
114 var id
= (prefix
|| '') + item
[key
];
115 var formatted
= {id
: id
, text
: id
};
117 _
.merge(formatted
, _
.pick(item
, extra
));
119 container
.push(formatted
);
124 // Replaces contents of fieldList array with current fields formatted for select2
125 function getFieldList(fieldList
, action
, addPseudoconstant
) {
126 var fieldInfo
= _
.cloneDeep(_
.findWhere(getEntity().actions
, {name
: action
}).fields
);
127 fieldList
.length
= 0;
128 if (addPseudoconstant
) {
129 addPseudoconstants(fieldInfo
, addPseudoconstant
);
131 formatForSelect2(fieldInfo
, fieldList
, 'name', ['description', 'required', 'default_value']);
134 // Note: this function expects fieldList to be select2-formatted already
135 function addJoins(fieldList
, addWildcard
, addPseudoconstant
) {
136 // Add entities specified by the join param
137 _
.each(getExplicitJoins(), function(joinEntity
, joinAlias
) {
138 var wildCard
= addWildcard
? [{id
: joinAlias
+ '.*', text
: joinAlias
+ '.*', 'description': 'All core ' + joinEntity
+ ' fields'}] : [],
139 joinFields
= _
.cloneDeep(entityFields(joinEntity
));
141 if (addPseudoconstant
) {
142 addPseudoconstants(joinFields
, addPseudoconstant
);
145 text
: joinEntity
+ ' AS ' + joinAlias
,
146 description
: 'Explicit join to ' + joinEntity
,
147 children
: wildCard
.concat(formatForSelect2(joinFields
, [], 'name', ['description'], joinAlias
+ '.'))
151 // Add implicit joins based on schema links
152 _
.each(links
[$scope
.entity
], function(link
) {
153 var linkFields
= _
.cloneDeep(entityFields(link
.entity
)),
154 wildCard
= addWildcard
? [{id
: link
.alias
+ '.*', text
: link
.alias
+ '.*', 'description': 'All core ' + link
.entity
+ ' fields'}] : [];
156 if (addPseudoconstant
) {
157 addPseudoconstants(linkFields
, addPseudoconstant
);
161 description
: 'Implicit join to ' + link
.entity
,
162 children
: wildCard
.concat(formatForSelect2(linkFields
, [], 'name', ['description'], link
.alias
+ '.'))
168 // Note: this function transforms a raw list a-la getFields; not a select2-formatted list
169 function addPseudoconstants(fieldList
, toAdd
) {
170 var optionFields
= _
.filter(fieldList
, 'options');
171 _
.each(optionFields
, function(field
) {
172 var pos
= _
.findIndex(fieldList
, {name
: field
.name
}) + 1;
173 _
.each(toAdd
, function(suffix
) {
174 var newField
= _
.cloneDeep(field
);
175 newField
.name
+= ':' + suffix
;
176 fieldList
.splice(pos
, 0, newField
);
181 $scope
.help = function(title
, content
) {
183 $scope
.helpTitle
= helpTitle
;
184 $scope
.helpContent
= helpContent
;
186 $scope
.helpTitle
= title
;
187 $scope
.helpContent
= formatHelp(content
);
191 // Sets the static help text (which gets overridden by mousing over other elements)
192 function setHelp(title
, content
) {
193 $scope
.helpTitle
= helpTitle
= title
;
194 $scope
.helpContent
= helpContent
= formatHelp(content
);
197 // Convert plain-text help to markdown; replace variables and format links
198 function formatHelp(rawContent
) {
199 function formatRefs(see
) {
200 _
.each(see
, function(ref
, idx
) {
201 var match
= ref
.match(/^\\Civi\\Api4\\([a-zA-Z]+)$/);
203 ref
= '#/explorer/' + match
[1];
205 if (ref
[0] === '\\') {
206 ref
= 'https://github.com/civicrm/civicrm-core/blob/master' + ref
.replace(/\\/i, '/') + '.php
';
208 see[idx] = '<a target
="' + (ref[0] === '#' ? '_self' : '_blank') + '" href
="' + ref + '">' + see[idx] + '</a
>';
211 var formatted = _.cloneDeep(rawContent);
212 if (formatted.description) {
213 formatted.description = marked(formatted.description);
215 if (formatted.comment) {
216 formatted.comment = marked(formatted.comment);
218 formatRefs(formatted.see);
222 $scope.fieldHelp = function(fieldName) {
223 var field = getField(fieldName, $scope.entity, $scope.action);
228 description: field.description,
229 type: field.data_type
231 if (field.default_value) {
232 info.default = field.default_value;
234 if (field.required_if) {
235 info.required_if = field.required_if;
236 } else if (field.required) {
237 info.required = 'true';
242 // Returns field list for write params (values, defaults)
243 $scope.fieldList = function(param) {
246 getFieldList(fields, $scope.action === 'getFields
' ? ($scope.params.action || 'get') : $scope.action, ['name
']);
247 // Disable fields that are already in use
248 _.each($scope.params[param] || [], function(val) {
249 var usedField = val[0].replace(':name
', '');
250 (_.findWhere(fields, {id: usedField}) || {}).disabled = true;
251 (_.findWhere(fields, {id: usedField + ':name
'}) || {}).disabled = true;
253 return {results: fields};
257 $scope.formatSelect2Item = function(row) {
258 return _.escape(row.text) +
259 (row.required ? '<span
class="crm-marker"> *</span
>' : '') +
260 (row.description ? '<div
class="crm-select2-row-description"><p
>' + _.escape(row.description) + '</p></div>' : '');
263 $scope.clearParam = function(name, idx) {
264 if (typeof idx === 'undefined') {
265 $scope.params[name] = $scope.availableParams[name].default;
267 $scope.params[name].splice(idx, 1);
271 // Gets params that should be represented as generic input fields in the explorer
272 // This fn doesn't have to be particularly efficient as its output is cached
in one
-time bindings
273 $scope
.getGenericParams = function(paramType
, defaultNull
) {
274 // Returns undefined if params are not yet set; one-time bindings will stabilize when this function returns a value
275 if (_
.isEmpty($scope
.availableParams
)) {
278 var specialParams
= ['select', 'fields', 'action', 'where', 'values', 'defaults', 'orderBy', 'chain', 'groupBy', 'having', 'join'];
279 if ($scope
.availableParams
.limit
&& $scope
.availableParams
.offset
) {
280 specialParams
.push('limit', 'offset');
282 return _
.transform($scope
.availableParams
, function(genericParams
, param
, name
) {
283 if (!_
.contains(specialParams
, name
) &&
284 !(typeof paramType
!== 'undefined' && !_
.contains(paramType
, param
.type
[0])) &&
285 !(typeof defaultNull
!== 'undefined' && ((param
.default === null) !== defaultNull
))
287 genericParams
[name
] = param
;
292 $scope
.selectRowCount = function() {
293 var index
= params
.select
.indexOf('row_count');
295 $scope
.params
.select
.push('row_count');
297 $scope
.params
.select
.splice(index
, 1);
301 $scope
.isSelectRowCount = function() {
302 return isSelectRowCount($scope
.params
);
305 $scope
.selectLang = function(lang
) {
306 $scope
.selectedTab
.code
= lang
;
310 function isSelectRowCount(params
) {
311 return params
&& params
.select
&& params
.select
.indexOf('row_count') >= 0;
314 function getEntity(entityName
) {
315 return _
.findWhere(schema
, {name
: entityName
|| $scope
.entity
});
318 // Get name of entity given join alias
319 function entityNameFromAlias(alias
) {
320 var joins
= getExplicitJoins(),
321 entity
= $scope
.entity
,
322 path
= alias
.split('.');
323 // First check explicit joins
327 // Then lookup implicit links
328 _
.each(path
, function(node
) {
329 entity
= _
.find(links
[entity
], {alias
: node
}).entity
;
334 // Get all params that have been set
335 function getParams() {
337 _
.each($scope
.params
, function(param
, key
) {
338 if (param
!= $scope
.availableParams
[key
].default && !(typeof param
=== 'object' && _
.isEmpty(param
))) {
339 if (_
.contains($scope
.availableParams
[key
].type
, 'array') && (typeof objectParams
[key
] === 'undefined')) {
340 params
[key
] = parseYaml(JSON
.parse(angular
.toJson(param
)));
346 _
.each(objectParams
, function(defaultVal
, key
) {
349 _
.each(params
[key
], function(item
) {
350 var val
= _
.cloneDeep(item
[1]);
351 // Remove blank items from "chain" array
352 if (_
.isArray(val
)) {
353 _
.eachRight(item
[1], function(v
, k
) {
360 newParam
[item
[0]] = parseYaml(val
);
362 params
[key
] = newParam
;
368 function parseYaml(input
) {
369 if (typeof input
=== 'undefined' || input
=== '') {
372 // Return literal quoted string without removing quotes - for the sake of JOIN ON clauses
373 if (_
.isString(input
) && input
[0] === input
[input
.length
- 1] && _
.includes(["'", '"'], input
[0])) {
376 if (_
.isObject(input
) || _
.isArray(input
)) {
377 _
.each(input
, function(item
, index
) {
378 input
[index
] = parseYaml(item
);
383 var output
= (input
=== '>') ? '>' : jsyaml
.safeLoad(input
);
384 // We don't want dates parsed to js objects
385 return _
.isDate(output
) ? input
: output
;
391 this.buildFieldList = function() {
392 var actionInfo
= _
.findWhere(actions
, {id
: $scope
.action
});
393 getFieldList($scope
.fields
, $scope
.action
);
394 getFieldList($scope
.fieldsAndJoins
, $scope
.action
, ['name']);
395 getFieldList($scope
.fieldsAndJoinsAndFunctions
, $scope
.action
);
396 getFieldList($scope
.fieldsAndJoinsAndFunctionsWithSuffixes
, $scope
.action
, ['name', 'label']);
397 getFieldList($scope
.fieldsAndJoinsAndFunctionsAndWildcards
, $scope
.action
, ['name', 'label']);
398 if (_
.contains(['get', 'update', 'delete', 'replace'], $scope
.action
)) {
399 addJoins($scope
.fieldsAndJoins
);
400 // SQL functions are supported if HAVING is
401 if (actionInfo
.params
.having
) {
403 text
: ts('FUNCTION'),
404 description
: ts('Calculate result of a SQL function'),
405 children
: _
.transform(CRM
.vars
.api4
.functions
, function(result
, fn
) {
407 id
: fn
.name
+ '() AS ' + fn
.name
.toLowerCase(),
408 text
: fn
.name
+ '()',
409 description
: fn
.name
+ '(' + describeSqlFn(fn
.params
) + ')'
413 $scope
.fieldsAndJoinsAndFunctions
.push(functions
);
414 $scope
.fieldsAndJoinsAndFunctionsWithSuffixes
.push(functions
);
415 $scope
.fieldsAndJoinsAndFunctionsAndWildcards
.push(functions
);
417 addJoins($scope
.fieldsAndJoinsAndFunctions
, true);
418 addJoins($scope
.fieldsAndJoinsAndFunctionsWithSuffixes
, false, ['name', 'label']);
419 addJoins($scope
.fieldsAndJoinsAndFunctionsAndWildcards
, true, ['name', 'label']);
421 // Custom fields are supported if HAVING is
422 if (actionInfo
.params
.having
) {
423 $scope
.fieldsAndJoinsAndFunctionsAndWildcards
.unshift({id
: 'custom.*', text
: 'custom.*', 'description': 'All custom fields'});
425 $scope
.fieldsAndJoinsAndFunctionsAndWildcards
.unshift({id
: '*', text
: '*', 'description': 'All core ' + $scope
.entity
+ ' fields'});
428 function selectAction() {
429 $scope
.action
= $routeParams
.api4action
;
430 if (!actions
.length
) {
431 formatForSelect2(getEntity().actions
, actions
, 'name', ['description', 'params']);
434 var actionInfo
= _
.findWhere(actions
, {id
: $scope
.action
});
435 _
.each(actionInfo
.params
, function (param
, name
) {
437 defaultVal
= _
.cloneDeep(param
.default);
439 switch (param
.type
[0]) {
442 format
= param
.type
[0];
453 if (name
=== 'limit') {
456 if (name
=== 'debug') {
459 if (name
=== 'values') {
460 defaultVal
= defaultValues(defaultVal
);
462 if (name
=== 'loadOptions' && $scope
.action
=== 'getFields') {
466 ['id', 'name', 'label'],
467 ['id', 'name', 'label', 'abbr', 'description', 'color', 'icon']
471 param
.type
= ['string'];
473 $scope
.$bindToRoute({
474 expr
: 'params["' + name
+ '"]',
478 deep
: format
=== 'json'
481 if (typeof objectParams
[name
] !== 'undefined' && name
!== 'orderBy') {
482 $scope
.$watch('params.' + name
, function (values
) {
483 // Remove empty values
484 _
.each(values
, function (clause
, index
) {
485 if (!clause
|| !clause
[0]) {
486 $scope
.clearParam(name
, index
);
491 if (name
=== 'select' && actionInfo
.params
.having
) {
492 $scope
.$watchCollection('params.select', function(newSelect
) {
493 // Ignore row_count, it can't be used in HAVING clause
494 var select
= _
.without(newSelect
, 'row_count');
495 $scope
.havingOptions
.length
= 0;
496 // An empty select is an implicit *
497 if (!select
.length
) {
500 _
.each(select
, function(item
) {
502 pieces
= item
.split(' AS '),
503 alias
= _
.trim(pieces
[pieces
.length
- 1]).replace(':label', ':name');
505 if (alias
[alias
.length
- 1] === '*') {
506 if (alias
.length
> 1) {
507 joinEntity
= entityNameFromAlias(alias
.slice(0, -2));
509 var fieldList
= _
.filter(getEntity(joinEntity
).fields
, {custom_field_id
: null});
510 formatForSelect2(fieldList
, $scope
.havingOptions
, 'name', ['description', 'required', 'default_value'], alias
.slice(0, -1));
513 $scope
.havingOptions
.push({id
: alias
, text
: alias
});
518 if (typeof objectParams
[name
] !== 'undefined' || name
=== 'groupBy' || name
=== 'select' || name
=== 'join') {
519 $scope
.$watch('controls.' + name
, function(value
) {
521 $timeout(function() {
523 if (name
=== 'join') {
524 $scope
.params
[name
].push([field
+ ' AS ' + _
.snakeCase(field
), false]);
525 ctrl
.buildFieldList();
527 else if (typeof objectParams
[name
] === 'undefined') {
528 $scope
.params
[name
].push(field
);
530 var defaultOp
= _
.cloneDeep(objectParams
[name
]);
531 if (name
=== 'chain') {
532 var num
= $scope
.params
.chain
.length
;
533 defaultOp
[0] = field
;
534 field
= 'name_me_' + num
;
536 $scope
.params
[name
].push([field
, defaultOp
]);
538 $scope
.controls
[name
] = null;
544 ctrl
.buildFieldList();
545 $scope
.availableParams
= actionInfo
.params
;
550 function describeSqlFn(params
) {
552 _
.each(params
, function(param
) {
555 desc
+= _
.filter(param
.prefix
).join('|') + ' ';
557 if (param
.expr
=== 1) {
559 } else if (param
.expr
> 1) {
560 desc
+= 'expr, ... ';
563 desc
+= ' ' + _
.filter(param
.suffix
).join('|') + ' ';
566 return desc
.replace(/[ ]+/g, ' ');
569 function defaultValues(defaultVal
) {
570 _
.each($scope
.fields
, function(field
) {
571 if (field
.required
) {
572 defaultVal
.push([field
.id
, '']);
578 function stringify(value
, trim
) {
579 if (typeof value
=== 'undefined') {
582 var str
= JSON
.stringify(value
).replace(/,/g
, ', ');
584 str
= str
.slice(1, -1);
589 function writeCode() {
591 entity
= $scope
.entity
,
592 action
= $scope
.action
,
593 params
= getParams(),
594 index
= isInt($scope
.index
) ? +$scope
.index
: parseYaml($scope
.index
),
596 if ($scope
.entity
&& $scope
.action
) {
598 if (action
.slice(0, 3) === 'get') {
599 result
= entity
.substr(0, 7) === 'Custom_' ? _
.camelCase(entity
.substr(7)) : entity
;
600 result
= lcfirst(action
.replace(/s$/, '').slice(3) || result
);
602 var results
= lcfirst(_
.isNumber(index
) ? result
: pluralize(result
)),
603 paramCount
= _
.size(params
),
606 switch ($scope
.selectedTab
.code
) {
610 var js
= "'" + entity
+ "', '" + action
+ "', {";
611 _
.each(params
, function(param
, key
) {
612 js
+= "\n " + key
+ ': ' + stringify(param
) +
613 (++i
< paramCount
? ',' : '');
614 if (key
=== 'checkPermissions') {
615 js
+= ' // IGNORED: permissions are always enforced from client-side requests';
619 if (index
|| index
=== 0) {
620 js
+= ', ' + JSON
.stringify(index
);
622 code
.js
= "CRM.api4(" + js
+ ").then(function(" + results
+ ") {\n // do something with " + results
+ " array\n}, function(failure) {\n // handle failure\n});";
623 code
.js2
= "CRM.api4({" + results
+ ': [' + js
+ "]}).then(function(batch) {\n // do something with batch." + results
+ " array\n}, function(failure) {\n // handle failure\n});";
624 code
.ang
= "crmApi4(" + js
+ ").then(function(" + results
+ ") {\n // do something with " + results
+ " array\n}, function(failure) {\n // handle failure\n});";
625 code
.ang2
= "crmApi4({" + results
+ ': [' + js
+ "]}).then(function(batch) {\n // do something with batch." + results
+ " array\n}, function(failure) {\n // handle failure\n});";
630 code
.php
= '$' + results
+ " = civicrm_api4('" + entity
+ "', '" + action
+ "', [";
631 _
.each(params
, function(param
, key
) {
632 code
.php
+= "\n '" + key
+ "' => " + phpFormat(param
, 4) + ',';
635 if (index
|| index
=== 0) {
636 code
.php
+= ', ' + phpFormat(index
);
641 code
.oop
= '$' + results
+ " = " + formatOOP(entity
, action
, params
, 2) + "\n ->execute()";
642 if (_
.isNumber(index
)) {
643 code
.oop
+= !index
? '\n ->first()' : (index
=== -1 ? '\n ->last()' : '\n ->itemAt(' + index
+ ')');
645 if (_
.isString(index
) || (_
.isPlainObject(index
) && !index
[0] && !index
['0'])) {
646 code
.oop
+= "\n ->indexBy('" + (_
.isPlainObject(index
) ? _
.keys(index
)[0] : index
) + "')";
648 if (_
.isArray(index
) || _
.isPlainObject(index
)) {
649 code
.oop
+= "\n ->column('" + (_
.isArray(index
) ? index
[0] : _
.values(index
)[0]) + "')";
653 if (!_
.isNumber(index
)) {
654 code
.oop
+= "foreach ($" + results
+ ' as $' + ((_
.isString(index
) && index
) ? index
+ ' => $' : '') + result
+ ') {\n // do something\n}';
659 // Cli code using json input
660 code
.long = 'cv api4 ' + entity
+ '.' + action
+ ' ' + cliFormat(JSON
.stringify(params
));
661 code
.pipe
= 'echo ' + cliFormat(JSON
.stringify(params
)) + ' | cv api4 ' + entity
+ '.' + action
+ ' --in=json';
663 // Cli code using short syntax
664 code
.short = 'cv api4 ' + entity
+ '.' + action
;
665 var limitSet
= false;
666 _
.each(params
, function(param
, key
) {
668 case (key
=== 'select' && !_
.includes(param
.join(), ' ')):
669 code
.short += ' +s ' + cliFormat(param
.join(','));
671 case (key
=== 'where' && !_
.intersection(_
.map(param
, 0), ['AND', 'OR', 'NOT']).length
):
672 _
.each(param
, function(clause
) {
673 code
.short += ' +w ' + cliFormat(clause
[0] + ' ' + clause
[1] + (clause
.length
> 2 ? (' ' + JSON
.stringify(clause
[2])) : ''));
676 case (key
=== 'orderBy'):
677 _
.each(param
, function(dir
, field
) {
678 code
.short += ' +o ' + cliFormat(field
+ ' ' + dir
);
681 case (key
=== 'values'):
682 _
.each(param
, function(val
, field
) {
683 code
.short += ' +v ' + cliFormat(field
+ '=' + val
);
686 case (key
=== 'limit' || key
=== 'offset'):
687 // These 2 get combined
690 code
.short += ' +l ' + (params
.limit
|| '0') + (params
.offset
? ('@' + params
.offset
) : '');
694 code
.short += ' ' + key
+ '=' + (typeof param
=== 'string' ? cliFormat(param
) : cliFormat(JSON
.stringify(param
)));
699 _
.each($scope
.code
, function(vals
) {
700 _
.each(vals
, function(style
) {
701 style
.code
= code
[style
.name
] ? prettyPrintOne(code
[style
.name
]) : '';
707 function formatOOP(entity
, action
, params
, indent
) {
709 newLine
= "\n" + _
.repeat(' ', indent
),
710 perm
= params
.checkPermissions
=== false ? 'FALSE' : '';
711 if (entity
.substr(0, 7) !== 'Custom_') {
712 code
= "\\Civi\\Api4\\" + entity
+ '::' + action
+ '(' + perm
+ ')';
714 code
= "\\Civi\\Api4\\CustomValue::" + action
+ "('" + entity
.substr(7) + "'" + (perm
? ', ' : '') + perm
+ ")";
716 _
.each(params
, function(param
, key
) {
718 if (typeof objectParams
[key
] !== 'undefined' && key
!== 'chain') {
719 _
.each(param
, function(item
, index
) {
720 val
= phpFormat(index
) + ', ' + phpFormat(item
, 2 + indent
);
721 code
+= newLine
+ "->add" + ucfirst(key
).replace(/s$/, '') + '(' + val
+ ')';
723 } else if (key
=== 'where') {
724 _
.each(param
, function (clause
) {
725 if (clause
[0] === 'AND' || clause
[0] === 'OR' || clause
[0] === 'NOT') {
726 code
+= newLine
+ "->addClause(" + phpFormat(clause
[0]) + ", " + phpFormat(clause
[1]).slice(1, -1) + ')';
728 code
+= newLine
+ "->addWhere(" + phpFormat(clause
).slice(1, -1) + ")";
731 } else if (key
=== 'select') {
732 // selectRowCount() is a shortcut for addSelect('row_count')
733 if (isSelectRowCount(params
)) {
734 code
+= newLine
+ '->selectRowCount()';
735 param
= _
.without(param
, 'row_count');
737 // addSelect() is a variadic function & can take multiple arguments
739 code
+= newLine
+ '->addSelect(' + phpFormat(param
).slice(1, -1) + ')';
741 } else if (key
=== 'chain') {
742 _
.each(param
, function(chain
, name
) {
743 code
+= newLine
+ "->addChain('" + name
+ "', " + formatOOP(chain
[0], chain
[1], chain
[2], 2 + indent
);
744 code
+= (chain
.length
> 3 ? ',' : '') + (!_
.isEmpty(chain
[2]) ? newLine
: ' ') + (chain
.length
> 3 ? phpFormat(chain
[3]) : '') + ')';
747 else if (key
!== 'checkPermissions') {
748 code
+= newLine
+ "->set" + ucfirst(key
) + '(' + phpFormat(param
, 2 + indent
) + ')';
754 function isInt(value
) {
755 if (_
.isFinite(value
)) {
758 if (!_
.isString(value
)) {
761 return /^-{0,1}\d+$/.test(value
);
764 function formatMeta(resp
) {
766 _
.each(resp
, function(val
, key
) {
767 if (key
!== 'values' && !_
.isPlainObject(val
) && !_
.isFunction(val
)) {
768 ret
+= (ret
.length
? ', ' : '') + key
+ ': ' + (_
.isArray(val
) ? '[' + val
+ ']' : val
);
771 return prettyPrintOne(_
.escape(ret
));
774 $scope
.execute = function() {
775 $scope
.status
= 'info';
776 $scope
.loading
= true;
777 $http
.post(CRM
.url('civicrm/ajax/api4/' + $scope
.entity
+ '/' + $scope
.action
, {
778 params
: angular
.toJson(getParams()),
779 index
: isInt($scope
.index
) ? +$scope
.index
: parseYaml($scope
.index
)
782 'X-Requested-With': 'XMLHttpRequest'
784 }).then(function(resp
) {
785 $scope
.loading
= false;
786 $scope
.status
= resp
.data
&& resp
.data
.debug
&& resp
.data
.debug
.log
? 'warning' : 'success';
787 $scope
.debug
= debugFormat(resp
.data
);
789 formatMeta(resp
.data
),
790 prettyPrintOne('(' + resp
.data
.values
.length
+ ') ' + _
.escape(JSON
.stringify(resp
.data
.values
, null, 2)), 'js', 1)
793 $scope
.loading
= false;
794 $scope
.status
= 'danger';
795 $scope
.debug
= debugFormat(resp
.data
);
798 prettyPrintOne(_
.escape(JSON
.stringify(resp
.data
, null, 2)))
803 function debugFormat(data
) {
804 var debug
= data
.debug
? prettyPrintOne(_
.escape(JSON
.stringify(data
.debug
, null, 2)).replace(/\\n/g, "\n")) : null;
810 * Format value to look like php code
812 function phpFormat(val
, indent
) {
813 if (typeof val
=== 'undefined') {
816 if (val
=== null || val
=== true || val
=== false) {
817 return JSON
.stringify(val
).toUpperCase();
819 indent
= (typeof indent
=== 'number') ? _
.repeat(' ', indent
) : (indent
|| '');
821 baseLine
= indent
? indent
.slice(0, -2) : '',
822 newLine
= indent
? '\n' : '',
823 trailingComma
= indent
? ',' : '';
824 if ($.isPlainObject(val
)) {
825 $.each(val
, function(k
, v
) {
826 ret
+= (ret
? ', ' : '') + newLine
+ indent
+ "'" + k
+ "' => " + phpFormat(v
);
828 return '[' + ret
+ trailingComma
+ newLine
+ baseLine
+ ']';
830 if ($.isArray(val
)) {
831 $.each(val
, function(k
, v
) {
832 ret
+= (ret
? ', ' : '') + newLine
+ indent
+ phpFormat(v
);
834 return '[' + ret
+ trailingComma
+ newLine
+ baseLine
+ ']';
836 if (_
.isString(val
) && !_
.contains(val
, "'")) {
837 return "'" + val
+ "'";
839 return JSON
.stringify(val
).replace(/\$/g, '\\$');
842 // Format string to be cli-input-safe
843 function cliFormat(str
) {
844 if (!_
.includes(str
, ' ') && !_
.includes(str
, '"') && !_
.includes(str
, "'")) {
847 if (!_
.includes(str
, "'")) {
848 return "'" + str
+ "'";
850 if (!_
.includes(str
, '"')) {
851 return '"' + str
+ '"';
853 return "'" + str
.replace(/'/g, "\\'") + "'";
856 function fetchMeta() {
857 crmApi4(getMetaParams)
858 .then(function(data) {
860 getEntity().actions = data.actions;
866 // Help for an entity with no action selected
867 function showEntityHelp(entityName) {
868 var entityInfo = getEntity(entityName);
869 setHelp($scope.entity, {
870 description: entityInfo.description,
871 comment: entityInfo.comment,
876 if (!$scope.entity) {
877 setHelp(ts('APIv4 Explorer
'), {description: docs.description, comment: docs.comment, see: docs.see});
878 } else if (!actions.length && !getEntity().actions) {
879 getMetaParams.actions = [$scope.entity, 'getActions
', {chain: {fields: [$scope.entity, 'getFields
', {action: '$name
'}]}}];
886 showEntityHelp($scope.entity);
889 // Update route when changing entity
890 $scope.$watch('entity
', function(newVal, oldVal) {
891 if (oldVal !== newVal) {
892 // Flush actions cache to re-fetch for new entity
894 $location.url('/explorer/' + newVal);
898 // Update route when changing actions
899 $scope.$watch('action
', function(newVal, oldVal) {
900 if ($scope.entity && $routeParams.api4action !== newVal && !_.isUndefined(newVal)) {
901 $location.url('/explorer/' + $scope.entity + '/' + newVal);
903 setHelp($scope.entity + '::' + newVal, _.pick(_.findWhere(getEntity().actions, {name: newVal}), ['description
', 'comment
', 'see
']));
907 $scope.paramDoc = function(name) {
908 return docs.params[name];
911 $scope.executeDoc = function() {
913 description: ts('Runs API call on the CiviCRM database
.'),
914 comment: ts('Results and debugging info will be displayed below
.')
916 if ($scope.action === 'delete') {
917 doc.WARNING = ts('This API call will be executed on the real database
. Deleting data cannot be undone
.');
919 else if ($scope.action && $scope.action.slice(0, 3) !== 'get') {
920 doc.WARNING = ts('This API call will be executed on the real database
. It cannot be undone
.');
925 $scope.saveDoc = function() {
927 description: ts('Save API call as a smart group
.'),
928 comment: ts('Create a SavedSearch using these API params to populate a smart group
.') +
929 '\n\n' + ts('NOTE
: you must select contact id as the only field
.')
933 $scope.$watch('params
', writeCode, true);
934 $scope.$watch('index
', writeCode);
937 $scope.save = function() {
938 $scope.params.limit = $scope.params.offset = 0;
939 if ($scope.params.chain.length) {
940 CRM.alert(ts('Smart groups are not compatible
with API chaining
.'), ts('Error
'), 'error
', {expires: 5000});
943 if ($scope.params.select.length !== 1 || !_.includes($scope.params.select[0], 'id
')) {
944 CRM.alert(ts('To create a smart group
, the API must select contact id and no other fields
.'), ts('Error
'), 'error
', {expires: 5000});
950 visibility: 'User and User Admin Only
',
953 entity: $scope.entity,
954 params: JSON.parse(angular.toJson($scope.params))
956 model.params.version = 4;
957 delete model.params.chain;
958 delete model.params.debug;
959 delete model.params.limit;
960 delete model.params.offset;
961 delete model.params.orderBy;
962 delete model.params.checkPermissions;
963 var options = CRM.utils.adjustDialogDefaults({
966 title: ts('Save smart group
')
968 dialogService.open('saveSearchDialog
', '~/api4Explorer/SaveSearch
.html
', model, options);
972 angular.module('api4Explorer
').controller('SaveSearchCtrl
', function($scope, crmApi4, dialogService) {
973 var ts = $scope.ts = CRM.ts(),
974 model = $scope.model;
975 $scope.groupEntityRefParams = {
978 params: {is_hidden: 0, is_active: 1, 'saved_search_id
.api_entity
': model.entity},
979 extra: ['saved_search_id
', 'description
', 'visibility
', 'group_type
']
983 minimumInputLength: 0,
984 placeholder: ts('Select existing group
')
987 if (!CRM.checkPerm('administer reserved groups
')) {
988 $scope.groupEntityRefParams.api.params.is_reserved = 0;
991 administerReservedGroups: CRM.checkPerm('administer reserved groups
')
993 $scope.options = CRM.vars.api4.groupOptions;
994 $scope.$watch('model
.id
', function(id) {
996 _.assign(model, $('#api
-save
-search
-select
-group
').select2('data
').extra);
999 $scope.cancel = function() {
1000 dialogService.cancel('saveSearchDialog
');
1002 $scope.save = function() {
1003 $('.ui
-dialog
:visible
').block();
1004 var group = model.id ? {id: model.id} : {title: model.title};
1005 group.description = model.description;
1006 group.visibility = model.visibility;
1007 group.group_type = model.group_type;
1008 group.saved_search_id = '$id
';
1010 api_entity: model.entity,
1011 api_params: model.params
1014 savedSearch.id = model.saved_search_id;
1016 crmApi4('SavedSearch
', 'save
', {records: [savedSearch], chain: {group: ['Group
', 'save
', {'records
': [group]}]}})
1017 .then(function(result) {
1018 dialogService.close('saveSearchDialog
', result[0]);
1023 angular.module('api4Explorer
').directive('crmApi4Clause
', function() {
1026 data: '<crmApi4Clause
'
1028 templateUrl: '~/api4Explorer/Clause
.html
',
1029 controller: function ($scope, $element, $timeout) {
1030 var ts = $scope.ts = CRM.ts(),
1031 ctrl = $scope.$ctrl = this;
1032 this.conjunctions = {AND: ts('And
'), OR: ts('Or
'), NOT: ts('Not
')};
1033 this.operators = CRM.vars.api4.operators;
1034 this.sortOptions = {
1036 connectWith: '.api4
-clause
-group
-sortable
',
1037 containment: $element.closest('.api4
-clause
-fieldset
'),
1043 this.addGroup = function(op) {
1044 $scope.data.clauses.push([op, []]);
1047 this.removeGroup = function() {
1048 $scope.data.groupParent.splice($scope.data.groupIndex, 1);
1051 function onSort(event, ui) {
1052 $($element).closest('.api4
-clause
-fieldset
').toggleClass('api4
-sorting
', event.type === 'sortstart
');
1053 $('.api4
-input
.form
-inline
').css('margin
-left
', '');
1056 // Indent clause while dragging between nested groups
1057 function onSortOver(event, ui) {
1060 offset = $(ui.placeholder).offset().left - $(ui.sender).offset().left;
1062 $('.api4
-input
.form
-inline
.ui
-sortable
-helper
').css('margin
-left
', '' + offset + 'px
');
1065 this.addClause = function() {
1066 $timeout(function() {
1067 if (ctrl.newClause) {
1068 $scope.data.clauses.push([ctrl.newClause, '=', '']);
1069 ctrl.newClause = null;
1073 $scope.$watch('data
.clauses
', function(values) {
1074 // Iterate in reverse order so index doesn't
get out
-of-sync during splice
1075 _
.forEachRight(values
, function(clause
, index
) {
1076 // Remove empty values
1077 if (index
>= ($scope
.data
.skip
|| 0)) {
1078 if (typeof clause
!== 'undefined' && !clause
[0]) {
1079 values
.splice(index
, 1);
1081 // Add/remove value if operator allows for one
1082 else if (typeof clause
[1] === 'string' && _
.contains(clause
[1], 'NULL')) {
1084 } else if (typeof clause
[1] === 'string' && clause
.length
=== 2) {
1094 angular
.module('api4Explorer').directive('api4ExpValue', function($routeParams
, crmApi4
) {
1097 data
: '=api4ExpValue'
1100 link: function (scope
, element
, attrs
, ctrl
) {
1101 var ts
= scope
.ts
= CRM
.ts(),
1102 multi
= _
.includes(['IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN'], scope
.data
.op
),
1103 entity
= $routeParams
.api4entity
,
1104 action
= scope
.data
.action
|| $routeParams
.api4action
;
1106 function destroyWidget() {
1107 var $el
= $(element
);
1108 if ($el
.is('.crm-form-date-wrapper .crm-hidden-date')) {
1109 $el
.crmDatepicker('destroy');
1111 if ($el
.is('.select2-container + input')) {
1112 $el
.crmEntityRef('destroy');
1114 $(element
).removeData().removeAttr('type').removeAttr('placeholder').show();
1117 function makeWidget(field
, op
) {
1118 var $el
= $(element
),
1119 inputType
= field
.input_type
,
1120 dataType
= field
.data_type
;
1122 op
= field
.serialize
|| dataType
=== 'Array' ? 'IN' : '=';
1124 multi
= _
.includes(['IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN'], op
);
1125 if (op
=== 'IS NULL' || op
=== 'IS NOT NULL') {
1129 if (inputType
=== 'Date') {
1130 if (_
.includes(['=', '!=', '<>', '<', '>=', '<', '<='], op
)) {
1131 $el
.crmDatepicker({time
: (field
.input_attrs
&& field
.input_attrs
.time
) || false});
1133 } else if (_
.includes(['=', '!=', '<>', 'IN', 'NOT IN'], op
) && (field
.fk_entity
|| field
.options
|| dataType
=== 'Boolean')) {
1134 if (field
.options
) {
1135 var id
= field
.pseudoconstant
|| 'id';
1136 $el
.addClass('loading').attr('placeholder', ts('- select -')).crmSelect2({multiple
: multi
, data
: [{id
: '', text
: ''}]});
1137 loadFieldOptions(field
.entity
|| entity
).then(function(data
) {
1138 var options
= _
.transform(data
[field
.name
].options
, function(options
, opt
) {
1139 options
.push({id
: opt
[id
], text
: opt
.label
, description
: opt
.description
, color
: opt
.color
, icon
: opt
.icon
});
1141 $el
.removeClass('loading').crmSelect2({data
: options
, multiple
: multi
});
1143 } else if (field
.fk_entity
) {
1144 $el
.crmEntityRef({entity
: field
.fk_entity
, select
:{multiple
: multi
}});
1145 } else if (dataType
=== 'Boolean') {
1146 $el
.attr('placeholder', ts('- select -')).crmSelect2({allowClear
: false, multiple
: multi
, placeholder
: ts('- select -'), data
: [
1147 {id
: 'true', text
: ts('Yes')},
1148 {id
: 'false', text
: ts('No')}
1151 } else if (dataType
=== 'Integer' && !multi
) {
1152 $el
.attr('type', 'number');
1156 function loadFieldOptions(entity
) {
1157 if (!fieldOptions
[entity
+ action
]) {
1158 fieldOptions
[entity
+ action
] = crmApi4(entity
, 'getFields', {
1159 loadOptions
: ['id', 'name', 'label', 'description', 'color', 'icon'],
1161 where
: [['options', '!=', false]],
1165 return fieldOptions
[entity
+ action
];
1168 // Copied from ng-list but applied conditionally if field is multi-valued
1169 var parseList = function(viewValue
) {
1170 // If the viewValue is invalid (say required but empty) it will be `undefined`
1171 if (_
.isUndefined(viewValue
)) return;
1180 _
.each(viewValue
.split(','), function(value
) {
1181 if (value
) list
.push(_
.trim(value
));
1188 // Copied from ng-list
1189 ctrl
.$parsers
.push(parseList
);
1190 ctrl
.$formatters
.push(function(value
) {
1191 return _
.isArray(value
) ? value
.join(', ') : value
;
1194 // Copied from ng-list
1195 ctrl
.$isEmpty = function(value
) {
1196 return !value
|| !value
.length
;
1199 scope
.$watchCollection('data', function(data
) {
1201 var field
= getField(data
.field
, entity
, action
);
1202 if (field
&& data
.format
!== 'plain') {
1203 makeWidget(field
, data
.op
);
1211 angular
.module('api4Explorer').directive('api4ExpChain', function(crmApi4
) {
1214 chain
: '=api4ExpChain',
1218 templateUrl
: '~/api4Explorer/Chain.html',
1219 link: function (scope
, element
, attrs
) {
1220 var ts
= scope
.ts
= CRM
.ts();
1222 function changeEntity(newEntity
, oldEntity
) {
1223 // When clearing entity remove this chain
1225 scope
.chain
[0] = '';
1228 // Reset action && index
1229 if (newEntity
!== oldEntity
) {
1230 scope
.chain
[1][1] = scope
.chain
[1][2] = '';
1232 if (getEntity(newEntity
).actions
) {
1235 crmApi4(newEntity
, 'getActions', {chain
: {fields
: [newEntity
, 'getFields', {action
: '$name'}]}})
1236 .then(function(data
) {
1237 getEntity(data
.entity
).actions
= data
;
1238 if (data
.entity
=== scope
.chain
[1][0]) {
1245 function setActions() {
1246 scope
.actions
= [''].concat(_
.pluck(getEntity(scope
.chain
[1][0]).actions
, 'name'));
1249 // Set default params when choosing action
1250 function changeAction(newAction
, oldAction
) {
1252 // Prepopulate links
1253 if (newAction
&& newAction
!== oldAction
) {
1255 scope
.chain
[1][3] = '';
1256 // Look for links back to main entity
1257 _
.each(entityFields(scope
.chain
[1][0]), function(field
) {
1258 if (field
.fk_entity
=== scope
.mainEntity
) {
1259 link
= [field
.name
, '$id'];
1262 // Look for links from main entity
1263 if (!link
&& newAction
!== 'create') {
1264 _
.each(entityFields(scope
.mainEntity
), function(field
) {
1265 if (field
.fk_entity
=== scope
.chain
[1][0]) {
1266 link
= ['id', '$' + field
.name
];
1267 // Since we're specifying the id, set index to getsingle
1268 scope
.chain
[1][3] = '0';
1272 if (link
&& _
.contains(['get', 'update', 'replace', 'delete'], newAction
)) {
1273 scope
.chain
[1][2] = '{where: [[' + link
[0] + ', =, ' + link
[1] + ']]}';
1275 else if (link
&& _
.contains(['create'], newAction
)) {
1276 scope
.chain
[1][2] = '{values: {' + link
[0] + ': ' + link
[1] + '}}';
1278 else if (link
&& _
.contains(['save'], newAction
)) {
1279 scope
.chain
[1][2] = '{records: [{' + link
[0] + ': ' + link
[1] + '}]}';
1281 scope
.chain
[1][2] = '{}';
1286 scope
.$watch("chain[1][0]", changeEntity
);
1287 scope
.$watch("chain[1][1]", changeAction
);
1292 function getEntity(entityName
) {
1293 return _
.findWhere(schema
, {name
: entityName
});
1296 function entityFields(entityName
, action
) {
1297 var entity
= getEntity(entityName
);
1298 if (entity
&& action
&& entity
.actions
) {
1299 return _
.findWhere(entity
.actions
, {name
: action
}).fields
;
1301 return _
.result(entity
, 'fields');
1304 function getExplicitJoins() {
1305 return _
.transform(params
.join
, function(joins
, join
) {
1306 var j
= join
[0].split(' AS '),
1307 joinEntity
= _
.trim(j
[0]),
1308 joinAlias
= _
.trim(j
[1]) || joinEntity
.toLowerCase();
1309 joins
[joinAlias
] = joinEntity
;
1313 function getField(fieldName
, entity
, action
) {
1314 var suffix
= fieldName
.split(':')[1];
1315 fieldName
= fieldName
.split(':')[0];
1316 var fieldNames
= fieldName
.split('.');
1317 var field
= get(entity
, fieldNames
);
1318 if (field
&& suffix
) {
1319 field
.pseudoconstant
= suffix
;
1323 function get(entity
, fieldNames
) {
1324 if (fieldNames
.length
=== 1) {
1325 return _
.findWhere(entityFields(entity
, action
), {name
: fieldNames
[0]});
1327 var comboName
= _
.findWhere(entityFields(entity
, action
), {name
: fieldNames
[0] + '.' + fieldNames
[1]});
1331 var linkName
= fieldNames
.shift(),
1332 newEntity
= getExplicitJoins()[linkName
] || _
.findWhere(links
[entity
], {alias
: linkName
}).entity
;
1333 return get(newEntity
, fieldNames
);
1337 // Collapsible optgroups for select2
1340 .on('select2-open', function(e
) {
1341 if ($(e
.target
).hasClass('collapsible-optgroups')) {
1343 .off('.collapseOptionGroup')
1344 .addClass('collapsible-optgroups-enabled')
1345 .on('click.collapseOptionGroup', '.select2-result-with-children > .select2-result-label', function() {
1346 $(this).parent().toggleClass('optgroup-expanded');
1350 .on('select2-close', function() {
1351 $('#select2-drop').off('.collapseOptionGroup').removeClass('collapsible-optgroups-enabled');
1354 })(angular
, CRM
.$, CRM
._
);