Giter Club home page Giter Club logo

ergontech_tabular's Introduction

Ergontech_Tabular Data Processor

ErgonTech_Tabular (sometimes refered to as "tabular" for the sake of brevity) is a Magento 1.x module designed to make tabular data processing easier. It provides a framework around which data import, export, and more can be built.

Installation

It is recommended to install ErgonTech_Tabular with composer. composer require ergontech/tabular-magento. Currently, there is no repository where Ergontech_Tabular can be found, so it must be added as a VCS repo. As it depends upon ergontech/tabular-core, that repository should also be added.

Components

Tabular is built using the following:

  • Profile: Represents a complete action, such as Import products into Magento from Google Sheet with ID x. Accepts a Processor and adds the necessary Steps to it to complete the action.
  • Step: A discrete action, such as create all nonexistent root categories found in the Rows (example)
  • Rows and Processor are described in Tabular's core

Usage

Out of the box, Tabular provides the following functionality:

  • Loading data from Google Sheets
  • Importing products, categories, and product categorization using AvS_FastSimpleImport
  • Importing attributes
  • Transforming column headers to match input requirements

Adding Functionality

The main entry points for functionality are profile type classes, profile type XML configuration, and Row Transforms.

Module Configuration

This module provides the following configuration values:

  • tabular/general/enabled A yes/no value. Enables/disables the entire module
  • tabular/google_api/type See ErgonTech\Tabular\Model_Source_Google_Api_Type
    • API keys only have access to public sheets, whereas a Service Account can access private sheets
  • tabular/google_api/api_key Authentication credentials for access. Use the correct authentication data corresponding to the chosen type.

Transform Helpers

Note: The Header Transform functionality of Tabular is deprecated and will be removed in the future!

Currently, most profile types have both a ErgonTech\Tabular\HeaderTransformStep and ErgonTech\Tabular\RowTransformStep(see their contents in ergontech/tabular-core). As of the pre-1.0 release phase, these both accept just one callback.

Example

Most Transform Helpers are picked as an "extra profile data" option. Existing Profile Types use a callback node in the option to specify the method to be called:

<!-- config/global/ergontech/tabular/profile/type/[type] -->
<extra>
    <transform_option>
        <input>select</input>
        <label>Transform Option</label>
        <options>
            <option_1>
                <label>First</label>
                <callback>ClassName_Of_Helper_Class::rowTransformMethodName</callback>
            </option_1>
            <option_2>
                <label>Second</label>
                <callback>ClassName_Of_Helper_Class::otherRowTransformMethodName</callback>
            </option_2>
        </options>
    </transform_option>
</extra>

For an example of how to retrieve the callback configuration and turn it into a valid callable, see ErgonTech\Tabular\Helper_RowTransforms::getRowTransformCallbackForProfile

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.