README

your go-to solution for effortless data imports. With a user-friendly interface and support for JSON data formats, importing data into Statamic becomes as easy as a wave of a wand. Experience the magic of hassle-free data management

This addon can work with JSON files extracted using a statamic exporter Wordpress plugin.

Json import

JSON file examples:

collections.example.json

{
  // Defining collections
  "collections": {
    // Name of new collection (You can add as many collections as you need)
    "post": {
      // Entrie slug
      "/post/top-10-titles": {
        // Date of creation (here you can use "order" keyword as well)
        "date": "2023-10-04",
        // Fields
        "data": {
          "title": "Top 10 Titles for example data",
          "content": "<div>Some HTML content for TinyMCE or Bard fields</div>",
          "author": "admin",
          "featured_image": "https://example.com/images/nice-image.webp", // It will download your image and add to assets
          "categories": ["category_1", "category_2"], // Create taxonomy and import it in "Taxonomy terms" field
          "tags": ["tag_1", "tag_2", "tag_3"] // For "Taxonomy terms" field
        }
      }
    }
  }
}

taxonomies.example.json

{
  // Defining taxonomies
  "taxonomies": {
    // Taxonomy name
    "categories": {
      // Taxonomy terms and titles:
      "development": {
        "title": "Development"
      },
      "outsourcing": {
        "title": "Outsourcing"
      },
      "product-design": {
        "title": "Product design"
      },
      "project-management": {
        "title": "Project management"
      },
      "startups": {
        "title": "Startups"
      },
      "tech-news": {
        "title": "Tech news"
      },
      "uncategorized": {
        "title": "Uncategorized"
      }
    }
  }
}

Features

Json import:

Create taxonomies and terms
Create pages
Create collections and entries
- includes fields choosing feature for importing in existing collections

Any meta data key prefixed with an underscore will be ignored.

Events

The addon is using the builtin methods for creating and saving content. As such, the normal events are dispatched which you can hook into for additional work according to your setup. That means you can listen on the following events to customize the import:

Statamic\Events\CollectionCreated
Statamic\Events\CollectionSaved
Statamic\Events\EntrySaving
Statamic\Events\EntryCreated
Statamic\Events\EntrySaved
Statamic\Events\TaxonomySaved
Statamic\Events\TermSaved
Statamic\Events\AssetSaved
Statamic\Events\AssetUploaded

By the time you read this there might be others. Consult the documentation to learn more.

Images

All URLs including image extensions (.png, .jpg, .webp and etc) will be downloaded. Featured images will be downloaded to the "assets" container by default (change in config), into a folder called "{collection_handle}/{entry_slug}", and saved in a assets field.

How to Install

You can search for this addon in the Tools > Addons section of the Statamic control panel and click install, or run the following command from your project root:

composer require maestroerror/statamic-magic-import

How to Use

Go to the Tools > Magic Import section and upload the json file.

For collections, the summary will show you 2 options: creating a new collection or importing in existing one.

When importing in existing collection, you can choose JSON field for each of your collection fields.

Even when creating new collection, there might be the collection with same name. If you choose to import it anyway, the content will be overwritten, but you can (De)Select anything you want (by titles) and click "Import".

Note: You might get timeout errors if you're importing large datasets and/or many images.

Config

The content of the config file looks like this:

<?php

return [

    /*
     * Enable downloading images. The default is 'true'.
     */
    'download_images' => true,

    /**
     * The name of the assets container where images should be downloaded.
     */
    'assets_container' => 'assets',

    /*
     * Whether to skip download of an image if it already exist. The default is 'false'.
     */
    'skip_existing_images' => false,

    /*
     * Enable image overwriting. When set to false, a new image are created with a timestamp suffix, if the image already exists. The default is 'false'.
     */
    'overwrite_images' => false,

    /*
     * Set images as Asset object, path or ID
     * Possible values: path, object, id (If none of them is set 'path' will be used)
     */
    'set_images_as' => "path",

    /*
     * Sets data in same manner as in CP controller, processing via blueprint's fields
     * Skips field if any error occured and logs the error
     */
    'set_data_using_fields' => false,

    /*
     * In case if you are updating your images path with some suffix, for example ".webp"
     */
    'image_suffix' => "",

    /*
     * Filter out meta data keys prefixed with '_'. The default is 'true'.
     */
    'exclude_underscore_data' => true,

];

You can publish configuration file using this command:

php artisan vendor:publish --tag=statamic-magic-import-config

You can publish other asset with the command:

php artisan vendor:publish --tag=statamic-magic-import

To Do

Using JSON field twice skips the first field (Was using "title" from json in "title" and "header" in collection and collection's "title" field was empty)

maestroerror / statamic-magic-import

Maintainers

Details