PHP download

Download the PHP package antonythorpe/consumer without Composer

On this page you can find all versions of the php package antonythorpe/consumer. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Table of contents
Download antonythorpe/consumer
More information about antonythorpe/consumer
Files in antonythorpe/consumer

Vendor antonythorpe
Package consumer
Short Description A SilverStripe BulkLoader for consuming external APIs
License MIT

Keywords json xml silverstripe BulkLoader

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:

If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.

Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
To use Composer is sometimes complicated. Especially for beginners.
Composer needs much resources. Sometimes they are not available on a simple webspace.
If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.

Please rate this library. Is it a good library?

Informations about the package consumer

consumer

A SilverStripe BulkLoader for consuming external APIs

Maintain data integrity with an external source of truth. Keep dataobjects up to date with fresh data received from external APIs. Inspired by burnbright/silverstripe-importexport.

Features

Retains a record of the maximum last edited date (to use as a limit in future API calls)
Display, Log and/or email Bulk Loader Results showing the changes made to a dataobject
Localisation options available for Results report
Preview setting for dry runs leaving the dataobject untouched

Use Case

Where there is an external source of truth that a dataobject needs to be updated from.

An example is an eCommerce website where the product prices need to be kept in alignment with an online inventory system (which is used post-sale to manage fulfilment of an order). With the eCommerce website being a subset of the total inventory items in stock, updating, without creating new product items, is required. The pricing and other properties change frequently. Based upon the philosophy of entering data only once a sync from the external source of truth would keep the website accurate, up to date and reduce maintenance.

How to use

Subclass \AntonyThorpe\Consumer\BulkLoader and set your column map between the external API fields and the dataobject (see docs and tests folder for guidance).
Create a BuildTask to retrieve fresh API data using a tool like Guzzle
Alter the dataobject via a method on your BulkLoader subclass
Review the Bulk Loader Results report
Create an instance of the Consumer class and record the last edited date for future reference
Setup a cron job to run the BuildTask on a regular basis and monitor incoming emails for exceptions

Example

A bulk loader for Silvershop Unleashed Software (link)

Requirements

SilverStripe

Documentation

Index

Support

None sorry.

Change Log

Link

Contributing

Link

License

MIT

All versions of consumer with dependencies

PHP Build Version

Package Version

Version 4.0.1 Release 15. Jun 2024
create-project require 0 people chose require and
0 people chose create-project.

Download

Download latest version of consumer from vendor antonythorpe

Requires php Version ^8.1
silverstripe/framework Version ^5.0.0

Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package antonythorpe/consumer contains the following files

Loading the files please wait ....