dev/core#4031 Export dates from SearchKit to spreadsheet in SQL format

[larssandergreen]

Before

From SearchKit Download Spreadsheet, dates are formatted in Complete Date and Time format. The default for this format is not readily recognized as a date in spreadsheets.

After

Dates are formatted in SQL DATETIME or DATE format for csv, xlxs and ods downloads. No change in pdfs, SearchKit itself or for dates that have been re-written in a Display.

[civibot]

No issue was found matching the number given in the pull request title. Please check the issue number.

[civibot]

(Standard links)

• If you are reviewing this pull-request, you may wish to consult the test sites and the Review Standards (long template, short template).

[colemanw]

This is definitely the functionality we want, but I'm concerned the code might be better placed in Civi\Api4\Action\SearchDisplay\Download::formatColumnValue() as that's more specific to the Download action.

[larssandergreen]

@colemanw I hear you, that would be cleaner. But by the time we're in formatColumnValue() the date is already formatted, so I think we have to go back to the point where it is in SQL format, rather than trying to work backwards from the formatted value. Or we could pass the raw value and data type along from AbstractRunAction::formatColumn(), so we're able to use it in formatColumnValue(), but that seems like a lot just for the rare case when we are downloading a spreadsheet with dates.

But it's not unlikely that I'm missing an obvious cleaner option - welcome any thoughts you have on a better approach.

[larssandergreen]

@colemanw How about something like this that keeps it all in Download?

[larssandergreen]

I'll update the tests if this makes sense.

[colemanw]

What is the purpose of this new param $dataType? I don't see it ever being passed into either this function nor Download:: formatViewValue.

[larssandergreen]

This is so that Download::formatViewValue can pass the result of $this->getSelectExpression($key)['dataType'] to AbstractRunAction::formatViewValue, so we don't have to do it twice for every row we download. Just thought if we're downloading 10k rows, maybe we want to avoid redundant steps.

[colemanw]

Ok, following the code to $this->getSelectExpression($key) it looks pretty efficient, it's just grabbing the value from a cached array. I don't think you're gaining any performance there, but I could see it as a code simplification if you make the $dataType param required and do not look it up within this function at all.

[colemanw]

Current revision looks great. Thanks for your work on this @larssandergreen - nice job!

[larssandergreen]

Great, thanks @colemanw for your help on this.