heyday / silverstripe-flexibledataformatters
Installs: 952
Dependents: 0
Suggesters: 0
Security: 0
Stars: 3
Watchers: 27
Forks: 1
Type:silverstripe-module
Requires
- composer/installers: ~1.0
Requires (Dev)
- phpunit/phpunit: ~3.7
- silverstripe/framework: 3.*
- symfony/class-loader: ~2.2
This package is auto-updated.
Last update: 2024-10-29 04:14:36 UTC
README
Provides a way to easily format a selection of a DataObject's fields used in a custom API. This is often useful when creating your own RESTful API that doesn't use SilverStripes RestfulServer
For a SilverStripe 2.4
compatible version see the branch 0.2
.
Installation (with composer)
$ composer require heyday/silverstripe-flexibledataformatters:~0.1
Usage
class MyDataObject extends DataObject implements FlexibleDataFormatterInterface { public static $db = array( 'Title' => 'Varchar(255)' ); public function getReadableFields() { return array( 'Title' ); } public function getDynamicFields() { return array(); } } $dataObject = new MyDataObject(array('Title' => 'Hello')); $formatter = new FlexibleJsonDataFormatter(); echo $formatter->convertDataObject($dataObject); // Results: // { // "Title": "Hello" // }
Unit testing
Install dev dependencies from within module:
silverstripe-flexibledataformatters/ $ composer install --dev
Use standard phpunit
command
silverstripe-flexibledataformatters/ $ phpunit
If you don't have phpunit
installed globally:
silverstripe-flexibledataformatters/ $ vendor/bin/phpunit
##License
Flexible Data Formatters is licensed under an MIT license