Spaces:
No application file
No application file
File size: 8,561 Bytes
d2897cd |
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 |
<?php
namespace Mautic\LeadBundle\Controller\Api;
use Doctrine\ORM\Tools\Pagination\Paginator;
use Mautic\CoreBundle\Cache\ResultCacheOptions;
use Mautic\LeadBundle\Entity\Company;
use Mautic\LeadBundle\Entity\CustomFieldEntityInterface;
use Mautic\LeadBundle\Entity\Lead;
use Mautic\LeadBundle\Entity\LeadField;
use Mautic\LeadBundle\Model\FieldModel;
use Symfony\Component\Form\Form;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RequestStack;
trait CustomFieldsApiControllerTrait
{
private ?RequestStack $requestStack = null;
/**
* @var mixed[]
*/
private $fieldCache = [];
/**
* Remove IpAddress and lastActive as it'll be handled outside the form.
*
* @param mixed[] $parameters
* @param Lead|Company $entity
* @param string $action
*
* @return mixed|void
*/
protected function prepareParametersForBinding(Request $request, $parameters, $entity, $action)
{
if ('company' === $this->entityNameOne) {
$object = 'company';
} else {
$object = 'lead';
unset($parameters['lastActive'], $parameters['tags'], $parameters['ipAddress']);
}
if (in_array($request->getMethod(), ['POST', 'PUT'])) {
// If a new contact or PUT update (complete representation of the objectd), set empty fields to field defaults if the parameter
// is not defined in the request
/** @var FieldModel $fieldModel */
$fieldModel = $this->getModel('lead.field');
$fields = $fieldModel->getFieldListWithProperties($object);
foreach ($fields as $alias => $field) {
// Set the default value if the parameter is not included in the request, there is no value for the given entity, and a default is defined
$currentValue = $entity->getFieldValue($alias);
if (!isset($parameters[$alias]) && ('' === $currentValue || null == $currentValue) && '' !== $field['defaultValue'] && null !== $field['defaultValue']) {
$parameters[$alias] = $field['defaultValue'];
}
}
}
return $parameters;
}
/**
* Flatten fields into an 'all' key for dev convenience.
*/
protected function preSerializeEntity(object $entity, string $action = 'view'): void
{
if ($entity instanceof CustomFieldEntityInterface) {
$fields = $entity->getFields();
$fields['all'] = $entity->getProfileFields();
// Temporary hack to address numbers being type casted to float which broke some API implementations because M2 used to return
// these as strings and values are normalized in a dozen differneet ways throughout LeadModel::setFieldValues methods and became
// too risky to hotfix
$fields = $this->fixNumbers($fields);
$entity->setFields($fields);
}
}
/**
* @param mixed[] $fields
*
* @return mixed[]
*/
private function fixNumbers(array $fields): array
{
$numberFields = [];
foreach ($fields as $group => $groupFields) {
if ('all' === $group) {
continue;
}
foreach ($groupFields as $field => $fieldDefinition) {
if ('points' === $field) {
// Points were always a number in M2
$numberFields[$field] = (int) $fields[$group][$field]['value'];
}
if ('number' !== $fieldDefinition['type'] || null === $fields[$group][$field]['value']) {
continue;
}
// Some requests don't seem to have properties unserialized by default (even in M2)
if (!isset($fieldDefinition['properties'])) {
$fieldDefinition['properties'] = [];
}
$properties = is_string($fieldDefinition['properties']) ? unserialize($fieldDefinition['properties']) : $fieldDefinition['properties'];
$fields[$group][$field]['value'] = empty($properties['scale']) ? (int) $fields[$group][$field]['value']
: (float) $fields[$group][$field]['value'];
$fields[$group][$field]['normalizedValue'] = empty($properties['scale']) ? (int) $fields[$group][$field]['normalizedValue']
: (float) $fields[$group][$field]['normalizedValue'];
$numberFields[$field] = $fields[$group][$field]['value'];
}
}
// Fix "all" fields
$fields['all'] = array_merge($fields['all'], $numberFields);
return $fields;
}
/**
* @return array<string, mixed>
*/
protected function getEntityFormOptions(): array
{
$object = ('company' === $this->entityNameOne) ? 'company' : 'lead';
if (isset($this->fieldCache[$object])) {
return $this->fieldCache[$object];
}
$model = $this->getModel('lead.field');
\assert($model instanceof FieldModel);
$fields = $model->getEntities(
[
'filter' => [
'force' => [
[
'column' => 'f.isPublished',
'expr' => 'eq',
'value' => true,
],
[
'column' => 'f.object',
'expr' => 'eq',
'value' => $object,
],
],
],
'hydration_mode' => 'HYDRATE_ARRAY',
'result_cache' => new ResultCacheOptions(LeadField::CACHE_NAMESPACE),
]
);
\assert($fields instanceof Paginator);
$this->fieldCache[$object] = ['fields' => $fields->getIterator()];
return $this->fieldCache[$object];
}
/**
* @param Lead|Company $entity
* @param Form $form
* @param mixed[] $parameters
* @param bool $isPostOrPatch
*
* @return bool|void
*/
protected function setCustomFieldValues($entity, $form, $parameters, $isPostOrPatch = false)
{
// set the custom field values
// pull the data from the form in order to apply the form's formatting
foreach ($form as $f) {
$parameters[$f->getName()] = $f->getData();
}
if ($isPostOrPatch) {
// Don't overwrite the contacts accumulated points
if (isset($parameters['points']) && empty($parameters['points'])) {
unset($parameters['points']);
}
// When merging a contact because of a unique identifier match in POST /api/contacts//new or PATCH /api/contacts//edit all 0 values must be unset because
// we have to assume 0 was not meant to overwrite an existing value. Other empty values will be caught by LeadModel::setFieldValues
$parameters = array_filter(
$parameters,
function ($value): bool {
if (is_numeric($value)) {
return 0 !== (int) $value;
}
return true;
}
);
}
$overwriteWithBlank = !$isPostOrPatch;
if (isset($parameters['overwriteWithBlank']) && !empty($parameters['overwriteWithBlank'])) {
$overwriteWithBlank = true;
unset($parameters['overwriteWithBlank']);
}
$this->model->setFieldValues($entity, $parameters, $overwriteWithBlank);
}
/**
* @param string $object
*
* @return void
*/
protected function setCleaningRules($object = 'lead')
{
$leadFieldModel = $this->getModel('lead.field');
\assert($leadFieldModel instanceof FieldModel);
$fields = $leadFieldModel->getFieldListWithProperties($object);
foreach ($fields as $field) {
if (!empty($field['properties']['allowHtml'])) {
$this->dataInputMasks[$field['alias']] = 'html'; /** @phpstan-ignore-line this is accessing a property from the parent class. Terrible. Refactor for M6. */
}
}
}
#[\Symfony\Contracts\Service\Attribute\Required]
public function setRequestStack(RequestStack $requestStack): void
{
$this->requestStack = $requestStack;
}
}
|