Git Product home page Git Product logo

data's Introduction

Afosto Data

Abstraction of the data models that are to be used to interact with our API. Currently this package has support for the following 'Operations':

More operations are to be included soon. If you see a great usecase for this but need more information just contact us at [email protected].

##Why

There already is an Api Client, why do I need this package? Well have concluded that the api client as it is right now it to tightly coupled with the API and interacting with it. This package is part of a bigger idea that we want to decouple parts that might be usefull for interaction with the API.

For instance you can already use the separated oauth-client to solve your problems in obtaining authentication for the API.

Getting Started

Simply follow the installation instructions.

Prerequisites

What things you need to install the software and how to install them

  • PHP5.5+
  • Composer (for installation)

Installing

Installing is easy through Composer.

composer require afosto/data

Examples

Now to build a product model:

$product = new Product();

Set the values inline:

$product->weight = 10;

$product->supplier = new Supplier();
$product->supplier->id = 1;
$product->supplier->name = 'TestSupplier';

Or use setAttributes to set data based on an input array

$item = new Item();
$item->setAttributes([
    'sku'    => 'TEST-SKU-234',
    'ean'    => '234554245',
    'prices' => [
        [
            'price_gross' => 23.54,
            'tax_class'   => [
                'id' => 2,
            ],
        ],
    ],
]);
$product->items[] = $item;

Optionally validate the newly generated model:

$product->validate();

Returns the structured data as an array:

$product->getAttributes();

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the Apache License 2.0 - see the LICENSE.md file for details

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.