Commit | Line | Data |
---|---|---|
19b53e5b C |
1 | <div id="bootstrap-theme" class="api4-explorer-page"> |
2 | <div crm-ui-debug="availableParams"></div> | |
3 | ||
4 | <h1 crm-page-title> | |
9cea3619 | 5 | {{ ts('CiviCRM APIv4') }}{{ entity ? (' (' + entity + '::' + action + ')') : '' }} |
19b53e5b C |
6 | </h1> |
7 | ||
8 | <!--This warning will show if bootstrap is unavailable. Normally it will be hidden by the bootstrap .collapse class.--> | |
9 | <div class="messages warning no-popup collapse"> | |
10 | <p> | |
11 | <i class="crm-i fa-exclamation-triangle"></i> | |
12 | <strong>{{ ts('Bootstrap theme not found.') }}</strong> | |
13 | </p> | |
14 | <p>{{ ts('This screen may not work correctly without a bootstrap-based theme such as Shoreditch installed.') }}</p> | |
15 | </div> | |
16 | ||
17 | <div class="api4-explorer-row"> | |
18 | <form name="api4-explorer" class="panel panel-default explorer-params-panel"> | |
19 | <div class="panel-heading"> | |
20 | <div class="form-inline"> | |
9cea3619 CW |
21 | <span ng-mouseenter="help('entity', paramDoc('$entity'))" ng-mouseleave="help()"> |
22 | <input class="collapsible-optgroups form-control" ng-model="entity" ng-disabled="!entities.length" ng-class="{loading: !entities.length}" crm-ui-select="{placeholder: ts('Entity'), data: entities}" /> | |
23 | </span> | |
24 | <span ng-mouseenter="help('action', paramDoc('$action'))" ng-mouseleave="help()"> | |
25 | <input class="collapsible-optgroups form-control" ng-model="action" ng-disabled="!entity || !actions.length" ng-class="{loading: entity && !actions.length}" crm-ui-select="{placeholder: ts('Action'), data: actions}" /> | |
26 | </span> | |
27 | <input class="form-control api4-index" type="search" ng-model="index" ng-mouseenter="help('index', paramDoc('$index'))" ng-mouseleave="help()" placeholder="{{ ts('Index') }}" /> | |
2c5d5bca | 28 | <button class="btn btn-success pull-right" crm-icon="fa-bolt" ng-disabled="!entity || !action || loading" ng-click="execute()" ng-mouseenter="help(ts('Execute'), executeDoc())" ng-mouseleave="help()">{{ ts('Execute') }}</button> |
d7507e89 | 29 | <button class="btn btn-primary pull-right" crm-icon="fa-save" ng-show="perm.editGroups && entity === 'Contact' && action === 'get'" ng-click="save()" ng-mouseenter="help(ts('Save smart group'), saveDoc())" ng-mouseleave="help()">{{ ts('Save...') }}</button> |
19b53e5b C |
30 | </div> |
31 | </div> | |
32 | <div class="panel-body"> | |
33 | <div class="api4-input form-inline"> | |
e730bd39 | 34 | <label class="form-control" ng-mouseenter="help(name, param)" ng-mouseleave="help()" ng-class="{'api4-option-selected': params[name]}" ng-repeat="(name, param) in availableParams" ng-if="!isSpecial(name) && param.type[0] === 'bool' && param.default !== null"> |
19b53e5b | 35 | <input type="checkbox" id="api4-param-{{ name }}" ng-model="params[name]"/> |
e730bd39 CW |
36 | {{ name }}<span class="crm-marker" ng-if="param.required"> *</span> |
37 | </label> | |
0c8e6f1e | 38 | <label class="form-control" ng-mouseenter="help('selectRowCount', availableParams.select)" ng-mouseleave="help()" ng-class="{'api4-option-selected': isSelectRowCount()}" ng-if="availableParams.select"> |
19b53e5b | 39 | <input type="checkbox" id="api4-param-selectRowCount" ng-checked="isSelectRowCount()" ng-click="selectRowCount()" /> |
0c8e6f1e CW |
40 | SelectRowCount |
41 | </label> | |
19b53e5b C |
42 | </div> |
43 | <div class="api4-input form-inline" ng-mouseenter="help(name, param)" ng-mouseleave="help()" ng-repeat="(name, param) in availableParams" ng-if="!isSpecial(name) && param.type[0] === 'bool' && param.default === null"> | |
44 | <label>{{ name }}<span class="crm-marker" ng-if="param.required"> *</span></label> | |
45 | <label class="radio-inline"> | |
46 | <input type="radio" ng-model="params[name]" ng-value="true" />true | |
47 | </label> | |
48 | <label class="radio-inline"> | |
49 | <input type="radio" ng-model="params[name]" ng-value="false" />false | |
50 | </label> | |
51 | <a href class="crm-hover-button" title="Clear" ng-click="clearParam(name)" ng-show="params[name] !== null"><i class="crm-i fa-times"></i></a> | |
52 | </div> | |
53 | <div class="api4-input form-inline" ng-mouseenter="help('select', availableParams.select)" ng-mouseleave="help()" ng-if="availableParams.select && !isSelectRowCount()"> | |
54 | <label for="api4-param-select">select<span class="crm-marker" ng-if="availableParams.select.required"> *</span></label> | |
39e0f675 | 55 | <input class="collapsible-optgroups form-control" ng-list crm-ui-select="{data: selectFieldsAndJoins, multiple: true}" placeholder="*" id="api4-param-select" ng-model="params.select" style="width: 85%;"/> |
19b53e5b C |
56 | </div> |
57 | <div class="api4-input form-inline" ng-mouseenter="help('fields', availableParams.fields)" ng-mouseleave="help()"ng-if="availableParams.fields"> | |
58 | <label for="api4-param-fields">fields<span class="crm-marker" ng-if="availableParams.fields.required"> *</span></label> | |
59 | <input class="form-control" ng-list crm-ui-select="{data: fields, multiple: true}" id="api4-param-fields" ng-model="params.fields" style="width: 85%;"/> | |
60 | </div> | |
61 | <div class="api4-input form-inline" ng-mouseenter="help('action', availableParams.action)" ng-mouseleave="help()"ng-if="availableParams.action"> | |
62 | <label for="api4-param-action">action<span class="crm-marker" ng-if="availableParams.action.required"> *</span></label> | |
63 | <input class="form-control" crm-ui-select="{data: actions, allowClear: true, placeholder: 'None'}" id="api4-param-action" ng-model="params.action"/> | |
64 | </div> | |
65 | <div class="api4-input form-inline" ng-mouseenter="help(name, param)" ng-mouseleave="help()" ng-repeat="(name, param) in availableParams" ng-if="!isSpecial(name) && (param.type[0] === 'string' || param.type[0] === 'int')"> | |
66 | <label for="api4-param-{{ name }}">{{ name }}<span class="crm-marker" ng-if="param.required"> *</span></label> | |
67 | <input class="form-control" ng-if="!param.options" type="{{ param.type[0] === 'int' && param.type.length === 1 ? 'number' : 'text' }}" id="api4-param-{{ name }}" ng-model="params[name]"/> | |
68 | <select class="form-control" ng-if="param.options" ng-options="o for o in param.options" id="api4-param-{{ name }}" ng-model="params[name]"></select> | |
69 | <a href class="crm-hover-button" title="Clear" ng-click="clearParam(name)" ng-show="!!params[name]"><i class="crm-i fa-times"></i></a> | |
70 | </div> | |
71 | <div class="api4-input" ng-mouseenter="help(name, param)" ng-mouseleave="help()" ng-repeat="(name, param) in availableParams" ng-if="!isSpecial(name) && (param.type[0] === 'array' || param.type[0] === 'mixed')"> | |
72 | <label for="api4-param-{{ name }}">{{ name }}<span class="crm-marker" ng-if="param.required"> *</span></label> | |
73 | <textarea class="form-control" type="{{ param.type[0] === 'int' && param.type.length === 1 ? 'number' : 'text' }}" id="api4-param-{{ name }}" ng-model="params[name]"> | |
74 | </textarea> | |
75 | </div> | |
76 | <fieldset ng-if="availableParams.where" class="api4-where-fieldset" ng-mouseenter="help('where', availableParams.where)" ng-mouseleave="help()" crm-api4-where-clause="{where: params.where, required: availableParams.where.required, op: 'AND', label: 'where', fields: fieldsAndJoins}"> | |
77 | </fieldset> | |
bb3786d2 CW |
78 | <fieldset ng-repeat="name in ['values', 'defaults']" ng-if="availableParams[name]" ng-mouseenter="help(name, availableParams[name])" ng-mouseleave="help()"> |
79 | <legend>{{ name }}<span class="crm-marker" ng-if="availableParams[name].required"> *</span></legend> | |
80 | <div class="api4-input form-inline" ng-repeat="clause in params[name]" ng-mouseenter="help('value: ' + clause[0], fieldHelp(clause[0]))" ng-mouseleave="help(name, availableParams[name])"> | |
81 | <input class="collapsible-optgroups form-control" ng-model="clause[0]" crm-ui-select="{formatResult: formatSelect2Item, formatSelection: formatSelect2Item, data: fieldList(name), allowClear: true, placeholder: 'Field'}" /> | |
c752d94b | 82 | <input class="form-control" ng-model="clause[1]" api4-exp-value="{field: clause[0], action: action === 'getFields' ? params.action || 'get' : action}" /> |
19b53e5b C |
83 | </div> |
84 | <div class="api4-input form-inline"> | |
bb3786d2 | 85 | <input class="collapsible-optgroups form-control" ng-model="controls[name]" crm-ui-select="{formatResult: formatSelect2Item, formatSelection: formatSelect2Item, data: fieldList(name), placeholder: ts('Add %1', {1: name.slice(0, -1)})}"/> |
19b53e5b C |
86 | </div> |
87 | </fieldset> | |
88 | <fieldset ng-if="availableParams.orderBy" ng-mouseenter="help('orderBy', availableParams.orderBy)" ng-mouseleave="help()"> | |
89 | <legend>orderBy<span class="crm-marker" ng-if="availableParams.orderBy.required"> *</span></legend> | |
90 | <div class="api4-input form-inline" ng-repeat="clause in params.orderBy"> | |
91 | <input class="collapsible-optgroups form-control" ng-model="clause[0]" crm-ui-select="{data: fieldsAndJoins, allowClear: true, placeholder: 'Field'}" /> | |
92 | <select class="form-control" ng-model="clause[1]"> | |
93 | <option value="ASC">ASC</option> | |
94 | <option value="DESC">DESC</option> | |
95 | </select> | |
96 | </div> | |
97 | <div class="api4-input form-inline"> | |
98 | <input class="collapsible-optgroups form-control" ng-model="controls.orderBy" crm-ui-select="{data: fieldsAndJoins}" placeholder="Add orderBy" /> | |
99 | </div> | |
100 | </fieldset> | |
101 | <fieldset ng-if="availableParams.chain" ng-mouseenter="help('chain', availableParams.chain)" ng-mouseleave="help()"> | |
102 | <legend>chain</legend> | |
103 | <div class="api4-input form-inline" ng-repeat="clause in params.chain" api4-exp-chain="clause" entities="entities" main-entity="entity" > | |
104 | </div> | |
105 | <div class="api4-input form-inline"> | |
106 | <input class="form-control" ng-model="controls.chain" crm-ui-select="{data: entities}" placeholder="Add chain" /> | |
107 | </div> | |
108 | </fieldset> | |
109 | </div> | |
110 | </form> | |
111 | <div class="panel panel-info explorer-help-panel"> | |
112 | <div class="panel-heading"> | |
113 | <h3 class="panel-title" crm-icon="fa-info-circle">{{ helpTitle }}</h3> | |
114 | </div> | |
115 | <div class="panel-body"> | |
136ca5bb CW |
116 | <h4 ng-bind-html="helpContent.description"></h4> |
117 | <div ng-bind-html="helpContent.comment"></div> | |
0493ec47 | 118 | <p ng-repeat="(key, item) in helpContent" ng-if="key !== 'description' && key !== 'comment' && key !== 'see'"> |
19b53e5b C |
119 | <strong>{{ key }}:</strong> {{ item }} |
120 | </p> | |
0493ec47 CW |
121 | <div ng-if="helpContent.see"> |
122 | <strong>See:</strong> | |
123 | <ul> | |
fc95d9a5 | 124 | <li ng-repeat="ref in helpContent.see" ng-bind-html="ref"> </li> |
0493ec47 CW |
125 | </ul> |
126 | </div> | |
19b53e5b C |
127 | </div> |
128 | </div> | |
129 | </div> | |
130 | <div class="api4-explorer-row"> | |
131 | <div class="panel panel-warning explorer-code-panel"> | |
19d01932 CW |
132 | <ul class="panel-heading nav nav-tabs"> |
133 | <li role="presentation" ng-repeat="tab in code" ng-class="{active: selectedTab.code === tab.lang}"> | |
134 | <a href ng-click="selectedTab.code = tab.lang"> | |
135 | {{ tab.lang }} | |
136 | </a> | |
137 | </li> | |
138 | </ul> | |
19b53e5b | 139 | <div class="panel-body"> |
19d01932 CW |
140 | <table ng-repeat="tab in code" ng-show="selectedTab.code === tab.lang"> |
141 | <tr ng-repeat="style in tab.style"> | |
142 | <td>{{ style.label }}</td> | |
143 | <td><pre class="prettyprint" ng-bind-html="style.code"></pre></td> | |
19b53e5b C |
144 | </tr> |
145 | </table> | |
146 | </div> | |
147 | </div> | |
148 | <div class="panel explorer-result-panel panel-{{ status }}" > | |
b65fa6dc | 149 | <ul class="panel-heading nav nav-tabs"> |
19d01932 CW |
150 | <li role="presentation" ng-class="{active: selectedTab.result === 'result'}"> |
151 | <a href ng-click="selectedTab.result = 'result'"> | |
b65fa6dc CW |
152 | <i class="fa fa-fw fa-circle-o" ng-if="status === 'default'"></i> |
153 | <i class="fa fa-fw fa-check-circle" ng-if="status === 'success'"></i> | |
154 | <i class="fa fa-fw fa-minus-circle" ng-if="status === 'danger'"></i> | |
155 | <i class="fa fa-fw fa-spinner fa-pulse" ng-if="status === 'warning'"></i> | |
156 | <span>{{ ts('Result') }}</span> | |
157 | </a> | |
158 | </li> | |
19d01932 CW |
159 | <li role="presentation" ng-if="perm.accessDebugOutput" ng-class="{active: selectedTab.result === 'debug'}"> |
160 | <a href ng-click="selectedTab.result = 'debug'"> | |
b65fa6dc CW |
161 | <i class="fa fa-fw fa-{{ debug ? 'bug' : 'circle-o' }}"></i> |
162 | <span>{{ ts('Debug') }}</span> | |
163 | </a> | |
164 | </li> | |
165 | </ul> | |
19b53e5b | 166 | <div class="panel-body"> |
19d01932 | 167 | <div ng-show="selectedTab.result === 'result'"> |
b65fa6dc CW |
168 | <pre class="prettyprint" ng-repeat="code in result" ng-bind-html="code"></pre> |
169 | </div> | |
19d01932 | 170 | <div ng-show="selectedTab.result === 'debug'"> |
b65fa6dc CW |
171 | <pre ng-if="debug" class="prettyprint" ng-bind-html="debug"></pre> |
172 | <p ng-if="!debug"> | |
173 | {{ ts('To view debugging output, enable the debug param before executing.') }} | |
174 | </p> | |
175 | <p ng-if="!debug"> | |
176 | {{ ts('Enable backtrace in system settings to see error backtraces.') }} | |
177 | </p> | |
178 | </div> | |
19b53e5b C |
179 | </div> |
180 | </div> | |
181 | </div> | |
19b53e5b | 182 | </div> |