library mason-php {🖫 171, ⚐ 19, ★ 19}

phonecom/mason-php

PHP library for generating Mason hypermedia documents

Wednesday, June 15, 2016
by curtisdf
Repository
8 Watchers
19 Stars
171 Installations

PHP
0 Dependents
0 Suggesters
0 Forks
0 Open issues
19 Versions
0 % Grown

The README.md

Mason PHP

, _(*1)

This project provides a PHP tool for building Hypermedia REST API's in Mason format., _(*2)

At present, it includes a set of Mason Builder classes for producing data structures that can be passed to json_encode() for rendering Mason response bodies., _(*3)

Example

Here is a simple example:, _(*4)

<?php
use PhoneCom\Mason\Builder\Document;

$doc = new Document([
    'first_name' => 'Oscar',
    'last_name' => 'Grouch',
    'birthday' => 'Apr 1',
    'address' => 'Sesame Street'
]);

$doc->addMetaProperty('@title', 'Oscar the Grouch')
    ->setProperty('clothing', 'Trash can')
    ->setControl('self', 'http://example.com/characters/oscar');

echo json_encode($doc);

This produces the following data structure:, _(*5)

{
    "first_name": "Oscar",
    "last_name": "Grouch",
    "birthday": "Apr 1",
    "address": "Sesame Street",
    "clothing": "Trash can",
    "@meta": {
        "@title": "Oscar the Grouch"
    },
    "@controls": {
        "self": {
            "href": "http://example.com/characters/oscar"
        }
    }
}

Motivation

Mason is a Hypermedia RESTful API format first published in 2013 by Jørn Wildt. It combines lessons learned from years of API implementations and close study of other competing formats such as Hal, Collection+JSON, and JSON-LD. Each format has its strengths, but none has the desired balance of simplicity and features., _(*6)

Mason-PHP was built to help promote Mason adoption within the PHP community, and to provide much needed tooling., _(*7)

Installation

This project is integrated with Composer. You can put it in your composer.json as a dependency:, _(*8)

"require": {
    "phonecom/mason-laravel": "1.*"
}

Usage

Documentation is forthcoming. All public methods are documented inline, so at the moment, the best way to learn is to browse the code., _(*9)

Tests

Run phpunit in the top folder. If you have the XDebug extension installed, you may also run it with the Code Coverage config which is provided separately, e.g. phpunit -c phpunit-coverage-html.xml, _(*10)

Contributors

This project was created and is managed by Phone.com. We're building a hot new Hypermedia API and we chose Mason!, _(*11)

Pull requests are welcome., _(*12)

License

The Versions

15/06 2016

dev-test-versioned-paths

PHP library for generating Mason hypermedia documents

library mason-php

PHP library for generating Mason hypermedia documents

phonecom/mason-php

The README.md

Mason PHP

Example

Motivation

Installation

Usage

Tests

Contributors

License

The Versions

dev-test-versioned-paths

The Requires

The Development Requires

by Curtis Farnham

dev-master

The Requires

The Development Requires

by Curtis Farnham

1.10.0

The Requires

The Development Requires

by Curtis Farnham

1.9.1

The Requires

The Development Requires

by Curtis Farnham

1.9.0

The Requires

The Development Requires

by Curtis Farnham

1.8.1

The Requires

The Development Requires

by Curtis Farnham

1.8.0

The Requires

The Development Requires

by Curtis Farnham

1.7.0

The Requires

The Development Requires

by Curtis Farnham

1.6.2

The Requires

The Development Requires

by Curtis Farnham

1.5.0

The Requires

The Development Requires

by Curtis Farnham

1.4.1

The Requires

The Development Requires

by Curtis Farnham

1.4.0

The Requires

The Development Requires

by Curtis Farnham

1.3.0

The Requires

The Development Requires

by Curtis Farnham

1.2.0

The Requires

The Development Requires

by Curtis Farnham

1.1.1

The Requires

The Development Requires

by Curtis Farnham

1.1.0

The Requires

The Development Requires

by Curtis Farnham

1.0.2

The Development Requires

by Curtis Farnham