-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactored required and permitted calculations.Moved attribute collec…
…tions parts to elements.
- Loading branch information
Showing
10 changed files
with
269 additions
and
145 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
107 changes: 0 additions & 107 deletions
107
app/plugins/CoreEnroller/templates/AttributeCollectors/multifield_attribute.inc
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| <?php | ||
| /** | ||
| * COmanage Registry Attribute Field | ||
| * | ||
| * Portions licensed to the University Corporation for Advanced Internet | ||
| * Development, Inc. ("UCAID") under one or more contributor license agreements. | ||
| * See the NOTICE file distributed with this work for additional information | ||
| * regarding copyright ownership. | ||
| * | ||
| * UCAID licenses this file to you under the Apache License, Version 2.0 | ||
| * (the "License"); you may not use this file except in compliance with the | ||
| * License. You may obtain a copy of the License at: | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| * | ||
| * @link https://www.internet2.edu/comanage COmanage Project | ||
| * @package registry | ||
| * @since COmanage Registry v5.0.0 | ||
| * @license Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0) | ||
| */ | ||
|
|
||
| declare(strict_types = 1); | ||
|
|
||
| use \Cake\Utility\Inflector; | ||
|
|
||
| // $attr: Obj | ||
|
|
||
| // Field Options array | ||
| $options = []; | ||
|
|
||
| // Get the static configuration of my attribute | ||
| $supportedAttributes = $this->Petition->getSupportedEnrollmentAttribute($attr->attribute); | ||
|
|
||
| // Do we have a default value configured? | ||
| // Either a value or an Environmental Variable, | ||
| // Each default value is mutually exclusive to the rest. We do not have to worry about a conflict. | ||
| $options['default'] = match(true) { | ||
| isset($attr->default_value) => $attr->default_value, | ||
| isset($attr->default_value_env_name) | ||
| && getenv($attr->default_value_env_name) !== false => getenv($attr->default_value_env_name), | ||
| isset($attr->default_value_datetime) => $attr->default_value_datetime, | ||
| default => '' | ||
| }; | ||
|
|
||
| // If we are re-rendering the Petition override the default value with whatever | ||
| // was previously saved | ||
| if(!empty($vv_petition_attributes)) { | ||
| $curEntity = $vv_petition_attributes->firstMatch(['enrollment_attribute_id' => $attr->id]); | ||
|
|
||
| if(!empty($curEntity->value)) { | ||
| $options['default'] = $curEntity->value; | ||
| } | ||
| } | ||
|
|
||
| // Construct the field arguments | ||
| $formArguments = [ | ||
| // We prefix the attribute ID with a string because Cake seems to sometimes have | ||
| // problems with field names that are purely integers (even if cast to strings) | ||
| 'fieldName' => 'field-' . $attr->id, | ||
| 'fieldLabel' => $attr->label, // fieldLabel is only applicable to checkboxes | ||
| 'fieldType' => $supportedAttributes['fieldType'], | ||
| 'fieldDescription' => $attr->description, | ||
| 'fieldNameAlias' => $attr->attribute // the field name to its enrollment attribute field name | ||
| ]; | ||
|
|
||
|
|
||
| /* | ||
| * Get the values for the attributes ending with _id | ||
| * Supported for attributes: group_id, cou_id, affiliation_type_id | ||
| */ | ||
| if(str_ends_with($attr->attribute, '_id')) { | ||
| $suffix = substr($attr->attribute, 0, -3); | ||
| $suffix = Inflector::pluralize(Inflector::camelize($suffix)) ; | ||
| $defaultValuesPopulated = 'defaultValue' . $suffix; | ||
| if ($this->get($defaultValuesPopulated) !== null) { | ||
| $formArguments['fieldType'] = 'select'; | ||
| $formArguments['fieldSelectOptions'] = $this->get($defaultValuesPopulated); | ||
| } | ||
| } | ||
|
|
||
| // READ-ONLY | ||
| if (isset($attr->modifiable) && !$attr->modifiable) { | ||
| $options['readonly'] = true; | ||
| } | ||
|
|
||
| // REQUIRED | ||
| if (isset($attr->required) && $attr->required) { | ||
| $options['required'] = true; | ||
| } | ||
|
|
||
| // Set the final fieldOptions | ||
| $formArguments['fieldOptions'] = $options; | ||
|
|
||
| // HIDDEN Field | ||
| // We print directly, we do not delegate to the element for further processing | ||
| if ($attr->hidden) { | ||
| // In case this is a hidden field, we need to get only the value | ||
| print $this->Form->hidden($formArguments['fieldName'], ['value' => $options['default']]); | ||
| } else { | ||
| // Print the element | ||
| print $this->element('form/listItem', [ | ||
| 'arguments' => $formArguments | ||
| ]); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
86 changes: 86 additions & 0 deletions
86
app/plugins/CoreEnroller/templates/element/mveas/fieldset-group.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| <?php | ||
| /** | ||
| * COmanage Registry Fields Set Group | ||
| * | ||
| * Portions licensed to the University Corporation for Advanced Internet | ||
| * Development, Inc. ("UCAID") under one or more contributor license agreements. | ||
| * See the NOTICE file distributed with this work for additional information | ||
| * regarding copyright ownership. | ||
| * | ||
| * UCAID licenses this file to you under the Apache License, Version 2.0 | ||
| * (the "License"); you may not use this file except in compliance with the | ||
| * License. You may obtain a copy of the License at: | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| * | ||
| * @link https://www.internet2.edu/comanage COmanage Project | ||
| * @package registry | ||
| * @since COmanage Registry v5.0.0 | ||
| * @license Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0) | ||
| */ | ||
|
|
||
| declare(strict_types = 1); | ||
|
|
||
| use \Cake\Utility\Inflector; | ||
|
|
||
| // $attr: object | ||
|
|
||
|
|
||
| // Grouped fields | ||
| $groupedFieldsVar = $attr->attribute . 'GroupedFields'; | ||
| $groupedFieldsArray = []; | ||
| if(!empty($$groupedFieldsVar)) { | ||
| $groupedFieldsArray = collection(array_keys($$groupedFieldsVar))->map(static fn($fields) => explode(',', $fields))->toArray(); | ||
| } | ||
|
|
||
| $permitted_fields_list = []; | ||
| $permitted_fields_variable_name = 'permitted_fields_' . Inflector::underscore($attr->attribute); | ||
| if (!empty($cosettings[0][$permitted_fields_variable_name])) { | ||
| $permitted_fields_list = explode(',', $cosettings[0][$permitted_fields_variable_name]); | ||
| } | ||
| // Address has no permitted fields configuration at CO level. And according to our design, | ||
| // the permitted fields are found in CoSettings. | ||
| // For all the attributes that have no permitted configuration at the CO level, | ||
| // we will get all the fields that we support | ||
| // We will construct the list of permitted fields from the list of required fields. | ||
| // The permitted fields will be the set that contains all the required fields. | ||
| $requiredDropDownListVar = $attr->attribute . 'RequiredFields'; | ||
| if(empty($permitted_fields_list) && !empty($$requiredDropDownListVar)) { | ||
| usort($$requiredDropDownListVar, static fn($a, $b) => count(explode(',', $a)) <=> count(explode(',', $b))); | ||
| $permitted_fields = end($$requiredDropDownListVar); | ||
| $permitted_fields_list = collection(explode(',', $permitted_fields))->map(fn($value) => trim($value)); | ||
| } | ||
|
|
||
| ?> | ||
|
|
||
| <?php foreach($groupedFieldsArray as $idx => $fields): ?> | ||
| <div class="fieldset-subgroup"> | ||
| <?php | ||
| $permitted_fields_list = $permitted_fields_list->map(static fn($value) => str_replace(' ', '_', Inflector::underscore($value))); | ||
| foreach($fields as $field) { | ||
| if($permitted_fields_list->contains($field)) { | ||
| // Print the element | ||
| print $this->element('CoreEnroller.mveas/fieldset-field', compact('field', 'attr')); | ||
| } | ||
| // Remove the field we render from the permitted list. | ||
| $permitted_fields_list = $permitted_fields_list->filter(fn($value) => $value !== $field); | ||
| } | ||
| ?> | ||
| </div> | ||
| <?php endforeach; ?> | ||
|
|
||
| <?php | ||
|
|
||
| // For all the remaining fields we do not need a group | ||
| foreach ($permitted_fields_list as $field) { | ||
| print $this->element('CoreEnroller.mveas/fieldset-field', compact('field', 'attr')); | ||
| } | ||
| ?> | ||
|
|
||
|
|
Oops, something went wrong.