A flat-file, serverless, document database for PHP that can store data in JSON, YAML or Markdown formats.
A flat-file, serverless, document database for PHP that can store data in JSON, YAML or Markdown formats.
A flat-file, serverless, document database for PHP that can store data in JSON, YAML or Markdown formats.
Often MySQL can be overkill for a small site or blog installation. Although it's present by as standard on many hosting packages it still requires several manual steps including configuration, user and databases creation etc.
Additionally, content stored in MySQL databases is impossible (or at least very difficult) to track using version control software. This makes sharing a site or app between a team difficult, requiring everybody to have access to a master database or their own copy. There's also complications when apps are setup on staging servers and changes that users make must be reflected in a developer's local copy. You've probably come up against this issue in the past and it's all a bit of a mess.
Flywheel hopes to enable a new breed of PHP apps and libraries by giving developers access to a datastore that acts in a similar way to a NoSQL database but has zero external dependencies. Documents (essentially associative arrays), can be saved and retrieved, sorted and limited.
Currently Flywheel is in heavy development and is not production ready yet. You might find that documents created from one version of Flywheel can't be loaded by another right now. As we get closer and closer to a v1 this is less likely to happen.
Flywheel is opinionated software. The following is assumed:
Optionally
Use Composer to install the flywheel package. Package details can be found on Packagist.org.
Run composer require jamesmoss/flywheel in your project directory to install the Flywheel package.
…You can filter down the number of documents returned by using the where, andWhere
and orWhere methods on a query.
…You can pass in an anonymous function to the where, andWhere
and orWhere methods to group predicates together. The anonymous function takes
one parameter which is an instance of JamesMoss\Flywheel\Predicate and has
the same methods. You can nest as many times you as like.
$posts = $repo->query()
->where('wordCount', '>', 100)
->andWhere(function($query) {
$query->where('author', '==', 'Hugo')
$query->orWhere('dateAdded', '>', new \DateTime('2014-05-04'))
})
->execute();Important Traditional logical operator precedence is not implemented yet.
If you have a mix of AND and ORs then you might not see the behaviour you expect.
Currently AND predicates are processed before OR, regardless of the order
they were defined in. Always use anonymous function to group your predicates
together explictly if you have a mix of AND and ORs.
The list of available comparison operators are:
== Equality=== Strict equality!= Not equals!== Strict not equals> Greater than>= Greater than or equal to// You can use sub keys too $posts = $repo->query() ->orderBy('translations.de DESC') ->execute();
// It's possible to sort on multiple fields by passing in an array to orderBy $posts = $repo->query() ->orderBy(['name ASC', 'age DESC']) ->execute();
// Use the special __id field name to sort by the document's ID $posts = $repo->query() ->orderBy('__id') ->execute();
You can limit how many documents get returned from the repo using `limit`. Offsets
are also supported much like a traditional database.
```php
// Get the last 5 blog posts
$posts = $repo->query()
->where('published', '==', 'true')
->orderBy('dateAdded DESC')
->limit(5)
->execute();
// Get 25 blog posts offset by 100 from the start.
$posts = $repo->query()
->where('published', '==', 'true')
->orderBy('dateAdded DESC')
->limit(25, 100)
->execute();
…
php
$config = new Config('/path/to/writable/directory', array(
'formatter' => new \JamesMoss\Flywheel\Formatter\YAML,
))The following formatter classes are available.
JamesMoss\Flywheel\Formatter\JSON - Will attempt to pretty print output if using PHP 5.4+. File extension is json.JamesMoss\Flywheel\Formatter\YAML - Uses yaml file extension, not yml.JamesMoss\Flywheel\Formatter\Markdown - Takes an optional parameter in the constructor which dictates
the name of the main field in the resulting Document (Defaults to body). File extension is md. Markdown isn't
converted into HTML, that's up to you.Important If you use the YAML or Markdown formatters when using the --no-dev flag in Composer you'll need
to manually add mustangostang\spyc to your composer.json. Flywheel tries to keep it's dependencies to a minimum.
If you write your own formatter it must implement JamesMoss\Flywheel\Formatter\Format.
Repository::findAll.There is good test coverage at the moment. If you'd like to run the tests yourself, use the following:
$ composer install
$ phpunitIf you spot something I've missed, fork this repo, create a new branch and submit a pull request. Make sure any features you add are covered by unit tests and you don't break any other tests.
No open issues yet, or sync has not completed.