Download the PHP package tystr/rest-orm without Composer

RestOrm

Note: as of v0.6.0 this library depends on PHP 7.x.

A simple ORM-like package for handling object persistence using a RESTful API.

Installation

Install tystr/rest-orm with composer:

# composer.phar require tystr/rest-orm:~0.1

Configuration

For each of your models you need to add mapping configuration and set up a Repository instance.

Mapping

RestOrm provides 2 annotations which must be used on each model:

• @Resource This configures the name of the rest resource to use when generating urls.
• @Id This configures the property to use as the identifier.

Data is hydrated into the models using JMS Serializer. See the documentation here for information on how to add mapping for your models.

Configure the Repository

Now that your models are mapped, you need to configure a Tystr\RestOrm\Repository\Repository instance for each of your models.

First, configure the guzzle client that will be used to make request to your API:

Next, set up the RequestFactory:

Now instantiate a Response Mapper. RestOrm currently provides 2 types of response mappers:

• Tystr\RestOrm\Response\StandardResponseMapper for basic JSON serialization/deserialization
• Tystr\RestOrm\Response\HalResponseMapper for HAL-formatted APIs

Finally, instantiate a Repository class for each of your models:

Usage

The Tystr\RestOrm\Repository\RepositoryInterface currently provides 4 basic methods for interacting with your models:

• save($model)
• findOneById($id)
• findAll()
• remove($model)