EXT: Readable name of your extension¶

What is this?¶

This is extension for quick export SQL table or query/ies to CSV file/s. You may configure number of files which will be available, for every file using their own settings, select different table, fields which will be exported, standard parts of MySQL query, file charset, csv fields separator and more. All that is fast and easy, using included example TypoScript.

You may also parse selected fields with own methods, like tstamp to human-readable date.

For what do I need it?¶

If you have data set in db, eg. some orders or contest answers, that must be quick sent to someone by email, or periodically downloaded by someone, or something like that, this extension is very useful.

Just make new page, insert plugin and set up the file, that will be downloaded by other or specified users, which you may specify by standard TYPO3 access settings.

It’s simple and easy to configure, additionally you may process selected fields using some functions, eg. convert timestamps to human- readable strings.

Want something more functional? It is a good base to develop something bigger.

Screenshots¶

Basic¶

Simply insert plugin on new page named eg. ‘CSV export’ and configure input and output using TypoScript.

A Backend Section type page is good idea, you might control download access for backend non-admin users.

To download file, you have to access url using ?f=[configuration_key], as here:

http://example.com/csv_export.html ?f=somestuff_orders

Note, that this plugin is not basing on standard TYPO3 page type handling, but is changing headers for whole page containing it, so do not insert it on standard frontend pages with normal content.

But it’s possible to make CSV output of any page uid using page type, if you use a snippet from Configuration/TypoScript/Setup/setup.ts

Caution where do you insert this plugin and what is exported!

Using in own plugins¶

One time I needed to display link to csv in my other plugin context. This needs to make query2csv object, prepare and pass config to it, and call when requested.

This can be done like:

$content .= '<a href="'.GeneralUtility::linkThisUrl($_SERVER['REQUEST_URI'], array('action' => 'getfile', 'f' => 'my_file')) . '">download file</a>';


if ($_GET['action'] == 'getfile')       {
        require_once(ExtensionManagementUtility::extPath('w_query2csv').'Classes/Plugins/Export.php');

        $conf = [
                'debug_allowed' => 0,
                'files.' => [
                        'my_file.' => [
                                'input.' => [
                                        'table' => 'tx_myext_table',
                                        'fields' => 'uid, crdate, name, value',
                                        'where' => 'AND type = 2',
                                        'order' => 'uid DESC',
                                        'limit' => 100,
                                ],
                                'output.' => [
                                        'filename' => 'output.csv',
                                        'process_fields.' => [
                                                'crdate' => 'WoloPl\WQuery2csv\Process->parseDate',
        ]]]]];


        $Q2csv = GeneralUtility::makeInstance('tx_wquery2csv_export');

        $Q2csv->main('', $conf);
        // note, that the script now throw output and exits!
}

((generated))¶

plugin.tx_wquery2csv_export  {
    files   {
        my_file {
            input {
              table = tx_somestuff_orders
              fields = tstamp,name,email,phone,stuff_uid
              where = category = 2
              group =
              order = tstamp DESC
              limit =
              enable_columns = 1
            }
            output {
              filename = somestuff_orders.csv
              separator = ,
              encoding =
              process_fields {
                tstamp = WoloPl\WQuery2csv\Process->parseDate
              }
            }
        }

        .... (some other keys with input and output options to access file using ?f=some_other_key)
    }

    debug_allowed = 1
}

plugin.tx_wquery2csv_export.files.my_file.input.table = tx_sometable

Reference / options description¶

tstamp = WoloPl\WQuery2csv\Process->parseDate
tstamp.format = d.m.Y H:i

->parseDate

.format = [string]

->valueMap

.map {    [array]
    source value = Export Value
    [in val = out val pairs]
}

->staticValue

.value = [string]

->unserialize

->tableLabelsFromRecordsCommalist

PLEASE REMEMBER¶

This is a low-level database exporter, which was intended to use by admins to easy download customized csv with product orders. Such things are always potentially dangerous if used in wrong way. Downloading full database tables by people who are not permitted may be a disaster - passwords leak, session hijack, etc… - so better check twice where do you put this plugin and what have you configured there, to not allow downloading any sensitive data by mistake!

I recommend always embeding it on pages with BE-user or admin access only, unless you are sure what are you doing.

Migrate from version 0.1¶

- typoscript setup key is now: plugin.tx_wquery2csv_export instead of plugin.tx_wquery2csv_pi1

- so the plugin content element embeded on page must be selected again and setup must be adjusted

- process_fields now expects full userfunc reference

- so, _process_parseDate option is now: WoloPlWQuery2csvProcess->parseDate

- process_fields_user is now removed, use process_fields instead, just like the rest

- output.where now need to be full, not starting from “AND”