lib/packages/wikibase/data-model/README.md
# Wikibase DataModel
[](http://travis-ci.org/wmde/WikibaseDataModel)
[](https://scrutinizer-ci.com/g/wmde/WikibaseDataModel/?branch=master)
[](https://scrutinizer-ci.com/g/wmde/WikibaseDataModel/?branch=master)
[](https://packagist.org/packages/wikibase/data-model)
[](https://packagist.org/packages/wikibase/data-model)
[](https://packagist.org/packages/wikibase/data-model)
[](//packagist.org/packages/wikibase/data-model)
**Wikibase DataModel** is the canonical PHP implementation of the
[Data Model](https://www.mediawiki.org/wiki/Wikibase/DataModel)
at the heart of the [Wikibase software](http://wikiba.se/).
It is primarily used by the Wikibase MediaWiki extensions, though
has no dependencies whatsoever on these or on MediaWiki itself.
Recent changes can be found in the [release notes](RELEASE-NOTES.md).
## Installation
You can use [Composer](http://getcomposer.org/) to download and install
this package as well as its dependencies. Alternatively you can simply clone
the git repository and take care of loading yourself.
### Composer
To add this package as a local, per-project dependency to your project, simply add a
dependency on `wikibase/data-model` to your project's `composer.json` file.
Here is a minimal example of a `composer.json` file that just defines a dependency on
Wikibase DataModel 9.x:
```js
{
"require": {
"wikibase/data-model": "~9.0"
}
}
```
### Manual
Get the Wikibase DataModel code, either via git, or some other means. Also get all dependencies.
You can find a list of the dependencies in the "require" section of the composer.json file.
The "autoload" section of this file specifies how to load the resources provide by this library.
## Library contents
This library contains domain objects that implement the concepts part of the
[Wikibase DataModel](https://www.mediawiki.org/wiki/Wikibase/DataModel).
This mainly includes simple value objects, though also contains core domain
logic either bound to such objects or encapsulated as service objects.
## Tests
This library comes with a set up PHPUnit tests that cover all non-trivial code. Additionally, code
style checks by PHPCS and PHPMD are supported. The configuration for all 3 these tools can be found
in the root directory. You can use the tools in their standard manner, though can run all checks
required by our CI by executing `composer ci`. To just run tests use `composer test`, and to just
run style checks use `composer cs`.
## Credits
### Development
Wikibase DataModel has been written by [Jeroen De Dauw](https://www.EntropyWins.wtf)
and Thiemo Kreuz as [Wikimedia Germany](https://wikimedia.de) employees for the [Wikidata project](https://wikidata.org/).
Contributions were also made by [several other people](https://www.ohloh.net/p/wikibasedatamodel/contributors?sort=commits).
### Concept
The initial [conceptual specification](https://www.mediawiki.org/wiki/Wikibase/DataModel)
for the DataModel was created by [Markus Krötzsch](http://korrekt.org/)
and [Denny Vrandečić](http://simia.net/wiki/Denny), with minor contributions by
Daniel Kinzler and Jeroen De Dauw.
## Links
* [Wikibase DataModel on Packagist](https://packagist.org/packages/wikibase/data-model)
* [Wikibase DataModel on Ohloh](https://www.ohloh.net/p/wikibasedatamodel/)
* [Wikibase DataModel on TravisCI](https://travis-ci.org/wmde/WikibaseDataModel)
* [Wikibase DataModel on ScrutinizerCI](https://scrutinizer-ci.com/g/wmde/WikibaseDataModel)
* [Wikibase DataModel on Wikimedia's Phabricator](https://phabricator.wikimedia.org/project/view/920/)
## See also
* [Blog posts on Wikibase DataModel](http://www.bn2vs.com/blog/tag/wikibase-datamodel/)
* [Wikibase DataModel Services](https://github.com/wmde/WikibaseDataModelServices)
* [Wikibase DataModel Serialization](https://github.com/wmde/WikibaseDataModelSerialization)
* [Wikibase Internal Serialization](https://github.com/wmde/WikibaseInternalSerialization)