mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2024-11-29 20:23:51 -06:00
332 lines
13 KiB
PHP
332 lines
13 KiB
PHP
<?php
|
|
/**
|
|
* csv.php
|
|
* Copyright (c) 2017 thegrumpydictator@gmail.com
|
|
*
|
|
* This file is part of Firefly III.
|
|
*
|
|
* Firefly III is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* Firefly III is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
declare(strict_types=1);
|
|
|
|
|
|
return [
|
|
|
|
/*
|
|
* Configuration for the CSV specifics.
|
|
*/
|
|
'import_specifics' => [
|
|
'IngDescription' => 'FireflyIII\Import\Specifics\IngDescription',
|
|
'RabobankDescription' => 'FireflyIII\Import\Specifics\RabobankDescription',
|
|
'AbnAmroDescription' => 'FireflyIII\Import\Specifics\AbnAmroDescription',
|
|
'SnsDescription' => 'FireflyIII\Import\Specifics\SnsDescription',
|
|
'PresidentsChoice' => 'FireflyIII\Import\Specifics\PresidentsChoice',
|
|
],
|
|
|
|
/*
|
|
* Configuration for possible column roles.
|
|
*
|
|
* The key is the short name for the column role. There are five values, which mean this:
|
|
*
|
|
* 'mappable'
|
|
* Whether or not the value in the CSV column can be linked to an existing value in your
|
|
* Firefly database. For example: account names can be linked to existing account names you have already
|
|
* so double entries cannot occur. This process is called "mapping". You have to make each unique value in your
|
|
* CSV file to an existing entry in your database. For example, map all account names in your CSV file to existing
|
|
* accounts. If you have an entry that does not exist in your database, you can set Firefly to ignore it, and it will
|
|
* create it.
|
|
*
|
|
* 'pre-process-map'
|
|
* In the case of tags, there are multiple values in one csv column (for example: "expense groceries snack" in one column).
|
|
* This means the content of the column must be "pre processed" aka split in parts so the importer can work with the data.
|
|
*
|
|
* 'pre-process-mapper'
|
|
* This is the class that will actually do the pre-processing.
|
|
*
|
|
* 'field'
|
|
* I don't believe this value is used any more, but I am not sure.
|
|
*
|
|
* 'converter'
|
|
* The converter is a class in app/Import/Converter that converts the given value into an object Firefly understands.
|
|
* The CategoryName converter can convert a category name into an actual category. This converter will take a mapping
|
|
* into account: if you mapped "Groceries" to category "Groceries" the converter will simply return "Groceries" instead of
|
|
* trying to make a new category also named Groceries.
|
|
*
|
|
* 'mapper'
|
|
* When you map data (see "mappable") you need a list of stuff you can map to. If you say a certain column is mappable
|
|
* and the column contains "category names", the mapper will be "Category" and it will give you a list of possible categories.
|
|
* This way the importer always presents you with a valid list of things to map to.
|
|
*
|
|
*
|
|
*
|
|
*/
|
|
'import_roles' => [
|
|
'_ignore' => [
|
|
'mappable' => false,
|
|
'pre-process-map' => false,
|
|
'field' => 'ignored',
|
|
'converter' => 'Ignore',
|
|
'mapper' => null,
|
|
|
|
|
|
],
|
|
'bill-id' => [
|
|
'mappable' => true,
|
|
'pre-process-map' => false,
|
|
'field' => 'bill',
|
|
'converter' => 'BillId',
|
|
'mapper' => 'Bills',
|
|
],
|
|
'bill-name' => [
|
|
'mappable' => true,
|
|
'pre-process-map' => false,
|
|
'field' => 'bill',
|
|
'converter' => 'BillName',
|
|
'mapper' => 'Bills',
|
|
],
|
|
'currency-id' => [
|
|
'mappable' => true,
|
|
'pre-process-map' => false,
|
|
'field' => 'currency',
|
|
'converter' => 'CurrencyId',
|
|
'mapper' => 'TransactionCurrencies',
|
|
],
|
|
'currency-name' => [
|
|
'mappable' => true,
|
|
'pre-process-map' => false,
|
|
'converter' => 'CurrencyName',
|
|
'field' => 'currency',
|
|
'mapper' => 'TransactionCurrencies',
|
|
],
|
|
'currency-code' => [
|
|
'mappable' => true,
|
|
'pre-process-map' => false,
|
|
'converter' => 'CurrencyCode',
|
|
'field' => 'currency',
|
|
'mapper' => 'TransactionCurrencies',
|
|
],
|
|
'external-id' => [
|
|
'mappable' => false,
|
|
'pre-process-map' => false,
|
|
'converter' => 'ExternalId',
|
|
'field' => 'external-id',
|
|
],
|
|
|
|
'currency-symbol' => [
|
|
'mappable' => true,
|
|
'pre-process-map' => false,
|
|
'converter' => 'CurrencySymbol',
|
|
'field' => 'currency',
|
|
'mapper' => 'TransactionCurrencies',
|
|
],
|
|
'description' => [
|
|
'mappable' => false,
|
|
'pre-process-map' => false,
|
|
'converter' => 'Description',
|
|
'field' => 'description',
|
|
],
|
|
'date-transaction' => [
|
|
'mappable' => false,
|
|
'pre-process-map' => false,
|
|
'converter' => 'Date',
|
|
'field' => 'date',
|
|
],
|
|
'date-interest' => [
|
|
'mappable' => false,
|
|
'pre-process-map' => false,
|
|
'converter' => 'Date',
|
|
'field' => 'date-interest',
|
|
],
|
|
'date-book' => [
|
|
'mappable' => false,
|
|
'pre-process-map' => false,
|
|
'converter' => 'Date',
|
|
'field' => 'date-book',
|
|
],
|
|
'date-process' => [
|
|
'mappable' => false,
|
|
'pre-process-map' => false,
|
|
'converter' => 'Date',
|
|
'field' => 'date-process',
|
|
],
|
|
'budget-id' => [
|
|
'mappable' => true,
|
|
'pre-process-map' => false,
|
|
'converter' => 'BudgetId',
|
|
'field' => 'budget',
|
|
'mapper' => 'Budgets',
|
|
],
|
|
'budget-name' => [
|
|
'mappable' => true,
|
|
'pre-process-map' => false,
|
|
'converter' => 'BudgetName',
|
|
'field' => 'budget',
|
|
'mapper' => 'Budgets',
|
|
],
|
|
'rabo-debet-credit' => [
|
|
'mappable' => false,
|
|
'pre-process-map' => false,
|
|
'converter' => 'RabobankDebetCredit',
|
|
'field' => 'amount-modifier',
|
|
],
|
|
'ing-debet-credit' => [
|
|
'mappable' => false,
|
|
'pre-process-map' => false,
|
|
'converter' => 'INGDebetCredit',
|
|
'field' => 'amount-modifier',
|
|
],
|
|
'category-id' => [
|
|
'mappable' => true,
|
|
'pre-process-map' => false,
|
|
'converter' => 'CategoryId',
|
|
'field' => 'category',
|
|
'mapper' => 'Categories',
|
|
],
|
|
'category-name' => [
|
|
'mappable' => true,
|
|
'pre-process-map' => false,
|
|
'converter' => 'CategoryName',
|
|
'field' => 'category',
|
|
'mapper' => 'Categories',
|
|
],
|
|
'tags-comma' => [
|
|
'mappable' => false,
|
|
'pre-process-map' => true,
|
|
'pre-process-mapper' => 'TagsComma',
|
|
'field' => 'tags',
|
|
'converter' => 'TagsComma',
|
|
'mapper' => 'Tags',
|
|
],
|
|
'tags-space' => [
|
|
'mappable' => false,
|
|
'pre-process-map' => true,
|
|
'pre-process-mapper' => 'TagsSpace',
|
|
'field' => 'tags',
|
|
'converter' => 'TagsSpace',
|
|
'mapper' => 'Tags',
|
|
],
|
|
'account-id' => [
|
|
'mappable' => true,
|
|
'pre-process-map' => false,
|
|
'field' => 'asset-account-id',
|
|
'converter' => 'AccountId',
|
|
'mapper' => 'AssetAccounts',
|
|
],
|
|
'account-name' => [
|
|
'mappable' => true,
|
|
'pre-process-map' => false,
|
|
'field' => 'asset-account-name',
|
|
'converter' => 'AssetAccountName',
|
|
'mapper' => 'AssetAccounts',
|
|
],
|
|
'account-iban' => [
|
|
'mappable' => true,
|
|
'pre-process-map' => false,
|
|
'field' => 'asset-account-iban',
|
|
'converter' => 'AssetAccountIban',
|
|
'mapper' => 'AssetAccountIbans',
|
|
|
|
],
|
|
'account-number' => [
|
|
'mappable' => true,
|
|
'pre-process-map' => false,
|
|
'field' => 'asset-account-number',
|
|
'converter' => 'AssetAccountNumber',
|
|
'mapper' => 'AssetAccounts',
|
|
],
|
|
'opposing-id' => [
|
|
'mappable' => true,
|
|
'pre-process-map' => false,
|
|
'field' => 'opposing-account-id',
|
|
'converter' => 'AccountId',
|
|
'mapper' => 'OpposingAccounts',
|
|
],
|
|
'opposing-name' => [
|
|
'mappable' => true,
|
|
'pre-process-map' => false,
|
|
'field' => 'opposing-account-name',
|
|
'converter' => 'OpposingAccountName',
|
|
'mapper' => 'OpposingAccounts',
|
|
],
|
|
'opposing-iban' => [
|
|
'mappable' => true,
|
|
'pre-process-map' => false,
|
|
'field' => 'opposing-account-iban',
|
|
'converter' => 'OpposingAccountIban',
|
|
'mapper' => 'OpposingAccountIbans',
|
|
],
|
|
'opposing-number' => [
|
|
'mappable' => true,
|
|
'pre-process-map' => false,
|
|
'field' => 'opposing-account-number',
|
|
'converter' => 'OpposingAccountNumber',
|
|
'mapper' => 'OpposingAccounts',
|
|
],
|
|
'amount' => [
|
|
'mappable' => false,
|
|
'pre-process-map' => false,
|
|
'converter' => 'Amount',
|
|
'field' => 'amount',
|
|
],
|
|
'amount_debet' => [
|
|
'mappable' => false,
|
|
'pre-process-map' => false,
|
|
'converter' => 'AmountDebet',
|
|
'field' => 'amount_debet',
|
|
],
|
|
'amount_credit' => [
|
|
'mappable' => false,
|
|
'pre-process-map' => false,
|
|
'converter' => 'AmountCredit',
|
|
'field' => 'amount_credit',
|
|
],
|
|
'sepa-ct-id' => [
|
|
'mappable' => false,
|
|
'pre-process-map' => false,
|
|
'converter' => 'Description',
|
|
'field' => 'description',
|
|
],
|
|
'sepa-ct-op' => [
|
|
'mappable' => false,
|
|
'pre-process-map' => false,
|
|
'converter' => 'Description',
|
|
'field' => 'description',
|
|
],
|
|
'sepa-db' => [
|
|
'mappable' => false,
|
|
'pre-process-map' => false,
|
|
'converter' => 'Description',
|
|
'field' => 'description',
|
|
],
|
|
],
|
|
|
|
// number of example rows:
|
|
'example_rows' => 5,
|
|
'default_config' => [
|
|
'initial-config-complete' => false,
|
|
'has-headers' => false, // assume
|
|
'date-format' => 'Ymd', // assume
|
|
'delimiter' => ',', // assume
|
|
'import-account' => 0, // none,
|
|
'specifics' => [], // none
|
|
'column-count' => 0, // unknown
|
|
'column-roles' => [], // unknown
|
|
'column-do-mapping' => [], // not yet set which columns must be mapped
|
|
'column-roles-complete' => false, // not yet configured roles for columns
|
|
'column-mapping-config' => [], // no mapping made yet.
|
|
'column-mapping-complete' => false, // so mapping is not complete.
|
|
],
|
|
];
|