Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bedita/import-tools
Tools for data import with BEdita
https://github.com/bedita/import-tools
Last synced: about 1 month ago
JSON representation
Tools for data import with BEdita
- Host: GitHub
- URL: https://github.com/bedita/import-tools
- Owner: bedita
- License: gpl-3.0
- Created: 2023-03-15T12:59:07.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-18T06:57:46.000Z (9 months ago)
- Last Synced: 2024-04-18T07:57:44.111Z (9 months ago)
- Language: PHP
- Size: 57.6 KB
- Stars: 2
- Watchers: 5
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BEdita/ImportTools plugin for CakePHP apps using BEdita
[](https://github.com/bedita/import-tools/actions?query=workflow%3Aphp)
[](https://codecov.io/gh/bedita/import-tools)
[](https://phpstan.org)
[](https://scrutinizer-ci.com/g/bedita/import-tools/?branch=main)
[](https://packagist.org/packages/bedita/import-tools)
[](https://github.com/bedita/import-tools/blob/main/LICENSE.LGPL)
## Installation
First, if `vendor` directory has not been created, you have to install composer dependencies using:
```bash
composer install
```
You can install this plugin into your CakePHP application using [composer](http://getcomposer.org).
The recommended way to install composer packages is:
```bash
composer require bedita/import-tools
```
## Commands
### AnonymizeUsersCommand
This command provides a tool to anonymize users.
Usage examples
```bash
// anonymize all users (except user by ID 1, admin)
$ bin/cake anonymize_users
// anonymize users by id 2,3,4
$ bin/cake anonymize_users --id 2,3,4
// anonymize all users except users by id 1,2,3
$ bin/cake anonymize_users --preserve 1,2,3
```
### ImportCommand
This command provides a tool to import data from csv file.
Usage examples:
```bash
# basic
$ bin/cake import --file documents.csv --type documents
$ bin/cake import -f documents.csv -t documents
# dry-run
$ bin/cake import --file articles.csv --type articles --dryrun yes
$ bin/cake import -f articles.csv -t articles -d yes
# destination folder
$ bin/cake import --file news.csv --type news --parent my-folder-uname
$ bin/cake import -f news.csv -t news -p my-folder-uname
# translations
$ bin/cake import --file translations.csv --type translations
$ bin/cake import -f translations.csv -t translations
```
### ImportProjectCommand
You could use this command when you are copying a remote database to a locale database, and after that you want to "adjust" applications and users.
Applications and users in default datasource will be updated.
Before launching it, you should setup properly default and import datasources in config/app_local.php.
Example:
```php
'Datasources' => [
// the target database
'default' => [
'className' => 'Cake\Database\Connection',
'driver' => 'Cake\Database\Driver\Mysql',
'host' => '***********',
'port' => '***********',
'username' => '***********',
'password' => '***********',
'database' => '***********',
// ...
],
// the remote database you want to you as source
'import' => [
'className' => 'Cake\Database\Connection',
'driver' => 'Cake\Database\Driver\Mysql',
'host' => '***********',
'port' => '***********',
'username' => '***********',
'password' => '***********',
'database' => '***********',
// ...
],
],
```
Usage example:
```bash
$ bin/cake import_project
```
### TranslateFileCommand
This command provides a tool to translate the content of a file from one language to another, using a translator service (i.e., set in `config/app_local.php`).
Translator service configuration example:
```php
'Translators' => [
'deepl' => [
'name' => 'DeepL',
'class' => '\BEdita\I18n\Deepl\Core\Translator',
'options' => [
'auth_key' => '************',
],
],
]
```
Usage example:
```bash
$ bin/cake translate_file \
--input articles-en.txt \
--output articles-it.txt \
--from en \
--to it \
--translator deepl
```
### TranslateObjectsCommand
This command provides a tool to translate the content of objects from one language to another, using a translator service (i.e., set in `config/app_local.php`, as described above).
Usage examples:
```bash
# basic
$ bin/cake translate_objects \
--from en \
--to it \
--engine deepl
# dry-run
$ bin/cake translate_objects \
--from en \
--to it \
--engine deepl \
--dry-run yes
# limit
$ bin/cake translate_objects \
--from en \
--to it \
--engine deepl \
--limit 10
# status
$ bin/cake translate_objects \
--from en \
--to it \
--engine deepl \
--status draft
# type
$ bin/cake translate_objects \
--from en \
--to it \
--engine deepl \
--type articles
```
## Utilities
You can find some utility classes in `src/Utility` folder.
### CsvTrait
This trait provides `readCsv` method to progressively read a csv file line by line.
Usage example:
```php
use BEdita\ImportTools\Utility\CsvTrait;
class MyImporter
{
use CsvTrait;
public function import(string $filename): void
{
foreach ($this->readCsv($filename) as $obj) {
// process $obj
}
}
}
```
### FileTrait
This trait provides `readFileStream` method to open "read-only" file stream (you can use local filesystem or adapter).
Usage example:
```php
use BEdita\ImportTools\Utility\FileTrait;
class MyImporter
{
use FileTrait;
public function read(string $file): void
{
[$fh, $close] = $this->readFileStream($path);
try {
flock($fh, LOCK_SH);
// do your stuff
} finally {
$close();
}
}
}
```
### TreeTrait
This trait provides `setParent` method to save the parent for a specified entity.
Usage example:
```php
use BEdita\ImportTools\Utility\TreeTrait;
class MyImporter
{
use TreeTrait;
public function import(string $filename, string $destination): void
{
foreach ($this->readCsv($filename) as $obj) {
$this->setParent($obj, $destination);
}
}
}
```
### Import
This class provides functions to import data from csv files into BEdita.
Public methods are:
- `saveObjects`: read data from csv and save objects
- `saveObject`: save a single object
- `saveTranslations`: read data from csv and save translations
- `saveTranslation`: save a single translation
- `translatedFields`: get translated fields for a given object
Usage example:
```php
use BEdita\ImportTools\Utility\Import;
class MyImporter
{
public function import(string $filename, string $type, ?string $parent, ?bool $dryrun): void
{
$import = new Import($filename, $type, $parent, $dryrun);
$import->saveObjects();
}
}
```